Typed constant for macro SDL_GL_CONTEXT_DEBUG_FLAG. Combine with .|. from Data.Bits.

Typed constant for macro SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG. Combine with .|. from Data.Bits.

Typed constant for macro SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG. Combine with .|. from Data.Bits.

Typed constant for macro SDL_GL_CONTEXT_RESET_ISOLATION_FLAG. Combine with .|. from Data.Bits.

Typed constant for macro SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE.

Typed constant for macro SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH.

Typed constant for macro SDL_GL_CONTEXT_RESET_NO_NOTIFICATION.

Typed constant for macro SDL_GL_CONTEXT_RESET_LOSE_CONTEXT.

Typed constant for macro SDL_GL_CONTEXT_PROFILE_CORE.

Typed constant for macro SDL_GL_CONTEXT_PROFILE_COMPATIBILITY.

Typed constant for macro SDL_GL_CONTEXT_PROFILE_ES.

Typed constant for macro SDL_WINDOW_FULLSCREEN. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_OPENGL. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_OCCLUDED. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_HIDDEN. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_BORDERLESS. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_RESIZABLE. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_MINIMIZED. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_MAXIMIZED. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_MOUSE_GRABBED. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_INPUT_FOCUS. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_MOUSE_FOCUS. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_EXTERNAL. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_MODAL. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_HIGH_PIXEL_DENSITY. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_MOUSE_CAPTURE. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_MOUSE_RELATIVE_MODE. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_ALWAYS_ON_TOP. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_UTILITY. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_TOOLTIP. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_POPUP_MENU. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_KEYBOARD_GRABBED. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_FILL_DOCUMENT. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_VULKAN. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_METAL. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_TRANSPARENT. Combine with .|. from Data.Bits.

Typed constant for macro SDL_WINDOW_NOT_FOCUSABLE. Combine with .|. from Data.Bits.

Get the number of video drivers compiled into SDL.

Returns

the number of built in video drivers.

Thread safety

This function should only be called on the main thread.

See also

getVideoDriver

sdl3-bindgen-sys notes

Since: 3.2.0

Get the number of video drivers compiled into SDL.

Returns

the number of built in video drivers.

Thread safety

This function should only be called on the main thread.

See also

getVideoDriver

sdl3-bindgen-sys notes

Since: 3.2.0

Get the name of a built in video driver.

The video drivers are presented in the order in which they are normally checked during initialization.

The names of drivers are all simple, low-ASCII identifiers, like "cocoa", "x11" or "windows". These never have Unicode characters, and are not meant to be proper names.

Returns

the name of the video driver with the given index, or NULL if index is out of bounds.

Thread safety

This function should only be called on the main thread.

See also

getNumVideoDrivers

sdl3-bindgen-sys notes

Since: 3.2.0

Get the name of a built in video driver.

The video drivers are presented in the order in which they are normally checked during initialization.

The names of drivers are all simple, low-ASCII identifiers, like "cocoa", "x11" or "windows". These never have Unicode characters, and are not meant to be proper names.

Returns

the name of the video driver with the given index, or NULL if index is out of bounds.

Thread safety

This function should only be called on the main thread.

See also

getNumVideoDrivers

sdl3-bindgen-sys notes

Since: 3.2.0

Get the name of the currently initialized video driver.

The names of drivers are all simple, low-ASCII identifiers, like "cocoa", "x11" or "windows". These never have Unicode characters, and are not meant to be proper names.

Returns

the name of the current video driver or NULL if no driver has been initialized.

Thread safety

This function should only be called on the main thread.

See also

getNumVideoDrivers, getVideoDriver

sdl3-bindgen-sys notes

Since: 3.2.0

Get the name of the currently initialized video driver.

The names of drivers are all simple, low-ASCII identifiers, like "cocoa", "x11" or "windows". These never have Unicode characters, and are not meant to be proper names.

Returns

the name of the current video driver or NULL if no driver has been initialized.

Thread safety

This function should only be called on the main thread.

See also

getNumVideoDrivers, getVideoDriver

sdl3-bindgen-sys notes

Since: 3.2.0

Get the current system theme.

Returns

the current system theme, light, dark, or unknown.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the current system theme.

Returns

the current system theme, light, dark, or unknown.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get a list of currently connected displays.

Returns

a 0 terminated array of display instance IDs or NULL on failure; call getError for more information. This should be freed with free when it is no longer needed.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get a list of currently connected displays.

Returns

a 0 terminated array of display instance IDs or NULL on failure; call getError for more information. This should be freed with free when it is no longer needed.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Return the primary display.

Returns

the instance ID of the primary display on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Return the primary display.

Returns

the instance ID of the primary display on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the properties associated with a display.

The following read-only properties are provided by SDL:

• sDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN: true if the display has HDR headroom above the SDR white point. This is for informational and diagnostic purposes only, as not all platforms provide this information at the display level.

On KMS/DRM:

• sDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER: the "panel orientation" property for the display in degrees of clockwise rotation. Note that this is provided only as a hint, and the application is responsible for any coordinate transformations needed to conform to the requested display orientation.

On Wayland:

• sDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER: the wl_output associated with the display

On Windows:

• sDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER: the monitor handle (HMONITOR) associated with the display

Returns

a valid property ID on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the properties associated with a display.

The following read-only properties are provided by SDL:

• sDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN: true if the display has HDR headroom above the SDR white point. This is for informational and diagnostic purposes only, as not all platforms provide this information at the display level.

On KMS/DRM:

• sDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER: the "panel orientation" property for the display in degrees of clockwise rotation. Note that this is provided only as a hint, and the application is responsible for any coordinate transformations needed to conform to the requested display orientation.

On Wayland:

• sDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER: the wl_output associated with the display

On Windows:

• sDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER: the monitor handle (HMONITOR) associated with the display

Returns

a valid property ID on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the name of a display in UTF-8 encoding.

Returns

the name of a display or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the name of a display in UTF-8 encoding.

Returns

the name of a display or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the desktop area represented by a display.

The primary display is often located at (0,0), but may be placed at a different location depending on monitor layout.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayUsableBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the desktop area represented by a display.

