Window style & layout

Table of Contents

• Reading/Setting the style
  • Decoration (Border, Titlebar)
  • Floating (Always on top)
  • Resizeable
• Getting/Changing the size/position
  • Window position
  • Window size
  • Fullscreen size
• Changing the window cursor
• Get/Set the window title
• Get/Set the window state
• Notes

Reading/Setting the style

Decoration (Border, Titlebar)

By default, a window is decorated. This means that it has a border, a title bar, and can be moved by the user.
If you enable window decorations, your window will have a border and a title bar always.

Use fplIsWindowDecorated() to determine if the window has decoration enabled or not.
Use fplSetWindowDecorated() to enable/disable the window decoration.

Example:

// Enable window decoration
fplSetWindowDecorated(true);
 
// Disable window decoration
fplSetWindowDecorated(false);
 
// Toggle window decoration
fplSetWindowDecorated(!fplIsWindowDecorated());

Note

You can overwrite the default decoration behavior by changing the value in fplWindowSettings::isDecorated from the fplSettings::window field at startup.

Floating (Always on top)

By default, a window is not in floating mode. This means when another window gets focus, your window loses its focus.
If you set your window to floating instead, your window will always be on top of others.

Use fplIsWindowFloating() to determine if the window is floating or not.
Use fplSetWindowFloating() to enable/disable the window floating.

Example:

// Enable window floating
fplSetWindowFloating(true);
 
// Disable window floating
fplSetWindowFloating(false);
 
// Toggle window floating
fplSetWindowFloating(!fplIsWindowFloating());

Note

You can overwrite the default floating behavior by changing the value in fplWindowSettings::isFloating from the fplSettings::window field at startup.

Resizeable

By default, a window is resizeable. This means you can resize your window however you like.

Use fplIsWindowResizable() to determine if the window is resizable or not.
Use fplSetWindowResizeable() to enable/disable the window resizing.

Example:

// Enable resizing of the window
fplSetWindowResizeable(true);
 
// Disable resizing of the window
fplSetWindowResizeable(false);
 
// Toggle window resizing mode
fplSetWindowResizeable(!fplIsWindowResizable());

Note

You can overwrite the default resizable behavior by changing the value in fplWindowSettings::isResizable from the fplSettings::window field at startup.

Getting/Changing the size/position

Window position

By default, a window uses either the default position from the platform or a fixed location of 0x0 screen units.

Use fplSetWindowPosition() to change the position of the window Use fplGetWindowPosition() to retrieve the current absolute window position from the top-left corner

Example:

// Retrieve absolute window position
fplWindowPosition curPos;
if (fplGetWindowPosition(&curPos)) {
    // Do something with the window position
}
 
// Change window absolute position to 0x0
fplSetWindowPosition(0, 0);

Window size

By default, a window is created using either the default size of the platform or a fixed size of 400x400 screen units.

Use fplSetWindowSize() to change the size of the area of the window.
Use fplGetWindowSize() to get the size of the area of the window.

Example:

// Retrieve window inner/client size
fplWindowSize curSize;
if (fplGetWindowSize(&curSize)) {
    // Do something with the client size
}
 
// Change window size to fit 800x600 screen units inside the client area
fplSetWindowSize(800, 600);

Note

You can overwrite the default window size by changing the value in fplWindowSettings::windowSize from the fplSettings::window field at startup.

Changing the window size changes the total size of the window - when decorations are enabled.

Fullscreen size

By default, the window is created in non-fullscreen mode, using fplWindowSettings::windowSize from the fplSettings::window or the default window size. See Window size for more details.

Use fplSetWindowFullscreenSize() to enable/disable fullscreen for the window with a given size and a color depth with support of switching the screen-resolution if needed.
Use fplSetWindowFullscreenRect() to enable/disable fullscreen for the window with a given size and a position without changing the screen-resolution.
Use fplIsWindowFullscreen() to determine if the window is in fullscreen mode or not.

Enable fullscreen example:

// Enable fullscreen on the nearest desktop
fplEnableWindowFullscreen();
 
// or
 
// Enable fullscreen on the nearest desktop
fplSetWindowFullscreenSize(true, 0, 0, 0);
 
// Enable 1080p fullscreen on the nearest desktop
fplSetWindowFullscreenSize(true, 1920, 1080, 0);
 
// Switch to 1080p screen resolution with a refresh rate of 60 Hz on the nearest desktop
fplSetWindowFullscreenSize(true, 1920, 1080, 60);
 
// Enable a 4k stretched resolution on two 1080p monitor left-right configuration
fplSetWindowFullscreenRect(true, 0, 0, 3840, 1080);

Disable fullscreen example:

// Disable fullscreen size
fplSetWindowFullscreenSize(false, 0, 0, 0);
 
// or
 
// Disable fullscreen rect
fplSetWindowFullscreenRect(false, 0, 0, 0, 0);
 
// or
 
// Disable fullscreen
fplDisableWindowFullscreen();

Query fullscreen state:

if (fplIsWindowFullscreen()) {
    // Do something on fullscreen mode
}
 
// Toggle fullscreen
fplSetWindowFullscreenSize(!fplIsWindowFullScreen(), 0, 0, 0);

Note

Set fplWindowSettings::isFullscreen to true to enable fullscreen at startup.

You can overwrite the fullscreen window size by changing the value in fplWindowSettings::fullscreenSize from the fplSettings::window field at startup.

You can overwrite the fullscreen refresh rate by changing the value in fplWindowSettings::fullscreenRefreshRate from the fplSettings::window field at startup.

If width or height in the fplWindowSettings.fullscreenSize field is zero, the current desktop rectangle is used from the nearest display.

Changing the window cursor

By default, the window has cursors enabled. Use fplSetWindowCursorEnabled to show/hide the cursor.

Example:

// Enable the cursor
fplSetWindowCursorEnabled(true);
 
// Disable the cursor
fplSetWindowCursorEnabled(false);

Get/Set the window title

By default, the window has an unnamed title. Use fplSetWindowTitle to set a window title on runtime.

Example:

// Set window title
fplSetWindowTitle("My awesome application");
 
// Get the window title
char titleBuffer[FPL_MAX_NAME_LENGTH];
fplGetWindowTitle(titleBuffer, fplArrayCount(titleBuffer));

Note

You can overwrite the window title by changing the value in fplWindowSettings::title from the fplSettings::window field at startup.

Get/Set the window state

By default, the window has a normal default state.

• Use fplSetWindowState to change to state the window state to a different one.
• Use fplGetWindowState to retrieve the current state of the window

Example:

// Iconify the window
fplSetWindowState(fplWindowState_Iconify);
 
// Maximize the window
fplSetWindowState(fplWindowState_Maximize);
 
// Reset to the normal when not normal
fplWindowState curState = fplGetWindowState();
if (curState != fplWindowState_Normal) {
    fplSetWindowState(fplWindowState_Normal);
}

Note

When the window is in fullscreen mode, fplWindowState_Fullscreen is returned from fplGetWindowState() always.

Warning

The window state fplWindowState_Fullscreen can never be set.

Notes

Note

Use fplSetDefaultWindowSettings() to initialize a fplWindowSettings to a default state.