Documentation

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

sDL_GetVideoDriver

C declaration

SDL_GetNumVideoDrivers, defined at SDL3/SDL_video.h 563:33

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

sDL_GetNumVideoDrivers

C declaration

SDL_GetVideoDriver, defined at SDL3/SDL_video.h 585:42

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

sDL_GetNumVideoDrivers, sDL_GetVideoDriver

C declaration

SDL_GetCurrentVideoDriver, defined at SDL3/SDL_video.h 604:42

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.

C declaration

SDL_GetSystemTheme, defined at SDL3/SDL_video.h 615:45

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 SDL_GetError() for more information. This should be freed with SDL_free() when it is no longer needed.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetDisplays, defined at SDL3/SDL_video.h 630:45

Since: 3.2.0

Return the primary display.

Returns

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

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDisplays

C declaration

SDL_GetPrimaryDisplay, defined at SDL3/SDL_video.h 644:43

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetDisplayProperties, defined at SDL3/SDL_video.h 682:46

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDisplays

C declaration

SDL_GetDisplayName, defined at SDL3/SDL_video.h 702:42

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDisplayUsableBounds, sDL_GetDisplays

C declaration

SDL_GetDisplayBounds, defined at SDL3/SDL_video.h 722:34

Since: 3.2.0

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

This is the same area as SDL_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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDisplayBounds, sDL_GetDisplays

C declaration

SDL_GetDisplayUsableBounds, defined at SDL3/SDL_video.h 748:34

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

sDL_GetDisplays

C declaration

SDL_GetNaturalDisplayOrientation, defined at SDL3/SDL_video.h 763:52

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

sDL_GetDisplays

C declaration

SDL_GetCurrentDisplayOrientation, defined at SDL3/SDL_video.h 778:52

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, SDL_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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowDisplayScale, sDL_GetDisplays

C declaration

SDL_GetDisplayContentScale, defined at SDL3/SDL_video.h 805:35

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 SDL_GetError() for more information. This is a single allocation that should be freed with SDL_free() when it is no longer needed.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDisplays

C declaration

SDL_GetFullscreenDisplayModes, defined at SDL3/SDL_video.h 833:48

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDisplays, sDL_GetFullscreenDisplayModes

C declaration

SDL_GetClosestFullscreenDisplayMode, defined at SDL3/SDL_video.h 864:34

Since: 3.2.0

Get information about the desktop's display mode.

There's a difference between this function and SDL_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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetCurrentDisplayMode, sDL_GetDisplays

C declaration

SDL_GetDesktopDisplayMode, defined at SDL3/SDL_video.h 885:53

Since: 3.2.0

Get information about the current display mode.

There's a difference between this function and SDL_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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDesktopDisplayMode, sDL_GetDisplays

C declaration

SDL_GetCurrentDisplayMode, defined at SDL3/SDL_video.h 906:53

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDisplayBounds, sDL_GetDisplays

C declaration

SDL_GetDisplayForPoint, defined at SDL3/SDL_video.h 922:43

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDisplayBounds, sDL_GetDisplays

C declaration

SDL_GetDisplayForRect, defined at SDL3/SDL_video.h 939:43

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetDisplayBounds, sDL_GetDisplays

C declaration

SDL_GetDisplayForWindow, defined at SDL3/SDL_video.h 956:43

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowDisplayScale

C declaration

SDL_GetWindowPixelDensity, defined at SDL3/SDL_video.h 975:35

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetWindowDisplayScale, defined at SDL3/SDL_video.h 999:35

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 SDL_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 SDL_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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowFullscreenMode, sDL_SetWindowFullscreen, sDL_SyncWindow

C declaration

SDL_SetWindowFullscreenMode, defined at SDL3/SDL_video.h 1034:34

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

sDL_SetWindowFullscreenMode, sDL_SetWindowFullscreen

C declaration

SDL_GetWindowFullscreenMode, defined at SDL3/SDL_video.h 1050:53

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 SDL_GetError() for more information. This should be freed with SDL_free() when it is no longer needed.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetWindowICCProfile, defined at SDL3/SDL_video.h 1065:36

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetWindowPixelFormat, defined at SDL3/SDL_video.h 1079:45

Since: 3.2.0

Get a list of valid windows.

Returns

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

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetWindows, defined at SDL3/SDL_video.h 1095:43

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, SDL_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 SDL_GetWindowSize() to query the client area's size in window coordinates, and SDL_GetWindowSizeInPixels() or SDL_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 SDL_DestroyWindow().

If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver, SDL_CreateWindow() will fail, because SDL_Vulkan_LoadLibrary() will fail.

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

If you intend to use this window with an SDL_Renderer, you should use SDL_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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

SDL_CreateWindowAndRenderer, sDL_CreatePopupWindow, sDL_CreateWindowWithProperties, sDL_DestroyWindow