The primary display is often located at (0,0), but may be placed at a different location depending on monitor layout.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayUsableBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the usable desktop area represented by a display, in screen coordinates.

This is the same area as getDisplayBounds reports, but with portions reserved by the system removed. For example, on Apple's macOS, this subtracts the area occupied by the menu bar and dock.

Setting a window to be fullscreen generally bypasses these unusable areas, so these are good guidelines for the maximum space available to a non-fullscreen window.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the usable desktop area represented by a display, in screen coordinates.

This is the same area as getDisplayBounds reports, but with portions reserved by the system removed. For example, on Apple's macOS, this subtracts the area occupied by the menu bar and dock.

Setting a window to be fullscreen generally bypasses these unusable areas, so these are good guidelines for the maximum space available to a non-fullscreen window.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the orientation of a display when it is unrotated.

Returns

the SDL_DisplayOrientation enum value of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the orientation of a display when it is unrotated.

Returns

the SDL_DisplayOrientation enum value of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the orientation of a display.

Returns

the SDL_DisplayOrientation enum value of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the orientation of a display.

Returns

the SDL_DisplayOrientation enum value of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the content scale of a display.

The content scale is the expected scale for content based on the DPI settings of the display. For example, a 4K display might have a 2.0 (200%) display scale, which means that the user expects UI elements to be twice as big on this display, to aid in readability.

After window creation, getWindowDisplayScale should be used to query the content scale factor for individual windows instead of querying the display for a window and calling this function, as the per-window content scale factor may differ from the base value of the display it is on, particularly on high-DPI and/or multi-monitor desktop configurations.

Returns

the content scale of the display, or 0.0f on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowDisplayScale, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the content scale of a display.

The content scale is the expected scale for content based on the DPI settings of the display. For example, a 4K display might have a 2.0 (200%) display scale, which means that the user expects UI elements to be twice as big on this display, to aid in readability.

After window creation, getWindowDisplayScale should be used to query the content scale factor for individual windows instead of querying the display for a window and calling this function, as the per-window content scale factor may differ from the base value of the display it is on, particularly on high-DPI and/or multi-monitor desktop configurations.

Returns

the content scale of the display, or 0.0f on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowDisplayScale, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get a list of fullscreen display modes available on a display.

The display modes are sorted in this priority:

• w -> largest to smallest
• h -> largest to smallest
• bits per pixel -> more colors to fewer colors
• packed pixel layout -> largest to smallest
• refresh rate -> highest to lowest
• pixel density -> lowest to highest

Returns

a NULL terminated array of display mode pointers or NULL on failure; call getError for more information. This is a single allocation that should be freed with free when it is no longer needed.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get a list of fullscreen display modes available on a display.

The display modes are sorted in this priority:

• w -> largest to smallest
• h -> largest to smallest
• bits per pixel -> more colors to fewer colors
• packed pixel layout -> largest to smallest
• refresh rate -> highest to lowest
• pixel density -> lowest to highest

Returns

a NULL terminated array of display mode pointers or NULL on failure; call getError for more information. This is a single allocation that should be freed with free when it is no longer needed.

Thread safety

This function should only be called on the main thread.

See also

getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the closest match to the requested display mode.

The available display modes are scanned and closest is filled in with the closest mode matching the requested mode and returned. The mode format and refresh rate default to the desktop mode if they are set to 0. The modes are scanned with size being first priority, format being second priority, and finally checking the refresh rate. If all the available modes are too small, then false is returned.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplays, getFullscreenDisplayModes

sdl3-bindgen-sys notes

Since: 3.2.0

Get the closest match to the requested display mode.

The available display modes are scanned and closest is filled in with the closest mode matching the requested mode and returned. The mode format and refresh rate default to the desktop mode if they are set to 0. The modes are scanned with size being first priority, format being second priority, and finally checking the refresh rate. If all the available modes are too small, then false is returned.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplays, getFullscreenDisplayModes

sdl3-bindgen-sys notes

Since: 3.2.0

Get information about the desktop's display mode.

There's a difference between this function and getCurrentDisplayMode when SDL runs fullscreen and has changed the resolution. In that case this function will return the previous native display mode, and not the current display mode.

Returns

a pointer to the desktop display mode or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getCurrentDisplayMode, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get information about the desktop's display mode.

There's a difference between this function and getCurrentDisplayMode when SDL runs fullscreen and has changed the resolution. In that case this function will return the previous native display mode, and not the current display mode.

Returns

a pointer to the desktop display mode or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getCurrentDisplayMode, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get information about the current display mode.

There's a difference between this function and getDesktopDisplayMode when SDL runs fullscreen and has changed the resolution. In that case this function will return the current display mode, and not the previous native display mode.

Returns

a pointer to the desktop display mode or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDesktopDisplayMode, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get information about the current display mode.

There's a difference between this function and getDesktopDisplayMode when SDL runs fullscreen and has changed the resolution. In that case this function will return the current display mode, and not the previous native display mode.

Returns

a pointer to the desktop display mode or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDesktopDisplayMode, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the display containing a point.

Returns

the instance ID of the display containing the point or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the display containing a point.

Returns

the instance ID of the display containing the point or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the display primarily containing a rect.

Returns

the instance ID of the display entirely containing the rect or closest to the center of the rect on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the display primarily containing a rect.

Returns

the instance ID of the display entirely containing the rect or closest to the center of the rect on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the display associated with a window.

Returns

the instance ID of the display containing the center of the window on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the display associated with a window.

Returns

the instance ID of the display containing the center of the window on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getDisplayBounds, getDisplays

sdl3-bindgen-sys notes

Since: 3.2.0

Get the pixel density of a window.

This is a ratio of pixel size to window size. For example, if the window is 1920x1080 and it has a high density back buffer of 3840x2160 pixels, it would have a pixel density of 2.0.

Returns

the pixel density or 0.0f on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowDisplayScale

sdl3-bindgen-sys notes

Since: 3.2.0

Get the pixel density of a window.

This is a ratio of pixel size to window size. For example, if the window is 1920x1080 and it has a high density back buffer of 3840x2160 pixels, it would have a pixel density of 2.0.

Returns

the pixel density or 0.0f on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowDisplayScale

sdl3-bindgen-sys notes

Since: 3.2.0

Get the content display scale relative to a window's pixel size.

This is a combination of the window pixel density and the display content scale, and is the expected scale for displaying content in this window. For example, if a 3840x2160 window had a display scale of 2.0, the user expects the content to take twice as many pixels and be the same physical size as if it were being displayed in a 1920x1080 window with a display scale of 1.0.

Conceptually this value corresponds to the scale display setting, and is updated when that setting is changed, or the window moves to a display with a different scale setting.

Returns

the display scale, or 0.0f on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the content display scale relative to a window's pixel size.

This is a combination of the window pixel density and the display content scale, and is the expected scale for displaying content in this window. For example, if a 3840x2160 window had a display scale of 2.0, the user expects the content to take twice as many pixels and be the same physical size as if it were being displayed in a 1920x1080 window with a display scale of 1.0.

Conceptually this value corresponds to the scale display setting, and is updated when that setting is changed, or the window moves to a display with a different scale setting.

Returns

the display scale, or 0.0f on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Set the display mode to use when a window is visible and fullscreen.

This only affects the display mode used when the window is fullscreen. To change the window size when the window is not fullscreen, use setWindowSize.

If the window is currently in the fullscreen state, this request is asynchronous on some windowing systems and the new mode dimensions may not be applied immediately upon the return of this function. If an immediate change is required, call syncWindow to block until the changes have taken effect.

When the new mode takes effect, an SDL_EVENT_WINDOW_RESIZED and/or an SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event will be emitted with the new mode dimensions.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowFullscreenMode, setWindowFullscreen, syncWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Set the display mode to use when a window is visible and fullscreen.

This only affects the display mode used when the window is fullscreen. To change the window size when the window is not fullscreen, use setWindowSize.

If the window is currently in the fullscreen state, this request is asynchronous on some windowing systems and the new mode dimensions may not be applied immediately upon the return of this function. If an immediate change is required, call syncWindow to block until the changes have taken effect.

When the new mode takes effect, an SDL_EVENT_WINDOW_RESIZED and/or an SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event will be emitted with the new mode dimensions.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowFullscreenMode, setWindowFullscreen, syncWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Query the display mode to use when a window is visible at fullscreen.

Returns

a pointer to the exclusive fullscreen mode to use or NULL for borderless fullscreen desktop mode.

Thread safety

This function should only be called on the main thread.

See also

setWindowFullscreenMode, setWindowFullscreen

sdl3-bindgen-sys notes

Since: 3.2.0

Query the display mode to use when a window is visible at fullscreen.

Returns

a pointer to the exclusive fullscreen mode to use or NULL for borderless fullscreen desktop mode.

Thread safety

This function should only be called on the main thread.

See also

setWindowFullscreenMode, setWindowFullscreen

sdl3-bindgen-sys notes

Since: 3.2.0

Get the raw ICC profile data for the screen the window is currently on.

Returns

the raw ICC profile data on success or NULL on failure; call getError for more information. This should be freed with free when it is no longer needed.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the raw ICC profile data for the screen the window is currently on.

Returns

the raw ICC profile data on success or NULL on failure; call getError for more information. This should be freed with free when it is no longer needed.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the pixel format associated with the window.

Returns

the pixel format of the window on success or SDL_PIXELFORMAT_UNKNOWN on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the pixel format associated with the window.

Returns

the pixel format of the window on success or SDL_PIXELFORMAT_UNKNOWN on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get a list of valid windows.

Returns

a NULL terminated array of SDL_Window pointers or NULL on failure; call getError for more information. This is a single allocation that should be freed with free when it is no longer needed.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get a list of valid windows.

Returns

a NULL terminated array of SDL_Window pointers or NULL on failure; call getError for more information. This is a single allocation that should be freed with free when it is no longer needed.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Create a window with the specified dimensions and flags.

The window size is a request and may be different than expected based on the desktop layout and window manager policies. Your application should be prepared to handle a window of any size.

flags may be any of the following OR'd together:

• SDL_WINDOW_FULLSCREEN: fullscreen window at desktop resolution
• SDL_WINDOW_OPENGL: window usable with an OpenGL context
• SDL_WINDOW_HIDDEN: window is not visible
• SDL_WINDOW_BORDERLESS: no window decoration
• SDL_WINDOW_RESIZABLE: window can be resized
• SDL_WINDOW_MINIMIZED: window is minimized
• SDL_WINDOW_MAXIMIZED: window is maximized
• SDL_WINDOW_MOUSE_GRABBED: window has grabbed mouse focus
• SDL_WINDOW_INPUT_FOCUS: window has input focus
• SDL_WINDOW_MOUSE_FOCUS: window has mouse focus
• SDL_WINDOW_EXTERNAL: window not created by SDL
• SDL_WINDOW_MODAL: window is modal
• SDL_WINDOW_HIGH_PIXEL_DENSITY: window uses high pixel density back buffer if possible
• SDL_WINDOW_MOUSE_CAPTURE: window has mouse captured (unrelated to MOUSE_GRABBED)
• SDL_WINDOW_ALWAYS_ON_TOP: window should always be above others
• SDL_WINDOW_UTILITY: window should be treated as a utility window, not showing in the task bar and window list
• SDL_WINDOW_TOOLTIP: window should be treated as a tooltip and does not get mouse or keyboard focus, requires a parent window
• SDL_WINDOW_POPUP_MENU: window should be treated as a popup menu, requires a parent window
• SDL_WINDOW_KEYBOARD_GRABBED: window has grabbed keyboard input
• SDL_WINDOW_VULKAN: window usable with a Vulkan instance
• SDL_WINDOW_METAL: window usable with a Metal instance
• SDL_WINDOW_TRANSPARENT: window with transparent buffer
• SDL_WINDOW_NOT_FOCUSABLE: window should not be focusable

The SDL_Window will be shown if SDL_WINDOW_HIDDEN is not set. If hidden at creation time, showWindow can be used to show it later.