C declaration

SDL_CreateWindow, defined at SDL3/SDL_video.h 1184:42

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 SDL_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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_CreateWindow, sDL_CreateWindowWithProperties, sDL_DestroyWindow, sDL_GetWindowParent

C declaration

SDL_CreatePopupWindow, defined at SDL3/SDL_video.h 1260:42

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 SDL_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 SDL_ShowWindow().

Returns

the window that was created or NULL on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

SDL_CreateProperties, sDL_CreateWindow, sDL_DestroyWindow

C declaration

SDL_CreateWindowWithProperties, defined at SDL3/SDL_video.h 1409:42

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowFromID

C declaration

SDL_GetWindowID, defined at SDL3/SDL_video.h 1466:42

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowID

C declaration

SDL_GetWindowFromID, defined at SDL3/SDL_video.h 1484:42

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

sDL_CreatePopupWindow

C declaration

SDL_GetWindowParent, defined at SDL3/SDL_video.h 1499:42

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 SDL_GL_SwapWindow 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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetWindowProperties, defined at SDL3/SDL_video.h 1628:46

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

sDL_CreateWindow, sDL_HideWindow, sDL_MaximizeWindow, sDL_MinimizeWindow, sDL_SetWindowFullscreen, sDL_SetWindowMouseGrab, sDL_SetWindowFillDocument, sDL_ShowWindow

C declaration

SDL_GetWindowFlags, defined at SDL3/SDL_video.h 1687:45

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowTitle

C declaration

SDL_SetWindowTitle, defined at SDL3/SDL_video.h 1705:34

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

sDL_SetWindowTitle

C declaration

SDL_GetWindowTitle, defined at SDL3/SDL_video.h 1720:42

Since: 3.2.0

Set the icon for a window.

If this function is passed a surface with alternate representations added using SDL_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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

SDL_AddSurfaceAlternateImage

C declaration

SDL_SetWindowIcon, defined at SDL3/SDL_video.h 1747:34

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 SDL_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 SDL_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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowPosition, sDL_SyncWindow

C declaration

SDL_SetWindowPosition, defined at SDL3/SDL_video.h 1788:34

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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowPosition

C declaration

SDL_GetWindowPosition, defined at SDL3/SDL_video.h 1813:34

Since: 3.2.0

Request that the size of a window's client area be set.

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

To change the exclusive fullscreen mode of a window, use SDL_SetWindowFullscreenMode().

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