On Apple's macOS, you must set the NSHighResolutionCapable Info.plist property to YES, otherwise you will not receive a High-DPI OpenGL canvas.

The window pixel size may differ from its window coordinate size if the window is on a high pixel density display. Use getWindowSize to query the client area's size in window coordinates, and getWindowSizeInPixels or getRenderOutputSize to query the drawable size in pixels. Note that the drawable size can vary after the window is created and should be queried again if you get an SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event.

If the window is created with any of the SDL_WINDOW_OPENGL or SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the corresponding UnloadLibrary function is called by destroyWindow.

If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver, createWindow will fail, because vulkanLoadLibrary will fail.

If SDL_WINDOW_METAL is specified on an OS that does not support Metal, createWindow will fail.

If you intend to use this window with an SDL_Renderer, you should use createWindowAndRenderer instead of this function, to avoid window flicker.

On non-Apple devices, SDL requires you to either not link to the Vulkan loader or link to a dynamic library version. This limitation may be removed in a future version of SDL.

Returns

the window that was created or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createWindowAndRenderer, createPopupWindow, createWindowWithProperties, destroyWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Create a window with the specified dimensions and flags.

The window size is a request and may be different than expected based on the desktop layout and window manager policies. Your application should be prepared to handle a window of any size.

flags may be any of the following OR'd together:

• SDL_WINDOW_FULLSCREEN: fullscreen window at desktop resolution
• SDL_WINDOW_OPENGL: window usable with an OpenGL context
• SDL_WINDOW_HIDDEN: window is not visible
• SDL_WINDOW_BORDERLESS: no window decoration
• SDL_WINDOW_RESIZABLE: window can be resized
• SDL_WINDOW_MINIMIZED: window is minimized
• SDL_WINDOW_MAXIMIZED: window is maximized
• SDL_WINDOW_MOUSE_GRABBED: window has grabbed mouse focus
• SDL_WINDOW_INPUT_FOCUS: window has input focus
• SDL_WINDOW_MOUSE_FOCUS: window has mouse focus
• SDL_WINDOW_EXTERNAL: window not created by SDL
• SDL_WINDOW_MODAL: window is modal
• SDL_WINDOW_HIGH_PIXEL_DENSITY: window uses high pixel density back buffer if possible
• SDL_WINDOW_MOUSE_CAPTURE: window has mouse captured (unrelated to MOUSE_GRABBED)
• SDL_WINDOW_ALWAYS_ON_TOP: window should always be above others
• SDL_WINDOW_UTILITY: window should be treated as a utility window, not showing in the task bar and window list
• SDL_WINDOW_TOOLTIP: window should be treated as a tooltip and does not get mouse or keyboard focus, requires a parent window
• SDL_WINDOW_POPUP_MENU: window should be treated as a popup menu, requires a parent window
• SDL_WINDOW_KEYBOARD_GRABBED: window has grabbed keyboard input
• SDL_WINDOW_VULKAN: window usable with a Vulkan instance
• SDL_WINDOW_METAL: window usable with a Metal instance
• SDL_WINDOW_TRANSPARENT: window with transparent buffer
• SDL_WINDOW_NOT_FOCUSABLE: window should not be focusable

The SDL_Window will be shown if SDL_WINDOW_HIDDEN is not set. If hidden at creation time, showWindow can be used to show it later.

On Apple's macOS, you must set the NSHighResolutionCapable Info.plist property to YES, otherwise you will not receive a High-DPI OpenGL canvas.

The window pixel size may differ from its window coordinate size if the window is on a high pixel density display. Use getWindowSize to query the client area's size in window coordinates, and getWindowSizeInPixels or getRenderOutputSize to query the drawable size in pixels. Note that the drawable size can vary after the window is created and should be queried again if you get an SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event.

If the window is created with any of the SDL_WINDOW_OPENGL or SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the corresponding UnloadLibrary function is called by destroyWindow.

If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver, createWindow will fail, because vulkanLoadLibrary will fail.

If SDL_WINDOW_METAL is specified on an OS that does not support Metal, createWindow will fail.

If you intend to use this window with an SDL_Renderer, you should use createWindowAndRenderer instead of this function, to avoid window flicker.

On non-Apple devices, SDL requires you to either not link to the Vulkan loader or link to a dynamic library version. This limitation may be removed in a future version of SDL.

Returns

the window that was created or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createWindowAndRenderer, createPopupWindow, createWindowWithProperties, destroyWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Create a child popup window of the specified parent window.

The window size is a request and may be different than expected based on the desktop layout and window manager policies. Your application should be prepared to handle a window of any size.

The flags parameter must contain at least one of the following:

• SDL_WINDOW_TOOLTIP: The popup window is a tooltip and will not pass any input events.
• SDL_WINDOW_POPUP_MENU: The popup window is a popup menu. The topmost popup menu will implicitly gain the keyboard focus.

The following flags are not relevant to popup window creation and will be ignored:

• SDL_WINDOW_MINIMIZED

• SDL_WINDOW_MAXIMIZED

• SDL_WINDOW_FULLSCREEN

• SDL_WINDOW_BORDERLESS

The following flags are incompatible with popup window creation and will cause it to fail:

• SDL_WINDOW_UTILITY

• SDL_WINDOW_MODAL

The parent parameter must be non-null and a valid window. The parent of a popup window can be either a regular, toplevel window, or another popup window.

Popup windows cannot be minimized, maximized, made fullscreen, raised, flash, be made a modal window, be the parent of a toplevel window, or grab the mouse and/or keyboard. Attempts to do so will fail.

Popup windows implicitly do not have a border/decorations and do not appear on the taskbar/dock or in lists of windows such as alt-tab menus.

By default, popup window positions will automatically be constrained to keep the entire window within display bounds. This can be overridden with the sDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN property.

By default, popup menus will automatically grab keyboard focus from the parent when shown. This behavior can be overridden by setting the SDL_WINDOW_NOT_FOCUSABLE flag, setting the sDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN property to false, or toggling it after creation via the setWindowFocusable function.

If a parent window is hidden or destroyed, any child popup windows will be recursively hidden or destroyed as well. Child popup windows not explicitly hidden will be restored when the parent is shown.

Returns

the window that was created or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createWindow, createWindowWithProperties, destroyWindow, getWindowParent

sdl3-bindgen-sys notes

Since: 3.2.0

Create a child popup window of the specified parent window.

The window size is a request and may be different than expected based on the desktop layout and window manager policies. Your application should be prepared to handle a window of any size.

The flags parameter must contain at least one of the following:

• SDL_WINDOW_TOOLTIP: The popup window is a tooltip and will not pass any input events.
• SDL_WINDOW_POPUP_MENU: The popup window is a popup menu. The topmost popup menu will implicitly gain the keyboard focus.

The following flags are not relevant to popup window creation and will be ignored:

• SDL_WINDOW_MINIMIZED

• SDL_WINDOW_MAXIMIZED

• SDL_WINDOW_FULLSCREEN

• SDL_WINDOW_BORDERLESS

The following flags are incompatible with popup window creation and will cause it to fail:

• SDL_WINDOW_UTILITY

• SDL_WINDOW_MODAL

The parent parameter must be non-null and a valid window. The parent of a popup window can be either a regular, toplevel window, or another popup window.

Popup windows cannot be minimized, maximized, made fullscreen, raised, flash, be made a modal window, be the parent of a toplevel window, or grab the mouse and/or keyboard. Attempts to do so will fail.

Popup windows implicitly do not have a border/decorations and do not appear on the taskbar/dock or in lists of windows such as alt-tab menus.

By default, popup window positions will automatically be constrained to keep the entire window within display bounds. This can be overridden with the sDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN property.

By default, popup menus will automatically grab keyboard focus from the parent when shown. This behavior can be overridden by setting the SDL_WINDOW_NOT_FOCUSABLE flag, setting the sDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN property to false, or toggling it after creation via the setWindowFocusable function.

If a parent window is hidden or destroyed, any child popup windows will be recursively hidden or destroyed as well. Child popup windows not explicitly hidden will be restored when the parent is shown.

Returns

the window that was created or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createWindow, createWindowWithProperties, destroyWindow, getWindowParent

sdl3-bindgen-sys notes

Since: 3.2.0

Create a window with the specified properties.

The window size is a request and may be different than expected based on the desktop layout and window manager policies. Your application should be prepared to handle a window of any size.

These are the supported properties:

• sDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN: true if the window should be always on top
• sDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN: true if the window has no window decoration
• sDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN: true if the "tooltip" and "menu" window types should be automatically constrained to be entirely within display bounds (default), false if no constraints on the position are desired.
• sDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN: true if the window will be used with an externally managed graphics context.
• sDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN: true if the window should accept keyboard input (defaults true)
• sDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN: true if the window should start in fullscreen mode at desktop resolution
• sDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER: the height of the window
• sDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN: true if the window should start hidden
• sDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN: true if the window uses a high pixel density buffer if possible
• sDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN: true if the window should start maximized
• sDL_PROP_WINDOW_CREATE_MENU_BOOLEAN: true if the window is a popup menu
• sDL_PROP_WINDOW_CREATE_METAL_BOOLEAN: true if the window will be used with Metal rendering
• sDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN: true if the window should start minimized
• sDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN: true if the window is modal to its parent
• sDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN: true if the window starts with grabbed mouse focus
• sDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN: true if the window will be used with OpenGL rendering
• sDL_PROP_WINDOW_CREATE_PARENT_POINTER: an SDL_Window that will be the parent of this window, required for windows with the "tooltip", "menu", and "modal" properties
• sDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN: true if the window should be resizable
• sDL_PROP_WINDOW_CREATE_TITLE_STRING: the title of the window, in UTF-8 encoding
• sDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN: true if the window show transparent in the areas with alpha of 0
• sDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN: true if the window is a tooltip
• sDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN: true if the window is a utility window, not showing in the task bar and window list
• sDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN: true if the window will be used with Vulkan rendering
• sDL_PROP_WINDOW_CREATE_WIDTH_NUMBER: the width of the window
• sDL_PROP_WINDOW_CREATE_X_NUMBER: the x position of the window, or sDL_WINDOWPOS_CENTERED, defaults to sDL_WINDOWPOS_UNDEFINED. This is relative to the parent for windows with the "tooltip" or "menu" property set.
• sDL_PROP_WINDOW_CREATE_Y_NUMBER: the y position of the window, or sDL_WINDOWPOS_CENTERED, defaults to sDL_WINDOWPOS_UNDEFINED. This is relative to the parent for windows with the "tooltip" or "menu" property set.

These are additional supported properties on macOS:

• sDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER: the (__unsafe_unretained) NSWindow associated with the window, if you want to wrap an existing window.
• sDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER: the (__unsafe_unretained) NSView associated with the window, defaults to [window contentView]

These are additional supported properties on iOS, tvOS, and visionOS:

• sDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER: the (__unsafe_unretained) UIWindowScene associated with the window, defaults to the active window scene.

These are additional supported properties on Wayland:

• sDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN - true if the application wants to use the Wayland surface for a custom role and does not want it attached to an XDG toplevel window. See README-wayland for more information on using custom surfaces.
• sDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN - true if the application wants an associated wl_egl_window object to be created and attached to the window, even if the window does not have the OpenGL property or SDL_WINDOW_OPENGL flag set.
• sDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER - the wl_surface associated with the window, if you want to wrap an existing window. See README-wayland for more information.

These are additional supported properties on Windows:

• sDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER: the HWND associated with the window, if you want to wrap an existing window.
• sDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER: optional, another window to share pixel format with, useful for OpenGL windows

These are additional supported properties with X11:

• sDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER: the X11 Window associated with the window, if you want to wrap an existing window.

The window is implicitly shown if the "hidden" property is not set.

These are additional supported properties with Emscripten:

• sDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING: the id given to the canvas element. This should start with a '#' sign
• sDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING: override the binding element for keyboard inputs for this canvas. The variable can be one of:
• "#window": the javascript window object (default)
• "#document": the javascript document object
• "#screen": the javascript window.screen object
• "#canvas": the WebGL canvas element
• "#none": Don't bind anything at all
• any other string without a leading # sign applies to the element on the page with that ID. Windows with the "tooltip" and "menu" properties are popup windows and have the behaviors and guidelines outlined in createPopupWindow.

If this window is being created to be used with an SDL_Renderer, you should not add a graphics API specific property (sDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN, etc), as SDL will handle that internally when it chooses a renderer. However, SDL might need to recreate your window at that point, which may cause the window to appear briefly, and then flicker as it is recreated. The correct approach to this is to create the window with the sDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN property set to true, then create the renderer, then show the window with showWindow.

Returns

the window that was created or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createProperties, createWindow, destroyWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Create a window with the specified properties.

The window size is a request and may be different than expected based on the desktop layout and window manager policies. Your application should be prepared to handle a window of any size.

These are the supported properties:

• sDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN: true if the window should be always on top
• sDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN: true if the window has no window decoration
• sDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN: true if the "tooltip" and "menu" window types should be automatically constrained to be entirely within display bounds (default), false if no constraints on the position are desired.
• sDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN: true if the window will be used with an externally managed graphics context.
• sDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN: true if the window should accept keyboard input (defaults true)
• sDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN: true if the window should start in fullscreen mode at desktop resolution
• sDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER: the height of the window
• sDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN: true if the window should start hidden
• sDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN: true if the window uses a high pixel density buffer if possible
• sDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN: true if the window should start maximized
• sDL_PROP_WINDOW_CREATE_MENU_BOOLEAN: true if the window is a popup menu
• sDL_PROP_WINDOW_CREATE_METAL_BOOLEAN: true if the window will be used with Metal rendering
• sDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN: true if the window should start minimized
• sDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN: true if the window is modal to its parent
• sDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN: true if the window starts with grabbed mouse focus
• sDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN: true if the window will be used with OpenGL rendering
• sDL_PROP_WINDOW_CREATE_PARENT_POINTER: an SDL_Window that will be the parent of this window, required for windows with the "tooltip", "menu", and "modal" properties
• sDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN: true if the window should be resizable
• sDL_PROP_WINDOW_CREATE_TITLE_STRING: the title of the window, in UTF-8 encoding
• sDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN: true if the window show transparent in the areas with alpha of 0
• sDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN: true if the window is a tooltip
• sDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN: true if the window is a utility window, not showing in the task bar and window list
• sDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN: true if the window will be used with Vulkan rendering
• sDL_PROP_WINDOW_CREATE_WIDTH_NUMBER: the width of the window
• sDL_PROP_WINDOW_CREATE_X_NUMBER: the x position of the window, or sDL_WINDOWPOS_CENTERED, defaults to sDL_WINDOWPOS_UNDEFINED. This is relative to the parent for windows with the "tooltip" or "menu" property set.
• sDL_PROP_WINDOW_CREATE_Y_NUMBER: the y position of the window, or sDL_WINDOWPOS_CENTERED, defaults to sDL_WINDOWPOS_UNDEFINED. This is relative to the parent for windows with the "tooltip" or "menu" property set.

These are additional supported properties on macOS:

• sDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER: the (__unsafe_unretained) NSWindow associated with the window, if you want to wrap an existing window.
• sDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER: the (__unsafe_unretained) NSView associated with the window, defaults to [window contentView]

These are additional supported properties on iOS, tvOS, and visionOS:

• sDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER: the (__unsafe_unretained) UIWindowScene associated with the window, defaults to the active window scene.

These are additional supported properties on Wayland:

• sDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN - true if the application wants to use the Wayland surface for a custom role and does not want it attached to an XDG toplevel window. See README-wayland for more information on using custom surfaces.
• sDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN - true if the application wants an associated wl_egl_window object to be created and attached to the window, even if the window does not have the OpenGL property or SDL_WINDOW_OPENGL flag set.
• sDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER - the wl_surface associated with the window, if you want to wrap an existing window. See README-wayland for more information.

These are additional supported properties on Windows:

• sDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER: the HWND associated with the window, if you want to wrap an existing window.
• sDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER: optional, another window to share pixel format with, useful for OpenGL windows

These are additional supported properties with X11:

• sDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER: the X11 Window associated with the window, if you want to wrap an existing window.

The window is implicitly shown if the "hidden" property is not set.

These are additional supported properties with Emscripten:

• sDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING: the id given to the canvas element. This should start with a '#' sign
• sDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING: override the binding element for keyboard inputs for this canvas. The variable can be one of:
• "#window": the javascript window object (default)
• "#document": the javascript document object
• "#screen": the javascript window.screen object
• "#canvas": the WebGL canvas element
• "#none": Don't bind anything at all
• any other string without a leading # sign applies to the element on the page with that ID. Windows with the "tooltip" and "menu" properties are popup windows and have the behaviors and guidelines outlined in createPopupWindow.

If this window is being created to be used with an SDL_Renderer, you should not add a graphics API specific property (sDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN, etc), as SDL will handle that internally when it chooses a renderer. However, SDL might need to recreate your window at that point, which may cause the window to appear briefly, and then flicker as it is recreated. The correct approach to this is to create the window with the sDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN property set to true, then create the renderer, then show the window with showWindow.

Returns

the window that was created or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createProperties, createWindow, destroyWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Get the numeric ID of a window.

The numeric ID is what SDL_WindowEvent references, and is necessary to map these events to specific SDL_Window objects.

Returns

the ID of the window on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowFromID

sdl3-bindgen-sys notes

Since: 3.2.0

Get the numeric ID of a window.

The numeric ID is what SDL_WindowEvent references, and is necessary to map these events to specific SDL_Window objects.

Returns

the ID of the window on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowFromID

sdl3-bindgen-sys notes

Since: 3.2.0

Get a window from a stored ID.

The numeric ID is what SDL_WindowEvent references, and is necessary to map these events to specific SDL_Window objects.

Returns