When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will be emitted with the new window dimensions. Note that the new dimensions may not match the exact size requested, as some windowing systems can restrict the window size in certain scenarios (e.g. constraining the size of the content area to remain within the usable 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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowSize, sDL_SetWindowFullscreenMode, sDL_SyncWindow

C declaration

SDL_SetWindowSize, defined at SDL3/SDL_video.h 1850:34

Since: 3.2.0

Get the size of a window's client area.

The window pixel size may differ from its window coordinate size if the window is on a high pixel density display. Use SDL_GetWindowSizeInPixels() or SDL_GetRenderOutputSize() to get the real client area size in pixels.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

SDL_GetRenderOutputSize, sDL_GetWindowSizeInPixels, sDL_SetWindowSize, SDL_EVENT_WINDOW_RESIZED

C declaration

SDL_GetWindowSize, defined at SDL3/SDL_video.h 1874:34

Since: 3.2.0

Get the safe area for this window.

Some devices have portions of the screen which are partially obscured or not interactive, possibly due to on-screen controls, curved edges, camera notches, TV overscan, etc. This function provides the area of the window which is safe to have interactable content. You should continue rendering into the rest of the window, but it should not contain visually important or interactable content.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetWindowSafeArea, defined at SDL3/SDL_video.h 1896:34

Since: 3.2.0

Request that the aspect ratio of a window's client area be set.

The aspect ratio is the ratio of width divided by height, e.g. 2560x1600 would be 1.6. Larger aspect ratios are wider and smaller aspect ratios are narrower.

If, at the time of this request, the window in a fixed-size state, such as maximized or fullscreen, the request will be deferred until the window exits this state and becomes resizable again.

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

When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will be emitted with the new window dimensions. Note that the new dimensions may not match the exact aspect ratio requested, as some windowing systems can restrict the window size in certain scenarios (e.g. constraining the size of the content area to remain within the usable 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 SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowAspectRatio, sDL_SyncWindow

C declaration

SDL_SetWindowAspectRatio, defined at SDL3/SDL_video.h 1937:34

Since: 3.2.0

Get the aspect ratio of a window's client area.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowAspectRatio

C declaration

SDL_GetWindowAspectRatio, defined at SDL3/SDL_video.h 1956:34

Since: 3.2.0

Get the size of a window's borders (decorations) around the client area.

Note: If this function fails (returns false), the size values will be initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the window in question was borderless.

Note: This function may fail on systems where the window has not yet been decorated by the display server (for example, immediately after calling SDL_CreateWindow). It is recommended that you wait at least until the window has been presented and composited, so that the window system has a chance to decorate the window and provide the border dimensions to SDL.

This function also returns false if getting the information is not supported.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowSize

C declaration

SDL_GetWindowBordersSize, defined at SDL3/SDL_video.h 1993:34

Since: 3.2.0

Get the size of a window's client area, in pixels.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_CreateWindow, sDL_GetWindowSize

C declaration

SDL_GetWindowSizeInPixels, defined at SDL3/SDL_video.h 2013:34

Since: 3.2.0

Set the minimum size of a window's client area.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowMinimumSize, sDL_SetWindowMaximumSize

C declaration

SDL_SetWindowMinimumSize, defined at SDL3/SDL_video.h 2031:34

Since: 3.2.0

Get the minimum size of a window's client area.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowMaximumSize, sDL_SetWindowMinimumSize

C declaration

SDL_GetWindowMinimumSize, defined at SDL3/SDL_video.h 2051:34

Since: 3.2.0

Set the maximum size of a window's client area.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowMaximumSize, sDL_SetWindowMinimumSize

C declaration

SDL_SetWindowMaximumSize, defined at SDL3/SDL_video.h 2069:34

Since: 3.2.0

Get the maximum size of a window's client area.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowMinimumSize, sDL_SetWindowMaximumSize

C declaration

SDL_GetWindowMaximumSize, defined at SDL3/SDL_video.h 2089:34

Since: 3.2.0

Set the border state of a window.

This will add or remove the window's SDL_WINDOW_BORDERLESS flag and add or remove the border from the actual window. This is a no-op if the window's border already matches the requested state.

You can't change the border state of a fullscreen window.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowFlags

C declaration

SDL_SetWindowBordered, defined at SDL3/SDL_video.h 2111:34

Since: 3.2.0

Set the user-resizable state of a window.

This will add or remove the window's SDL_WINDOW_RESIZABLE flag and allow/disallow user resizing of the window. This is a no-op if the window's resizable state already matches the requested state.

You can't change the resizable state of a fullscreen window.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowFlags

C declaration

SDL_SetWindowResizable, defined at SDL3/SDL_video.h 2133:34

Since: 3.2.0

Set the window to always be above the others.

This will add or remove the window's SDL_WINDOW_ALWAYS_ON_TOP flag. This will bring the window to the front and keep the window above the rest.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowFlags

C declaration

SDL_SetWindowAlwaysOnTop, defined at SDL3/SDL_video.h 2152:34

Since: 3.2.0

Set the window to fill the current document space (Emscripten only).

This will add or remove the window's SDL_WINDOW_FILL_DOCUMENT flag.

Currently this flag only applies to the Emscripten target.

When enabled, the canvas element fills the entire document. Resize events will be generated as the browser window is resized, as that will adjust the canvas size as well. The canvas will cover anything else on the page, including any controls provided by Emscripten in its generated HTML file (in fact, any elements on the page that aren't the canvas will be moved into a hidden div element).

Often times this is desirable for a browser-based game, but it means several things that we expect of an SDL window on other platforms might not work as expected, such as minimum window sizes and aspect ratios.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowFlags

C declaration

SDL_SetWindowFillDocument, defined at SDL3/SDL_video.h 2183:34

Since: 3.4.0

Show a window.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_HideWindow, sDL_RaiseWindow

C declaration

SDL_ShowWindow, defined at SDL3/SDL_video.h 2199:34

Since: 3.2.0

Hide a window.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_ShowWindow, SDL_WINDOW_HIDDEN

C declaration

SDL_HideWindow, defined at SDL3/SDL_video.h 2215:34

Since: 3.2.0

Request that a window be raised above other windows and gain the input focus.

The result of this request is subject to desktop window manager policy, particularly if raising the requested window would result in stealing focus from another application. If the window is successfully raised and gains input focus, an SDL_EVENT_WINDOW_FOCUS_GAINED event will be emitted, and the window will have the SDL_WINDOW_INPUT_FOCUS flag set.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_RaiseWindow, defined at SDL3/SDL_video.h 2235:34

Since: 3.2.0

Request that the window be made as large as possible.

Non-resizable windows can't be maximized. The window must have the SDL_WINDOW_RESIZABLE flag set, or this will have no effect.

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

When the window state changes, an SDL_EVENT_WINDOW_MAXIMIZED event will be emitted. Note that, as this is just a request, the windowing system can deny the state change.

When maximizing a window, whether the constraints set via SDL_SetWindowMaximumSize() are honored depends on the policy of the window manager. Win32 and macOS enforce the constraints when maximizing, while X11 and Wayland window managers may vary.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_MinimizeWindow, sDL_RestoreWindow, sDL_SyncWindow

C declaration

SDL_MaximizeWindow, defined at SDL3/SDL_video.h 2269:34

Since: 3.2.0

Request that the window be minimized to an iconic representation.

If the window is in a fullscreen state, this request has no direct effect. It may alter the state the window is returned to when leaving fullscreen.

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

When the window state changes, an SDL_EVENT_WINDOW_MINIMIZED event will be emitted. Note that, as this is just a request, the windowing system can deny the state change.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_MaximizeWindow, sDL_RestoreWindow, sDL_SyncWindow

C declaration

SDL_MinimizeWindow, defined at SDL3/SDL_video.h 2298:34

Since: 3.2.0

Request that the size and position of a minimized or maximized window be restored.

If the window is in a fullscreen state, this request has no direct effect. It may alter the state the window is returned to when leaving fullscreen.

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

When the window state changes, an SDL_EVENT_WINDOW_RESTORED event will be emitted. Note that, as this is just a request, the windowing system can deny the state change.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_MaximizeWindow, sDL_MinimizeWindow, sDL_SyncWindow

C declaration

SDL_RestoreWindow, defined at SDL3/SDL_video.h 2328:34

Since: 3.2.0

Request that the window's fullscreen state be changed.

By default a window in fullscreen state uses borderless fullscreen desktop mode, but a specific exclusive display mode can be set using SDL_SetWindowFullscreenMode().

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

When the window state changes, an SDL_EVENT_WINDOW_ENTER_FULLSCREEN or SDL_EVENT_WINDOW_LEAVE_FULLSCREEN event will be emitted. Note that, as this is just a request, it can be denied by the windowing system.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowFullscreenMode, sDL_SetWindowFullscreenMode, sDL_SyncWindow, SDL_WINDOW_FULLSCREEN

C declaration

SDL_SetWindowFullscreen, defined at SDL3/SDL_video.h 2360:34

Since: 3.2.0

Block until any pending window state is finalized.

On asynchronous windowing systems, this acts as a synchronization barrier for pending window state. It will attempt to wait until any pending window state has been applied and is guaranteed to return within finite time. Note that for how long it can potentially block depends on the underlying window system, as window state changes may involve somewhat lengthy animations that must complete before the window is in its final requested state.

On windowing systems where changes are immediate, this does nothing.

Returns

true on success or false if the operation timed out before the window was in the requested state.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowSize, sDL_SetWindowPosition, sDL_SetWindowFullscreen, sDL_MinimizeWindow, sDL_MaximizeWindow, sDL_RestoreWindow, SDL_HINT_VIDEO_SYNC_WINDOW_OPERATIONS

C declaration

SDL_SyncWindow, defined at SDL3/SDL_video.h 2391:34

Since: 3.2.0

Return whether the window has a surface associated with it.

Returns

true if there is a surface associated with the window, or false otherwise.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowSurface

C declaration

SDL_WindowHasSurface, defined at SDL3/SDL_video.h 2406:34

Since: 3.2.0

Get the SDL surface associated with the window.

A new surface will be created with the optimal format for the window, if necessary. This surface will be freed when the window is destroyed. Do not free this surface.

This surface will be invalidated if the window is resized. After resizing a window this function must be called again to return a valid surface.

You may not combine this with 3D or the rendering API on this window.

This function is affected by SDL_HINT_FRAMEBUFFER_ACCELERATION.

Returns

the surface associated with the window, or NULL on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_DestroyWindowSurface, sDL_WindowHasSurface, sDL_UpdateWindowSurface, sDL_UpdateWindowSurfaceRects

C declaration

SDL_GetWindowSurface, defined at SDL3/SDL_video.h 2435:43

Since: 3.2.0

Toggle VSync for the window surface.

When a window surface is created, vsync defaults to SDL_WINDOW_SURFACE_VSYNC_DISABLED.

The vsync parameter can be 1 to synchronize present with every vertical refresh, 2 to synchronize present with every second vertical refresh, etc., SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync), or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is supported by every driver, so you should check the return value to see whether the requested setting is supported.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowSurfaceVSync

C declaration

SDL_SetWindowSurfaceVSync, defined at SDL3/SDL_video.h 2461:34

Since: 3.2.0

Get VSync for the window surface.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowSurfaceVSync

C declaration

SDL_GetWindowSurfaceVSync, defined at SDL3/SDL_video.h 2481:34

Since: 3.2.0

Copy the window surface to the screen.

This is the function you use to reflect any changes to the surface on the screen.

This function is equivalent to the SDL 1.2 API SDL_Flip().

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowSurface, sDL_UpdateWindowSurfaceRects

C declaration

SDL_UpdateWindowSurface, defined at SDL3/SDL_video.h 2502:34

Since: 3.2.0

Copy areas of the window surface to the screen.

This is the function you use to reflect changes to portions of the surface on the screen.

This function is equivalent to the SDL 1.2 API SDL_UpdateRects().

Note that this function will update at least the rectangles specified, but this is only intended as an optimization; in practice, this might update more of the screen (or all of the screen!), depending on what method SDL uses to send pixels to the system.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowSurface, sDL_UpdateWindowSurface

C declaration

SDL_UpdateWindowSurfaceRects, defined at SDL3/SDL_video.h 2531:34

Since: 3.2.0

Destroy the surface associated with the window.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowSurface, sDL_WindowHasSurface

C declaration

SDL_DestroyWindowSurface, defined at SDL3/SDL_video.h 2547:34

Since: 3.2.0

Set a window's keyboard grab mode.

Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or the Meta/Super key. Note that not all system keyboard shortcuts can be captured by applications (one example is Ctrl+Alt+Del on Windows).

This is primarily intended for specialized applications such as VNC clients or VM frontends. Normal games should not use keyboard grab.

When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the window is full-screen to ensure the user is not trapped in your application. If you have a custom keyboard shortcut to exit fullscreen mode, you may suppress this behavior with SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED.

If the caller enables a grab while another window is currently grabbed, the other window loses its grab in favor of the caller's window.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowKeyboardGrab, sDL_SetWindowMouseGrab

C declaration

SDL_SetWindowKeyboardGrab, defined at SDL3/SDL_video.h 2580:34

Since: 3.2.0

Set a window's mouse grab mode.

Mouse grab confines the mouse cursor to the window.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowMouseRect, sDL_SetWindowMouseRect, sDL_SetWindowKeyboardGrab

C declaration

SDL_SetWindowMouseGrab, defined at SDL3/SDL_video.h 2600:34

Since: 3.2.0

Get a window's keyboard grab mode.

Returns

true if keyboard is grabbed, and false otherwise.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowKeyboardGrab

C declaration

SDL_GetWindowKeyboardGrab, defined at SDL3/SDL_video.h 2614:34

Since: 3.2.0

Get a window's mouse grab mode.

Returns

true if mouse is grabbed, and false otherwise.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowMouseRect, sDL_SetWindowMouseRect, sDL_SetWindowMouseGrab, sDL_SetWindowKeyboardGrab

C declaration

SDL_GetWindowMouseGrab, defined at SDL3/SDL_video.h 2631:34

Since: 3.2.0

Get the window that currently has an input grab enabled.

Returns

the window if input is grabbed or NULL otherwise.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowMouseGrab, sDL_SetWindowKeyboardGrab

C declaration

SDL_GetGrabbedWindow, defined at SDL3/SDL_video.h 2645:42

Since: 3.2.0

Confines the cursor to the specified area of a window.

Note that this does NOT grab the cursor, it only defines the area a cursor is restricted to when the window has mouse focus.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowMouseRect, sDL_GetWindowMouseGrab, sDL_SetWindowMouseGrab

C declaration

SDL_SetWindowMouseRect, defined at SDL3/SDL_video.h 2667:34

Since: 3.2.0

Get the mouse confinement rectangle of a window.

Returns

a pointer to the mouse confinement rectangle of a window, or NULL if there isn't one.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowMouseRect, sDL_GetWindowMouseGrab, sDL_SetWindowMouseGrab

C declaration

SDL_GetWindowMouseRect, defined at SDL3/SDL_video.h 2684:46

Since: 3.2.0

Set the opacity for a window.

The parameter opacity will be clamped internally between 0.0f (transparent) and 1.0f (opaque).

This function also returns false if setting the opacity isn't supported.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GetWindowOpacity

C declaration

SDL_SetWindowOpacity, defined at SDL3/SDL_video.h 2705:34

Since: 3.2.0

Get the opacity of a window.

If transparency isn't supported on this platform, opacity will be returned as 1.0f without error.

Returns

the opacity, (0.0f - transparent, 1.0f - opaque), or -1.0f on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowOpacity

C declaration

SDL_GetWindowOpacity, defined at SDL3/SDL_video.h 2723:35

Since: 3.2.0

Set the window as a child of a parent window.

If the window is already the child of an existing window, it will be reparented to the new owner. Setting the parent window to NULL unparents the window and removes child window status.

If a parent window is hidden or destroyed, the operation will be recursively applied to child windows. Child windows hidden with the parent that did not have their hidden status explicitly set will be restored when the parent is shown.

Attempting to set the parent of a window that is currently in the modal state will fail. Use SDL_SetWindowModal() to cancel the modal status before attempting to change the parent.

Popup windows cannot change parents and attempts to do so will fail.

Setting a parent window that is currently the sibling or descendent of the child window results in undefined behavior.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowModal

C declaration

SDL_SetWindowParent, defined at SDL3/SDL_video.h 2757:34

Since: 3.2.0

Toggle the state of the window as modal.

To enable modal status on a window, the window must currently be the child window of a parent, or toggling modal status on will fail.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_SetWindowParent, SDL_WINDOW_MODAL

C declaration

SDL_SetWindowModal, defined at SDL3/SDL_video.h 2777:34

Since: 3.2.0

Set whether the window may have input focus.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_SetWindowFocusable, defined at SDL3/SDL_video.h 2791:34

Since: 3.2.0

Display the system-level window menu.

This default window menu is provided by the system and on some platforms provides functionality for setting or changing privileged state on the window, such as moving it between workspaces or displays, or toggling the always-on-top property.

On platforms or desktops where this is unsupported, this function does nothing.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_ShowWindowSystemMenu, defined at SDL3/SDL_video.h 2817:34

Since: 3.2.0

Provide a callback that decides if a window region has special properties.

Normally windows are dragged and resized by decorations provided by the system window manager (a title bar, borders, etc), but for some apps, it makes sense to drag them from somewhere else inside the window itself; for example, one might have a borderless window that wants to be draggable from any part, or simulate its own title bar, etc.

This function lets the app provide a callback that designates pieces of a given window as special. This callback is run during event processing if we need to tell the OS to treat a region of the window specially; the use of this callback is known as "hit testing."

Mouse input may not be delivered to your application if it is within a special area; the OS will often apply that input to moving the window or resizing the window and not deliver it to the application.

Specifying NULL for a callback disables hit-testing. Hit-testing is disabled by default.

Platforms that don't support this functionality will return false unconditionally, even if you're attempting to disable hit-testing.

Your callback may fire at any time, and its firing does not indicate any specific behavior (for example, on Windows, this certainly might fire when the OS is deciding whether to drag your window, but it fires for lots of other reasons, too, some unrelated to anything you probably care about and when the mouse isn't actually at the location it is testing). Since this can fire at any time, you should try to keep your callback efficient, devoid of allocations, etc.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_SetWindowHitTest, defined at SDL3/SDL_video.h 2898:34

Since: 3.2.0

Set the shape of a transparent window.

This sets the alpha channel of a transparent window and any fully transparent areas are also transparent to mouse clicks. If you are using something besides the SDL render API, then you are responsible for drawing the alpha channel of the window to match the shape alpha channel to get consistent cross-platform results.

The shape is copied inside this function, so you can free it afterwards. If your shape surface changes, you should call SDL_SetWindowShape() again to update the window. This is an expensive operation, so should be done sparingly.

The window must have been created with the SDL_WINDOW_TRANSPARENT flag.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_SetWindowShape, defined at SDL3/SDL_video.h 2926:34

Since: 3.2.0

Request a window to demand attention from the user.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_FlashWindow, defined at SDL3/SDL_video.h 2940:34

Since: 3.2.0

Sets the state of the progress bar for the given window’s taskbar icon.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_SetWindowProgressState, defined at SDL3/SDL_video.h 2955:34

Since: 3.4.0

Get the state of the progress bar for the given window’s taskbar icon.

Returns

the progress state, or SDL_PROGRESS_STATE_INVALID on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetWindowProgressState, defined at SDL3/SDL_video.h 2968:47

Since: 3.4.0

Sets the value of the progress bar for the given window’s taskbar icon.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_SetWindowProgressValue, defined at SDL3/SDL_video.h 2983:34

Since: 3.4.0

Get the value of the progress bar for the given window’s taskbar icon.

Returns

the progress value in the range of [0.0f - 1.0f], or -1.0f on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GetWindowProgressValue, defined at SDL3/SDL_video.h 2996:35

Since: 3.4.0

Destroy a window.

Any child windows owned by the window will be recursively destroyed as well.

Note that on some platforms, the visible window may not actually be removed from the screen until the SDL event loop is pumped again, even though the SDL_Window is no longer valid after this call.

Thread safety

This function should only be called on the main thread.

See also

sDL_CreatePopupWindow, sDL_CreateWindow, sDL_CreateWindowWithProperties

C declaration

SDL_DestroyWindow, defined at SDL3/SDL_video.h 3018:34

Since: 3.2.0

Check whether the screensaver is currently enabled.

The screensaver is disabled by default.

The default can also be changed using SDL_HINT_VIDEO_ALLOW_SCREENSAVER.

Returns

true if the screensaver is enabled, false if it is disabled.

Thread safety

This function should only be called on the main thread.

See also

sDL_DisableScreenSaver, sDL_EnableScreenSaver

C declaration

SDL_ScreenSaverEnabled, defined at SDL3/SDL_video.h 3037:34

Since: 3.2.0

Allow the screen to be blanked by a screen saver.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_DisableScreenSaver, sDL_ScreenSaverEnabled

C declaration

SDL_EnableScreenSaver, defined at SDL3/SDL_video.h 3052:34

Since: 3.2.0

Prevent the screen from being blanked by a screen saver.

If you disable the screensaver, it is automatically re-enabled when SDL quits.

The screensaver is disabled by default, but this may by changed by SDL_HINT_VIDEO_ALLOW_SCREENSAVER.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_EnableScreenSaver, sDL_ScreenSaverEnabled

C declaration

SDL_DisableScreenSaver, defined at SDL3/SDL_video.h 3073:34

Since: 3.2.0

Dynamically load an OpenGL library.

This should be done after initializing the video driver, but before creating any OpenGL windows. If no OpenGL library is loaded, the default library will be loaded upon creation of the first OpenGL window.

If you do this, you need to retrieve all of the GL functions used in your program from the dynamic library using SDL_GL_GetProcAddress().

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_GetProcAddress, sDL_GL_UnloadLibrary

C declaration

SDL_GL_LoadLibrary, defined at SDL3/SDL_video.h 3103:34

Since: 3.2.0

Get an OpenGL function by name.

If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all GL functions must be retrieved this way. Usually this is used to retrieve function pointers to OpenGL extensions.

There are some quirks to looking up OpenGL functions that require some extra care from the application. If you code carefully, you can handle these quirks without any platform-specific code, though:

• On Windows, function pointers are specific to the current GL context; this means you need to have created a GL context and made it current before calling SDL_GL_GetProcAddress(). If you recreate your context or create a second context, you should assume that any existing function pointers aren't valid to use with it. This is (currently) a Windows-specific limitation, and in practice lots of drivers don't suffer this limitation, but it is still the way the wgl API is documented to work and you should expect crashes if you don't respect it. Store a copy of the function pointers that comes and goes with context lifespan.
• On X11, function pointers returned by this function are valid for any context, and can even be looked up before a context is created at all. This means that, for at least some common OpenGL implementations, if you look up a function that doesn't exist, you'll get a non-NULL result that is NOT safe to call. You must always make sure the function is actually available for a given GL context before calling it, by checking for the existence of the appropriate extension with SDL_GL_ExtensionSupported(), or verifying that the version of OpenGL you're using offers the function as core functionality.
• Some OpenGL drivers, on all platforms, will return NULL if a function isn't supported, but you can't count on this behavior. Check for extensions you use, and if you get a NULL anyway, act as if that extension wasn't available. This is probably a bug in the driver, but you can code defensively for this scenario anyhow.
• Just because you're on Linux/Unix, don't assume you'll be using X11. Next-gen display servers are waiting to replace it, and may or may not make the same promises about function pointers.
• OpenGL function pointers must be declared APIENTRY as in the example code. This will ensure the proper calling convention is followed on platforms where this matters (Win32) thereby avoiding stack corruption.

Returns

a pointer to the named OpenGL function. The returned pointer should be cast to the appropriate function signature.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_ExtensionSupported, sDL_GL_LoadLibrary, sDL_GL_UnloadLibrary

C declaration

SDL_GL_GetProcAddress, defined at SDL3/SDL_video.h 3158:49

Since: 3.2.0

Get an EGL library function by name.

If an EGL library is loaded, this function allows applications to get entry points for EGL functions. This is useful to provide to an EGL API and extension loader.

Returns

a pointer to the named EGL function. The returned pointer should be cast to the appropriate function signature.

Thread safety

This function should only be called on the main thread.

See also

sDL_EGL_GetCurrentDisplay

C declaration

SDL_EGL_GetProcAddress, defined at SDL3/SDL_video.h 3177:49

Since: 3.2.0

Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_LoadLibrary

C declaration

SDL_GL_UnloadLibrary, defined at SDL3/SDL_video.h 3188:34

Since: 3.2.0

Check if an OpenGL extension is supported for the current context.

This function operates on the current GL context; you must have created a context and it must be current before calling this function. Do not assume that all contexts you create will have the same set of extensions available, or that recreating an existing context will offer the same extensions again.

While it's probably not a massive overhead, this function is not an O(1) operation. Check the extensions you care about after creating the GL context and save that information somewhere instead of calling the function every time you need to know.

Returns

true if the extension is supported, false otherwise.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GL_ExtensionSupported, defined at SDL3/SDL_video.h 3211:34

Since: 3.2.0

Reset all previously set OpenGL context attributes to their default values.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_GetAttribute, sDL_GL_SetAttribute

C declaration

SDL_GL_ResetAttributes, defined at SDL3/SDL_video.h 3223:34

Since: 3.2.0

Set an OpenGL window attribute before window creation.

This function sets the OpenGL attribute attr to value. The requested attributes should be set before creating an OpenGL window. You should use SDL_GL_GetAttribute() to check the values after creating the OpenGL context, since the values obtained can differ from the requested ones.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_CreateContext, sDL_GL_GetAttribute, sDL_GL_ResetAttributes

C declaration

SDL_GL_SetAttribute, defined at SDL3/SDL_video.h 3246:34

Since: 3.2.0

Get the actual value for an attribute from the current context.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_ResetAttributes, sDL_GL_SetAttribute

C declaration

SDL_GL_GetAttribute, defined at SDL3/SDL_video.h 3264:34

Since: 3.2.0

Create an OpenGL context for an OpenGL window, and make it current.

The OpenGL context will be created with the current states set through SDL_GL_SetAttribute().

The SDL_Window specified must have been created with the SDL_WINDOW_OPENGL flag, or context creation will fail.

Windows users new to OpenGL should note that, for historical reasons, GL functions added after OpenGL version 1.1 are not available by default. Those functions must be loaded at run-time, either with an OpenGL extension-handling library or with SDL_GL_GetProcAddress() and its related functions.

SDL_GLContext is opaque to the application.

Returns

the OpenGL context associated with window or NULL on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_DestroyContext, sDL_GL_MakeCurrent

C declaration

SDL_GL_CreateContext, defined at SDL3/SDL_video.h 3294:43

Since: 3.2.0

Set up an OpenGL context for rendering into an OpenGL window.

The context must have been created with a compatible window.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_CreateContext

C declaration

SDL_GL_MakeCurrent, defined at SDL3/SDL_video.h 3312:34

Since: 3.2.0

Get the currently active OpenGL window.

Returns

the currently active OpenGL window on success or NULL on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GL_GetCurrentWindow, defined at SDL3/SDL_video.h 3324:42

Since: 3.2.0

Get the currently active OpenGL context.

Returns

the currently active OpenGL context or NULL on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_MakeCurrent

C declaration

SDL_GL_GetCurrentContext, defined at SDL3/SDL_video.h 3338:43

Since: 3.2.0

Get the currently active EGL display.

Returns

the currently active EGL display or NULL on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_EGL_GetCurrentDisplay, defined at SDL3/SDL_video.h 3350:44

Since: 3.2.0

Get the currently active EGL config.

Returns

the currently active EGL config or NULL on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_EGL_GetCurrentConfig, defined at SDL3/SDL_video.h 3362:43

Since: 3.2.0

Get the EGL surface associated with the window.

Returns

the EGLSurface pointer associated with the window, or NULL on failure.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_EGL_GetWindowSurface, defined at SDL3/SDL_video.h 3375:44

Since: 3.2.0

Sets the callbacks for defining custom EGLAttrib arrays for EGL initialization.

Callbacks that aren't needed can be set to NULL.

NOTE: These callback pointers will be reset after SDL_GL_ResetAttributes.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_EGL_SetAttributeCallbacks, defined at SDL3/SDL_video.h 3397:34

Since: 3.2.0

Set the swap interval for the current OpenGL context.

Some systems allow specifying -1 for the interval, to enable adaptive vsync. Adaptive vsync works the same as vsync, but if you've already missed the vertical retrace for a given frame, it swaps buffers immediately, which might be less jarring for the user during occasional framerate drops. If an application requests adaptive vsync and the system does not support it, this function will fail and return false. In such a case, you should probably retry the call with 1 for the interval.

Adaptive vsync is implemented for some glX drivers with GLX_EXT_swap_control_tear, and for some Windows drivers with WGL_EXT_swap_control_tear.

Read more on the Khronos wiki: https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_GetSwapInterval

C declaration

SDL_GL_SetSwapInterval, defined at SDL3/SDL_video.h 3430:34

Since: 3.2.0

Get the swap interval for the current OpenGL context.

If the system can't determine the swap interval, or there isn't a valid current context, this function will set *interval to 0 as a safe default.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_SetSwapInterval

C declaration

SDL_GL_GetSwapInterval, defined at SDL3/SDL_video.h 3451:34

Since: 3.2.0

Update a window with OpenGL rendering.

This is used with double-buffered OpenGL contexts, which are the default.

On macOS, make sure you bind 0 to the draw framebuffer before swapping the window, otherwise nothing will happen. If you aren't using glBindFramebuffer(), this is the default and you won't have to do anything extra.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

C declaration

SDL_GL_SwapWindow, defined at SDL3/SDL_video.h 3471:34

Since: 3.2.0

Delete an OpenGL context.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

See also

sDL_GL_CreateContext

C declaration

SDL_GL_DestroyContext, defined at SDL3/SDL_video.h 3486:34

Since: 3.2.0