the window associated with id or NULL if it doesn't exist; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowID

sdl3-bindgen-sys notes

Since: 3.2.0

Get a window from a stored ID.

The numeric ID is what SDL_WindowEvent references, and is necessary to map these events to specific SDL_Window objects.

Returns

the window associated with id or NULL if it doesn't exist; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowID

sdl3-bindgen-sys notes

Since: 3.2.0

Get parent of a window.

Returns

the parent of the window on success or NULL if the window has no parent.

Thread safety

This function should only be called on the main thread.

See also

createPopupWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Get parent of a window.

Returns

the parent of the window on success or NULL if the window has no parent.

Thread safety

This function should only be called on the main thread.

See also

createPopupWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Get the properties associated with a window.

The following read-only properties are provided by SDL:

• sDL_PROP_WINDOW_SHAPE_POINTER: the surface associated with a shaped window
• sDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN: true if the window has HDR headroom above the SDR white point. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
• sDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT: the value of SDR white in the SDL_COLORSPACE_SRGB_LINEAR colorspace. On Windows this corresponds to the SDR white level in scRGB colorspace, and on Apple platforms this is always 1.0 for EDR content. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
• sDL_PROP_WINDOW_HDR_HEADROOM_FLOAT: the additional high dynamic range that can be displayed, in terms of the SDR white point. When HDR is not enabled, this will be 1.0. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.

On Android:

• sDL_PROP_WINDOW_ANDROID_WINDOW_POINTER: the ANativeWindow associated with the window
• sDL_PROP_WINDOW_ANDROID_SURFACE_POINTER: the EGLSurface associated with the window

On iOS:

• sDL_PROP_WINDOW_UIKIT_WINDOW_POINTER: the (__unsafe_unretained) UIWindow associated with the window
• sDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER: the NSInteger tag associated with metal views on the window
• sDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER: the OpenGL view's framebuffer object. It must be bound when rendering to the screen using OpenGL.
• sDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER: the OpenGL view's renderbuffer object. It must be bound when glSwapWindow is called.
• sDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER: the OpenGL view's resolve framebuffer, when MSAA is used.

On KMS/DRM:

• sDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER: the device index associated with the window (e.g. the X in /dev/dri/cardX)
• sDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER: the DRM FD associated with the window
• sDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER: the GBM device associated with the window

On macOS:

• sDL_PROP_WINDOW_COCOA_WINDOW_POINTER: the (__unsafe_unretained) NSWindow associated with the window
• sDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER: the NSInteger tag associated with metal views on the window

On OpenVR:

• sDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER: the OpenVR Overlay Handle ID for the associated overlay window.

On Vivante:

• sDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER: the EGLNativeDisplayType associated with the window
• sDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER: the EGLNativeWindowType associated with the window
• sDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER: the EGLSurface associated with the window

On Windows:

• sDL_PROP_WINDOW_WIN32_HWND_POINTER: the HWND associated with the window
• sDL_PROP_WINDOW_WIN32_HDC_POINTER: the HDC associated with the window
• sDL_PROP_WINDOW_WIN32_INSTANCE_POINTER: the HINSTANCE associated with the window

On Wayland:

Note: The xdg_* window objects do not internally persist across window show/hide calls. They will be null if the window is hidden and must be queried each time it is shown.

• sDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER: the wl_display associated with the window
• sDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER: the wl_surface associated with the window
• sDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER: the wp_viewport associated with the window
• sDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER: the wl_egl_window associated with the window
• sDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER: the xdg_surface associated with the window
• sDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER: the xdg_toplevel role associated with the window
• 'SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING': the export handle associated with the window
• sDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER: the xdg_popup role associated with the window
• sDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER: the xdg_positioner associated with the window, in popup mode

On X11:

• sDL_PROP_WINDOW_X11_DISPLAY_POINTER: the X11 Display associated with the window
• sDL_PROP_WINDOW_X11_SCREEN_NUMBER: the screen number associated with the window
• sDL_PROP_WINDOW_X11_WINDOW_NUMBER: the X11 Window associated with the window

On Emscripten:

• sDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING: the id the canvas element will have
• sDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING: the keyboard element that associates keyboard events to this window

Returns

a valid property ID on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the properties associated with a window.

The following read-only properties are provided by SDL:

• sDL_PROP_WINDOW_SHAPE_POINTER: the surface associated with a shaped window
• sDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN: true if the window has HDR headroom above the SDR white point. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
• sDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT: the value of SDR white in the SDL_COLORSPACE_SRGB_LINEAR colorspace. On Windows this corresponds to the SDR white level in scRGB colorspace, and on Apple platforms this is always 1.0 for EDR content. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
• sDL_PROP_WINDOW_HDR_HEADROOM_FLOAT: the additional high dynamic range that can be displayed, in terms of the SDR white point. When HDR is not enabled, this will be 1.0. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.

On Android:

• sDL_PROP_WINDOW_ANDROID_WINDOW_POINTER: the ANativeWindow associated with the window
• sDL_PROP_WINDOW_ANDROID_SURFACE_POINTER: the EGLSurface associated with the window

On iOS:

• sDL_PROP_WINDOW_UIKIT_WINDOW_POINTER: the (__unsafe_unretained) UIWindow associated with the window
• sDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER: the NSInteger tag associated with metal views on the window
• sDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER: the OpenGL view's framebuffer object. It must be bound when rendering to the screen using OpenGL.
• sDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER: the OpenGL view's renderbuffer object. It must be bound when glSwapWindow is called.
• sDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER: the OpenGL view's resolve framebuffer, when MSAA is used.

On KMS/DRM:

• sDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER: the device index associated with the window (e.g. the X in /dev/dri/cardX)
• sDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER: the DRM FD associated with the window
• sDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER: the GBM device associated with the window

On macOS:

• sDL_PROP_WINDOW_COCOA_WINDOW_POINTER: the (__unsafe_unretained) NSWindow associated with the window
• sDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER: the NSInteger tag associated with metal views on the window

On OpenVR:

• sDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER: the OpenVR Overlay Handle ID for the associated overlay window.

On Vivante:

• sDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER: the EGLNativeDisplayType associated with the window
• sDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER: the EGLNativeWindowType associated with the window
• sDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER: the EGLSurface associated with the window

On Windows:

• sDL_PROP_WINDOW_WIN32_HWND_POINTER: the HWND associated with the window
• sDL_PROP_WINDOW_WIN32_HDC_POINTER: the HDC associated with the window
• sDL_PROP_WINDOW_WIN32_INSTANCE_POINTER: the HINSTANCE associated with the window

On Wayland:

Note: The xdg_* window objects do not internally persist across window show/hide calls. They will be null if the window is hidden and must be queried each time it is shown.

• sDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER: the wl_display associated with the window
• sDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER: the wl_surface associated with the window
• sDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER: the wp_viewport associated with the window
• sDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER: the wl_egl_window associated with the window
• sDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER: the xdg_surface associated with the window
• sDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER: the xdg_toplevel role associated with the window
• 'SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING': the export handle associated with the window
• sDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER: the xdg_popup role associated with the window
• sDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER: the xdg_positioner associated with the window, in popup mode

On X11:

• sDL_PROP_WINDOW_X11_DISPLAY_POINTER: the X11 Display associated with the window
• sDL_PROP_WINDOW_X11_SCREEN_NUMBER: the screen number associated with the window
• sDL_PROP_WINDOW_X11_WINDOW_NUMBER: the X11 Window associated with the window

On Emscripten:

• sDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING: the id the canvas element will have
• sDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING: the keyboard element that associates keyboard events to this window

Returns

a valid property ID on success or 0 on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the window flags.

Returns

a mask of the SDL_WindowFlags associated with window.

Thread safety

This function should only be called on the main thread.

See also

createWindow, hideWindow, maximizeWindow, minimizeWindow, setWindowFullscreen, setWindowMouseGrab, setWindowFillDocument, showWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Get the window flags.

Returns

a mask of the SDL_WindowFlags associated with window.

Thread safety

This function should only be called on the main thread.

See also

createWindow, hideWindow, maximizeWindow, minimizeWindow, setWindowFullscreen, setWindowMouseGrab, setWindowFillDocument, showWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Set the title of a window.

This string is expected to be in UTF-8 encoding.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowTitle

sdl3-bindgen-sys notes

Since: 3.2.0

Set the title of a window.

This string is expected to be in UTF-8 encoding.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowTitle

sdl3-bindgen-sys notes

Since: 3.2.0

Get the title of a window.

Returns

the title of the window in UTF-8 format or "" if there is no title.

Thread safety

This function should only be called on the main thread.

See also

setWindowTitle

sdl3-bindgen-sys notes

Since: 3.2.0

Get the title of a window.

Returns

the title of the window in UTF-8 format or "" if there is no title.

Thread safety

This function should only be called on the main thread.

See also

setWindowTitle

sdl3-bindgen-sys notes

Since: 3.2.0

Set the icon for a window.

If this function is passed a surface with alternate representations added using addSurfaceAlternateImage, the surface will be interpreted as the content to be used for 100% display scale, and the alternate representations will be used for high DPI situations. For example, if the original surface is 32x32, then on a 2x macOS display or 200% display scale on Windows, a 64x64 version of the image will be used, if available. If a matching version of the image isn't available, the closest larger size image will be downscaled to the appropriate size and be used instead, if available. Otherwise, the closest smaller image will be upscaled and be used instead.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

addSurfaceAlternateImage

sdl3-bindgen-sys notes

Since: 3.2.0

Set the icon for a window.

If this function is passed a surface with alternate representations added using addSurfaceAlternateImage, the surface will be interpreted as the content to be used for 100% display scale, and the alternate representations will be used for high DPI situations. For example, if the original surface is 32x32, then on a 2x macOS display or 200% display scale on Windows, a 64x64 version of the image will be used, if available. If a matching version of the image isn't available, the closest larger size image will be downscaled to the appropriate size and be used instead, if available. Otherwise, the closest smaller image will be upscaled and be used instead.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

addSurfaceAlternateImage

sdl3-bindgen-sys notes

Since: 3.2.0

Request that the window's position be set.

If the window is in an exclusive fullscreen or maximized state, this request has no effect.

This can be used to reposition fullscreen-desktop windows onto a different display, however, as exclusive fullscreen windows are locked to a specific display, they can only be repositioned programmatically via setWindowFullscreenMode.

On some windowing systems this request is asynchronous and the new coordinates may not have have been applied immediately upon the return of this function. If an immediate change is required, call syncWindow to block until the changes have taken effect.

When the window position changes, an SDL_EVENT_WINDOW_MOVED event will be emitted with the window's new coordinates. Note that the new coordinates may not match the exact coordinates requested, as some windowing systems can restrict the position of the window in certain scenarios (e.g. constraining the position so the window is always within desktop bounds). Additionally, as this is just a request, it can be denied by the windowing system.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowPosition, syncWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Request that the window's position be set.

If the window is in an exclusive fullscreen or maximized state, this request has no effect.

This can be used to reposition fullscreen-desktop windows onto a different display, however, as exclusive fullscreen windows are locked to a specific display, they can only be repositioned programmatically via setWindowFullscreenMode.

On some windowing systems this request is asynchronous and the new coordinates may not have have been applied immediately upon the return of this function. If an immediate change is required, call syncWindow to block until the changes have taken effect.

When the window position changes, an SDL_EVENT_WINDOW_MOVED event will be emitted with the window's new coordinates. Note that the new coordinates may not match the exact coordinates requested, as some windowing systems can restrict the position of the window in certain scenarios (e.g. constraining the position so the window is always within desktop bounds). Additionally, as this is just a request, it can be denied by the windowing system.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getWindowPosition, syncWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Get the position of a window.

This is the current position of the window as last reported by the windowing system.

If you do not need the value for one of the positions a NULL may be passed in the x or y parameter.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

setWindowPosition

sdl3-bindgen-sys notes

Since: 3.2.0