SDL 3.0
Data Structures | Macros | Typedefs | Enumerations | Functions
SDL_video.h File Reference
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_error.h>
#include <SDL3/SDL_pixels.h>
#include <SDL3/SDL_properties.h>
#include <SDL3/SDL_rect.h>
#include <SDL3/SDL_surface.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>
+ Include dependency graph for SDL_video.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SDL_DisplayMode
 

Macros

#define SDL_PROP_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER   "SDL.video.wayland.wl_display"
 
#define SDL_WINDOW_FULLSCREEN   SDL_UINT64_C(0x0000000000000001)
 
#define SDL_WINDOW_OPENGL   SDL_UINT64_C(0x0000000000000002)
 
#define SDL_WINDOW_OCCLUDED   SDL_UINT64_C(0x0000000000000004)
 
#define SDL_WINDOW_HIDDEN   SDL_UINT64_C(0x0000000000000008)
 
#define SDL_WINDOW_BORDERLESS   SDL_UINT64_C(0x0000000000000010)
 
#define SDL_WINDOW_RESIZABLE   SDL_UINT64_C(0x0000000000000020)
 
#define SDL_WINDOW_MINIMIZED   SDL_UINT64_C(0x0000000000000040)
 
#define SDL_WINDOW_MAXIMIZED   SDL_UINT64_C(0x0000000000000080)
 
#define SDL_WINDOW_MOUSE_GRABBED   SDL_UINT64_C(0x0000000000000100)
 
#define SDL_WINDOW_INPUT_FOCUS   SDL_UINT64_C(0x0000000000000200)
 
#define SDL_WINDOW_MOUSE_FOCUS   SDL_UINT64_C(0x0000000000000400)
 
#define SDL_WINDOW_EXTERNAL   SDL_UINT64_C(0x0000000000000800)
 
#define SDL_WINDOW_MODAL   SDL_UINT64_C(0x0000000000001000)
 
#define SDL_WINDOW_HIGH_PIXEL_DENSITY   SDL_UINT64_C(0x0000000000002000)
 
#define SDL_WINDOW_MOUSE_CAPTURE   SDL_UINT64_C(0x0000000000004000)
 
#define SDL_WINDOW_MOUSE_RELATIVE_MODE   SDL_UINT64_C(0x0000000000008000)
 
#define SDL_WINDOW_ALWAYS_ON_TOP   SDL_UINT64_C(0x0000000000010000)
 
#define SDL_WINDOW_UTILITY   SDL_UINT64_C(0x0000000000020000)
 
#define SDL_WINDOW_TOOLTIP   SDL_UINT64_C(0x0000000000040000)
 
#define SDL_WINDOW_POPUP_MENU   SDL_UINT64_C(0x0000000000080000)
 
#define SDL_WINDOW_KEYBOARD_GRABBED   SDL_UINT64_C(0x0000000000100000)
 
#define SDL_WINDOW_FILL_DOCUMENT   SDL_UINT64_C(0x0000000000200000)
 
#define SDL_WINDOW_VULKAN   SDL_UINT64_C(0x0000000010000000)
 
#define SDL_WINDOW_METAL   SDL_UINT64_C(0x0000000020000000)
 
#define SDL_WINDOW_TRANSPARENT   SDL_UINT64_C(0x0000000040000000)
 
#define SDL_WINDOW_NOT_FOCUSABLE   SDL_UINT64_C(0x0000000080000000)
 
#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u
 
#define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)   (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
 
#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
 
#define SDL_WINDOWPOS_ISUNDEFINED(X)   (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
 
#define SDL_WINDOWPOS_CENTERED_MASK   0x2FFF0000u
 
#define SDL_WINDOWPOS_CENTERED_DISPLAY(X)   (SDL_WINDOWPOS_CENTERED_MASK|(X))
 
#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)
 
#define SDL_WINDOWPOS_ISCENTERED(X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
 
#define SDL_GL_CONTEXT_PROFILE_CORE   0x0001
 
#define SDL_GL_CONTEXT_PROFILE_COMPATIBILITY   0x0002
 
#define SDL_GL_CONTEXT_PROFILE_ES   0x0004
 
#define SDL_GL_CONTEXT_DEBUG_FLAG   0x0001
 
#define SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG   0x0002
 
#define SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG   0x0004
 
#define SDL_GL_CONTEXT_RESET_ISOLATION_FLAG   0x0008
 
#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE   0x0000
 
#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH   0x0001
 
#define SDL_GL_CONTEXT_RESET_NO_NOTIFICATION   0x0000
 
#define SDL_GL_CONTEXT_RESET_LOSE_CONTEXT   0x0001
 
#define SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN   "SDL.display.HDR_enabled"
 
#define SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER   "SDL.display.KMSDRM.panel_orientation"
 
#define SDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER   "SDL.display.wayland.wl_output"
 
#define SDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER   "SDL.display.windows.hmonitor"
 
#define SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN   "SDL.window.create.always_on_top"
 
#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN   "SDL.window.create.borderless"
 
#define SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN   "SDL.window.create.constrain_popup"
 
#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN   "SDL.window.create.focusable"
 
#define SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN   "SDL.window.create.external_graphics_context"
 
#define SDL_PROP_WINDOW_CREATE_FLAGS_NUMBER   "SDL.window.create.flags"
 
#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN   "SDL.window.create.fullscreen"
 
#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER   "SDL.window.create.height"
 
#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN   "SDL.window.create.hidden"
 
#define SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN   "SDL.window.create.high_pixel_density"
 
#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN   "SDL.window.create.maximized"
 
#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN   "SDL.window.create.menu"
 
#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN   "SDL.window.create.metal"
 
#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN   "SDL.window.create.minimized"
 
#define SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN   "SDL.window.create.modal"
 
#define SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN   "SDL.window.create.mouse_grabbed"
 
#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN   "SDL.window.create.opengl"
 
#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER   "SDL.window.create.parent"
 
#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN   "SDL.window.create.resizable"
 
#define SDL_PROP_WINDOW_CREATE_TITLE_STRING   "SDL.window.create.title"
 
#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN   "SDL.window.create.transparent"
 
#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN   "SDL.window.create.tooltip"
 
#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN   "SDL.window.create.utility"
 
#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN   "SDL.window.create.vulkan"
 
#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER   "SDL.window.create.width"
 
#define SDL_PROP_WINDOW_CREATE_X_NUMBER   "SDL.window.create.x"
 
#define SDL_PROP_WINDOW_CREATE_Y_NUMBER   "SDL.window.create.y"
 
#define SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER   "SDL.window.create.cocoa.window"
 
#define SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER   "SDL.window.create.cocoa.view"
 
#define SDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER   "SDL.window.create.uikit.windowscene"
 
#define SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN   "SDL.window.create.wayland.surface_role_custom"
 
#define SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN   "SDL.window.create.wayland.create_egl_window"
 
#define SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER   "SDL.window.create.wayland.wl_surface"
 
#define SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER   "SDL.window.create.win32.hwnd"
 
#define SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER   "SDL.window.create.win32.pixel_format_hwnd"
 
#define SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER   "SDL.window.create.x11.window"
 
#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING   "SDL.window.create.emscripten.canvas_id"
 
#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING   "SDL.window.create.emscripten.keyboard_element"
 
#define SDL_PROP_WINDOW_SHAPE_POINTER   "SDL.window.shape"
 
#define SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN   "SDL.window.HDR_enabled"
 
#define SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT   "SDL.window.SDR_white_level"
 
#define SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT   "SDL.window.HDR_headroom"
 
#define SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER   "SDL.window.android.window"
 
#define SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER   "SDL.window.android.surface"
 
#define SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER   "SDL.window.uikit.window"
 
#define SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER   "SDL.window.uikit.metal_view_tag"
 
#define SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER   "SDL.window.uikit.opengl.framebuffer"
 
#define SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER   "SDL.window.uikit.opengl.renderbuffer"
 
#define SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER   "SDL.window.uikit.opengl.resolve_framebuffer"
 
#define SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER   "SDL.window.kmsdrm.dev_index"
 
#define SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER   "SDL.window.kmsdrm.drm_fd"
 
#define SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER   "SDL.window.kmsdrm.gbm_dev"
 
#define SDL_PROP_WINDOW_COCOA_WINDOW_POINTER   "SDL.window.cocoa.window"
 
#define SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER   "SDL.window.cocoa.metal_view_tag"
 
#define SDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER   "SDL.window.openvr.overlay_id"
 
#define SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER   "SDL.window.vivante.display"
 
#define SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER   "SDL.window.vivante.window"
 
#define SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER   "SDL.window.vivante.surface"
 
#define SDL_PROP_WINDOW_WIN32_HWND_POINTER   "SDL.window.win32.hwnd"
 
#define SDL_PROP_WINDOW_WIN32_HDC_POINTER   "SDL.window.win32.hdc"
 
#define SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER   "SDL.window.win32.instance"
 
#define SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER   "SDL.window.wayland.display"
 
#define SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER   "SDL.window.wayland.surface"
 
#define SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER   "SDL.window.wayland.viewport"
 
#define SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER   "SDL.window.wayland.egl_window"
 
#define SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER   "SDL.window.wayland.xdg_surface"
 
#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER   "SDL.window.wayland.xdg_toplevel"
 
#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING   "SDL.window.wayland.xdg_toplevel_export_handle"
 
#define SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER   "SDL.window.wayland.xdg_popup"
 
#define SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER   "SDL.window.wayland.xdg_positioner"
 
#define SDL_PROP_WINDOW_X11_DISPLAY_POINTER   "SDL.window.x11.display"
 
#define SDL_PROP_WINDOW_X11_SCREEN_NUMBER   "SDL.window.x11.screen"
 
#define SDL_PROP_WINDOW_X11_WINDOW_NUMBER   "SDL.window.x11.window"
 
#define SDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING   "SDL.window.emscripten.canvas_id"
 
#define SDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING   "SDL.window.emscripten.keyboard_element"
 
#define SDL_WINDOW_SURFACE_VSYNC_DISABLED   0
 
#define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE   (-1)
 

Typedefs

typedef Uint32 SDL_DisplayID
 
typedef Uint32 SDL_WindowID
 
typedef struct SDL_DisplayModeData SDL_DisplayModeData
 
typedef struct SDL_Window SDL_Window
 
typedef Uint64 SDL_WindowFlags
 
typedef struct SDL_GLContextState * SDL_GLContext
 
typedef void * SDL_EGLDisplay
 
typedef void * SDL_EGLConfig
 
typedef void * SDL_EGLSurface
 
typedef intptr_t SDL_EGLAttrib
 
typedef int SDL_EGLint
 
typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void *userdata)
 
typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void *userdata, SDL_EGLDisplay display, SDL_EGLConfig config)
 
typedef Uint32 SDL_GLProfile
 
typedef Uint32 SDL_GLContextFlag
 
typedef Uint32 SDL_GLContextReleaseFlag
 
typedef Uint32 SDL_GLContextResetNotification
 
typedef SDL_HitTestResult(* SDL_HitTest) (SDL_Window *win, const SDL_Point *area, void *data)
 

Enumerations

enum  SDL_SystemTheme {
  SDL_SYSTEM_THEME_UNKNOWN ,
  SDL_SYSTEM_THEME_LIGHT ,
  SDL_SYSTEM_THEME_DARK
}
 
enum  SDL_DisplayOrientation {
  SDL_ORIENTATION_UNKNOWN ,
  SDL_ORIENTATION_LANDSCAPE ,
  SDL_ORIENTATION_LANDSCAPE_FLIPPED ,
  SDL_ORIENTATION_PORTRAIT ,
  SDL_ORIENTATION_PORTRAIT_FLIPPED
}
 
enum  SDL_FlashOperation {
  SDL_FLASH_CANCEL ,
  SDL_FLASH_BRIEFLY ,
  SDL_FLASH_UNTIL_FOCUSED
}
 
enum  SDL_ProgressState {
  SDL_PROGRESS_STATE_INVALID = -1 ,
  SDL_PROGRESS_STATE_NONE ,
  SDL_PROGRESS_STATE_INDETERMINATE ,
  SDL_PROGRESS_STATE_NORMAL ,
  SDL_PROGRESS_STATE_PAUSED ,
  SDL_PROGRESS_STATE_ERROR
}
 
enum  SDL_GLAttr {
  SDL_GL_RED_SIZE ,
  SDL_GL_GREEN_SIZE ,
  SDL_GL_BLUE_SIZE ,
  SDL_GL_ALPHA_SIZE ,
  SDL_GL_BUFFER_SIZE ,
  SDL_GL_DOUBLEBUFFER ,
  SDL_GL_DEPTH_SIZE ,
  SDL_GL_STENCIL_SIZE ,
  SDL_GL_ACCUM_RED_SIZE ,
  SDL_GL_ACCUM_GREEN_SIZE ,
  SDL_GL_ACCUM_BLUE_SIZE ,
  SDL_GL_ACCUM_ALPHA_SIZE ,
  SDL_GL_STEREO ,
  SDL_GL_MULTISAMPLEBUFFERS ,
  SDL_GL_MULTISAMPLESAMPLES ,
  SDL_GL_ACCELERATED_VISUAL ,
  SDL_GL_RETAINED_BACKING ,
  SDL_GL_CONTEXT_MAJOR_VERSION ,
  SDL_GL_CONTEXT_MINOR_VERSION ,
  SDL_GL_CONTEXT_FLAGS ,
  SDL_GL_CONTEXT_PROFILE_MASK ,
  SDL_GL_SHARE_WITH_CURRENT_CONTEXT ,
  SDL_GL_FRAMEBUFFER_SRGB_CAPABLE ,
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR ,
  SDL_GL_CONTEXT_RESET_NOTIFICATION ,
  SDL_GL_CONTEXT_NO_ERROR ,
  SDL_GL_FLOATBUFFERS ,
  SDL_GL_EGL_PLATFORM
}
 
enum  SDL_HitTestResult {
  SDL_HITTEST_NORMAL ,
  SDL_HITTEST_DRAGGABLE ,
  SDL_HITTEST_RESIZE_TOPLEFT ,
  SDL_HITTEST_RESIZE_TOP ,
  SDL_HITTEST_RESIZE_TOPRIGHT ,
  SDL_HITTEST_RESIZE_RIGHT ,
  SDL_HITTEST_RESIZE_BOTTOMRIGHT ,
  SDL_HITTEST_RESIZE_BOTTOM ,
  SDL_HITTEST_RESIZE_BOTTOMLEFT ,
  SDL_HITTEST_RESIZE_LEFT
}
 

Functions

int SDL_GetNumVideoDrivers (void)
 
const char * SDL_GetVideoDriver (int index)
 
const char * SDL_GetCurrentVideoDriver (void)
 
SDL_SystemTheme SDL_GetSystemTheme (void)
 
SDL_DisplayID * SDL_GetDisplays (int *count)
 
SDL_DisplayID SDL_GetPrimaryDisplay (void)
 
SDL_PropertiesID SDL_GetDisplayProperties (SDL_DisplayID displayID)
 
const char * SDL_GetDisplayName (SDL_DisplayID displayID)
 
bool SDL_GetDisplayBounds (SDL_DisplayID displayID, SDL_Rect *rect)
 
bool SDL_GetDisplayUsableBounds (SDL_DisplayID displayID, SDL_Rect *rect)
 
SDL_DisplayOrientation SDL_GetNaturalDisplayOrientation (SDL_DisplayID displayID)
 
SDL_DisplayOrientation SDL_GetCurrentDisplayOrientation (SDL_DisplayID displayID)
 
float SDL_GetDisplayContentScale (SDL_DisplayID displayID)
 
SDL_DisplayMode ** SDL_GetFullscreenDisplayModes (SDL_DisplayID displayID, int *count)
 
bool SDL_GetClosestFullscreenDisplayMode (SDL_DisplayID displayID, int w, int h, float refresh_rate, bool include_high_density_modes, SDL_DisplayMode *closest)
 
const SDL_DisplayMode * SDL_GetDesktopDisplayMode (SDL_DisplayID displayID)
 
const SDL_DisplayMode * SDL_GetCurrentDisplayMode (SDL_DisplayID displayID)
 
SDL_DisplayID SDL_GetDisplayForPoint (const SDL_Point *point)
 
SDL_DisplayID SDL_GetDisplayForRect (const SDL_Rect *rect)
 
SDL_DisplayID SDL_GetDisplayForWindow (SDL_Window *window)
 
float SDL_GetWindowPixelDensity (SDL_Window *window)
 
float SDL_GetWindowDisplayScale (SDL_Window *window)
 
bool SDL_SetWindowFullscreenMode (SDL_Window *window, const SDL_DisplayMode *mode)
 
const SDL_DisplayMode * SDL_GetWindowFullscreenMode (SDL_Window *window)
 
void * SDL_GetWindowICCProfile (SDL_Window *window, size_t *size)
 
SDL_PixelFormat SDL_GetWindowPixelFormat (SDL_Window *window)
 
SDL_Window ** SDL_GetWindows (int *count)
 
SDL_Window * SDL_CreateWindow (const char *title, int w, int h, SDL_WindowFlags flags)
 
SDL_Window * SDL_CreatePopupWindow (SDL_Window *parent, int offset_x, int offset_y, int w, int h, SDL_WindowFlags flags)
 
SDL_Window * SDL_CreateWindowWithProperties (SDL_PropertiesID props)
 
SDL_WindowID SDL_GetWindowID (SDL_Window *window)
 
SDL_Window * SDL_GetWindowFromID (SDL_WindowID id)
 
SDL_Window * SDL_GetWindowParent (SDL_Window *window)
 
SDL_PropertiesID SDL_GetWindowProperties (SDL_Window *window)
 
SDL_WindowFlags SDL_GetWindowFlags (SDL_Window *window)
 
bool SDL_SetWindowTitle (SDL_Window *window, const char *title)
 
const char * SDL_GetWindowTitle (SDL_Window *window)
 
bool SDL_SetWindowIcon (SDL_Window *window, SDL_Surface *icon)
 
bool SDL_SetWindowPosition (SDL_Window *window, int x, int y)
 
bool SDL_GetWindowPosition (SDL_Window *window, int *x, int *y)
 
bool SDL_SetWindowSize (SDL_Window *window, int w, int h)
 
bool SDL_GetWindowSize (SDL_Window *window, int *w, int *h)
 
bool SDL_GetWindowSafeArea (SDL_Window *window, SDL_Rect *rect)
 
bool SDL_SetWindowAspectRatio (SDL_Window *window, float min_aspect, float max_aspect)
 
bool SDL_GetWindowAspectRatio (SDL_Window *window, float *min_aspect, float *max_aspect)
 
bool SDL_GetWindowBordersSize (SDL_Window *window, int *top, int *left, int *bottom, int *right)
 
bool SDL_GetWindowSizeInPixels (SDL_Window *window, int *w, int *h)
 
bool SDL_SetWindowMinimumSize (SDL_Window *window, int min_w, int min_h)
 
bool SDL_GetWindowMinimumSize (SDL_Window *window, int *w, int *h)
 
bool SDL_SetWindowMaximumSize (SDL_Window *window, int max_w, int max_h)
 
bool SDL_GetWindowMaximumSize (SDL_Window *window, int *w, int *h)
 
bool SDL_SetWindowBordered (SDL_Window *window, bool bordered)
 
bool SDL_SetWindowResizable (SDL_Window *window, bool resizable)
 
bool SDL_SetWindowAlwaysOnTop (SDL_Window *window, bool on_top)
 
bool SDL_SetWindowFillDocument (SDL_Window *window, bool fill)
 
bool SDL_ShowWindow (SDL_Window *window)
 
bool SDL_HideWindow (SDL_Window *window)
 
bool SDL_RaiseWindow (SDL_Window *window)
 
bool SDL_MaximizeWindow (SDL_Window *window)
 
bool SDL_MinimizeWindow (SDL_Window *window)
 
bool SDL_RestoreWindow (SDL_Window *window)
 
bool SDL_SetWindowFullscreen (SDL_Window *window, bool fullscreen)
 
bool SDL_SyncWindow (SDL_Window *window)
 
bool SDL_WindowHasSurface (SDL_Window *window)
 
SDL_Surface * SDL_GetWindowSurface (SDL_Window *window)
 
bool SDL_SetWindowSurfaceVSync (SDL_Window *window, int vsync)
 
bool SDL_GetWindowSurfaceVSync (SDL_Window *window, int *vsync)
 
bool SDL_UpdateWindowSurface (SDL_Window *window)
 
bool SDL_UpdateWindowSurfaceRects (SDL_Window *window, const SDL_Rect *rects, int numrects)
 
bool SDL_DestroyWindowSurface (SDL_Window *window)
 
bool SDL_SetWindowKeyboardGrab (SDL_Window *window, bool grabbed)
 
bool SDL_SetWindowMouseGrab (SDL_Window *window, bool grabbed)
 
bool SDL_GetWindowKeyboardGrab (SDL_Window *window)
 
bool SDL_GetWindowMouseGrab (SDL_Window *window)
 
SDL_Window * SDL_GetGrabbedWindow (void)
 
bool SDL_SetWindowMouseRect (SDL_Window *window, const SDL_Rect *rect)
 
const SDL_Rect * SDL_GetWindowMouseRect (SDL_Window *window)
 
bool SDL_SetWindowOpacity (SDL_Window *window, float opacity)
 
float SDL_GetWindowOpacity (SDL_Window *window)
 
bool SDL_SetWindowParent (SDL_Window *window, SDL_Window *parent)
 
bool SDL_SetWindowModal (SDL_Window *window, bool modal)
 
bool SDL_SetWindowFocusable (SDL_Window *window, bool focusable)
 
bool SDL_ShowWindowSystemMenu (SDL_Window *window, int x, int y)
 
bool SDL_SetWindowHitTest (SDL_Window *window, SDL_HitTest callback, void *callback_data)
 
bool SDL_SetWindowShape (SDL_Window *window, SDL_Surface *shape)
 
bool SDL_FlashWindow (SDL_Window *window, SDL_FlashOperation operation)
 
bool SDL_SetWindowProgressState (SDL_Window *window, SDL_ProgressState state)
 
SDL_ProgressState SDL_GetWindowProgressState (SDL_Window *window)
 
bool SDL_SetWindowProgressValue (SDL_Window *window, float value)
 
float SDL_GetWindowProgressValue (SDL_Window *window)
 
void SDL_DestroyWindow (SDL_Window *window)
 
bool SDL_ScreenSaverEnabled (void)
 
bool SDL_EnableScreenSaver (void)
 
bool SDL_DisableScreenSaver (void)
 
OpenGL support functions
bool SDL_GL_LoadLibrary (const char *path)
 
SDL_FunctionPointer SDL_GL_GetProcAddress (const char *proc)
 
SDL_FunctionPointer SDL_EGL_GetProcAddress (const char *proc)
 
void SDL_GL_UnloadLibrary (void)
 
bool SDL_GL_ExtensionSupported (const char *extension)
 
void SDL_GL_ResetAttributes (void)
 
bool SDL_GL_SetAttribute (SDL_GLAttr attr, int value)
 
bool SDL_GL_GetAttribute (SDL_GLAttr attr, int *value)
 
SDL_GLContext SDL_GL_CreateContext (SDL_Window *window)
 
bool SDL_GL_MakeCurrent (SDL_Window *window, SDL_GLContext context)
 
SDL_Window * SDL_GL_GetCurrentWindow (void)
 
SDL_GLContext SDL_GL_GetCurrentContext (void)
 
SDL_EGLDisplay SDL_EGL_GetCurrentDisplay (void)
 
SDL_EGLConfig SDL_EGL_GetCurrentConfig (void)
 
SDL_EGLSurface SDL_EGL_GetWindowSurface (SDL_Window *window)
 
void SDL_EGL_SetAttributeCallbacks (SDL_EGLAttribArrayCallback platformAttribCallback, SDL_EGLIntArrayCallback surfaceAttribCallback, SDL_EGLIntArrayCallback contextAttribCallback, void *userdata)
 
bool SDL_GL_SetSwapInterval (int interval)
 
bool SDL_GL_GetSwapInterval (int *interval)
 
bool SDL_GL_SwapWindow (SDL_Window *window)
 
bool SDL_GL_DestroyContext (SDL_GLContext context)
 

Macro Definition Documentation

◆ SDL_GL_CONTEXT_DEBUG_FLAG

#define SDL_GL_CONTEXT_DEBUG_FLAG   0x0001

Definition at line 521 of file SDL_video.h.

◆ SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG

#define SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG   0x0002

Definition at line 522 of file SDL_video.h.

◆ SDL_GL_CONTEXT_PROFILE_COMPATIBILITY

#define SDL_GL_CONTEXT_PROFILE_COMPATIBILITY   0x0002

OpenGL Compatibility Profile context

Definition at line 510 of file SDL_video.h.

◆ SDL_GL_CONTEXT_PROFILE_CORE

#define SDL_GL_CONTEXT_PROFILE_CORE   0x0001

OpenGL Core Profile context

Definition at line 509 of file SDL_video.h.

◆ SDL_GL_CONTEXT_PROFILE_ES

#define SDL_GL_CONTEXT_PROFILE_ES   0x0004

GLX_CONTEXT_ES2_PROFILE_BIT_EXT

Definition at line 511 of file SDL_video.h.

◆ SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH

#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH   0x0001

Definition at line 536 of file SDL_video.h.

◆ SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE

#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE   0x0000

Definition at line 535 of file SDL_video.h.

◆ SDL_GL_CONTEXT_RESET_ISOLATION_FLAG

#define SDL_GL_CONTEXT_RESET_ISOLATION_FLAG   0x0008

Definition at line 524 of file SDL_video.h.

◆ SDL_GL_CONTEXT_RESET_LOSE_CONTEXT

#define SDL_GL_CONTEXT_RESET_LOSE_CONTEXT   0x0001

Definition at line 547 of file SDL_video.h.

◆ SDL_GL_CONTEXT_RESET_NO_NOTIFICATION

#define SDL_GL_CONTEXT_RESET_NO_NOTIFICATION   0x0000

Definition at line 546 of file SDL_video.h.

◆ SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG

#define SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG   0x0004

Definition at line 523 of file SDL_video.h.

◆ SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN

#define SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN   "SDL.display.HDR_enabled"

Definition at line 684 of file SDL_video.h.

◆ SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER

#define SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER   "SDL.display.KMSDRM.panel_orientation"

Definition at line 685 of file SDL_video.h.

◆ SDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER

#define SDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER   "SDL.display.wayland.wl_output"

Definition at line 686 of file SDL_video.h.

◆ SDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER

#define SDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER   "SDL.display.windows.hmonitor"

Definition at line 687 of file SDL_video.h.

◆ SDL_PROP_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER

#define SDL_PROP_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER   "SDL.video.wayland.wl_display"

The pointer to the global wl_display object used by the Wayland video backend.

Can be set before the video subsystem is initialized to import an external wl_display object from an application or toolkit for use in SDL, or read after initialization to export the wl_display used by the Wayland video backend. Setting this property after the video subsystem has been initialized has no effect, and reading it when the video subsystem is uninitialized will either return the user provided value, if one was set prior to initialization, or NULL. See docs/README-wayland.md for more information.

Since
This macro is available since SDL 3.2.0.

Definition at line 103 of file SDL_video.h.

◆ SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER

#define SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER   "SDL.window.android.surface"

Definition at line 1635 of file SDL_video.h.

◆ SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER

#define SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER   "SDL.window.android.window"

Definition at line 1634 of file SDL_video.h.

◆ SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER

#define SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER   "SDL.window.cocoa.metal_view_tag"

Definition at line 1645 of file SDL_video.h.

◆ SDL_PROP_WINDOW_COCOA_WINDOW_POINTER

#define SDL_PROP_WINDOW_COCOA_WINDOW_POINTER   "SDL.window.cocoa.window"

Definition at line 1644 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN   "SDL.window.create.always_on_top"

Definition at line 1411 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN   "SDL.window.create.borderless"

Definition at line 1412 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER

#define SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER   "SDL.window.create.cocoa.view"

Definition at line 1439 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER

#define SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER   "SDL.window.create.cocoa.window"

Definition at line 1438 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN   "SDL.window.create.constrain_popup"

Definition at line 1413 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING

#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING   "SDL.window.create.emscripten.canvas_id"

Definition at line 1447 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING

#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING   "SDL.window.create.emscripten.keyboard_element"

Definition at line 1448 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN   "SDL.window.create.external_graphics_context"

Definition at line 1415 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FLAGS_NUMBER

#define SDL_PROP_WINDOW_CREATE_FLAGS_NUMBER   "SDL.window.create.flags"

Definition at line 1416 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN   "SDL.window.create.focusable"

Definition at line 1414 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN   "SDL.window.create.fullscreen"

Definition at line 1417 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER

#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER   "SDL.window.create.height"

Definition at line 1418 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN   "SDL.window.create.hidden"

Definition at line 1419 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN   "SDL.window.create.high_pixel_density"

Definition at line 1420 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN   "SDL.window.create.maximized"

Definition at line 1421 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN   "SDL.window.create.menu"

Definition at line 1422 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN   "SDL.window.create.metal"

Definition at line 1423 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN   "SDL.window.create.minimized"

Definition at line 1424 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN   "SDL.window.create.modal"

Definition at line 1425 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN   "SDL.window.create.mouse_grabbed"

Definition at line 1426 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN   "SDL.window.create.opengl"

Definition at line 1427 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_PARENT_POINTER

#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER   "SDL.window.create.parent"

Definition at line 1428 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN   "SDL.window.create.resizable"

Definition at line 1429 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TITLE_STRING

#define SDL_PROP_WINDOW_CREATE_TITLE_STRING   "SDL.window.create.title"

Definition at line 1430 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN   "SDL.window.create.tooltip"

Definition at line 1432 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN   "SDL.window.create.transparent"

Definition at line 1431 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN   "SDL.window.create.utility"

Definition at line 1433 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN   "SDL.window.create.vulkan"

Definition at line 1434 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN   "SDL.window.create.wayland.create_egl_window"

Definition at line 1442 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN   "SDL.window.create.wayland.surface_role_custom"

Definition at line 1441 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER

#define SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER   "SDL.window.create.wayland.wl_surface"

Definition at line 1443 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER

#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER   "SDL.window.create.width"

Definition at line 1435 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER

#define SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER   "SDL.window.create.win32.hwnd"

Definition at line 1444 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER

#define SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER   "SDL.window.create.win32.pixel_format_hwnd"

Definition at line 1445 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER

#define SDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER   "SDL.window.create.uikit.windowscene"

Definition at line 1440 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER

#define SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER   "SDL.window.create.x11.window"

Definition at line 1446 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_X_NUMBER

#define SDL_PROP_WINDOW_CREATE_X_NUMBER   "SDL.window.create.x"

Definition at line 1436 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_Y_NUMBER

#define SDL_PROP_WINDOW_CREATE_Y_NUMBER   "SDL.window.create.y"

Definition at line 1437 of file SDL_video.h.

◆ SDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING

#define SDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING   "SDL.window.emscripten.canvas_id"

Definition at line 1665 of file SDL_video.h.

◆ SDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING

#define SDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING   "SDL.window.emscripten.keyboard_element"

Definition at line 1666 of file SDL_video.h.

◆ SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN

#define SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN   "SDL.window.HDR_enabled"

Definition at line 1631 of file SDL_video.h.

◆ SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT

#define SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT   "SDL.window.HDR_headroom"

Definition at line 1633 of file SDL_video.h.

◆ SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER

#define SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER   "SDL.window.kmsdrm.dev_index"

Definition at line 1641 of file SDL_video.h.

◆ SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER

#define SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER   "SDL.window.kmsdrm.drm_fd"

Definition at line 1642 of file SDL_video.h.

◆ SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER

#define SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER   "SDL.window.kmsdrm.gbm_dev"

Definition at line 1643 of file SDL_video.h.

◆ SDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER

#define SDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER   "SDL.window.openvr.overlay_id"

Definition at line 1646 of file SDL_video.h.

◆ SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT

#define SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT   "SDL.window.SDR_white_level"

Definition at line 1632 of file SDL_video.h.

◆ SDL_PROP_WINDOW_SHAPE_POINTER

#define SDL_PROP_WINDOW_SHAPE_POINTER   "SDL.window.shape"

Definition at line 1630 of file SDL_video.h.

◆ SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER

#define SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER   "SDL.window.uikit.metal_view_tag"

Definition at line 1637 of file SDL_video.h.

◆ SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER

#define SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER   "SDL.window.uikit.opengl.framebuffer"

Definition at line 1638 of file SDL_video.h.

◆ SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER

#define SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER   "SDL.window.uikit.opengl.renderbuffer"

Definition at line 1639 of file SDL_video.h.

◆ SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER

#define SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER   "SDL.window.uikit.opengl.resolve_framebuffer"

Definition at line 1640 of file SDL_video.h.

◆ SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER

#define SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER   "SDL.window.uikit.window"

Definition at line 1636 of file SDL_video.h.

◆ SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER

#define SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER   "SDL.window.vivante.display"

Definition at line 1647 of file SDL_video.h.

◆ SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER

#define SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER   "SDL.window.vivante.surface"

Definition at line 1649 of file SDL_video.h.

◆ SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER

#define SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER   "SDL.window.vivante.window"

Definition at line 1648 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER

#define SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER   "SDL.window.wayland.display"

Definition at line 1653 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER

#define SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER   "SDL.window.wayland.egl_window"

Definition at line 1656 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER

#define SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER   "SDL.window.wayland.surface"

Definition at line 1654 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER

#define SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER   "SDL.window.wayland.viewport"

Definition at line 1655 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER

#define SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER   "SDL.window.wayland.xdg_popup"

Definition at line 1660 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER

#define SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER   "SDL.window.wayland.xdg_positioner"

Definition at line 1661 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER

#define SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER   "SDL.window.wayland.xdg_surface"

Definition at line 1657 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING

#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING   "SDL.window.wayland.xdg_toplevel_export_handle"

Definition at line 1659 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER

#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER   "SDL.window.wayland.xdg_toplevel"

Definition at line 1658 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WIN32_HDC_POINTER

#define SDL_PROP_WINDOW_WIN32_HDC_POINTER   "SDL.window.win32.hdc"

Definition at line 1651 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WIN32_HWND_POINTER

#define SDL_PROP_WINDOW_WIN32_HWND_POINTER   "SDL.window.win32.hwnd"

Definition at line 1650 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER

#define SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER   "SDL.window.win32.instance"

Definition at line 1652 of file SDL_video.h.

◆ SDL_PROP_WINDOW_X11_DISPLAY_POINTER

#define SDL_PROP_WINDOW_X11_DISPLAY_POINTER   "SDL.window.x11.display"

Definition at line 1662 of file SDL_video.h.

◆ SDL_PROP_WINDOW_X11_SCREEN_NUMBER

#define SDL_PROP_WINDOW_X11_SCREEN_NUMBER   "SDL.window.x11.screen"

Definition at line 1663 of file SDL_video.h.

◆ SDL_PROP_WINDOW_X11_WINDOW_NUMBER

#define SDL_PROP_WINDOW_X11_WINDOW_NUMBER   "SDL.window.x11.window"

Definition at line 1664 of file SDL_video.h.

◆ SDL_WINDOW_ALWAYS_ON_TOP

#define SDL_WINDOW_ALWAYS_ON_TOP   SDL_UINT64_C(0x0000000000010000)

window should always be above others

Definition at line 213 of file SDL_video.h.

◆ SDL_WINDOW_BORDERLESS

#define SDL_WINDOW_BORDERLESS   SDL_UINT64_C(0x0000000000000010)

no window decoration

Definition at line 201 of file SDL_video.h.

◆ SDL_WINDOW_EXTERNAL

#define SDL_WINDOW_EXTERNAL   SDL_UINT64_C(0x0000000000000800)

window not created by SDL

Definition at line 208 of file SDL_video.h.

◆ SDL_WINDOW_FILL_DOCUMENT

#define SDL_WINDOW_FILL_DOCUMENT   SDL_UINT64_C(0x0000000000200000)

window is in fill-document mode (Emscripten only), since SDL 3.4.0

Definition at line 218 of file SDL_video.h.

◆ SDL_WINDOW_FULLSCREEN

#define SDL_WINDOW_FULLSCREEN   SDL_UINT64_C(0x0000000000000001)

window is in fullscreen mode

Definition at line 197 of file SDL_video.h.

◆ SDL_WINDOW_HIDDEN

#define SDL_WINDOW_HIDDEN   SDL_UINT64_C(0x0000000000000008)

window is neither mapped onto the desktop nor shown in the taskbar/dock/window list; SDL_ShowWindow() is required for it to become visible

Definition at line 200 of file SDL_video.h.

◆ SDL_WINDOW_HIGH_PIXEL_DENSITY

#define SDL_WINDOW_HIGH_PIXEL_DENSITY   SDL_UINT64_C(0x0000000000002000)

window uses high pixel density back buffer if possible

Definition at line 210 of file SDL_video.h.

◆ SDL_WINDOW_INPUT_FOCUS

#define SDL_WINDOW_INPUT_FOCUS   SDL_UINT64_C(0x0000000000000200)

window has input focus

Definition at line 206 of file SDL_video.h.

◆ SDL_WINDOW_KEYBOARD_GRABBED

#define SDL_WINDOW_KEYBOARD_GRABBED   SDL_UINT64_C(0x0000000000100000)

window has grabbed keyboard input

Definition at line 217 of file SDL_video.h.

◆ SDL_WINDOW_MAXIMIZED

#define SDL_WINDOW_MAXIMIZED   SDL_UINT64_C(0x0000000000000080)

window is maximized

Definition at line 204 of file SDL_video.h.

◆ SDL_WINDOW_METAL

#define SDL_WINDOW_METAL   SDL_UINT64_C(0x0000000020000000)

window usable for Metal view

Definition at line 220 of file SDL_video.h.

◆ SDL_WINDOW_MINIMIZED

#define SDL_WINDOW_MINIMIZED   SDL_UINT64_C(0x0000000000000040)

window is minimized

Definition at line 203 of file SDL_video.h.

◆ SDL_WINDOW_MODAL

#define SDL_WINDOW_MODAL   SDL_UINT64_C(0x0000000000001000)

window is modal

Definition at line 209 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_CAPTURE

#define SDL_WINDOW_MOUSE_CAPTURE   SDL_UINT64_C(0x0000000000004000)

window has mouse captured (unrelated to MOUSE_GRABBED)

Definition at line 211 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_FOCUS

#define SDL_WINDOW_MOUSE_FOCUS   SDL_UINT64_C(0x0000000000000400)

window has mouse focus

Definition at line 207 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_GRABBED

#define SDL_WINDOW_MOUSE_GRABBED   SDL_UINT64_C(0x0000000000000100)

window has grabbed mouse input

Definition at line 205 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_RELATIVE_MODE

#define SDL_WINDOW_MOUSE_RELATIVE_MODE   SDL_UINT64_C(0x0000000000008000)

window has relative mode enabled

Definition at line 212 of file SDL_video.h.

◆ SDL_WINDOW_NOT_FOCUSABLE

#define SDL_WINDOW_NOT_FOCUSABLE   SDL_UINT64_C(0x0000000080000000)

window should not be focusable

Definition at line 222 of file SDL_video.h.

◆ SDL_WINDOW_OCCLUDED

#define SDL_WINDOW_OCCLUDED   SDL_UINT64_C(0x0000000000000004)

window is occluded

Definition at line 199 of file SDL_video.h.

◆ SDL_WINDOW_OPENGL

#define SDL_WINDOW_OPENGL   SDL_UINT64_C(0x0000000000000002)

window usable with OpenGL context

Definition at line 198 of file SDL_video.h.

◆ SDL_WINDOW_POPUP_MENU

#define SDL_WINDOW_POPUP_MENU   SDL_UINT64_C(0x0000000000080000)

window should be treated as a popup menu, requires a parent window

Definition at line 216 of file SDL_video.h.

◆ SDL_WINDOW_RESIZABLE

#define SDL_WINDOW_RESIZABLE   SDL_UINT64_C(0x0000000000000020)

window can be resized

Definition at line 202 of file SDL_video.h.

◆ SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE

#define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE   (-1)

Definition at line 2464 of file SDL_video.h.

◆ SDL_WINDOW_SURFACE_VSYNC_DISABLED

#define SDL_WINDOW_SURFACE_VSYNC_DISABLED   0

Definition at line 2463 of file SDL_video.h.

◆ SDL_WINDOW_TOOLTIP

#define SDL_WINDOW_TOOLTIP   SDL_UINT64_C(0x0000000000040000)

window should be treated as a tooltip and does not get mouse or keyboard focus, requires a parent window

Definition at line 215 of file SDL_video.h.

◆ SDL_WINDOW_TRANSPARENT

#define SDL_WINDOW_TRANSPARENT   SDL_UINT64_C(0x0000000040000000)

window with transparent buffer

Definition at line 221 of file SDL_video.h.

◆ SDL_WINDOW_UTILITY

#define SDL_WINDOW_UTILITY   SDL_UINT64_C(0x0000000000020000)

window should be treated as a utility window, not showing in the task bar and window list

Definition at line 214 of file SDL_video.h.

◆ SDL_WINDOW_VULKAN

#define SDL_WINDOW_VULKAN   SDL_UINT64_C(0x0000000010000000)

window usable for Vulkan surface

Definition at line 219 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Used to indicate that the window position should be centered.

This always uses the primary display.

Since
This macro is available since SDL 3.2.0.
See also
SDL_SetWindowPosition

Definition at line 308 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

#define SDL_WINDOWPOS_CENTERED_DISPLAY (   X)    (SDL_WINDOWPOS_CENTERED_MASK|(X))

Used to indicate that the window position should be centered.

SDL_WINDOWPOS_CENTERED is the same, but always uses the primary display instead of specifying one.

Parameters
Xthe SDL_DisplayID of the display to use.
Since
This macro is available since SDL 3.2.0.
See also
SDL_SetWindowPosition

Definition at line 297 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_MASK

#define SDL_WINDOWPOS_CENTERED_MASK   0x2FFF0000u

A magic value used with SDL_WINDOWPOS_CENTERED.

Generally this macro isn't used directly, but rather through SDL_WINDOWPOS_CENTERED or SDL_WINDOWPOS_CENTERED_DISPLAY.

Since
This macro is available since SDL 3.2.0.
See also
SDL_SetWindowPosition

Definition at line 283 of file SDL_video.h.

◆ SDL_WINDOWPOS_ISCENTERED

#define SDL_WINDOWPOS_ISCENTERED (   X)     (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)

A macro to test if the window position is marked as "centered."

Parameters
Xthe window position value.
Since
This macro is available since SDL 3.2.0.
See also
SDL_GetWindowPosition

Definition at line 319 of file SDL_video.h.

328{
329 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
330 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
331 SDL_FLASH_UNTIL_FOCUSED /**< Flash the window until it gets focus */
332} SDL_FlashOperation;
333
334/**
335 * Window progress state
336 *
337 * \since This enum is available since SDL 3.2.8.
338 */
339typedef enum SDL_ProgressState
340{
341 SDL_PROGRESS_STATE_INVALID = -1, /**< An invalid progress state indicating an error; check SDL_GetError() */
342 SDL_PROGRESS_STATE_NONE, /**< No progress bar is shown */
343 SDL_PROGRESS_STATE_INDETERMINATE, /**< The progress bar is shown in a indeterminate state */
344 SDL_PROGRESS_STATE_NORMAL, /**< The progress bar is shown in a normal state */
345 SDL_PROGRESS_STATE_PAUSED, /**< The progress bar is shown in a paused state */
346 SDL_PROGRESS_STATE_ERROR /**< The progress bar is shown in a state indicating the application had an error */
347} SDL_ProgressState;
348
349/**
350 * An opaque handle to an OpenGL context.
351 *
352 * \since This datatype is available since SDL 3.2.0.
353 *
354 * \sa SDL_GL_CreateContext
355 * \sa SDL_GL_SetAttribute
356 * \sa SDL_GL_MakeCurrent
357 * \sa SDL_GL_DestroyContext
358 */
359typedef struct SDL_GLContextState *SDL_GLContext;
360
361/**
362 * Opaque type for an EGL display.
363 *
364 * \since This datatype is available since SDL 3.2.0.
365 */
366typedef void *SDL_EGLDisplay;
367
368/**
369 * Opaque type for an EGL config.
370 *
371 * \since This datatype is available since SDL 3.2.0.
372 */
373typedef void *SDL_EGLConfig;
374
375/**
376 * Opaque type for an EGL surface.
377 *
378 * \since This datatype is available since SDL 3.2.0.
379 */
380typedef void *SDL_EGLSurface;
381
382/**
383 * An EGL attribute, used when creating an EGL context.
384 *
385 * \since This datatype is available since SDL 3.2.0.
386 */
387typedef intptr_t SDL_EGLAttrib;
388
389/**
390 * An EGL integer attribute, used when creating an EGL surface.
391 *
392 * \since This datatype is available since SDL 3.2.0.
393 */
394typedef int SDL_EGLint;
395
396/**
397 * EGL platform attribute initialization callback.
398 *
399 * This is called when SDL is attempting to create an EGL context, to let the
400 * app add extra attributes to its eglGetPlatformDisplay() call.
401 *
402 * The callback should return a pointer to an EGL attribute array terminated
403 * with `EGL_NONE`. If this function returns NULL, the SDL_CreateWindow
404 * process will fail gracefully.
405 *
406 * The returned pointer should be allocated with SDL_malloc() and will be
407 * passed to SDL_free().
408 *
409 * The arrays returned by each callback will be appended to the existing
410 * attribute arrays defined by SDL.
411 *
412 * \param userdata an app-controlled pointer that is passed to the callback.
413 * \returns a newly-allocated array of attributes, terminated with `EGL_NONE`.
414 *
415 * \since This datatype is available since SDL 3.2.0.
416 *
417 * \sa SDL_EGL_SetAttributeCallbacks
418 */
419typedef SDL_EGLAttrib *(SDLCALL *SDL_EGLAttribArrayCallback)(void *userdata);
420
421/**
422 * EGL surface/context attribute initialization callback types.
423 *
424 * This is called when SDL is attempting to create an EGL surface, to let the
425 * app add extra attributes to its eglCreateWindowSurface() or
426 * eglCreateContext calls.
427 *
428 * For convenience, the EGLDisplay and EGLConfig to use are provided to the
429 * callback.
430 *
431 * The callback should return a pointer to an EGL attribute array terminated
432 * with `EGL_NONE`. If this function returns NULL, the SDL_CreateWindow
433 * process will fail gracefully.
434 *
435 * The returned pointer should be allocated with SDL_malloc() and will be
436 * passed to SDL_free().
437 *
438 * The arrays returned by each callback will be appended to the existing
439 * attribute arrays defined by SDL.
440 *
441 * \param userdata an app-controlled pointer that is passed to the callback.
442 * \param display the EGL display to be used.
443 * \param config the EGL config to be used.
444 * \returns a newly-allocated array of attributes, terminated with `EGL_NONE`.
445 *
446 * \since This datatype is available since SDL 3.2.0.
447 *
448 * \sa SDL_EGL_SetAttributeCallbacks
449 */
450typedef SDL_EGLint *(SDLCALL *SDL_EGLIntArrayCallback)(void *userdata, SDL_EGLDisplay display, SDL_EGLConfig config);
451
452/**
453 * An enumeration of OpenGL configuration attributes.
454 *
455 * While you can set most OpenGL attributes normally, the attributes listed
456 * above must be known before SDL creates the window that will be used with
457 * the OpenGL context. These attributes are set and read with
458 * SDL_GL_SetAttribute() and SDL_GL_GetAttribute().
459 *
460 * In some cases, these attributes are minimum requests; the GL does not
461 * promise to give you exactly what you asked for. It's possible to ask for a
462 * 16-bit depth buffer and get a 24-bit one instead, for example, or to ask
463 * for no stencil buffer and still have one available. Context creation should
464 * fail if the GL can't provide your requested attributes at a minimum, but
465 * you should check to see exactly what you got.
466 *
467 * \since This enum is available since SDL 3.2.0.
468 */
469typedef enum SDL_GLAttr
470{
471 SDL_GL_RED_SIZE, /**< the minimum number of bits for the red channel of the color buffer; defaults to 8. */
472 SDL_GL_GREEN_SIZE, /**< the minimum number of bits for the green channel of the color buffer; defaults to 8. */
473 SDL_GL_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the color buffer; defaults to 8. */
474 SDL_GL_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the color buffer; defaults to 8. */
475 SDL_GL_BUFFER_SIZE, /**< the minimum number of bits for frame buffer size; defaults to 0. */
476 SDL_GL_DOUBLEBUFFER, /**< whether the output is single or double buffered; defaults to double buffering on. */
477 SDL_GL_DEPTH_SIZE, /**< the minimum number of bits in the depth buffer; defaults to 16. */
478 SDL_GL_STENCIL_SIZE, /**< the minimum number of bits in the stencil buffer; defaults to 0. */
479 SDL_GL_ACCUM_RED_SIZE, /**< the minimum number of bits for the red channel of the accumulation buffer; defaults to 0. */
480 SDL_GL_ACCUM_GREEN_SIZE, /**< the minimum number of bits for the green channel of the accumulation buffer; defaults to 0. */
481 SDL_GL_ACCUM_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0. */
482 SDL_GL_ACCUM_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0. */
483 SDL_GL_STEREO, /**< whether the output is stereo 3D; defaults to off. */
484 SDL_GL_MULTISAMPLEBUFFERS, /**< the number of buffers used for multisample anti-aliasing; defaults to 0. */
485 SDL_GL_MULTISAMPLESAMPLES, /**< the number of samples used around the current pixel used for multisample anti-aliasing. */
486 SDL_GL_ACCELERATED_VISUAL, /**< set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either. */
487 SDL_GL_RETAINED_BACKING, /**< not used (deprecated). */
488 SDL_GL_CONTEXT_MAJOR_VERSION, /**< OpenGL context major version. */
489 SDL_GL_CONTEXT_MINOR_VERSION, /**< OpenGL context minor version. */
490 SDL_GL_CONTEXT_FLAGS, /**< some combination of 0 or more of elements of the SDL_GLContextFlag enumeration; defaults to 0. */
491 SDL_GL_CONTEXT_PROFILE_MASK, /**< type of GL context (Core, Compatibility, ES). See SDL_GLProfile; default value depends on platform. */
492 SDL_GL_SHARE_WITH_CURRENT_CONTEXT, /**< OpenGL context sharing; defaults to 0. */
493 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, /**< requests sRGB-capable visual if 1. Defaults to -1 ("don't care"). This is a request; GL drivers might not comply! */
494 SDL_GL_CONTEXT_RELEASE_BEHAVIOR, /**< sets context the release behavior. See SDL_GLContextReleaseFlag; defaults to FLUSH. */
495 SDL_GL_CONTEXT_RESET_NOTIFICATION, /**< set context reset notification. See SDL_GLContextResetNotification; defaults to NO_NOTIFICATION. */
496 SDL_GL_CONTEXT_NO_ERROR,
497 SDL_GL_FLOATBUFFERS,
498 SDL_GL_EGL_PLATFORM
499} SDL_GLAttr;
500
501/**
502 * Possible values to be set for the SDL_GL_CONTEXT_PROFILE_MASK attribute.
503 *
504 * \since This datatype is available since SDL 3.2.0.
505 */
506typedef Uint32 SDL_GLProfile;
507
508#define SDL_GL_CONTEXT_PROFILE_CORE 0x0001 /**< OpenGL Core Profile context */
509#define SDL_GL_CONTEXT_PROFILE_COMPATIBILITY 0x0002 /**< OpenGL Compatibility Profile context */
510#define SDL_GL_CONTEXT_PROFILE_ES 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
511
512
513/**
514 * Possible flags to be set for the SDL_GL_CONTEXT_FLAGS attribute.
515 *
516 * \since This datatype is available since SDL 3.2.0.
517 */
518typedef Uint32 SDL_GLContextFlag;
519
520#define SDL_GL_CONTEXT_DEBUG_FLAG 0x0001
521#define SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG 0x0002
522#define SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG 0x0004
523#define SDL_GL_CONTEXT_RESET_ISOLATION_FLAG 0x0008
524
525
526/**
527 * Possible values to be set for the SDL_GL_CONTEXT_RELEASE_BEHAVIOR
528 * attribute.
529 *
530 * \since This datatype is available since SDL 3.2.0.
531 */
532typedef Uint32 SDL_GLContextReleaseFlag;
533
534#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 0x0000
535#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 0x0001
536
537
538/**
539 * Possible values to be set SDL_GL_CONTEXT_RESET_NOTIFICATION attribute.
540 *
541 * \since This datatype is available since SDL 3.2.0.
542 */
543typedef Uint32 SDL_GLContextResetNotification;
544
545#define SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 0x0000
546#define SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 0x0001
547
548
549/* Function prototypes */
550
551/**
552 * Get the number of video drivers compiled into SDL.
553 *
554 * \returns the number of built in video drivers.
555 *
556 * \threadsafety This function should only be called on the main thread.
557 *
558 * \since This function is available since SDL 3.2.0.
559 *
560 * \sa SDL_GetVideoDriver
561 */
562extern SDL_DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
563
564/**
565 * Get the name of a built in video driver.
566 *
567 * The video drivers are presented in the order in which they are normally
568 * checked during initialization.
569 *
570 * The names of drivers are all simple, low-ASCII identifiers, like "cocoa",
571 * "x11" or "windows". These never have Unicode characters, and are not meant
572 * to be proper names.
573 *
574 * \param index the index of a video driver.
575 * \returns the name of the video driver with the given **index**, or NULL if
576 * index is out of bounds.
577 *
578 * \threadsafety This function should only be called on the main thread.
579 *
580 * \since This function is available since SDL 3.2.0.
581 *
582 * \sa SDL_GetNumVideoDrivers
583 */
584extern SDL_DECLSPEC const char * SDLCALL SDL_GetVideoDriver(int index);
585
586/**
587 * Get the name of the currently initialized video driver.
588 *
589 * The names of drivers are all simple, low-ASCII identifiers, like "cocoa",
590 * "x11" or "windows". These never have Unicode characters, and are not meant
591 * to be proper names.
592 *
593 * \returns the name of the current video driver or NULL if no driver has been
594 * initialized.
595 *
596 * \threadsafety This function should only be called on the main thread.
597 *
598 * \since This function is available since SDL 3.2.0.
599 *
600 * \sa SDL_GetNumVideoDrivers
601 * \sa SDL_GetVideoDriver
602 */
603extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentVideoDriver(void);
604
605/**
606 * Get the current system theme.
607 *
608 * \returns the current system theme, light, dark, or unknown.
609 *
610 * \threadsafety This function should only be called on the main thread.
611 *
612 * \since This function is available since SDL 3.2.0.
613 */
614extern SDL_DECLSPEC SDL_SystemTheme SDLCALL SDL_GetSystemTheme(void);
615
616/**
617 * Get a list of currently connected displays.
618 *
619 * \param count a pointer filled in with the number of displays returned, may
620 * be NULL.
621 * \returns a 0 terminated array of display instance IDs or NULL on failure;
622 * call SDL_GetError() for more information. This should be freed
623 * with SDL_free() when it is no longer needed.
624 *
625 * \threadsafety This function should only be called on the main thread.
626 *
627 * \since This function is available since SDL 3.2.0.
628 */
629extern SDL_DECLSPEC SDL_DisplayID * SDLCALL SDL_GetDisplays(int *count);
630
631/**
632 * Return the primary display.
633 *
634 * \returns the instance ID of the primary display on success or 0 on failure;
635 * call SDL_GetError() for more information.
636 *
637 * \threadsafety This function should only be called on the main thread.
638 *
639 * \since This function is available since SDL 3.2.0.
640 *
641 * \sa SDL_GetDisplays
642 */
643extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetPrimaryDisplay(void);
644
645/**
646 * Get the properties associated with a display.
647 *
648 * The following read-only properties are provided by SDL:
649 *
650 * - `SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN`: true if the display has HDR
651 * headroom above the SDR white point. This is for informational and
652 * diagnostic purposes only, as not all platforms provide this information
653 * at the display level.
654 *
655 * On KMS/DRM:
656 *
657 * - `SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER`: the "panel
658 * orientation" property for the display in degrees of clockwise rotation.
659 * Note that this is provided only as a hint, and the application is
660 * responsible for any coordinate transformations needed to conform to the
661 * requested display orientation.
662 *
663 * On Wayland:
664 *
665 * - `SDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER`: the wl_output associated
666 * with the display
667 *
668 * On Windows:
669 *
670 * - `SDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER`: the monitor handle
671 * (HMONITOR) associated with the display
672 *
673 * \param displayID the instance ID of the display to query.
674 * \returns a valid property ID on success or 0 on failure; call
675 * SDL_GetError() for more information.
676 *
677 * \threadsafety This function should only be called on the main thread.
678 *
679 * \since This function is available since SDL 3.2.0.
680 */
681extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetDisplayProperties(SDL_DisplayID displayID);
682
683#define SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN "SDL.display.HDR_enabled"
684#define SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER "SDL.display.KMSDRM.panel_orientation"
685#define SDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER "SDL.display.wayland.wl_output"
686#define SDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER "SDL.display.windows.hmonitor"
687
688/**
689 * Get the name of a display in UTF-8 encoding.
690 *
691 * \param displayID the instance ID of the display to query.
692 * \returns the name of a display or NULL on failure; call SDL_GetError() for
693 * more information.
694 *
695 * \threadsafety This function should only be called on the main thread.
696 *
697 * \since This function is available since SDL 3.2.0.
698 *
699 * \sa SDL_GetDisplays
700 */
701extern SDL_DECLSPEC const char * SDLCALL SDL_GetDisplayName(SDL_DisplayID displayID);
702
703/**
704 * Get the desktop area represented by a display.
705 *
706 * The primary display is often located at (0,0), but may be placed at a
707 * different location depending on monitor layout.
708 *
709 * \param displayID the instance ID of the display to query.
710 * \param rect the SDL_Rect structure filled in with the display bounds.
711 * \returns true on success or false on failure; call SDL_GetError() for more
712 * information.
713 *
714 * \threadsafety This function should only be called on the main thread.
715 *
716 * \since This function is available since SDL 3.2.0.
717 *
718 * \sa SDL_GetDisplayUsableBounds
719 * \sa SDL_GetDisplays
720 */
721extern SDL_DECLSPEC bool SDLCALL SDL_GetDisplayBounds(SDL_DisplayID displayID, SDL_Rect *rect);
722
723/**
724 * Get the usable desktop area represented by a display, in screen
725 * coordinates.
726 *
727 * This is the same area as SDL_GetDisplayBounds() reports, but with portions
728 * reserved by the system removed. For example, on Apple's macOS, this
729 * subtracts the area occupied by the menu bar and dock.
730 *
731 * Setting a window to be fullscreen generally bypasses these unusable areas,
732 * so these are good guidelines for the maximum space available to a
733 * non-fullscreen window.
734 *
735 * \param displayID the instance ID of the display to query.
736 * \param rect the SDL_Rect structure filled in with the display bounds.
737 * \returns true on success or false on failure; call SDL_GetError() for more
738 * information.
739 *
740 * \threadsafety This function should only be called on the main thread.
741 *
742 * \since This function is available since SDL 3.2.0.
743 *
744 * \sa SDL_GetDisplayBounds
745 * \sa SDL_GetDisplays
746 */
747extern SDL_DECLSPEC bool SDLCALL SDL_GetDisplayUsableBounds(SDL_DisplayID displayID, SDL_Rect *rect);
748
749/**
750 * Get the orientation of a display when it is unrotated.
751 *
752 * \param displayID the instance ID of the display to query.
753 * \returns the SDL_DisplayOrientation enum value of the display, or
754 * `SDL_ORIENTATION_UNKNOWN` if it isn't available.
755 *
756 * \threadsafety This function should only be called on the main thread.
757 *
758 * \since This function is available since SDL 3.2.0.
759 *
760 * \sa SDL_GetDisplays
761 */
762extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetNaturalDisplayOrientation(SDL_DisplayID displayID);
763
764/**
765 * Get the orientation of a display.
766 *
767 * \param displayID the instance ID of the display to query.
768 * \returns the SDL_DisplayOrientation enum value of the display, or
769 * `SDL_ORIENTATION_UNKNOWN` if it isn't available.
770 *
771 * \threadsafety This function should only be called on the main thread.
772 *
773 * \since This function is available since SDL 3.2.0.
774 *
775 * \sa SDL_GetDisplays
776 */
777extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetCurrentDisplayOrientation(SDL_DisplayID displayID);
778
779/**
780 * Get the content scale of a display.
781 *
782 * The content scale is the expected scale for content based on the DPI
783 * settings of the display. For example, a 4K display might have a 2.0 (200%)
784 * display scale, which means that the user expects UI elements to be twice as
785 * big on this display, to aid in readability.
786 *
787 * After window creation, SDL_GetWindowDisplayScale() should be used to query
788 * the content scale factor for individual windows instead of querying the
789 * display for a window and calling this function, as the per-window content
790 * scale factor may differ from the base value of the display it is on,
791 * particularly on high-DPI and/or multi-monitor desktop configurations.
792 *
793 * \param displayID the instance ID of the display to query.
794 * \returns the content scale of the display, or 0.0f on failure; call
795 * SDL_GetError() for more information.
796 *
797 * \threadsafety This function should only be called on the main thread.
798 *
799 * \since This function is available since SDL 3.2.0.
800 *
801 * \sa SDL_GetWindowDisplayScale
802 * \sa SDL_GetDisplays
803 */
804extern SDL_DECLSPEC float SDLCALL SDL_GetDisplayContentScale(SDL_DisplayID displayID);
805
806/**
807 * Get a list of fullscreen display modes available on a display.
808 *
809 * The display modes are sorted in this priority:
810 *
811 * - w -> largest to smallest
812 * - h -> largest to smallest
813 * - bits per pixel -> more colors to fewer colors
814 * - packed pixel layout -> largest to smallest
815 * - refresh rate -> highest to lowest
816 * - pixel density -> lowest to highest
817 *
818 * \param displayID the instance ID of the display to query.
819 * \param count a pointer filled in with the number of display modes returned,
820 * may be NULL.
821 * \returns a NULL terminated array of display mode pointers or NULL on
822 * failure; call SDL_GetError() for more information. This is a
823 * single allocation that should be freed with SDL_free() when it is
824 * no longer needed.
825 *
826 * \threadsafety This function should only be called on the main thread.
827 *
828 * \since This function is available since SDL 3.2.0.
829 *
830 * \sa SDL_GetDisplays
831 */
832extern SDL_DECLSPEC SDL_DisplayMode ** SDLCALL SDL_GetFullscreenDisplayModes(SDL_DisplayID displayID, int *count);
833
834/**
835 * Get the closest match to the requested display mode.
836 *
837 * The available display modes are scanned and `closest` is filled in with the
838 * closest mode matching the requested mode and returned. The mode format and
839 * refresh rate default to the desktop mode if they are set to 0. The modes
840 * are scanned with size being first priority, format being second priority,
841 * and finally checking the refresh rate. If all the available modes are too
842 * small, then false is returned.
843 *
844 * \param displayID the instance ID of the display to query.
845 * \param w the width in pixels of the desired display mode.
846 * \param h the height in pixels of the desired display mode.
847 * \param refresh_rate the refresh rate of the desired display mode, or 0.0f
848 * for the desktop refresh rate.
849 * \param include_high_density_modes boolean to include high density modes in
850 * the search.
851 * \param closest a pointer filled in with the closest display mode equal to
852 * or larger than the desired mode.
853 * \returns true on success or false on failure; call SDL_GetError() for more
854 * information.
855 *
856 * \threadsafety This function should only be called on the main thread.
857 *
858 * \since This function is available since SDL 3.2.0.
859 *
860 * \sa SDL_GetDisplays
861 * \sa SDL_GetFullscreenDisplayModes
862 */
863extern SDL_DECLSPEC bool SDLCALL SDL_GetClosestFullscreenDisplayMode(SDL_DisplayID displayID, int w, int h, float refresh_rate, bool include_high_density_modes, SDL_DisplayMode *closest);
864
865/**
866 * Get information about the desktop's display mode.
867 *
868 * There's a difference between this function and SDL_GetCurrentDisplayMode()
869 * when SDL runs fullscreen and has changed the resolution. In that case this
870 * function will return the previous native display mode, and not the current
871 * display mode.
872 *
873 * \param displayID the instance ID of the display to query.
874 * \returns a pointer to the desktop display mode or NULL on failure; call
875 * SDL_GetError() for more information.
876 *
877 * \threadsafety This function should only be called on the main thread.
878 *
879 * \since This function is available since SDL 3.2.0.
880 *
881 * \sa SDL_GetCurrentDisplayMode
882 * \sa SDL_GetDisplays
883 */
884extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayID displayID);
885
886/**
887 * Get information about the current display mode.
888 *
889 * There's a difference between this function and SDL_GetDesktopDisplayMode()
890 * when SDL runs fullscreen and has changed the resolution. In that case this
891 * function will return the current display mode, and not the previous native
892 * display mode.
893 *
894 * \param displayID the instance ID of the display to query.
895 * \returns a pointer to the desktop display mode or NULL on failure; call
896 * SDL_GetError() for more information.
897 *
898 * \threadsafety This function should only be called on the main thread.
899 *
900 * \since This function is available since SDL 3.2.0.
901 *
902 * \sa SDL_GetDesktopDisplayMode
903 * \sa SDL_GetDisplays
904 */
905extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayID displayID);
906
907/**
908 * Get the display containing a point.
909 *
910 * \param point the point to query.
911 * \returns the instance ID of the display containing the point or 0 on
912 * failure; call SDL_GetError() for more information.
913 *
914 * \threadsafety This function should only be called on the main thread.
915 *
916 * \since This function is available since SDL 3.2.0.
917 *
918 * \sa SDL_GetDisplayBounds
919 * \sa SDL_GetDisplays
920 */
921extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForPoint(const SDL_Point *point);
922
923/**
924 * Get the display primarily containing a rect.
925 *
926 * \param rect the rect to query.
927 * \returns the instance ID of the display entirely containing the rect or
928 * closest to the center of the rect on success or 0 on failure; call
929 * SDL_GetError() for more information.
930 *
931 * \threadsafety This function should only be called on the main thread.
932 *
933 * \since This function is available since SDL 3.2.0.
934 *
935 * \sa SDL_GetDisplayBounds
936 * \sa SDL_GetDisplays
937 */
938extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForRect(const SDL_Rect *rect);
939
940/**
941 * Get the display associated with a window.
942 *
943 * \param window the window to query.
944 * \returns the instance ID of the display containing the center of the window
945 * on success or 0 on failure; call SDL_GetError() for more
946 * information.
947 *
948 * \threadsafety This function should only be called on the main thread.
949 *
950 * \since This function is available since SDL 3.2.0.
951 *
952 * \sa SDL_GetDisplayBounds
953 * \sa SDL_GetDisplays
954 */
955extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForWindow(SDL_Window *window);
956
957/**
958 * Get the pixel density of a window.
959 *
960 * This is a ratio of pixel size to window size. For example, if the window is
961 * 1920x1080 and it has a high density back buffer of 3840x2160 pixels, it
962 * would have a pixel density of 2.0.
963 *
964 * \param window the window to query.
965 * \returns the pixel density or 0.0f on failure; call SDL_GetError() for more
966 * information.
967 *
968 * \threadsafety This function should only be called on the main thread.
969 *
970 * \since This function is available since SDL 3.2.0.
971 *
972 * \sa SDL_GetWindowDisplayScale
973 */
974extern SDL_DECLSPEC float SDLCALL SDL_GetWindowPixelDensity(SDL_Window *window);
975
976/**
977 * Get the content display scale relative to a window's pixel size.
978 *
979 * This is a combination of the window pixel density and the display content
980 * scale, and is the expected scale for displaying content in this window. For
981 * example, if a 3840x2160 window had a display scale of 2.0, the user expects
982 * the content to take twice as many pixels and be the same physical size as
983 * if it were being displayed in a 1920x1080 window with a display scale of
984 * 1.0.
985 *
986 * Conceptually this value corresponds to the scale display setting, and is
987 * updated when that setting is changed, or the window moves to a display with
988 * a different scale setting.
989 *
990 * \param window the window to query.
991 * \returns the display scale, or 0.0f on failure; call SDL_GetError() for
992 * more information.
993 *
994 * \threadsafety This function should only be called on the main thread.
995 *
996 * \since This function is available since SDL 3.2.0.
997 */
998extern SDL_DECLSPEC float SDLCALL SDL_GetWindowDisplayScale(SDL_Window *window);
999
1000/**
1001 * Set the display mode to use when a window is visible and fullscreen.
1002 *
1003 * This only affects the display mode used when the window is fullscreen. To
1004 * change the window size when the window is not fullscreen, use
1005 * SDL_SetWindowSize().
1006 *
1007 * If the window is currently in the fullscreen state, this request is
1008 * asynchronous on some windowing systems and the new mode dimensions may not
1009 * be applied immediately upon the return of this function. If an immediate
1010 * change is required, call SDL_SyncWindow() to block until the changes have
1011 * taken effect.
1012 *
1013 * When the new mode takes effect, an SDL_EVENT_WINDOW_RESIZED and/or an
1014 * SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event will be emitted with the new mode
1015 * dimensions.
1016 *
1017 * \param window the window to affect.
1018 * \param mode a pointer to the display mode to use, which can be NULL for
1019 * borderless fullscreen desktop mode, or one of the fullscreen
1020 * modes returned by SDL_GetFullscreenDisplayModes() to set an
1021 * exclusive fullscreen mode.
1022 * \returns true on success or false on failure; call SDL_GetError() for more
1023 * information.
1024 *
1025 * \threadsafety This function should only be called on the main thread.
1026 *
1027 * \since This function is available since SDL 3.2.0.
1028 *
1029 * \sa SDL_GetWindowFullscreenMode
1030 * \sa SDL_SetWindowFullscreen
1031 * \sa SDL_SyncWindow
1032 */
1033extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFullscreenMode(SDL_Window *window, const SDL_DisplayMode *mode);
1034
1035/**
1036 * Query the display mode to use when a window is visible at fullscreen.
1037 *
1038 * \param window the window to query.
1039 * \returns a pointer to the exclusive fullscreen mode to use or NULL for
1040 * borderless fullscreen desktop mode.
1041 *
1042 * \threadsafety This function should only be called on the main thread.
1043 *
1044 * \since This function is available since SDL 3.2.0.
1045 *
1046 * \sa SDL_SetWindowFullscreenMode
1047 * \sa SDL_SetWindowFullscreen
1048 */
1049extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetWindowFullscreenMode(SDL_Window *window);
1050
1051/**
1052 * Get the raw ICC profile data for the screen the window is currently on.
1053 *
1054 * \param window the window to query.
1055 * \param size the size of the ICC profile.
1056 * \returns the raw ICC profile data on success or NULL on failure; call
1057 * SDL_GetError() for more information. This should be freed with
1058 * SDL_free() when it is no longer needed.
1059 *
1060 * \threadsafety This function should only be called on the main thread.
1061 *
1062 * \since This function is available since SDL 3.2.0.
1063 */
1064extern SDL_DECLSPEC void * SDLCALL SDL_GetWindowICCProfile(SDL_Window *window, size_t *size);
1065
1066/**
1067 * Get the pixel format associated with the window.
1068 *
1069 * \param window the window to query.
1070 * \returns the pixel format of the window on success or
1071 * SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more
1072 * information.
1073 *
1074 * \threadsafety This function should only be called on the main thread.
1075 *
1076 * \since This function is available since SDL 3.2.0.
1077 */
1078extern SDL_DECLSPEC SDL_PixelFormat SDLCALL SDL_GetWindowPixelFormat(SDL_Window *window);
1079
1080/**
1081 * Get a list of valid windows.
1082 *
1083 * \param count a pointer filled in with the number of windows returned, may
1084 * be NULL.
1085 * \returns a NULL terminated array of SDL_Window pointers or NULL on failure;
1086 * call SDL_GetError() for more information. This is a single
1087 * allocation that should be freed with SDL_free() when it is no
1088 * longer needed.
1089 *
1090 * \threadsafety This function should only be called on the main thread.
1091 *
1092 * \since This function is available since SDL 3.2.0.
1093 */
1094extern SDL_DECLSPEC SDL_Window ** SDLCALL SDL_GetWindows(int *count);
1095
1096/**
1097 * Create a window with the specified dimensions and flags.
1098 *
1099 * The window size is a request and may be different than expected based on
1100 * the desktop layout and window manager policies. Your application should be
1101 * prepared to handle a window of any size.
1102 *
1103 * `flags` may be any of the following OR'd together:
1104 *
1105 * - `SDL_WINDOW_FULLSCREEN`: fullscreen window at desktop resolution
1106 * - `SDL_WINDOW_OPENGL`: window usable with an OpenGL context
1107 * - `SDL_WINDOW_HIDDEN`: window is not visible
1108 * - `SDL_WINDOW_BORDERLESS`: no window decoration
1109 * - `SDL_WINDOW_RESIZABLE`: window can be resized
1110 * - `SDL_WINDOW_MINIMIZED`: window is minimized
1111 * - `SDL_WINDOW_MAXIMIZED`: window is maximized
1112 * - `SDL_WINDOW_MOUSE_GRABBED`: window has grabbed mouse focus
1113 * - `SDL_WINDOW_INPUT_FOCUS`: window has input focus
1114 * - `SDL_WINDOW_MOUSE_FOCUS`: window has mouse focus
1115 * - `SDL_WINDOW_EXTERNAL`: window not created by SDL
1116 * - `SDL_WINDOW_MODAL`: window is modal
1117 * - `SDL_WINDOW_HIGH_PIXEL_DENSITY`: window uses high pixel density back
1118 * buffer if possible
1119 * - `SDL_WINDOW_MOUSE_CAPTURE`: window has mouse captured (unrelated to
1120 * MOUSE_GRABBED)
1121 * - `SDL_WINDOW_ALWAYS_ON_TOP`: window should always be above others
1122 * - `SDL_WINDOW_UTILITY`: window should be treated as a utility window, not
1123 * showing in the task bar and window list
1124 * - `SDL_WINDOW_TOOLTIP`: window should be treated as a tooltip and does not
1125 * get mouse or keyboard focus, requires a parent window
1126 * - `SDL_WINDOW_POPUP_MENU`: window should be treated as a popup menu,
1127 * requires a parent window
1128 * - `SDL_WINDOW_KEYBOARD_GRABBED`: window has grabbed keyboard input
1129 * - `SDL_WINDOW_VULKAN`: window usable with a Vulkan instance
1130 * - `SDL_WINDOW_METAL`: window usable with a Metal instance
1131 * - `SDL_WINDOW_TRANSPARENT`: window with transparent buffer
1132 * - `SDL_WINDOW_NOT_FOCUSABLE`: window should not be focusable
1133 *
1134 * The SDL_Window will be shown if SDL_WINDOW_HIDDEN is not set. If hidden at
1135 * creation time, SDL_ShowWindow() can be used to show it later.
1136 *
1137 * On Apple's macOS, you **must** set the NSHighResolutionCapable Info.plist
1138 * property to YES, otherwise you will not receive a High-DPI OpenGL canvas.
1139 *
1140 * The window pixel size may differ from its window coordinate size if the
1141 * window is on a high pixel density display. Use SDL_GetWindowSize() to query
1142 * the client area's size in window coordinates, and
1143 * SDL_GetWindowSizeInPixels() or SDL_GetRenderOutputSize() to query the
1144 * drawable size in pixels. Note that the drawable size can vary after the
1145 * window is created and should be queried again if you get an
1146 * SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event.
1147 *
1148 * If the window is created with any of the SDL_WINDOW_OPENGL or
1149 * SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function
1150 * (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the
1151 * corresponding UnloadLibrary function is called by SDL_DestroyWindow().
1152 *
1153 * If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver,
1154 * SDL_CreateWindow() will fail, because SDL_Vulkan_LoadLibrary() will fail.
1155 *
1156 * If SDL_WINDOW_METAL is specified on an OS that does not support Metal,
1157 * SDL_CreateWindow() will fail.
1158 *
1159 * If you intend to use this window with an SDL_Renderer, you should use
1160 * SDL_CreateWindowAndRenderer() instead of this function, to avoid window
1161 * flicker.
1162 *
1163 * On non-Apple devices, SDL requires you to either not link to the Vulkan
1164 * loader or link to a dynamic library version. This limitation may be removed
1165 * in a future version of SDL.
1166 *
1167 * \param title the title of the window, in UTF-8 encoding.
1168 * \param w the width of the window.
1169 * \param h the height of the window.
1170 * \param flags 0, or one or more SDL_WindowFlags OR'd together.
1171 * \returns the window that was created or NULL on failure; call
1172 * SDL_GetError() for more information.
1173 *
1174 * \threadsafety This function should only be called on the main thread.
1175 *
1176 * \since This function is available since SDL 3.2.0.
1177 *
1178 * \sa SDL_CreateWindowAndRenderer
1179 * \sa SDL_CreatePopupWindow
1180 * \sa SDL_CreateWindowWithProperties
1181 * \sa SDL_DestroyWindow
1182 */
1183extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title, int w, int h, SDL_WindowFlags flags);
1184
1185/**
1186 * Create a child popup window of the specified parent window.
1187 *
1188 * The window size is a request and may be different than expected based on
1189 * the desktop layout and window manager policies. Your application should be
1190 * prepared to handle a window of any size.
1191 *
1192 * The flags parameter **must** contain at least one of the following:
1193 *
1194 * - `SDL_WINDOW_TOOLTIP`: The popup window is a tooltip and will not pass any
1195 * input events.
1196 * - `SDL_WINDOW_POPUP_MENU`: The popup window is a popup menu. The topmost
1197 * popup menu will implicitly gain the keyboard focus.
1198 *
1199 * The following flags are not relevant to popup window creation and will be
1200 * ignored:
1201 *
1202 * - `SDL_WINDOW_MINIMIZED`
1203 * - `SDL_WINDOW_MAXIMIZED`
1204 * - `SDL_WINDOW_FULLSCREEN`
1205 * - `SDL_WINDOW_BORDERLESS`
1206 *
1207 * The following flags are incompatible with popup window creation and will
1208 * cause it to fail:
1209 *
1210 * - `SDL_WINDOW_UTILITY`
1211 * - `SDL_WINDOW_MODAL`
1212 *
1213 * The parent parameter **must** be non-null and a valid window. The parent of
1214 * a popup window can be either a regular, toplevel window, or another popup
1215 * window.
1216 *
1217 * Popup windows cannot be minimized, maximized, made fullscreen, raised,
1218 * flash, be made a modal window, be the parent of a toplevel window, or grab
1219 * the mouse and/or keyboard. Attempts to do so will fail.
1220 *
1221 * Popup windows implicitly do not have a border/decorations and do not appear
1222 * on the taskbar/dock or in lists of windows such as alt-tab menus.
1223 *
1224 * By default, popup window positions will automatically be constrained to
1225 * keep the entire window within display bounds. This can be overridden with
1226 * the `SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN` property.
1227 *
1228 * By default, popup menus will automatically grab keyboard focus from the
1229 * parent when shown. This behavior can be overridden by setting the
1230 * `SDL_WINDOW_NOT_FOCUSABLE` flag, setting the
1231 * `SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN` property to false, or toggling
1232 * it after creation via the `SDL_SetWindowFocusable()` function.
1233 *
1234 * If a parent window is hidden or destroyed, any child popup windows will be
1235 * recursively hidden or destroyed as well. Child popup windows not explicitly
1236 * hidden will be restored when the parent is shown.
1237 *
1238 * \param parent the parent of the window, must not be NULL.
1239 * \param offset_x the x position of the popup window relative to the origin
1240 * of the parent.
1241 * \param offset_y the y position of the popup window relative to the origin
1242 * of the parent window.
1243 * \param w the width of the window.
1244 * \param h the height of the window.
1245 * \param flags SDL_WINDOW_TOOLTIP or SDL_WINDOW_POPUP_MENU, and zero or more
1246 * additional SDL_WindowFlags OR'd together.
1247 * \returns the window that was created or NULL on failure; call
1248 * SDL_GetError() for more information.
1249 *
1250 * \threadsafety This function should only be called on the main thread.
1251 *
1252 * \since This function is available since SDL 3.2.0.
1253 *
1254 * \sa SDL_CreateWindow
1255 * \sa SDL_CreateWindowWithProperties
1256 * \sa SDL_DestroyWindow
1257 * \sa SDL_GetWindowParent
1258 */
1259extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreatePopupWindow(SDL_Window *parent, int offset_x, int offset_y, int w, int h, SDL_WindowFlags flags);
1260
1261/**
1262 * Create a window with the specified properties.
1263 *
1264 * The window size is a request and may be different than expected based on
1265 * the desktop layout and window manager policies. Your application should be
1266 * prepared to handle a window of any size.
1267 *
1268 * These are the supported properties:
1269 *
1270 * - `SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN`: true if the window should
1271 * be always on top
1272 * - `SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN`: true if the window has no
1273 * window decoration
1274 * - `SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN`: true if the "tooltip"
1275 * and "menu" window types should be automatically constrained to be
1276 * entirely within display bounds (default), false if no constraints on the
1277 * position are desired.
1278 * - `SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN`: true if the
1279 * window will be used with an externally managed graphics context.
1280 * - `SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN`: true if the window should
1281 * accept keyboard input (defaults true)
1282 * - `SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN`: true if the window should
1283 * start in fullscreen mode at desktop resolution
1284 * - `SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER`: the height of the window
1285 * - `SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN`: true if the window should start
1286 * hidden
1287 * - `SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN`: true if the window
1288 * uses a high pixel density buffer if possible
1289 * - `SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN`: true if the window should
1290 * start maximized
1291 * - `SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN`: true if the window is a popup menu
1292 * - `SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN`: true if the window will be used
1293 * with Metal rendering
1294 * - `SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN`: true if the window should
1295 * start minimized
1296 * - `SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN`: true if the window is modal to
1297 * its parent
1298 * - `SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN`: true if the window starts
1299 * with grabbed mouse focus
1300 * - `SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN`: true if the window will be used
1301 * with OpenGL rendering
1302 * - `SDL_PROP_WINDOW_CREATE_PARENT_POINTER`: an SDL_Window that will be the
1303 * parent of this window, required for windows with the "tooltip", "menu",
1304 * and "modal" properties
1305 * - `SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN`: true if the window should be
1306 * resizable
1307 * - `SDL_PROP_WINDOW_CREATE_TITLE_STRING`: the title of the window, in UTF-8
1308 * encoding
1309 * - `SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN`: true if the window show
1310 * transparent in the areas with alpha of 0
1311 * - `SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN`: true if the window is a tooltip
1312 * - `SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN`: true if the window is a utility
1313 * window, not showing in the task bar and window list
1314 * - `SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN`: true if the window will be used
1315 * with Vulkan rendering
1316 * - `SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER`: the width of the window
1317 * - `SDL_PROP_WINDOW_CREATE_X_NUMBER`: the x position of the window, or
1318 * `SDL_WINDOWPOS_CENTERED`, defaults to `SDL_WINDOWPOS_UNDEFINED`. This is
1319 * relative to the parent for windows with the "tooltip" or "menu" property
1320 * set.
1321 * - `SDL_PROP_WINDOW_CREATE_Y_NUMBER`: the y position of the window, or
1322 * `SDL_WINDOWPOS_CENTERED`, defaults to `SDL_WINDOWPOS_UNDEFINED`. This is
1323 * relative to the parent for windows with the "tooltip" or "menu" property
1324 * set.
1325 *
1326 * These are additional supported properties on macOS:
1327 *
1328 * - `SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER`: the
1329 * `(__unsafe_unretained)` NSWindow associated with the window, if you want
1330 * to wrap an existing window.
1331 * - `SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER`: the `(__unsafe_unretained)`
1332 * NSView associated with the window, defaults to `[window contentView]`
1333 *
1334 * These are additional supported properties on iOS, tvOS, and visionOS:
1335 *
1336 * - `SDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER`: the `(__unsafe_unretained)`
1337 * UIWindowScene associated with the window, defaults to the active window
1338 * scene.
1339 *
1340 * These are additional supported properties on Wayland:
1341 *
1342 * - `SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN` - true if
1343 * the application wants to use the Wayland surface for a custom role and
1344 * does not want it attached to an XDG toplevel window. See
1345 * [README-wayland](README-wayland) for more information on using custom
1346 * surfaces.
1347 * - `SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN` - true if the
1348 * application wants an associated `wl_egl_window` object to be created and
1349 * attached to the window, even if the window does not have the OpenGL
1350 * property or `SDL_WINDOW_OPENGL` flag set.
1351 * - `SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER` - the wl_surface
1352 * associated with the window, if you want to wrap an existing window. See
1353 * [README-wayland](README-wayland) for more information.
1354 *
1355 * These are additional supported properties on Windows:
1356 *
1357 * - `SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER`: the HWND associated with the
1358 * window, if you want to wrap an existing window.
1359 * - `SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER`: optional,
1360 * another window to share pixel format with, useful for OpenGL windows
1361 *
1362 * These are additional supported properties with X11:
1363 *
1364 * - `SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER`: the X11 Window associated
1365 * with the window, if you want to wrap an existing window.
1366 *
1367 * The window is implicitly shown if the "hidden" property is not set.
1368 *
1369 * These are additional supported properties with Emscripten:
1370 *
1371 * - `SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING`: the id given to the
1372 * canvas element. This should start with a '#' sign
1373 * - `SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING`: override the
1374 * binding element for keyboard inputs for this canvas. The variable can be
1375 * one of:
1376 * - "#window": the javascript window object (default)
1377 * - "#document": the javascript document object
1378 * - "#screen": the javascript window.screen object
1379 * - "#canvas": the WebGL canvas element
1380 * - "#none": Don't bind anything at all
1381 * - any other string without a leading # sign applies to the element on the
1382 * page with that ID. Windows with the "tooltip" and "menu" properties are
1383 * popup windows and have the behaviors and guidelines outlined in
1384 * SDL_CreatePopupWindow().
1385 *
1386 * If this window is being created to be used with an SDL_Renderer, you should
1387 * not add a graphics API specific property
1388 * (`SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN`, etc), as SDL will handle that
1389 * internally when it chooses a renderer. However, SDL might need to recreate
1390 * your window at that point, which may cause the window to appear briefly,
1391 * and then flicker as it is recreated. The correct approach to this is to
1392 * create the window with the `SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN` property
1393 * set to true, then create the renderer, then show the window with
1394 * SDL_ShowWindow().
1395 *
1396 * \param props the properties to use.
1397 * \returns the window that was created or NULL on failure; call
1398 * SDL_GetError() for more information.
1399 *
1400 * \threadsafety This function should only be called on the main thread.
1401 *
1402 * \since This function is available since SDL 3.2.0.
1403 *
1404 * \sa SDL_CreateProperties
1405 * \sa SDL_CreateWindow
1406 * \sa SDL_DestroyWindow
1407 */
1408extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowWithProperties(SDL_PropertiesID props);
1409
1410#define SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN "SDL.window.create.always_on_top"
1411#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN "SDL.window.create.borderless"
1412#define SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN "SDL.window.create.constrain_popup"
1413#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN "SDL.window.create.focusable"
1414#define SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN "SDL.window.create.external_graphics_context"
1415#define SDL_PROP_WINDOW_CREATE_FLAGS_NUMBER "SDL.window.create.flags"
1416#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN "SDL.window.create.fullscreen"
1417#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER "SDL.window.create.height"
1418#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN "SDL.window.create.hidden"
1419#define SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN "SDL.window.create.high_pixel_density"
1420#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN "SDL.window.create.maximized"
1421#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN "SDL.window.create.menu"
1422#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN "SDL.window.create.metal"
1423#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN "SDL.window.create.minimized"
1424#define SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN "SDL.window.create.modal"
1425#define SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN "SDL.window.create.mouse_grabbed"
1426#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN "SDL.window.create.opengl"
1427#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER "SDL.window.create.parent"
1428#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN "SDL.window.create.resizable"
1429#define SDL_PROP_WINDOW_CREATE_TITLE_STRING "SDL.window.create.title"
1430#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN "SDL.window.create.transparent"
1431#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN "SDL.window.create.tooltip"
1432#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN "SDL.window.create.utility"
1433#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN "SDL.window.create.vulkan"
1434#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER "SDL.window.create.width"
1435#define SDL_PROP_WINDOW_CREATE_X_NUMBER "SDL.window.create.x"
1436#define SDL_PROP_WINDOW_CREATE_Y_NUMBER "SDL.window.create.y"
1437#define SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER "SDL.window.create.cocoa.window"
1438#define SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER "SDL.window.create.cocoa.view"
1439#define SDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER "SDL.window.create.uikit.windowscene"
1440#define SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN "SDL.window.create.wayland.surface_role_custom"
1441#define SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN "SDL.window.create.wayland.create_egl_window"
1442#define SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER "SDL.window.create.wayland.wl_surface"
1443#define SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER "SDL.window.create.win32.hwnd"
1444#define SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER "SDL.window.create.win32.pixel_format_hwnd"
1445#define SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER "SDL.window.create.x11.window"
1446#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING "SDL.window.create.emscripten.canvas_id"
1447#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING "SDL.window.create.emscripten.keyboard_element"
1448
1449/**
1450 * Get the numeric ID of a window.
1451 *
1452 * The numeric ID is what SDL_WindowEvent references, and is necessary to map
1453 * these events to specific SDL_Window objects.
1454 *
1455 * \param window the window to query.
1456 * \returns the ID of the window on success or 0 on failure; call
1457 * SDL_GetError() for more information.
1458 *
1459 * \threadsafety This function should only be called on the main thread.
1460 *
1461 * \since This function is available since SDL 3.2.0.
1462 *
1463 * \sa SDL_GetWindowFromID
1464 */
1465extern SDL_DECLSPEC SDL_WindowID SDLCALL SDL_GetWindowID(SDL_Window *window);
1466
1467/**
1468 * Get a window from a stored ID.
1469 *
1470 * The numeric ID is what SDL_WindowEvent references, and is necessary to map
1471 * these events to specific SDL_Window objects.
1472 *
1473 * \param id the ID of the window.
1474 * \returns the window associated with `id` or NULL if it doesn't exist; call
1475 * SDL_GetError() for more information.
1476 *
1477 * \threadsafety This function should only be called on the main thread.
1478 *
1479 * \since This function is available since SDL 3.2.0.
1480 *
1481 * \sa SDL_GetWindowID
1482 */
1483extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(SDL_WindowID id);
1484
1485/**
1486 * Get parent of a window.
1487 *
1488 * \param window the window to query.
1489 * \returns the parent of the window on success or NULL if the window has no
1490 * parent.
1491 *
1492 * \threadsafety This function should only be called on the main thread.
1493 *
1494 * \since This function is available since SDL 3.2.0.
1495 *
1496 * \sa SDL_CreatePopupWindow
1497 */
1498extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetWindowParent(SDL_Window *window);
1499
1500/**
1501 * Get the properties associated with a window.
1502 *
1503 * The following read-only properties are provided by SDL:
1504 *
1505 * - `SDL_PROP_WINDOW_SHAPE_POINTER`: the surface associated with a shaped
1506 * window
1507 * - `SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN`: true if the window has HDR
1508 * headroom above the SDR white point. This property can change dynamically
1509 * when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
1510 * - `SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT`: the value of SDR white in the
1511 * SDL_COLORSPACE_SRGB_LINEAR colorspace. On Windows this corresponds to the
1512 * SDR white level in scRGB colorspace, and on Apple platforms this is
1513 * always 1.0 for EDR content. This property can change dynamically when
1514 * SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
1515 * - `SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT`: the additional high dynamic range
1516 * that can be displayed, in terms of the SDR white point. When HDR is not
1517 * enabled, this will be 1.0. This property can change dynamically when
1518 * SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
1519 *
1520 * On Android:
1521 *
1522 * - `SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER`: the ANativeWindow associated
1523 * with the window
1524 * - `SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER`: the EGLSurface associated with
1525 * the window
1526 *
1527 * On iOS:
1528 *
1529 * - `SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER`: the `(__unsafe_unretained)`
1530 * UIWindow associated with the window
1531 * - `SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER`: the NSInteger tag
1532 * associated with metal views on the window
1533 * - `SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER`: the OpenGL view's
1534 * framebuffer object. It must be bound when rendering to the screen using
1535 * OpenGL.
1536 * - `SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER`: the OpenGL view's
1537 * renderbuffer object. It must be bound when SDL_GL_SwapWindow is called.
1538 * - `SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER`: the OpenGL
1539 * view's resolve framebuffer, when MSAA is used.
1540 *
1541 * On KMS/DRM:
1542 *
1543 * - `SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER`: the device index associated
1544 * with the window (e.g. the X in /dev/dri/cardX)
1545 * - `SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER`: the DRM FD associated with the
1546 * window
1547 * - `SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER`: the GBM device associated
1548 * with the window
1549 *
1550 * On macOS:
1551 *
1552 * - `SDL_PROP_WINDOW_COCOA_WINDOW_POINTER`: the `(__unsafe_unretained)`
1553 * NSWindow associated with the window
1554 * - `SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER`: the NSInteger tag
1555 * associated with metal views on the window
1556 *
1557 * On OpenVR:
1558 *
1559 * - `SDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER`: the OpenVR Overlay Handle ID
1560 * for the associated overlay window.
1561 *
1562 * On Vivante:
1563 *
1564 * - `SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER`: the EGLNativeDisplayType
1565 * associated with the window
1566 * - `SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER`: the EGLNativeWindowType
1567 * associated with the window
1568 * - `SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER`: the EGLSurface associated with
1569 * the window
1570 *
1571 * On Windows:
1572 *
1573 * - `SDL_PROP_WINDOW_WIN32_HWND_POINTER`: the HWND associated with the window
1574 * - `SDL_PROP_WINDOW_WIN32_HDC_POINTER`: the HDC associated with the window
1575 * - `SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER`: the HINSTANCE associated with
1576 * the window
1577 *
1578 * On Wayland:
1579 *
1580 * Note: The `xdg_*` window objects do not internally persist across window
1581 * show/hide calls. They will be null if the window is hidden and must be
1582 * queried each time it is shown.
1583 *
1584 * - `SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER`: the wl_display associated with
1585 * the window
1586 * - `SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER`: the wl_surface associated with
1587 * the window
1588 * - `SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER`: the wp_viewport associated
1589 * with the window
1590 * - `SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER`: the wl_egl_window
1591 * associated with the window
1592 * - `SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER`: the xdg_surface associated
1593 * with the window
1594 * - `SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER`: the xdg_toplevel role
1595 * associated with the window
1596 * - 'SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING': the export
1597 * handle associated with the window
1598 * - `SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER`: the xdg_popup role
1599 * associated with the window
1600 * - `SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER`: the xdg_positioner
1601 * associated with the window, in popup mode
1602 *
1603 * On X11:
1604 *
1605 * - `SDL_PROP_WINDOW_X11_DISPLAY_POINTER`: the X11 Display associated with
1606 * the window
1607 * - `SDL_PROP_WINDOW_X11_SCREEN_NUMBER`: the screen number associated with
1608 * the window
1609 * - `SDL_PROP_WINDOW_X11_WINDOW_NUMBER`: the X11 Window associated with the
1610 * window
1611 *
1612 * On Emscripten:
1613 *
1614 * - `SDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING`: the id the canvas element
1615 * will have
1616 * - `SDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING`: the keyboard
1617 * element that associates keyboard events to this window
1618 *
1619 * \param window the window to query.
1620 * \returns a valid property ID on success or 0 on failure; call
1621 * SDL_GetError() for more information.
1622 *
1623 * \threadsafety This function should only be called on the main thread.
1624 *
1625 * \since This function is available since SDL 3.2.0.
1626 */
1627extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetWindowProperties(SDL_Window *window);
1628
1629#define SDL_PROP_WINDOW_SHAPE_POINTER "SDL.window.shape"
1630#define SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN "SDL.window.HDR_enabled"
1631#define SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT "SDL.window.SDR_white_level"
1632#define SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT "SDL.window.HDR_headroom"
1633#define SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER "SDL.window.android.window"
1634#define SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER "SDL.window.android.surface"
1635#define SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER "SDL.window.uikit.window"
1636#define SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER "SDL.window.uikit.metal_view_tag"
1637#define SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER "SDL.window.uikit.opengl.framebuffer"
1638#define SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER "SDL.window.uikit.opengl.renderbuffer"
1639#define SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER "SDL.window.uikit.opengl.resolve_framebuffer"
1640#define SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER "SDL.window.kmsdrm.dev_index"
1641#define SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER "SDL.window.kmsdrm.drm_fd"
1642#define SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER "SDL.window.kmsdrm.gbm_dev"
1643#define SDL_PROP_WINDOW_COCOA_WINDOW_POINTER "SDL.window.cocoa.window"
1644#define SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER "SDL.window.cocoa.metal_view_tag"
1645#define SDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER "SDL.window.openvr.overlay_id"
1646#define SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER "SDL.window.vivante.display"
1647#define SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER "SDL.window.vivante.window"
1648#define SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER "SDL.window.vivante.surface"
1649#define SDL_PROP_WINDOW_WIN32_HWND_POINTER "SDL.window.win32.hwnd"
1650#define SDL_PROP_WINDOW_WIN32_HDC_POINTER "SDL.window.win32.hdc"
1651#define SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER "SDL.window.win32.instance"
1652#define SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER "SDL.window.wayland.display"
1653#define SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER "SDL.window.wayland.surface"
1654#define SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER "SDL.window.wayland.viewport"
1655#define SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER "SDL.window.wayland.egl_window"
1656#define SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER "SDL.window.wayland.xdg_surface"
1657#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER "SDL.window.wayland.xdg_toplevel"
1658#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING "SDL.window.wayland.xdg_toplevel_export_handle"
1659#define SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER "SDL.window.wayland.xdg_popup"
1660#define SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER "SDL.window.wayland.xdg_positioner"
1661#define SDL_PROP_WINDOW_X11_DISPLAY_POINTER "SDL.window.x11.display"
1662#define SDL_PROP_WINDOW_X11_SCREEN_NUMBER "SDL.window.x11.screen"
1663#define SDL_PROP_WINDOW_X11_WINDOW_NUMBER "SDL.window.x11.window"
1664#define SDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING "SDL.window.emscripten.canvas_id"
1665#define SDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING "SDL.window.emscripten.keyboard_element"
1666
1667/**
1668 * Get the window flags.
1669 *
1670 * \param window the window to query.
1671 * \returns a mask of the SDL_WindowFlags associated with `window`.
1672 *
1673 * \threadsafety This function should only be called on the main thread.
1674 *
1675 * \since This function is available since SDL 3.2.0.
1676 *
1677 * \sa SDL_CreateWindow
1678 * \sa SDL_HideWindow
1679 * \sa SDL_MaximizeWindow
1680 * \sa SDL_MinimizeWindow
1681 * \sa SDL_SetWindowFullscreen
1682 * \sa SDL_SetWindowMouseGrab
1683 * \sa SDL_SetWindowFillDocument
1684 * \sa SDL_ShowWindow
1685 */
1686extern SDL_DECLSPEC SDL_WindowFlags SDLCALL SDL_GetWindowFlags(SDL_Window *window);
1687
1688/**
1689 * Set the title of a window.
1690 *
1691 * This string is expected to be in UTF-8 encoding.
1692 *
1693 * \param window the window to change.
1694 * \param title the desired window title in UTF-8 format.
1695 * \returns true on success or false on failure; call SDL_GetError() for more
1696 * information.
1697 *
1698 * \threadsafety This function should only be called on the main thread.
1699 *
1700 * \since This function is available since SDL 3.2.0.
1701 *
1702 * \sa SDL_GetWindowTitle
1703 */
1704extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowTitle(SDL_Window *window, const char *title);
1705
1706/**
1707 * Get the title of a window.
1708 *
1709 * \param window the window to query.
1710 * \returns the title of the window in UTF-8 format or "" if there is no
1711 * title.
1712 *
1713 * \threadsafety This function should only be called on the main thread.
1714 *
1715 * \since This function is available since SDL 3.2.0.
1716 *
1717 * \sa SDL_SetWindowTitle
1718 */
1719extern SDL_DECLSPEC const char * SDLCALL SDL_GetWindowTitle(SDL_Window *window);
1720
1721/**
1722 * Set the icon for a window.
1723 *
1724 * If this function is passed a surface with alternate representations added
1725 * using SDL_AddSurfaceAlternateImage(), the surface will be interpreted as
1726 * the content to be used for 100% display scale, and the alternate
1727 * representations will be used for high DPI situations. For example, if the
1728 * original surface is 32x32, then on a 2x macOS display or 200% display scale
1729 * on Windows, a 64x64 version of the image will be used, if available. If a
1730 * matching version of the image isn't available, the closest larger size
1731 * image will be downscaled to the appropriate size and be used instead, if
1732 * available. Otherwise, the closest smaller image will be upscaled and be
1733 * used instead.
1734 *
1735 * \param window the window to change.
1736 * \param icon an SDL_Surface structure containing the icon for the window.
1737 * \returns true on success or false on failure; call SDL_GetError() for more
1738 * information.
1739 *
1740 * \threadsafety This function should only be called on the main thread.
1741 *
1742 * \since This function is available since SDL 3.2.0.
1743 *
1744 * \sa SDL_AddSurfaceAlternateImage
1745 */
1746extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon);
1747
1748/**
1749 * Request that the window's position be set.
1750 *
1751 * If the window is in an exclusive fullscreen or maximized state, this
1752 * request has no effect.
1753 *
1754 * This can be used to reposition fullscreen-desktop windows onto a different
1755 * display, however, as exclusive fullscreen windows are locked to a specific
1756 * display, they can only be repositioned programmatically via
1757 * SDL_SetWindowFullscreenMode().
1758 *
1759 * On some windowing systems this request is asynchronous and the new
1760 * coordinates may not have have been applied immediately upon the return of
1761 * this function. If an immediate change is required, call SDL_SyncWindow() to
1762 * block until the changes have taken effect.
1763 *
1764 * When the window position changes, an SDL_EVENT_WINDOW_MOVED event will be
1765 * emitted with the window's new coordinates. Note that the new coordinates
1766 * may not match the exact coordinates requested, as some windowing systems
1767 * can restrict the position of the window in certain scenarios (e.g.
1768 * constraining the position so the window is always within desktop bounds).
1769 * Additionally, as this is just a request, it can be denied by the windowing
1770 * system.
1771 *
1772 * \param window the window to reposition.
1773 * \param x the x coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
1774 * `SDL_WINDOWPOS_UNDEFINED`.
1775 * \param y the y coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
1776 * `SDL_WINDOWPOS_UNDEFINED`.
1777 * \returns true on success or false on failure; call SDL_GetError() for more
1778 * information.
1779 *
1780 * \threadsafety This function should only be called on the main thread.
1781 *
1782 * \since This function is available since SDL 3.2.0.
1783 *
1784 * \sa SDL_GetWindowPosition
1785 * \sa SDL_SyncWindow
1786 */
1787extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowPosition(SDL_Window *window, int x, int y);
1788
1789/**
1790 * Get the position of a window.
1791 *
1792 * This is the current position of the window as last reported by the
1793 * windowing system.
1794 *
1795 * If you do not need the value for one of the positions a NULL may be passed
1796 * in the `x` or `y` parameter.
1797 *
1798 * \param window the window to query.
1799 * \param x a pointer filled in with the x position of the window, may be
1800 * NULL.
1801 * \param y a pointer filled in with the y position of the window, may be
1802 * NULL.
1803 * \returns true on success or false on failure; call SDL_GetError() for more
1804 * information.
1805 *
1806 * \threadsafety This function should only be called on the main thread.
1807 *
1808 * \since This function is available since SDL 3.2.0.
1809 *
1810 * \sa SDL_SetWindowPosition
1811 */
1812extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowPosition(SDL_Window *window, int *x, int *y);
1813
1814/**
1815 * Request that the size of a window's client area be set.
1816 *
1817 * If the window is in a fullscreen or maximized state, this request has no
1818 * effect.
1819 *
1820 * To change the exclusive fullscreen mode of a window, use
1821 * SDL_SetWindowFullscreenMode().
1822 *
1823 * On some windowing systems, this request is asynchronous and the new window
1824 * size may not have have been applied immediately upon the return of this
1825 * function. If an immediate change is required, call SDL_SyncWindow() to
1826 * block until the changes have taken effect.
1827 *
1828 * When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will be
1829 * emitted with the new window dimensions. Note that the new dimensions may
1830 * not match the exact size requested, as some windowing systems can restrict
1831 * the window size in certain scenarios (e.g. constraining the size of the
1832 * content area to remain within the usable desktop bounds). Additionally, as
1833 * this is just a request, it can be denied by the windowing system.
1834 *
1835 * \param window the window to change.
1836 * \param w the width of the window, must be > 0.
1837 * \param h the height of the window, must be > 0.
1838 * \returns true on success or false on failure; call SDL_GetError() for more
1839 * information.
1840 *
1841 * \threadsafety This function should only be called on the main thread.
1842 *
1843 * \since This function is available since SDL 3.2.0.
1844 *
1845 * \sa SDL_GetWindowSize
1846 * \sa SDL_SetWindowFullscreenMode
1847 * \sa SDL_SyncWindow
1848 */
1849extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSize(SDL_Window *window, int w, int h);
1850
1851/**
1852 * Get the size of a window's client area.
1853 *
1854 * The window pixel size may differ from its window coordinate size if the
1855 * window is on a high pixel density display. Use SDL_GetWindowSizeInPixels()
1856 * or SDL_GetRenderOutputSize() to get the real client area size in pixels.
1857 *
1858 * \param window the window to query the width and height from.
1859 * \param w a pointer filled in with the width of the window, may be NULL.
1860 * \param h a pointer filled in with the height of the window, may be NULL.
1861 * \returns true on success or false on failure; call SDL_GetError() for more
1862 * information.
1863 *
1864 * \threadsafety This function should only be called on the main thread.
1865 *
1866 * \since This function is available since SDL 3.2.0.
1867 *
1868 * \sa SDL_GetRenderOutputSize
1869 * \sa SDL_GetWindowSizeInPixels
1870 * \sa SDL_SetWindowSize
1871 * \sa SDL_EVENT_WINDOW_RESIZED
1872 */
1873extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSize(SDL_Window *window, int *w, int *h);
1874
1875/**
1876 * Get the safe area for this window.
1877 *
1878 * Some devices have portions of the screen which are partially obscured or
1879 * not interactive, possibly due to on-screen controls, curved edges, camera
1880 * notches, TV overscan, etc. This function provides the area of the window
1881 * which is safe to have interactable content. You should continue rendering
1882 * into the rest of the window, but it should not contain visually important
1883 * or interactable content.
1884 *
1885 * \param window the window to query.
1886 * \param rect a pointer filled in with the client area that is safe for
1887 * interactive content.
1888 * \returns true on success or false on failure; call SDL_GetError() for more
1889 * information.
1890 *
1891 * \threadsafety This function should only be called on the main thread.
1892 *
1893 * \since This function is available since SDL 3.2.0.
1894 */
1895extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSafeArea(SDL_Window *window, SDL_Rect *rect);
1896
1897/**
1898 * Request that the aspect ratio of a window's client area be set.
1899 *
1900 * The aspect ratio is the ratio of width divided by height, e.g. 2560x1600
1901 * would be 1.6. Larger aspect ratios are wider and smaller aspect ratios are
1902 * narrower.
1903 *
1904 * If, at the time of this request, the window in a fixed-size state, such as
1905 * maximized or fullscreen, the request will be deferred until the window
1906 * exits this state and becomes resizable again.
1907 *
1908 * On some windowing systems, this request is asynchronous and the new window
1909 * aspect ratio may not have have been applied immediately upon the return of
1910 * this function. If an immediate change is required, call SDL_SyncWindow() to
1911 * block until the changes have taken effect.
1912 *
1913 * When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will be
1914 * emitted with the new window dimensions. Note that the new dimensions may
1915 * not match the exact aspect ratio requested, as some windowing systems can
1916 * restrict the window size in certain scenarios (e.g. constraining the size
1917 * of the content area to remain within the usable desktop bounds).
1918 * Additionally, as this is just a request, it can be denied by the windowing
1919 * system.
1920 *
1921 * \param window the window to change.
1922 * \param min_aspect the minimum aspect ratio of the window, or 0.0f for no
1923 * limit.
1924 * \param max_aspect the maximum aspect ratio of the window, or 0.0f for no
1925 * limit.
1926 * \returns true on success or false on failure; call SDL_GetError() for more
1927 * information.
1928 *
1929 * \threadsafety This function should only be called on the main thread.
1930 *
1931 * \since This function is available since SDL 3.2.0.
1932 *
1933 * \sa SDL_GetWindowAspectRatio
1934 * \sa SDL_SyncWindow
1935 */
1936extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAspectRatio(SDL_Window *window, float min_aspect, float max_aspect);
1937
1938/**
1939 * Get the aspect ratio of a window's client area.
1940 *
1941 * \param window the window to query the width and height from.
1942 * \param min_aspect a pointer filled in with the minimum aspect ratio of the
1943 * window, may be NULL.
1944 * \param max_aspect a pointer filled in with the maximum aspect ratio of the
1945 * window, may be NULL.
1946 * \returns true on success or false on failure; call SDL_GetError() for more
1947 * information.
1948 *
1949 * \threadsafety This function should only be called on the main thread.
1950 *
1951 * \since This function is available since SDL 3.2.0.
1952 *
1953 * \sa SDL_SetWindowAspectRatio
1954 */
1955extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowAspectRatio(SDL_Window *window, float *min_aspect, float *max_aspect);
1956
1957/**
1958 * Get the size of a window's borders (decorations) around the client area.
1959 *
1960 * Note: If this function fails (returns false), the size values will be
1961 * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the
1962 * window in question was borderless.
1963 *
1964 * Note: This function may fail on systems where the window has not yet been
1965 * decorated by the display server (for example, immediately after calling
1966 * SDL_CreateWindow). It is recommended that you wait at least until the
1967 * window has been presented and composited, so that the window system has a
1968 * chance to decorate the window and provide the border dimensions to SDL.
1969 *
1970 * This function also returns false if getting the information is not
1971 * supported.
1972 *
1973 * \param window the window to query the size values of the border
1974 * (decorations) from.
1975 * \param top pointer to variable for storing the size of the top border; NULL
1976 * is permitted.
1977 * \param left pointer to variable for storing the size of the left border;
1978 * NULL is permitted.
1979 * \param bottom pointer to variable for storing the size of the bottom
1980 * border; NULL is permitted.
1981 * \param right pointer to variable for storing the size of the right border;
1982 * NULL is permitted.
1983 * \returns true on success or false on failure; call SDL_GetError() for more
1984 * information.
1985 *
1986 * \threadsafety This function should only be called on the main thread.
1987 *
1988 * \since This function is available since SDL 3.2.0.
1989 *
1990 * \sa SDL_GetWindowSize
1991 */
1992extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right);
1993
1994/**
1995 * Get the size of a window's client area, in pixels.
1996 *
1997 * \param window the window from which the drawable size should be queried.
1998 * \param w a pointer to variable for storing the width in pixels, may be
1999 * NULL.
2000 * \param h a pointer to variable for storing the height in pixels, may be
2001 * NULL.
2002 * \returns true on success or false on failure; call SDL_GetError() for more
2003 * information.
2004 *
2005 * \threadsafety This function should only be called on the main thread.
2006 *
2007 * \since This function is available since SDL 3.2.0.
2008 *
2009 * \sa SDL_CreateWindow
2010 * \sa SDL_GetWindowSize
2011 */
2012extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSizeInPixels(SDL_Window *window, int *w, int *h);
2013
2014/**
2015 * Set the minimum size of a window's client area.
2016 *
2017 * \param window the window to change.
2018 * \param min_w the minimum width of the window, or 0 for no limit.
2019 * \param min_h the minimum height of the window, or 0 for no limit.
2020 * \returns true on success or false on failure; call SDL_GetError() for more
2021 * information.
2022 *
2023 * \threadsafety This function should only be called on the main thread.
2024 *
2025 * \since This function is available since SDL 3.2.0.
2026 *
2027 * \sa SDL_GetWindowMinimumSize
2028 * \sa SDL_SetWindowMaximumSize
2029 */
2030extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window, int min_w, int min_h);
2031
2032/**
2033 * Get the minimum size of a window's client area.
2034 *
2035 * \param window the window to query.
2036 * \param w a pointer filled in with the minimum width of the window, may be
2037 * NULL.
2038 * \param h a pointer filled in with the minimum height of the window, may be
2039 * NULL.
2040 * \returns true on success or false on failure; call SDL_GetError() for more
2041 * information.
2042 *
2043 * \threadsafety This function should only be called on the main thread.
2044 *
2045 * \since This function is available since SDL 3.2.0.
2046 *
2047 * \sa SDL_GetWindowMaximumSize
2048 * \sa SDL_SetWindowMinimumSize
2049 */
2050extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window, int *w, int *h);
2051
2052/**
2053 * Set the maximum size of a window's client area.
2054 *
2055 * \param window the window to change.
2056 * \param max_w the maximum width of the window, or 0 for no limit.
2057 * \param max_h the maximum height of the window, or 0 for no limit.
2058 * \returns true on success or false on failure; call SDL_GetError() for more
2059 * information.
2060 *
2061 * \threadsafety This function should only be called on the main thread.
2062 *
2063 * \since This function is available since SDL 3.2.0.
2064 *
2065 * \sa SDL_GetWindowMaximumSize
2066 * \sa SDL_SetWindowMinimumSize
2067 */
2068extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window, int max_w, int max_h);
2069
2070/**
2071 * Get the maximum size of a window's client area.
2072 *
2073 * \param window the window to query.
2074 * \param w a pointer filled in with the maximum width of the window, may be
2075 * NULL.
2076 * \param h a pointer filled in with the maximum height of the window, may be
2077 * NULL.
2078 * \returns true on success or false on failure; call SDL_GetError() for more
2079 * information.
2080 *
2081 * \threadsafety This function should only be called on the main thread.
2082 *
2083 * \since This function is available since SDL 3.2.0.
2084 *
2085 * \sa SDL_GetWindowMinimumSize
2086 * \sa SDL_SetWindowMaximumSize
2087 */
2088extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window, int *w, int *h);
2089
2090/**
2091 * Set the border state of a window.
2092 *
2093 * This will add or remove the window's `SDL_WINDOW_BORDERLESS` flag and add
2094 * or remove the border from the actual window. This is a no-op if the
2095 * window's border already matches the requested state.
2096 *
2097 * You can't change the border state of a fullscreen window.
2098 *
2099 * \param window the window of which to change the border state.
2100 * \param bordered false to remove border, true to add border.
2101 * \returns true on success or false on failure; call SDL_GetError() for more
2102 * information.
2103 *
2104 * \threadsafety This function should only be called on the main thread.
2105 *
2106 * \since This function is available since SDL 3.2.0.
2107 *
2108 * \sa SDL_GetWindowFlags
2109 */
2110extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowBordered(SDL_Window *window, bool bordered);
2111
2112/**
2113 * Set the user-resizable state of a window.
2114 *
2115 * This will add or remove the window's `SDL_WINDOW_RESIZABLE` flag and
2116 * allow/disallow user resizing of the window. This is a no-op if the window's
2117 * resizable state already matches the requested state.
2118 *
2119 * You can't change the resizable state of a fullscreen window.
2120 *
2121 * \param window the window of which to change the resizable state.
2122 * \param resizable true to allow resizing, false to disallow.
2123 * \returns true on success or false on failure; call SDL_GetError() for more
2124 * information.
2125 *
2126 * \threadsafety This function should only be called on the main thread.
2127 *
2128 * \since This function is available since SDL 3.2.0.
2129 *
2130 * \sa SDL_GetWindowFlags
2131 */
2132extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowResizable(SDL_Window *window, bool resizable);
2133
2134/**
2135 * Set the window to always be above the others.
2136 *
2137 * This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP` flag. This
2138 * will bring the window to the front and keep the window above the rest.
2139 *
2140 * \param window the window of which to change the always on top state.
2141 * \param on_top true to set the window always on top, false to disable.
2142 * \returns true on success or false on failure; call SDL_GetError() for more
2143 * information.
2144 *
2145 * \threadsafety This function should only be called on the main thread.
2146 *
2147 * \since This function is available since SDL 3.2.0.
2148 *
2149 * \sa SDL_GetWindowFlags
2150 */
2151extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window *window, bool on_top);
2152
2153/**
2154 * Set the window to fill the current document space (Emscripten only).
2155 *
2156 * This will add or remove the window's `SDL_WINDOW_FILL_DOCUMENT` flag.
2157 *
2158 * Currently this flag only applies to the Emscripten target.
2159 *
2160 * When enabled, the canvas element fills the entire document. Resize events
2161 * will be generated as the browser window is resized, as that will adjust the
2162 * canvas size as well. The canvas will cover anything else on the page,
2163 * including any controls provided by Emscripten in its generated HTML file
2164 * (in fact, any elements on the page that aren't the canvas will be moved
2165 * into a hidden `div` element).
2166 *
2167 * Often times this is desirable for a browser-based game, but it means
2168 * several things that we expect of an SDL window on other platforms might not
2169 * work as expected, such as minimum window sizes and aspect ratios.
2170 *
2171 * \param window the window of which to change the fill-document state.
2172 * \param fill true to set the window to fill the document, false to disable.
2173 * \returns true on success or false on failure; call SDL_GetError() for more
2174 * information.
2175 *
2176 * \threadsafety This function should only be called on the main thread.
2177 *
2178 * \since This function is available since SDL 3.4.0.
2179 *
2180 * \sa SDL_GetWindowFlags
2181 */
2182extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFillDocument(SDL_Window *window, bool fill);
2183
2184/**
2185 * Show a window.
2186 *
2187 * \param window the window to show.
2188 * \returns true on success or false on failure; call SDL_GetError() for more
2189 * information.
2190 *
2191 * \threadsafety This function should only be called on the main thread.
2192 *
2193 * \since This function is available since SDL 3.2.0.
2194 *
2195 * \sa SDL_HideWindow
2196 * \sa SDL_RaiseWindow
2197 */
2198extern SDL_DECLSPEC bool SDLCALL SDL_ShowWindow(SDL_Window *window);
2199
2200/**
2201 * Hide a window.
2202 *
2203 * \param window the window to hide.
2204 * \returns true on success or false on failure; call SDL_GetError() for more
2205 * information.
2206 *
2207 * \threadsafety This function should only be called on the main thread.
2208 *
2209 * \since This function is available since SDL 3.2.0.
2210 *
2211 * \sa SDL_ShowWindow
2212 * \sa SDL_WINDOW_HIDDEN
2213 */
2214extern SDL_DECLSPEC bool SDLCALL SDL_HideWindow(SDL_Window *window);
2215
2216/**
2217 * Request that a window be raised above other windows and gain the input
2218 * focus.
2219 *
2220 * The result of this request is subject to desktop window manager policy,
2221 * particularly if raising the requested window would result in stealing focus
2222 * from another application. If the window is successfully raised and gains
2223 * input focus, an SDL_EVENT_WINDOW_FOCUS_GAINED event will be emitted, and
2224 * the window will have the SDL_WINDOW_INPUT_FOCUS flag set.
2225 *
2226 * \param window the window to raise.
2227 * \returns true on success or false on failure; call SDL_GetError() for more
2228 * information.
2229 *
2230 * \threadsafety This function should only be called on the main thread.
2231 *
2232 * \since This function is available since SDL 3.2.0.
2233 */
2234extern SDL_DECLSPEC bool SDLCALL SDL_RaiseWindow(SDL_Window *window);
2235
2236/**
2237 * Request that the window be made as large as possible.
2238 *
2239 * Non-resizable windows can't be maximized. The window must have the
2240 * SDL_WINDOW_RESIZABLE flag set, or this will have no effect.
2241 *
2242 * On some windowing systems this request is asynchronous and the new window
2243 * state may not have have been applied immediately upon the return of this
2244 * function. If an immediate change is required, call SDL_SyncWindow() to
2245 * block until the changes have taken effect.
2246 *
2247 * When the window state changes, an SDL_EVENT_WINDOW_MAXIMIZED event will be
2248 * emitted. Note that, as this is just a request, the windowing system can
2249 * deny the state change.
2250 *
2251 * When maximizing a window, whether the constraints set via
2252 * SDL_SetWindowMaximumSize() are honored depends on the policy of the window
2253 * manager. Win32 and macOS enforce the constraints when maximizing, while X11
2254 * and Wayland window managers may vary.
2255 *
2256 * \param window the window to maximize.
2257 * \returns true on success or false on failure; call SDL_GetError() for more
2258 * information.
2259 *
2260 * \threadsafety This function should only be called on the main thread.
2261 *
2262 * \since This function is available since SDL 3.2.0.
2263 *
2264 * \sa SDL_MinimizeWindow
2265 * \sa SDL_RestoreWindow
2266 * \sa SDL_SyncWindow
2267 */
2268extern SDL_DECLSPEC bool SDLCALL SDL_MaximizeWindow(SDL_Window *window);
2269
2270/**
2271 * Request that the window be minimized to an iconic representation.
2272 *
2273 * If the window is in a fullscreen state, this request has no direct effect.
2274 * It may alter the state the window is returned to when leaving fullscreen.
2275 *
2276 * On some windowing systems this request is asynchronous and the new window
2277 * state may not have been applied immediately upon the return of this
2278 * function. If an immediate change is required, call SDL_SyncWindow() to
2279 * block until the changes have taken effect.
2280 *
2281 * When the window state changes, an SDL_EVENT_WINDOW_MINIMIZED event will be
2282 * emitted. Note that, as this is just a request, the windowing system can
2283 * deny the state change.
2284 *
2285 * \param window the window to minimize.
2286 * \returns true on success or false on failure; call SDL_GetError() for more
2287 * information.
2288 *
2289 * \threadsafety This function should only be called on the main thread.
2290 *
2291 * \since This function is available since SDL 3.2.0.
2292 *
2293 * \sa SDL_MaximizeWindow
2294 * \sa SDL_RestoreWindow
2295 * \sa SDL_SyncWindow
2296 */
2297extern SDL_DECLSPEC bool SDLCALL SDL_MinimizeWindow(SDL_Window *window);
2298
2299/**
2300 * Request that the size and position of a minimized or maximized window be
2301 * restored.
2302 *
2303 * If the window is in a fullscreen state, this request has no direct effect.
2304 * It may alter the state the window is returned to when leaving fullscreen.
2305 *
2306 * On some windowing systems this request is asynchronous and the new window
2307 * state may not have have been applied immediately upon the return of this
2308 * function. If an immediate change is required, call SDL_SyncWindow() to
2309 * block until the changes have taken effect.
2310 *
2311 * When the window state changes, an SDL_EVENT_WINDOW_RESTORED event will be
2312 * emitted. Note that, as this is just a request, the windowing system can
2313 * deny the state change.
2314 *
2315 * \param window the window to restore.
2316 * \returns true on success or false on failure; call SDL_GetError() for more
2317 * information.
2318 *
2319 * \threadsafety This function should only be called on the main thread.
2320 *
2321 * \since This function is available since SDL 3.2.0.
2322 *
2323 * \sa SDL_MaximizeWindow
2324 * \sa SDL_MinimizeWindow
2325 * \sa SDL_SyncWindow
2326 */
2327extern SDL_DECLSPEC bool SDLCALL SDL_RestoreWindow(SDL_Window *window);
2328
2329/**
2330 * Request that the window's fullscreen state be changed.
2331 *
2332 * By default a window in fullscreen state uses borderless fullscreen desktop
2333 * mode, but a specific exclusive display mode can be set using
2334 * SDL_SetWindowFullscreenMode().
2335 *
2336 * On some windowing systems this request is asynchronous and the new
2337 * fullscreen state may not have have been applied immediately upon the return
2338 * of this function. If an immediate change is required, call SDL_SyncWindow()
2339 * to block until the changes have taken effect.
2340 *
2341 * When the window state changes, an SDL_EVENT_WINDOW_ENTER_FULLSCREEN or
2342 * SDL_EVENT_WINDOW_LEAVE_FULLSCREEN event will be emitted. Note that, as this
2343 * is just a request, it can be denied by the windowing system.
2344 *
2345 * \param window the window to change.
2346 * \param fullscreen true for fullscreen mode, false for windowed mode.
2347 * \returns true on success or false on failure; call SDL_GetError() for more
2348 * information.
2349 *
2350 * \threadsafety This function should only be called on the main thread.
2351 *
2352 * \since This function is available since SDL 3.2.0.
2353 *
2354 * \sa SDL_GetWindowFullscreenMode
2355 * \sa SDL_SetWindowFullscreenMode
2356 * \sa SDL_SyncWindow
2357 * \sa SDL_WINDOW_FULLSCREEN
2358 */
2359extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, bool fullscreen);
2360
2361/**
2362 * Block until any pending window state is finalized.
2363 *
2364 * On asynchronous windowing systems, this acts as a synchronization barrier
2365 * for pending window state. It will attempt to wait until any pending window
2366 * state has been applied and is guaranteed to return within finite time. Note
2367 * that for how long it can potentially block depends on the underlying window
2368 * system, as window state changes may involve somewhat lengthy animations
2369 * that must complete before the window is in its final requested state.
2370 *
2371 * On windowing systems where changes are immediate, this does nothing.
2372 *
2373 * \param window the window for which to wait for the pending state to be
2374 * applied.
2375 * \returns true on success or false if the operation timed out before the
2376 * window was in the requested state.
2377 *
2378 * \threadsafety This function should only be called on the main thread.
2379 *
2380 * \since This function is available since SDL 3.2.0.
2381 *
2382 * \sa SDL_SetWindowSize
2383 * \sa SDL_SetWindowPosition
2384 * \sa SDL_SetWindowFullscreen
2385 * \sa SDL_MinimizeWindow
2386 * \sa SDL_MaximizeWindow
2387 * \sa SDL_RestoreWindow
2388 * \sa SDL_HINT_VIDEO_SYNC_WINDOW_OPERATIONS
2389 */
2390extern SDL_DECLSPEC bool SDLCALL SDL_SyncWindow(SDL_Window *window);
2391
2392/**
2393 * Return whether the window has a surface associated with it.
2394 *
2395 * \param window the window to query.
2396 * \returns true if there is a surface associated with the window, or false
2397 * otherwise.
2398 *
2399 * \threadsafety This function should only be called on the main thread.
2400 *
2401 * \since This function is available since SDL 3.2.0.
2402 *
2403 * \sa SDL_GetWindowSurface
2404 */
2405extern SDL_DECLSPEC bool SDLCALL SDL_WindowHasSurface(SDL_Window *window);
2406
2407/**
2408 * Get the SDL surface associated with the window.
2409 *
2410 * A new surface will be created with the optimal format for the window, if
2411 * necessary. This surface will be freed when the window is destroyed. Do not
2412 * free this surface.
2413 *
2414 * This surface will be invalidated if the window is resized. After resizing a
2415 * window this function must be called again to return a valid surface.
2416 *
2417 * You may not combine this with 3D or the rendering API on this window.
2418 *
2419 * This function is affected by `SDL_HINT_FRAMEBUFFER_ACCELERATION`.
2420 *
2421 * \param window the window to query.
2422 * \returns the surface associated with the window, or NULL on failure; call
2423 * SDL_GetError() for more information.
2424 *
2425 * \threadsafety This function should only be called on the main thread.
2426 *
2427 * \since This function is available since SDL 3.2.0.
2428 *
2429 * \sa SDL_DestroyWindowSurface
2430 * \sa SDL_WindowHasSurface
2431 * \sa SDL_UpdateWindowSurface
2432 * \sa SDL_UpdateWindowSurfaceRects
2433 */
2434extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window *window);
2435
2436/**
2437 * Toggle VSync for the window surface.
2438 *
2439 * When a window surface is created, vsync defaults to
2440 * SDL_WINDOW_SURFACE_VSYNC_DISABLED.
2441 *
2442 * The `vsync` parameter can be 1 to synchronize present with every vertical
2443 * refresh, 2 to synchronize present with every second vertical refresh, etc.,
2444 * SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync),
2445 * or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is
2446 * supported by every driver, so you should check the return value to see
2447 * whether the requested setting is supported.
2448 *
2449 * \param window the window.
2450 * \param vsync the vertical refresh sync interval.
2451 * \returns true on success or false on failure; call SDL_GetError() for more
2452 * information.
2453 *
2454 * \threadsafety This function should only be called on the main thread.
2455 *
2456 * \since This function is available since SDL 3.2.0.
2457 *
2458 * \sa SDL_GetWindowSurfaceVSync
2459 */
2460extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSurfaceVSync(SDL_Window *window, int vsync);
2461
2462#define SDL_WINDOW_SURFACE_VSYNC_DISABLED 0
2463#define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE (-1)
2464
2465/**
2466 * Get VSync for the window surface.
2467 *
2468 * \param window the window to query.
2469 * \param vsync an int filled with the current vertical refresh sync interval.
2470 * See SDL_SetWindowSurfaceVSync() for the meaning of the value.
2471 * \returns true on success or false on failure; call SDL_GetError() for more
2472 * information.
2473 *
2474 * \threadsafety This function should only be called on the main thread.
2475 *
2476 * \since This function is available since SDL 3.2.0.
2477 *
2478 * \sa SDL_SetWindowSurfaceVSync
2479 */
2480extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSurfaceVSync(SDL_Window *window, int *vsync);
2481
2482/**
2483 * Copy the window surface to the screen.
2484 *
2485 * This is the function you use to reflect any changes to the surface on the
2486 * screen.
2487 *
2488 * This function is equivalent to the SDL 1.2 API SDL_Flip().
2489 *
2490 * \param window the window to update.
2491 * \returns true on success or false on failure; call SDL_GetError() for more
2492 * information.
2493 *
2494 * \threadsafety This function should only be called on the main thread.
2495 *
2496 * \since This function is available since SDL 3.2.0.
2497 *
2498 * \sa SDL_GetWindowSurface
2499 * \sa SDL_UpdateWindowSurfaceRects
2500 */
2501extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurface(SDL_Window *window);
2502
2503/**
2504 * Copy areas of the window surface to the screen.
2505 *
2506 * This is the function you use to reflect changes to portions of the surface
2507 * on the screen.
2508 *
2509 * This function is equivalent to the SDL 1.2 API SDL_UpdateRects().
2510 *
2511 * Note that this function will update _at least_ the rectangles specified,
2512 * but this is only intended as an optimization; in practice, this might
2513 * update more of the screen (or all of the screen!), depending on what method
2514 * SDL uses to send pixels to the system.
2515 *
2516 * \param window the window to update.
2517 * \param rects an array of SDL_Rect structures representing areas of the
2518 * surface to copy, in pixels.
2519 * \param numrects the number of rectangles.
2520 * \returns true on success or false on failure; call SDL_GetError() for more
2521 * information.
2522 *
2523 * \threadsafety This function should only be called on the main thread.
2524 *
2525 * \since This function is available since SDL 3.2.0.
2526 *
2527 * \sa SDL_GetWindowSurface
2528 * \sa SDL_UpdateWindowSurface
2529 */
2530extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects);
2531
2532/**
2533 * Destroy the surface associated with the window.
2534 *
2535 * \param window the window to update.
2536 * \returns true on success or false on failure; call SDL_GetError() for more
2537 * information.
2538 *
2539 * \threadsafety This function should only be called on the main thread.
2540 *
2541 * \since This function is available since SDL 3.2.0.
2542 *
2543 * \sa SDL_GetWindowSurface
2544 * \sa SDL_WindowHasSurface
2545 */
2546extern SDL_DECLSPEC bool SDLCALL SDL_DestroyWindowSurface(SDL_Window *window);
2547
2548/**
2549 * Set a window's keyboard grab mode.
2550 *
2551 * Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or
2552 * the Meta/Super key. Note that not all system keyboard shortcuts can be
2553 * captured by applications (one example is Ctrl+Alt+Del on Windows).
2554 *
2555 * This is primarily intended for specialized applications such as VNC clients
2556 * or VM frontends. Normal games should not use keyboard grab.
2557 *
2558 * When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the
2559 * window is full-screen to ensure the user is not trapped in your
2560 * application. If you have a custom keyboard shortcut to exit fullscreen
2561 * mode, you may suppress this behavior with
2562 * `SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED`.
2563 *
2564 * If the caller enables a grab while another window is currently grabbed, the
2565 * other window loses its grab in favor of the caller's window.
2566 *
2567 * \param window the window for which the keyboard grab mode should be set.
2568 * \param grabbed this is true to grab keyboard, and false to release.
2569 * \returns true on success or false on failure; call SDL_GetError() for more
2570 * information.
2571 *
2572 * \threadsafety This function should only be called on the main thread.
2573 *
2574 * \since This function is available since SDL 3.2.0.
2575 *
2576 * \sa SDL_GetWindowKeyboardGrab
2577 * \sa SDL_SetWindowMouseGrab
2578 */
2579extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window *window, bool grabbed);
2580
2581/**
2582 * Set a window's mouse grab mode.
2583 *
2584 * Mouse grab confines the mouse cursor to the window.
2585 *
2586 * \param window the window for which the mouse grab mode should be set.
2587 * \param grabbed this is true to grab mouse, and false to release.
2588 * \returns true on success or false on failure; call SDL_GetError() for more
2589 * information.
2590 *
2591 * \threadsafety This function should only be called on the main thread.
2592 *
2593 * \since This function is available since SDL 3.2.0.
2594 *
2595 * \sa SDL_GetWindowMouseRect
2596 * \sa SDL_SetWindowMouseRect
2597 * \sa SDL_SetWindowKeyboardGrab
2598 */
2599extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMouseGrab(SDL_Window *window, bool grabbed);
2600
2601/**
2602 * Get a window's keyboard grab mode.
2603 *
2604 * \param window the window to query.
2605 * \returns true if keyboard is grabbed, and false otherwise.
2606 *
2607 * \threadsafety This function should only be called on the main thread.
2608 *
2609 * \since This function is available since SDL 3.2.0.
2610 *
2611 * \sa SDL_SetWindowKeyboardGrab
2612 */
2613extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window *window);
2614
2615/**
2616 * Get a window's mouse grab mode.
2617 *
2618 * \param window the window to query.
2619 * \returns true if mouse is grabbed, and false otherwise.
2620 *
2621 * \threadsafety This function should only be called on the main thread.
2622 *
2623 * \since This function is available since SDL 3.2.0.
2624 *
2625 * \sa SDL_GetWindowMouseRect
2626 * \sa SDL_SetWindowMouseRect
2627 * \sa SDL_SetWindowMouseGrab
2628 * \sa SDL_SetWindowKeyboardGrab
2629 */
2630extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMouseGrab(SDL_Window *window);
2631
2632/**
2633 * Get the window that currently has an input grab enabled.
2634 *
2635 * \returns the window if input is grabbed or NULL otherwise.
2636 *
2637 * \threadsafety This function should only be called on the main thread.
2638 *
2639 * \since This function is available since SDL 3.2.0.
2640 *
2641 * \sa SDL_SetWindowMouseGrab
2642 * \sa SDL_SetWindowKeyboardGrab
2643 */
2644extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void);
2645
2646/**
2647 * Confines the cursor to the specified area of a window.
2648 *
2649 * Note that this does NOT grab the cursor, it only defines the area a cursor
2650 * is restricted to when the window has mouse focus.
2651 *
2652 * \param window the window that will be associated with the barrier.
2653 * \param rect a rectangle area in window-relative coordinates. If NULL the
2654 * barrier for the specified window will be destroyed.
2655 * \returns true on success or false on failure; call SDL_GetError() for more
2656 * information.
2657 *
2658 * \threadsafety This function should only be called on the main thread.
2659 *
2660 * \since This function is available since SDL 3.2.0.
2661 *
2662 * \sa SDL_GetWindowMouseRect
2663 * \sa SDL_GetWindowMouseGrab
2664 * \sa SDL_SetWindowMouseGrab
2665 */
2666extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect);
2667
2668/**
2669 * Get the mouse confinement rectangle of a window.
2670 *
2671 * \param window the window to query.
2672 * \returns a pointer to the mouse confinement rectangle of a window, or NULL
2673 * if there isn't one.
2674 *
2675 * \threadsafety This function should only be called on the main thread.
2676 *
2677 * \since This function is available since SDL 3.2.0.
2678 *
2679 * \sa SDL_SetWindowMouseRect
2680 * \sa SDL_GetWindowMouseGrab
2681 * \sa SDL_SetWindowMouseGrab
2682 */
2683extern SDL_DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window *window);
2684
2685/**
2686 * Set the opacity for a window.
2687 *
2688 * The parameter `opacity` will be clamped internally between 0.0f
2689 * (transparent) and 1.0f (opaque).
2690 *
2691 * This function also returns false if setting the opacity isn't supported.
2692 *
2693 * \param window the window which will be made transparent or opaque.
2694 * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque).
2695 * \returns true on success or false on failure; call SDL_GetError() for more
2696 * information.
2697 *
2698 * \threadsafety This function should only be called on the main thread.
2699 *
2700 * \since This function is available since SDL 3.2.0.
2701 *
2702 * \sa SDL_GetWindowOpacity
2703 */
2704extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowOpacity(SDL_Window *window, float opacity);
2705
2706/**
2707 * Get the opacity of a window.
2708 *
2709 * If transparency isn't supported on this platform, opacity will be returned
2710 * as 1.0f without error.
2711 *
2712 * \param window the window to get the current opacity value from.
2713 * \returns the opacity, (0.0f - transparent, 1.0f - opaque), or -1.0f on
2714 * failure; call SDL_GetError() for more information.
2715 *
2716 * \threadsafety This function should only be called on the main thread.
2717 *
2718 * \since This function is available since SDL 3.2.0.
2719 *
2720 * \sa SDL_SetWindowOpacity
2721 */
2722extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window);
2723
2724/**
2725 * Set the window as a child of a parent window.
2726 *
2727 * If the window is already the child of an existing window, it will be
2728 * reparented to the new owner. Setting the parent window to NULL unparents
2729 * the window and removes child window status.
2730 *
2731 * If a parent window is hidden or destroyed, the operation will be
2732 * recursively applied to child windows. Child windows hidden with the parent
2733 * that did not have their hidden status explicitly set will be restored when
2734 * the parent is shown.
2735 *
2736 * Attempting to set the parent of a window that is currently in the modal
2737 * state will fail. Use SDL_SetWindowModal() to cancel the modal status before
2738 * attempting to change the parent.
2739 *
2740 * Popup windows cannot change parents and attempts to do so will fail.
2741 *
2742 * Setting a parent window that is currently the sibling or descendent of the
2743 * child window results in undefined behavior.
2744 *
2745 * \param window the window that should become the child of a parent.
2746 * \param parent the new parent window for the child window.
2747 * \returns true on success or false on failure; call SDL_GetError() for more
2748 * information.
2749 *
2750 * \threadsafety This function should only be called on the main thread.
2751 *
2752 * \since This function is available since SDL 3.2.0.
2753 *
2754 * \sa SDL_SetWindowModal
2755 */
2756extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowParent(SDL_Window *window, SDL_Window *parent);
2757
2758/**
2759 * Toggle the state of the window as modal.
2760 *
2761 * To enable modal status on a window, the window must currently be the child
2762 * window of a parent, or toggling modal status on will fail.
2763 *
2764 * \param window the window on which to set the modal state.
2765 * \param modal true to toggle modal status on, false to toggle it off.
2766 * \returns true on success or false on failure; call SDL_GetError() for more
2767 * information.
2768 *
2769 * \threadsafety This function should only be called on the main thread.
2770 *
2771 * \since This function is available since SDL 3.2.0.
2772 *
2773 * \sa SDL_SetWindowParent
2774 * \sa SDL_WINDOW_MODAL
2775 */
2776extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowModal(SDL_Window *window, bool modal);
2777
2778/**
2779 * Set whether the window may have input focus.
2780 *
2781 * \param window the window to set focusable state.
2782 * \param focusable true to allow input focus, false to not allow input focus.
2783 * \returns true on success or false on failure; call SDL_GetError() for more
2784 * information.
2785 *
2786 * \threadsafety This function should only be called on the main thread.
2787 *
2788 * \since This function is available since SDL 3.2.0.
2789 */
2790extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFocusable(SDL_Window *window, bool focusable);
2791
2792
2793/**
2794 * Display the system-level window menu.
2795 *
2796 * This default window menu is provided by the system and on some platforms
2797 * provides functionality for setting or changing privileged state on the
2798 * window, such as moving it between workspaces or displays, or toggling the
2799 * always-on-top property.
2800 *
2801 * On platforms or desktops where this is unsupported, this function does
2802 * nothing.
2803 *
2804 * \param window the window for which the menu will be displayed.
2805 * \param x the x coordinate of the menu, relative to the origin (top-left) of
2806 * the client area.
2807 * \param y the y coordinate of the menu, relative to the origin (top-left) of
2808 * the client area.
2809 * \returns true on success or false on failure; call SDL_GetError() for more
2810 * information.
2811 *
2812 * \threadsafety This function should only be called on the main thread.
2813 *
2814 * \since This function is available since SDL 3.2.0.
2815 */
2816extern SDL_DECLSPEC bool SDLCALL SDL_ShowWindowSystemMenu(SDL_Window *window, int x, int y);
2817
2818/**
2819 * Possible return values from the SDL_HitTest callback.
2820 *
2821 * \threadsafety This function should only be called on the main thread.
2822 *
2823 * \since This enum is available since SDL 3.2.0.
2824 *
2825 * \sa SDL_HitTest
2826 */
2827typedef enum SDL_HitTestResult
2828{
2829 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
2830 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
2831 SDL_HITTEST_RESIZE_TOPLEFT, /**< Region is the resizable top-left corner border. */
2832 SDL_HITTEST_RESIZE_TOP, /**< Region is the resizable top border. */
2833 SDL_HITTEST_RESIZE_TOPRIGHT, /**< Region is the resizable top-right corner border. */
2834 SDL_HITTEST_RESIZE_RIGHT, /**< Region is the resizable right border. */
2835 SDL_HITTEST_RESIZE_BOTTOMRIGHT, /**< Region is the resizable bottom-right corner border. */
2836 SDL_HITTEST_RESIZE_BOTTOM, /**< Region is the resizable bottom border. */
2837 SDL_HITTEST_RESIZE_BOTTOMLEFT, /**< Region is the resizable bottom-left corner border. */
2838 SDL_HITTEST_RESIZE_LEFT /**< Region is the resizable left border. */
2839} SDL_HitTestResult;
2840
2841/**
2842 * Callback used for hit-testing.
2843 *
2844 * \param win the SDL_Window where hit-testing was set on.
2845 * \param area an SDL_Point which should be hit-tested.
2846 * \param data what was passed as `callback_data` to SDL_SetWindowHitTest().
2847 * \returns an SDL_HitTestResult value.
2848 *
2849 * \sa SDL_SetWindowHitTest
2850 */
2851typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
2852 const SDL_Point *area,
2853 void *data);
2854
2855/**
2856 * Provide a callback that decides if a window region has special properties.
2857 *
2858 * Normally windows are dragged and resized by decorations provided by the
2859 * system window manager (a title bar, borders, etc), but for some apps, it
2860 * makes sense to drag them from somewhere else inside the window itself; for
2861 * example, one might have a borderless window that wants to be draggable from
2862 * any part, or simulate its own title bar, etc.
2863 *
2864 * This function lets the app provide a callback that designates pieces of a
2865 * given window as special. This callback is run during event processing if we
2866 * need to tell the OS to treat a region of the window specially; the use of
2867 * this callback is known as "hit testing."
2868 *
2869 * Mouse input may not be delivered to your application if it is within a
2870 * special area; the OS will often apply that input to moving the window or
2871 * resizing the window and not deliver it to the application.
2872 *
2873 * Specifying NULL for a callback disables hit-testing. Hit-testing is
2874 * disabled by default.
2875 *
2876 * Platforms that don't support this functionality will return false
2877 * unconditionally, even if you're attempting to disable hit-testing.
2878 *
2879 * Your callback may fire at any time, and its firing does not indicate any
2880 * specific behavior (for example, on Windows, this certainly might fire when
2881 * the OS is deciding whether to drag your window, but it fires for lots of
2882 * other reasons, too, some unrelated to anything you probably care about _and
2883 * when the mouse isn't actually at the location it is testing_). Since this
2884 * can fire at any time, you should try to keep your callback efficient,
2885 * devoid of allocations, etc.
2886 *
2887 * \param window the window to set hit-testing on.
2888 * \param callback the function to call when doing a hit-test.
2889 * \param callback_data an app-defined void pointer passed to **callback**.
2890 * \returns true on success or false on failure; call SDL_GetError() for more
2891 * information.
2892 *
2893 * \threadsafety This function should only be called on the main thread.
2894 *
2895 * \since This function is available since SDL 3.2.0.
2896 */
2897extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data);
2898
2899/**
2900 * Set the shape of a transparent window.
2901 *
2902 * This sets the alpha channel of a transparent window and any fully
2903 * transparent areas are also transparent to mouse clicks. If you are using
2904 * something besides the SDL render API, then you are responsible for drawing
2905 * the alpha channel of the window to match the shape alpha channel to get
2906 * consistent cross-platform results.
2907 *
2908 * The shape is copied inside this function, so you can free it afterwards. If
2909 * your shape surface changes, you should call SDL_SetWindowShape() again to
2910 * update the window. This is an expensive operation, so should be done
2911 * sparingly.
2912 *
2913 * The window must have been created with the SDL_WINDOW_TRANSPARENT flag.
2914 *
2915 * \param window the window.
2916 * \param shape the surface representing the shape of the window, or NULL to
2917 * remove any current shape.
2918 * \returns true on success or false on failure; call SDL_GetError() for more
2919 * information.
2920 *
2921 * \threadsafety This function should only be called on the main thread.
2922 *
2923 * \since This function is available since SDL 3.2.0.
2924 */
2925extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surface *shape);
2926
2927/**
2928 * Request a window to demand attention from the user.
2929 *
2930 * \param window the window to be flashed.
2931 * \param operation the operation to perform.
2932 * \returns true on success or false on failure; call SDL_GetError() for more
2933 * information.
2934 *
2935 * \threadsafety This function should only be called on the main thread.
2936 *
2937 * \since This function is available since SDL 3.2.0.
2938 */
2939extern SDL_DECLSPEC bool SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation);
2940
2941/**
2942 * Sets the state of the progress bar for the given window’s taskbar icon.
2943 *
2944 * \param window the window whose progress state is to be modified.
2945 * \param state the progress state. `SDL_PROGRESS_STATE_NONE` stops displaying
2946 * the progress bar.
2947 * \returns true on success or false on failure; call SDL_GetError() for more
2948 * information.
2949 *
2950 * \threadsafety This function should only be called on the main thread.
2951 *
2952 * \since This function is available since SDL 3.4.0.
2953 */
2954extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowProgressState(SDL_Window *window, SDL_ProgressState state);
2955
2956/**
2957 * Get the state of the progress bar for the given window’s taskbar icon.
2958 *
2959 * \param window the window to get the current progress state from.
2960 * \returns the progress state, or `SDL_PROGRESS_STATE_INVALID` on failure;
2961 * call SDL_GetError() for more information.
2962 *
2963 * \threadsafety This function should only be called on the main thread.
2964 *
2965 * \since This function is available since SDL 3.4.0.
2966 */
2967extern SDL_DECLSPEC SDL_ProgressState SDLCALL SDL_GetWindowProgressState(SDL_Window *window);
2968
2969/**
2970 * Sets the value of the progress bar for the given window’s taskbar icon.
2971 *
2972 * \param window the window whose progress value is to be modified.
2973 * \param value the progress value in the range of [0.0f - 1.0f]. If the value
2974 * is outside the valid range, it gets clamped.
2975 * \returns true on success or false on failure; call SDL_GetError() for more
2976 * information.
2977 *
2978 * \threadsafety This function should only be called on the main thread.
2979 *
2980 * \since This function is available since SDL 3.4.0.
2981 */
2982extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowProgressValue(SDL_Window *window, float value);
2983
2984/**
2985 * Get the value of the progress bar for the given window’s taskbar icon.
2986 *
2987 * \param window the window to get the current progress value from.
2988 * \returns the progress value in the range of [0.0f - 1.0f], or -1.0f on
2989 * failure; call SDL_GetError() for more information.
2990 *
2991 * \threadsafety This function should only be called on the main thread.
2992 *
2993 * \since This function is available since SDL 3.4.0.
2994 */
2995extern SDL_DECLSPEC float SDLCALL SDL_GetWindowProgressValue(SDL_Window *window);
2996
2997/**
2998 * Destroy a window.
2999 *
3000 * Any child windows owned by the window will be recursively destroyed as
3001 * well.
3002 *
3003 * Note that on some platforms, the visible window may not actually be removed
3004 * from the screen until the SDL event loop is pumped again, even though the
3005 * SDL_Window is no longer valid after this call.
3006 *
3007 * \param window the window to destroy.
3008 *
3009 * \threadsafety This function should only be called on the main thread.
3010 *
3011 * \since This function is available since SDL 3.2.0.
3012 *
3013 * \sa SDL_CreatePopupWindow
3014 * \sa SDL_CreateWindow
3015 * \sa SDL_CreateWindowWithProperties
3016 */
3017extern SDL_DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window *window);
3018
3019
3020/**
3021 * Check whether the screensaver is currently enabled.
3022 *
3023 * The screensaver is disabled by default.
3024 *
3025 * The default can also be changed using `SDL_HINT_VIDEO_ALLOW_SCREENSAVER`.
3026 *
3027 * \returns true if the screensaver is enabled, false if it is disabled.
3028 *
3029 * \threadsafety This function should only be called on the main thread.
3030 *
3031 * \since This function is available since SDL 3.2.0.
3032 *
3033 * \sa SDL_DisableScreenSaver
3034 * \sa SDL_EnableScreenSaver
3035 */
3036extern SDL_DECLSPEC bool SDLCALL SDL_ScreenSaverEnabled(void);
3037
3038/**
3039 * Allow the screen to be blanked by a screen saver.
3040 *
3041 * \returns true on success or false on failure; call SDL_GetError() for more
3042 * information.
3043 *
3044 * \threadsafety This function should only be called on the main thread.
3045 *
3046 * \since This function is available since SDL 3.2.0.
3047 *
3048 * \sa SDL_DisableScreenSaver
3049 * \sa SDL_ScreenSaverEnabled
3050 */
3051extern SDL_DECLSPEC bool SDLCALL SDL_EnableScreenSaver(void);
3052
3053/**
3054 * Prevent the screen from being blanked by a screen saver.
3055 *
3056 * If you disable the screensaver, it is automatically re-enabled when SDL
3057 * quits.
3058 *
3059 * The screensaver is disabled by default, but this may by changed by
3060 * SDL_HINT_VIDEO_ALLOW_SCREENSAVER.
3061 *
3062 * \returns true on success or false on failure; call SDL_GetError() for more
3063 * information.
3064 *
3065 * \threadsafety This function should only be called on the main thread.
3066 *
3067 * \since This function is available since SDL 3.2.0.
3068 *
3069 * \sa SDL_EnableScreenSaver
3070 * \sa SDL_ScreenSaverEnabled
3071 */
3072extern SDL_DECLSPEC bool SDLCALL SDL_DisableScreenSaver(void);
3073
3074
3075/**
3076 * \name OpenGL support functions
3077 */
3078/* @{ */
3079
3080/**
3081 * Dynamically load an OpenGL library.
3082 *
3083 * This should be done after initializing the video driver, but before
3084 * creating any OpenGL windows. If no OpenGL library is loaded, the default
3085 * library will be loaded upon creation of the first OpenGL window.
3086 *
3087 * If you do this, you need to retrieve all of the GL functions used in your
3088 * program from the dynamic library using SDL_GL_GetProcAddress().
3089 *
3090 * \param path the platform dependent OpenGL library name, or NULL to open the
3091 * default OpenGL library.
3092 * \returns true on success or false on failure; call SDL_GetError() for more
3093 * information.
3094 *
3095 * \threadsafety This function should only be called on the main thread.
3096 *
3097 * \since This function is available since SDL 3.2.0.
3098 *
3099 * \sa SDL_GL_GetProcAddress
3100 * \sa SDL_GL_UnloadLibrary
3101 */
3102extern SDL_DECLSPEC bool SDLCALL SDL_GL_LoadLibrary(const char *path);
3103
3104/**
3105 * Get an OpenGL function by name.
3106 *
3107 * If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all
3108 * GL functions must be retrieved this way. Usually this is used to retrieve
3109 * function pointers to OpenGL extensions.
3110 *
3111 * There are some quirks to looking up OpenGL functions that require some
3112 * extra care from the application. If you code carefully, you can handle
3113 * these quirks without any platform-specific code, though:
3114 *
3115 * - On Windows, function pointers are specific to the current GL context;
3116 * this means you need to have created a GL context and made it current
3117 * before calling SDL_GL_GetProcAddress(). If you recreate your context or
3118 * create a second context, you should assume that any existing function
3119 * pointers aren't valid to use with it. This is (currently) a
3120 * Windows-specific limitation, and in practice lots of drivers don't suffer
3121 * this limitation, but it is still the way the wgl API is documented to
3122 * work and you should expect crashes if you don't respect it. Store a copy
3123 * of the function pointers that comes and goes with context lifespan.
3124 * - On X11, function pointers returned by this function are valid for any
3125 * context, and can even be looked up before a context is created at all.
3126 * This means that, for at least some common OpenGL implementations, if you
3127 * look up a function that doesn't exist, you'll get a non-NULL result that
3128 * is _NOT_ safe to call. You must always make sure the function is actually
3129 * available for a given GL context before calling it, by checking for the
3130 * existence of the appropriate extension with SDL_GL_ExtensionSupported(),
3131 * or verifying that the version of OpenGL you're using offers the function
3132 * as core functionality.
3133 * - Some OpenGL drivers, on all platforms, *will* return NULL if a function
3134 * isn't supported, but you can't count on this behavior. Check for
3135 * extensions you use, and if you get a NULL anyway, act as if that
3136 * extension wasn't available. This is probably a bug in the driver, but you
3137 * can code defensively for this scenario anyhow.
3138 * - Just because you're on Linux/Unix, don't assume you'll be using X11.
3139 * Next-gen display servers are waiting to replace it, and may or may not
3140 * make the same promises about function pointers.
3141 * - OpenGL function pointers must be declared `APIENTRY` as in the example
3142 * code. This will ensure the proper calling convention is followed on
3143 * platforms where this matters (Win32) thereby avoiding stack corruption.
3144 *
3145 * \param proc the name of an OpenGL function.
3146 * \returns a pointer to the named OpenGL function. The returned pointer
3147 * should be cast to the appropriate function signature.
3148 *
3149 * \threadsafety This function should only be called on the main thread.
3150 *
3151 * \since This function is available since SDL 3.2.0.
3152 *
3153 * \sa SDL_GL_ExtensionSupported
3154 * \sa SDL_GL_LoadLibrary
3155 * \sa SDL_GL_UnloadLibrary
3156 */
3157extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_GL_GetProcAddress(const char *proc);
3158
3159/**
3160 * Get an EGL library function by name.
3161 *
3162 * If an EGL library is loaded, this function allows applications to get entry
3163 * points for EGL functions. This is useful to provide to an EGL API and
3164 * extension loader.
3165 *
3166 * \param proc the name of an EGL function.
3167 * \returns a pointer to the named EGL function. The returned pointer should
3168 * be cast to the appropriate function signature.
3169 *
3170 * \threadsafety This function should only be called on the main thread.
3171 *
3172 * \since This function is available since SDL 3.2.0.
3173 *
3174 * \sa SDL_EGL_GetCurrentDisplay
3175 */
3176extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_EGL_GetProcAddress(const char *proc);
3177
3178/**
3179 * Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
3180 *
3181 * \threadsafety This function should only be called on the main thread.
3182 *
3183 * \since This function is available since SDL 3.2.0.
3184 *
3185 * \sa SDL_GL_LoadLibrary
3186 */
3187extern SDL_DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
3188
3189/**
3190 * Check if an OpenGL extension is supported for the current context.
3191 *
3192 * This function operates on the current GL context; you must have created a
3193 * context and it must be current before calling this function. Do not assume
3194 * that all contexts you create will have the same set of extensions
3195 * available, or that recreating an existing context will offer the same
3196 * extensions again.
3197 *
3198 * While it's probably not a massive overhead, this function is not an O(1)
3199 * operation. Check the extensions you care about after creating the GL
3200 * context and save that information somewhere instead of calling the function
3201 * every time you need to know.
3202 *
3203 * \param extension the name of the extension to check.
3204 * \returns true if the extension is supported, false otherwise.
3205 *
3206 * \threadsafety This function should only be called on the main thread.
3207 *
3208 * \since This function is available since SDL 3.2.0.
3209 */
3210extern SDL_DECLSPEC bool SDLCALL SDL_GL_ExtensionSupported(const char *extension);
3211
3212/**
3213 * Reset all previously set OpenGL context attributes to their default values.
3214 *
3215 * \threadsafety This function should only be called on the main thread.
3216 *
3217 * \since This function is available since SDL 3.2.0.
3218 *
3219 * \sa SDL_GL_GetAttribute
3220 * \sa SDL_GL_SetAttribute
3221 */
3222extern SDL_DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
3223
3224/**
3225 * Set an OpenGL window attribute before window creation.
3226 *
3227 * This function sets the OpenGL attribute `attr` to `value`. The requested
3228 * attributes should be set before creating an OpenGL window. You should use
3229 * SDL_GL_GetAttribute() to check the values after creating the OpenGL
3230 * context, since the values obtained can differ from the requested ones.
3231 *
3232 * \param attr an enum value specifying the OpenGL attribute to set.
3233 * \param value the desired value for the attribute.
3234 * \returns true on success or false on failure; call SDL_GetError() for more
3235 * information.
3236 *
3237 * \threadsafety This function should only be called on the main thread.
3238 *
3239 * \since This function is available since SDL 3.2.0.
3240 *
3241 * \sa SDL_GL_CreateContext
3242 * \sa SDL_GL_GetAttribute
3243 * \sa SDL_GL_ResetAttributes
3244 */
3245extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetAttribute(SDL_GLAttr attr, int value);
3246
3247/**
3248 * Get the actual value for an attribute from the current context.
3249 *
3250 * \param attr an SDL_GLAttr enum value specifying the OpenGL attribute to
3251 * get.
3252 * \param value a pointer filled in with the current value of `attr`.
3253 * \returns true on success or false on failure; call SDL_GetError() for more
3254 * information.
3255 *
3256 * \threadsafety This function should only be called on the main thread.
3257 *
3258 * \since This function is available since SDL 3.2.0.
3259 *
3260 * \sa SDL_GL_ResetAttributes
3261 * \sa SDL_GL_SetAttribute
3262 */
3263extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetAttribute(SDL_GLAttr attr, int *value);
3264
3265/**
3266 * Create an OpenGL context for an OpenGL window, and make it current.
3267 *
3268 * The OpenGL context will be created with the current states set through
3269 * SDL_GL_SetAttribute().
3270 *
3271 * The SDL_Window specified must have been created with the SDL_WINDOW_OPENGL
3272 * flag, or context creation will fail.
3273 *
3274 * Windows users new to OpenGL should note that, for historical reasons, GL
3275 * functions added after OpenGL version 1.1 are not available by default.
3276 * Those functions must be loaded at run-time, either with an OpenGL
3277 * extension-handling library or with SDL_GL_GetProcAddress() and its related
3278 * functions.
3279 *
3280 * SDL_GLContext is opaque to the application.
3281 *
3282 * \param window the window to associate with the context.
3283 * \returns the OpenGL context associated with `window` or NULL on failure;
3284 * call SDL_GetError() for more information.
3285 *
3286 * \threadsafety This function should only be called on the main thread.
3287 *
3288 * \since This function is available since SDL 3.2.0.
3289 *
3290 * \sa SDL_GL_DestroyContext
3291 * \sa SDL_GL_MakeCurrent
3292 */
3293extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *window);
3294
3295/**
3296 * Set up an OpenGL context for rendering into an OpenGL window.
3297 *
3298 * The context must have been created with a compatible window.
3299 *
3300 * \param window the window to associate with the context.
3301 * \param context the OpenGL context to associate with the window.
3302 * \returns true on success or false on failure; call SDL_GetError() for more
3303 * information.
3304 *
3305 * \threadsafety This function should only be called on the main thread.
3306 *
3307 * \since This function is available since SDL 3.2.0.
3308 *
3309 * \sa SDL_GL_CreateContext
3310 */
3311extern SDL_DECLSPEC bool SDLCALL SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext context);
3312
3313/**
3314 * Get the currently active OpenGL window.
3315 *
3316 * \returns the currently active OpenGL window on success or NULL on failure;
3317 * call SDL_GetError() for more information.
3318 *
3319 * \threadsafety This function should only be called on the main thread.
3320 *
3321 * \since This function is available since SDL 3.2.0.
3322 */
3323extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GL_GetCurrentWindow(void);
3324
3325/**
3326 * Get the currently active OpenGL context.
3327 *
3328 * \returns the currently active OpenGL context or NULL on failure; call
3329 * SDL_GetError() for more information.
3330 *
3331 * \threadsafety This function should only be called on the main thread.
3332 *
3333 * \since This function is available since SDL 3.2.0.
3334 *
3335 * \sa SDL_GL_MakeCurrent
3336 */
3337extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
3338
3339/**
3340 * Get the currently active EGL display.
3341 *
3342 * \returns the currently active EGL display or NULL on failure; call
3343 * SDL_GetError() for more information.
3344 *
3345 * \threadsafety This function should only be called on the main thread.
3346 *
3347 * \since This function is available since SDL 3.2.0.
3348 */
3349extern SDL_DECLSPEC SDL_EGLDisplay SDLCALL SDL_EGL_GetCurrentDisplay(void);
3350
3351/**
3352 * Get the currently active EGL config.
3353 *
3354 * \returns the currently active EGL config or NULL on failure; call
3355 * SDL_GetError() for more information.
3356 *
3357 * \threadsafety This function should only be called on the main thread.
3358 *
3359 * \since This function is available since SDL 3.2.0.
3360 */
3361extern SDL_DECLSPEC SDL_EGLConfig SDLCALL SDL_EGL_GetCurrentConfig(void);
3362
3363/**
3364 * Get the EGL surface associated with the window.
3365 *
3366 * \param window the window to query.
3367 * \returns the EGLSurface pointer associated with the window, or NULL on
3368 * failure.
3369 *
3370 * \threadsafety This function should only be called on the main thread.
3371 *
3372 * \since This function is available since SDL 3.2.0.
3373 */
3374extern SDL_DECLSPEC SDL_EGLSurface SDLCALL SDL_EGL_GetWindowSurface(SDL_Window *window);
3375
3376/**
3377 * Sets the callbacks for defining custom EGLAttrib arrays for EGL
3378 * initialization.
3379 *
3380 * Callbacks that aren't needed can be set to NULL.
3381 *
3382 * NOTE: These callback pointers will be reset after SDL_GL_ResetAttributes.
3383 *
3384 * \param platformAttribCallback callback for attributes to pass to
3385 * eglGetPlatformDisplay. May be NULL.
3386 * \param surfaceAttribCallback callback for attributes to pass to
3387 * eglCreateSurface. May be NULL.
3388 * \param contextAttribCallback callback for attributes to pass to
3389 * eglCreateContext. May be NULL.
3390 * \param userdata a pointer that is passed to the callbacks.
3391 *
3392 * \threadsafety This function should only be called on the main thread.
3393 *
3394 * \since This function is available since SDL 3.2.0.
3395 */
3396extern SDL_DECLSPEC void SDLCALL SDL_EGL_SetAttributeCallbacks(SDL_EGLAttribArrayCallback platformAttribCallback,
3397 SDL_EGLIntArrayCallback surfaceAttribCallback,
3398 SDL_EGLIntArrayCallback contextAttribCallback, void *userdata);
3399
3400/**
3401 * Set the swap interval for the current OpenGL context.
3402 *
3403 * Some systems allow specifying -1 for the interval, to enable adaptive
3404 * vsync. Adaptive vsync works the same as vsync, but if you've already missed
3405 * the vertical retrace for a given frame, it swaps buffers immediately, which
3406 * might be less jarring for the user during occasional framerate drops. If an
3407 * application requests adaptive vsync and the system does not support it,
3408 * this function will fail and return false. In such a case, you should
3409 * probably retry the call with 1 for the interval.
3410 *
3411 * Adaptive vsync is implemented for some glX drivers with
3412 * GLX_EXT_swap_control_tear, and for some Windows drivers with
3413 * WGL_EXT_swap_control_tear.
3414 *
3415 * Read more on the Khronos wiki:
3416 * https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync
3417 *
3418 * \param interval 0 for immediate updates, 1 for updates synchronized with
3419 * the vertical retrace, -1 for adaptive vsync.
3420 * \returns true on success or false on failure; call SDL_GetError() for more
3421 * information.
3422 *
3423 * \threadsafety This function should only be called on the main thread.
3424 *
3425 * \since This function is available since SDL 3.2.0.
3426 *
3427 * \sa SDL_GL_GetSwapInterval
3428 */
3429extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetSwapInterval(int interval);
3430
3431/**
3432 * Get the swap interval for the current OpenGL context.
3433 *
3434 * If the system can't determine the swap interval, or there isn't a valid
3435 * current context, this function will set *interval to 0 as a safe default.
3436 *
3437 * \param interval output interval value. 0 if there is no vertical retrace
3438 * synchronization, 1 if the buffer swap is synchronized with
3439 * the vertical retrace, and -1 if late swaps happen
3440 * immediately instead of waiting for the next retrace.
3441 * \returns true on success or false on failure; call SDL_GetError() for more
3442 * information.
3443 *
3444 * \threadsafety This function should only be called on the main thread.
3445 *
3446 * \since This function is available since SDL 3.2.0.
3447 *
3448 * \sa SDL_GL_SetSwapInterval
3449 */
3450extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetSwapInterval(int *interval);
3451
3452/**
3453 * Update a window with OpenGL rendering.
3454 *
3455 * This is used with double-buffered OpenGL contexts, which are the default.
3456 *
3457 * On macOS, make sure you bind 0 to the draw framebuffer before swapping the
3458 * window, otherwise nothing will happen. If you aren't using
3459 * glBindFramebuffer(), this is the default and you won't have to do anything
3460 * extra.
3461 *
3462 * \param window the window to change.
3463 * \returns true on success or false on failure; call SDL_GetError() for more
3464 * information.
3465 *
3466 * \threadsafety This function should only be called on the main thread.
3467 *
3468 * \since This function is available since SDL 3.2.0.
3469 */
3470extern SDL_DECLSPEC bool SDLCALL SDL_GL_SwapWindow(SDL_Window *window);
3471
3472/**
3473 * Delete an OpenGL context.
3474 *
3475 * \param context the OpenGL context to be deleted.
3476 * \returns true on success or false on failure; call SDL_GetError() for more
3477 * information.
3478 *
3479 * \threadsafety This function should only be called on the main thread.
3480 *
3481 * \since This function is available since SDL 3.2.0.
3482 *
3483 * \sa SDL_GL_CreateContext
3484 */
3485extern SDL_DECLSPEC bool SDLCALL SDL_GL_DestroyContext(SDL_GLContext context);
3486
3487/* @} *//* OpenGL support functions */
3488
3489
3490/* Ends C function definitions when using C++ */
3491#ifdef __cplusplus
3492}
3493#endif
3494#include <SDL3/SDL_close_code.h>
3495
3496#endif /* SDL_video_h_ */
SDL_close_code.h
SDL_PixelFormat
SDL_PixelFormat
Definition SDL_pixels.h:549
SDL_PropertiesID
Uint32 SDL_PropertiesID
Definition SDL_properties.h:66
size
SDL_MALLOC size_t size
Definition SDL_stdinc.h:1366
SDL_FunctionPointer
void(* SDL_FunctionPointer)(void)
Definition SDL_stdinc.h:6176
Uint32
uint32_t Uint32
Definition SDL_stdinc.h:482
SDL_SystemTheme
SDL_SystemTheme
Definition SDL_video.h:111
SDL_GLContext
struct SDL_GLContextState * SDL_GLContext
Definition SDL_video.h:360
SDL_SetWindowSize
bool SDL_SetWindowSize(SDL_Window *window, int w, int h)
SDL_SetWindowFocusable
bool SDL_SetWindowFocusable(SDL_Window *window, bool focusable)
SDL_HitTestResult
SDL_HitTestResult
Definition SDL_video.h:2829
SDL_HITTEST_DRAGGABLE
@ SDL_HITTEST_DRAGGABLE
Definition SDL_video.h:2831
SDL_HITTEST_RESIZE_LEFT
@ SDL_HITTEST_RESIZE_LEFT
Definition SDL_video.h:2839
SDL_HITTEST_RESIZE_TOP
@ SDL_HITTEST_RESIZE_TOP
Definition SDL_video.h:2833
SDL_HITTEST_RESIZE_TOPRIGHT
@ SDL_HITTEST_RESIZE_TOPRIGHT
Definition SDL_video.h:2834
SDL_HITTEST_NORMAL
@ SDL_HITTEST_NORMAL
Definition SDL_video.h:2830
SDL_HITTEST_RESIZE_BOTTOM
@ SDL_HITTEST_RESIZE_BOTTOM
Definition SDL_video.h:2837
SDL_HITTEST_RESIZE_BOTTOMRIGHT
@ SDL_HITTEST_RESIZE_BOTTOMRIGHT
Definition SDL_video.h:2836
SDL_HITTEST_RESIZE_BOTTOMLEFT
@ SDL_HITTEST_RESIZE_BOTTOMLEFT
Definition SDL_video.h:2838
SDL_HITTEST_RESIZE_RIGHT
@ SDL_HITTEST_RESIZE_RIGHT
Definition SDL_video.h:2835
SDL_HITTEST_RESIZE_TOPLEFT
@ SDL_HITTEST_RESIZE_TOPLEFT
Definition SDL_video.h:2832
SDL_SetWindowFullscreenMode
bool SDL_SetWindowFullscreenMode(SDL_Window *window, const SDL_DisplayMode *mode)
SDL_GetDisplayForPoint
SDL_DisplayID SDL_GetDisplayForPoint(const SDL_Point *point)
SDL_GetClosestFullscreenDisplayMode
bool SDL_GetClosestFullscreenDisplayMode(SDL_DisplayID displayID, int w, int h, float refresh_rate, bool include_high_density_modes, SDL_DisplayMode *closest)
SDL_SetWindowShape
bool SDL_SetWindowShape(SDL_Window *window, SDL_Surface *shape)
SDL_SetWindowMouseRect
bool SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect)
SDL_SetWindowProgressState
bool SDL_SetWindowProgressState(SDL_Window *window, SDL_ProgressState state)
SDL_SetWindowHitTest
bool SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data)
SDL_SetWindowModal
bool SDL_SetWindowModal(SDL_Window *window, bool modal)
SDL_EGLIntArrayCallback
SDL_EGLint *(* SDL_EGLIntArrayCallback)(void *userdata, SDL_EGLDisplay display, SDL_EGLConfig config)
Definition SDL_video.h:451
SDL_DisableScreenSaver
bool SDL_DisableScreenSaver(void)
SDL_GetWindowSurface
SDL_Surface * SDL_GetWindowSurface(SDL_Window *window)
SDL_SetWindowResizable
bool SDL_SetWindowResizable(SDL_Window *window, bool resizable)
SDL_GetDisplayName
const char * SDL_GetDisplayName(SDL_DisplayID displayID)
SDL_GetWindowProgressValue
float SDL_GetWindowProgressValue(SDL_Window *window)
SDL_SetWindowIcon
bool SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon)
SDL_GLContextReleaseFlag
Uint32 SDL_GLContextReleaseFlag
Definition SDL_video.h:533
SDL_GetWindowFlags
SDL_WindowFlags SDL_GetWindowFlags(SDL_Window *window)
SDL_GetDisplayBounds
bool SDL_GetDisplayBounds(SDL_DisplayID displayID, SDL_Rect *rect)
SDL_GetWindowPosition
bool SDL_GetWindowPosition(SDL_Window *window, int *x, int *y)
SDL_ShowWindow
bool SDL_ShowWindow(SDL_Window *window)
SDL_EGLDisplay
void * SDL_EGLDisplay
Definition SDL_video.h:367
SDL_FlashWindow
bool SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation)
SDL_GetWindowTitle
const char * SDL_GetWindowTitle(SDL_Window *window)
SDL_SetWindowBordered
bool SDL_SetWindowBordered(SDL_Window *window, bool bordered)
SDL_GL_LoadLibrary
bool SDL_GL_LoadLibrary(const char *path)
SDL_SetWindowKeyboardGrab
bool SDL_SetWindowKeyboardGrab(SDL_Window *window, bool grabbed)
SDL_HitTest
SDL_HitTestResult(* SDL_HitTest)(SDL_Window *win, const SDL_Point *area, void *data)
Definition SDL_video.h:2852
SDL_SetWindowOpacity
bool SDL_SetWindowOpacity(SDL_Window *window, float opacity)
SDL_GetWindowPixelFormat
SDL_PixelFormat SDL_GetWindowPixelFormat(SDL_Window *window)
SDL_GL_ResetAttributes
void SDL_GL_ResetAttributes(void)
SDL_GLProfile
Uint32 SDL_GLProfile
Definition SDL_video.h:507
SDL_GL_GetSwapInterval
bool SDL_GL_GetSwapInterval(int *interval)
SDL_FlashOperation
SDL_FlashOperation
Definition SDL_video.h:329
SDL_FLASH_UNTIL_FOCUSED
@ SDL_FLASH_UNTIL_FOCUSED
Definition SDL_video.h:332
SDL_FLASH_BRIEFLY
@ SDL_FLASH_BRIEFLY
Definition SDL_video.h:331
SDL_FLASH_CANCEL
@ SDL_FLASH_CANCEL
Definition SDL_video.h:330
SDL_GL_MakeCurrent
bool SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext context)
SDL_GetWindowICCProfile
void * SDL_GetWindowICCProfile(SDL_Window *window, size_t *size)
SDL_DisplayID
Uint32 SDL_DisplayID
Definition SDL_video.h:75
SDL_GetWindowOpacity
float SDL_GetWindowOpacity(SDL_Window *window)
SDL_GetWindowProperties
SDL_PropertiesID SDL_GetWindowProperties(SDL_Window *window)
SDL_GetDisplayForRect
SDL_DisplayID SDL_GetDisplayForRect(const SDL_Rect *rect)
SDL_EGLAttrib
intptr_t SDL_EGLAttrib
Definition SDL_video.h:388
SDL_MaximizeWindow
bool SDL_MaximizeWindow(SDL_Window *window)
SDL_GetFullscreenDisplayModes
SDL_DisplayMode ** SDL_GetFullscreenDisplayModes(SDL_DisplayID displayID, int *count)
SDL_MinimizeWindow
bool SDL_MinimizeWindow(SDL_Window *window)
SDL_SetWindowTitle
bool SDL_SetWindowTitle(SDL_Window *window, const char *title)
SDL_ShowWindowSystemMenu
bool SDL_ShowWindowSystemMenu(SDL_Window *window, int x, int y)
SDL_SetWindowMinimumSize
bool SDL_SetWindowMinimumSize(SDL_Window *window, int min_w, int min_h)
SDL_GetWindowMouseRect
const SDL_Rect * SDL_GetWindowMouseRect(SDL_Window *window)
SDL_GetWindowDisplayScale
float SDL_GetWindowDisplayScale(SDL_Window *window)
SDL_GL_DestroyContext
bool SDL_GL_DestroyContext(SDL_GLContext context)
SDL_GetDisplays
SDL_DisplayID * SDL_GetDisplays(int *count)
SDL_GetWindowFromID
SDL_Window * SDL_GetWindowFromID(SDL_WindowID id)
SDL_GLAttr
SDL_GLAttr
Definition SDL_video.h:471
SDL_GL_EGL_PLATFORM
@ SDL_GL_EGL_PLATFORM
Definition SDL_video.h:499
SDL_GL_FRAMEBUFFER_SRGB_CAPABLE
@ SDL_GL_FRAMEBUFFER_SRGB_CAPABLE
Definition SDL_video.h:494
SDL_GL_CONTEXT_RELEASE_BEHAVIOR
@ SDL_GL_CONTEXT_RELEASE_BEHAVIOR
Definition SDL_video.h:495
SDL_GL_DOUBLEBUFFER
@ SDL_GL_DOUBLEBUFFER
Definition SDL_video.h:477
SDL_GL_STENCIL_SIZE
@ SDL_GL_STENCIL_SIZE
Definition SDL_video.h:479
SDL_GL_CONTEXT_MAJOR_VERSION
@ SDL_GL_CONTEXT_MAJOR_VERSION
Definition SDL_video.h:489
SDL_GL_CONTEXT_RESET_NOTIFICATION
@ SDL_GL_CONTEXT_RESET_NOTIFICATION
Definition SDL_video.h:496
SDL_GL_ACCUM_ALPHA_SIZE
@ SDL_GL_ACCUM_ALPHA_SIZE
Definition SDL_video.h:483
SDL_GL_MULTISAMPLESAMPLES
@ SDL_GL_MULTISAMPLESAMPLES
Definition SDL_video.h:486
SDL_GL_CONTEXT_MINOR_VERSION
@ SDL_GL_CONTEXT_MINOR_VERSION
Definition SDL_video.h:490
SDL_GL_FLOATBUFFERS
@ SDL_GL_FLOATBUFFERS
Definition SDL_video.h:498
SDL_GL_STEREO
@ SDL_GL_STEREO
Definition SDL_video.h:484
SDL_GL_MULTISAMPLEBUFFERS
@ SDL_GL_MULTISAMPLEBUFFERS
Definition SDL_video.h:485
SDL_GL_ACCUM_GREEN_SIZE
@ SDL_GL_ACCUM_GREEN_SIZE
Definition SDL_video.h:481
SDL_GL_BLUE_SIZE
@ SDL_GL_BLUE_SIZE
Definition SDL_video.h:474
SDL_GL_SHARE_WITH_CURRENT_CONTEXT
@ SDL_GL_SHARE_WITH_CURRENT_CONTEXT
Definition SDL_video.h:493
SDL_GL_RETAINED_BACKING
@ SDL_GL_RETAINED_BACKING
Definition SDL_video.h:488
SDL_GL_RED_SIZE
@ SDL_GL_RED_SIZE
Definition SDL_video.h:472
SDL_GL_ALPHA_SIZE
@ SDL_GL_ALPHA_SIZE
Definition SDL_video.h:475
SDL_GL_BUFFER_SIZE
@ SDL_GL_BUFFER_SIZE
Definition SDL_video.h:476
SDL_GL_ACCELERATED_VISUAL
@ SDL_GL_ACCELERATED_VISUAL
Definition SDL_video.h:487
SDL_GL_ACCUM_BLUE_SIZE
@ SDL_GL_ACCUM_BLUE_SIZE
Definition SDL_video.h:482
SDL_GL_DEPTH_SIZE
@ SDL_GL_DEPTH_SIZE
Definition SDL_video.h:478
SDL_GL_ACCUM_RED_SIZE
@ SDL_GL_ACCUM_RED_SIZE
Definition SDL_video.h:480
SDL_GL_CONTEXT_FLAGS
@ SDL_GL_CONTEXT_FLAGS
Definition SDL_video.h:491
SDL_GL_CONTEXT_PROFILE_MASK
@ SDL_GL_CONTEXT_PROFILE_MASK
Definition SDL_video.h:492
SDL_GL_CONTEXT_NO_ERROR
@ SDL_GL_CONTEXT_NO_ERROR
Definition SDL_video.h:497
SDL_GL_GREEN_SIZE
@ SDL_GL_GREEN_SIZE
Definition SDL_video.h:473
SDL_HideWindow
bool SDL_HideWindow(SDL_Window *window)
SDL_Window
struct SDL_Window SDL_Window
Definition SDL_video.h:175
SDL_GetWindowID
SDL_WindowID SDL_GetWindowID(SDL_Window *window)
SDL_GetPrimaryDisplay
SDL_DisplayID SDL_GetPrimaryDisplay(void)
SDL_GetWindows
SDL_Window ** SDL_GetWindows(int *count)
SDL_GL_CreateContext
SDL_GLContext SDL_GL_CreateContext(SDL_Window *window)
SDL_GetCurrentVideoDriver
const char * SDL_GetCurrentVideoDriver(void)
SDL_SetWindowAlwaysOnTop
bool SDL_SetWindowAlwaysOnTop(SDL_Window *window, bool on_top)
SDL_EGLConfig
void * SDL_EGLConfig
Definition SDL_video.h:374
SDL_GetWindowMaximumSize
bool SDL_GetWindowMaximumSize(SDL_Window *window, int *w, int *h)
SDL_UpdateWindowSurface
bool SDL_UpdateWindowSurface(SDL_Window *window)
SDL_GetWindowPixelDensity
float SDL_GetWindowPixelDensity(SDL_Window *window)
SDL_GetWindowSize
bool SDL_GetWindowSize(SDL_Window *window, int *w, int *h)
SDL_ProgressState
SDL_ProgressState
Definition SDL_video.h:341
SDL_PROGRESS_STATE_PAUSED
@ SDL_PROGRESS_STATE_PAUSED
Definition SDL_video.h:346
SDL_PROGRESS_STATE_NONE
@ SDL_PROGRESS_STATE_NONE
Definition SDL_video.h:343
SDL_PROGRESS_STATE_INVALID
@ SDL_PROGRESS_STATE_INVALID
Definition SDL_video.h:342
SDL_PROGRESS_STATE_NORMAL
@ SDL_PROGRESS_STATE_NORMAL
Definition SDL_video.h:345
SDL_PROGRESS_STATE_INDETERMINATE
@ SDL_PROGRESS_STATE_INDETERMINATE
Definition SDL_video.h:344
SDL_PROGRESS_STATE_ERROR
@ SDL_PROGRESS_STATE_ERROR
Definition SDL_video.h:347
SDL_SetWindowMaximumSize
bool SDL_SetWindowMaximumSize(SDL_Window *window, int max_w, int max_h)
SDL_GetDesktopDisplayMode
const SDL_DisplayMode * SDL_GetDesktopDisplayMode(SDL_DisplayID displayID)
SDL_WindowID
Uint32 SDL_WindowID
Definition SDL_video.h:84
SDL_GetWindowSurfaceVSync
bool SDL_GetWindowSurfaceVSync(SDL_Window *window, int *vsync)
SDL_EGL_GetCurrentConfig
SDL_EGLConfig SDL_EGL_GetCurrentConfig(void)
SDL_GetWindowProgressState
SDL_ProgressState SDL_GetWindowProgressState(SDL_Window *window)
SDL_GetDisplayForWindow
SDL_DisplayID SDL_GetDisplayForWindow(SDL_Window *window)
SDL_GL_SwapWindow
bool SDL_GL_SwapWindow(SDL_Window *window)
SDL_EGLint
int SDL_EGLint
Definition SDL_video.h:395
SDL_EGL_GetProcAddress
SDL_FunctionPointer SDL_EGL_GetProcAddress(const char *proc)
SDL_GL_GetProcAddress
SDL_FunctionPointer SDL_GL_GetProcAddress(const char *proc)
SDL_GL_ExtensionSupported
bool SDL_GL_ExtensionSupported(const char *extension)
SDL_EGL_GetCurrentDisplay
SDL_EGLDisplay SDL_EGL_GetCurrentDisplay(void)
SDL_CreateWindow
SDL_Window * SDL_CreateWindow(const char *title, int w, int h, SDL_WindowFlags flags)
SDL_WindowFlags
Uint64 SDL_WindowFlags
Definition SDL_video.h:195
SDL_GL_GetCurrentContext
SDL_GLContext SDL_GL_GetCurrentContext(void)
SDL_RestoreWindow
bool SDL_RestoreWindow(SDL_Window *window)
SDL_GetGrabbedWindow
SDL_Window * SDL_GetGrabbedWindow(void)
SDL_GL_UnloadLibrary
void SDL_GL_UnloadLibrary(void)
SDL_GLContextResetNotification
Uint32 SDL_GLContextResetNotification
Definition SDL_video.h:544
SDL_GLContextFlag
Uint32 SDL_GLContextFlag
Definition SDL_video.h:519
SDL_SyncWindow
bool SDL_SyncWindow(SDL_Window *window)
SDL_GetWindowKeyboardGrab
bool SDL_GetWindowKeyboardGrab(SDL_Window *window)
SDL_GetNumVideoDrivers
int SDL_GetNumVideoDrivers(void)
SDL_SetWindowFillDocument
bool SDL_SetWindowFillDocument(SDL_Window *window, bool fill)
SDL_GetDisplayContentScale
float SDL_GetDisplayContentScale(SDL_DisplayID displayID)
SDL_GL_GetCurrentWindow
SDL_Window * SDL_GL_GetCurrentWindow(void)
SDL_CreateWindowWithProperties
SDL_Window * SDL_CreateWindowWithProperties(SDL_PropertiesID props)
SDL_SetWindowAspectRatio
bool SDL_SetWindowAspectRatio(SDL_Window *window, float min_aspect, float max_aspect)
SDL_EGL_SetAttributeCallbacks
void SDL_EGL_SetAttributeCallbacks(SDL_EGLAttribArrayCallback platformAttribCallback, SDL_EGLIntArrayCallback surfaceAttribCallback, SDL_EGLIntArrayCallback contextAttribCallback, void *userdata)
SDL_GetWindowSafeArea
bool SDL_GetWindowSafeArea(SDL_Window *window, SDL_Rect *rect)
SDL_SetWindowParent
bool SDL_SetWindowParent(SDL_Window *window, SDL_Window *parent)
SDL_SetWindowFullscreen
bool SDL_SetWindowFullscreen(SDL_Window *window, bool fullscreen)
SDL_EGLAttribArrayCallback
SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback)(void *userdata)
Definition SDL_video.h:420
SDL_RaiseWindow
bool SDL_RaiseWindow(SDL_Window *window)
SDL_GetNaturalDisplayOrientation
SDL_DisplayOrientation SDL_GetNaturalDisplayOrientation(SDL_DisplayID displayID)
SDL_GetVideoDriver
const char * SDL_GetVideoDriver(int index)
SDL_GL_SetAttribute
bool SDL_GL_SetAttribute(SDL_GLAttr attr, int value)
SDL_GetWindowMouseGrab
bool SDL_GetWindowMouseGrab(SDL_Window *window)
SDL_EGLSurface
void * SDL_EGLSurface
Definition SDL_video.h:381
SDL_GetCurrentDisplayOrientation
SDL_DisplayOrientation SDL_GetCurrentDisplayOrientation(SDL_DisplayID displayID)
SDL_DestroyWindow
void SDL_DestroyWindow(SDL_Window *window)
SDL_EGL_GetWindowSurface
SDL_EGLSurface SDL_EGL_GetWindowSurface(SDL_Window *window)
SDL_GL_GetAttribute
bool SDL_GL_GetAttribute(SDL_GLAttr attr, int *value)
SDL_GetDisplayUsableBounds
bool SDL_GetDisplayUsableBounds(SDL_DisplayID displayID, SDL_Rect *rect)
SDL_WindowHasSurface
bool SDL_WindowHasSurface(SDL_Window *window)
SDL_GL_SetSwapInterval
bool SDL_GL_SetSwapInterval(int interval)
SDL_GetWindowFullscreenMode
const SDL_DisplayMode * SDL_GetWindowFullscreenMode(SDL_Window *window)
SDL_GetCurrentDisplayMode
const SDL_DisplayMode * SDL_GetCurrentDisplayMode(SDL_DisplayID displayID)
SDL_CreatePopupWindow
SDL_Window * SDL_CreatePopupWindow(SDL_Window *parent, int offset_x, int offset_y, int w, int h, SDL_WindowFlags flags)
SDL_GetSystemTheme
SDL_SystemTheme SDL_GetSystemTheme(void)
SDL_GetWindowBordersSize
bool SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right)
SDL_UpdateWindowSurfaceRects
bool SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects)
SDL_SetWindowPosition
bool SDL_SetWindowPosition(SDL_Window *window, int x, int y)
SDL_GetWindowAspectRatio
bool SDL_GetWindowAspectRatio(SDL_Window *window, float *min_aspect, float *max_aspect)
SDL_DestroyWindowSurface
bool SDL_DestroyWindowSurface(SDL_Window *window)
SDL_GetWindowParent
SDL_Window * SDL_GetWindowParent(SDL_Window *window)
SDL_SetWindowMouseGrab
bool SDL_SetWindowMouseGrab(SDL_Window *window, bool grabbed)
SDL_DisplayOrientation
SDL_DisplayOrientation
Definition SDL_video.h:160
SDL_GetWindowSizeInPixels
bool SDL_GetWindowSizeInPixels(SDL_Window *window, int *w, int *h)
SDL_ScreenSaverEnabled
bool SDL_ScreenSaverEnabled(void)
SDL_SetWindowProgressValue
bool SDL_SetWindowProgressValue(SDL_Window *window, float value)
SDL_GetWindowMinimumSize
bool SDL_GetWindowMinimumSize(SDL_Window *window, int *w, int *h)
SDL_EnableScreenSaver
bool SDL_EnableScreenSaver(void)
SDL_SetWindowSurfaceVSync
bool SDL_SetWindowSurfaceVSync(SDL_Window *window, int vsync)
SDL_GetDisplayProperties
SDL_PropertiesID SDL_GetDisplayProperties(SDL_DisplayID displayID)
window
static SDL_Window * window
Definition hello.c:16
SDL_DisplayMode
Definition SDL_video.h:140
SDL_Point
Definition SDL_rect.h:50
SDL_Rect
Definition SDL_rect.h:84
SDL_Surface
Definition SDL_surface.h:139

◆ SDL_WINDOWPOS_ISUNDEFINED

#define SDL_WINDOWPOS_ISUNDEFINED (   X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)

A macro to test if the window position is marked as "undefined."

Parameters
Xthe window position value.
Since
This macro is available since SDL 3.2.0.
See also
SDL_SetWindowPosition

Definition at line 271 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Used to indicate that you don't care what the window position/display is.

This always uses the primary display.

Since
This macro is available since SDL 3.2.0.
See also
SDL_SetWindowPosition

Definition at line 260 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

#define SDL_WINDOWPOS_UNDEFINED_DISPLAY (   X)    (SDL_WINDOWPOS_UNDEFINED_MASK|(X))

Used to indicate that you don't care what the window position is.

If you really don't care, SDL_WINDOWPOS_UNDEFINED is the same, but always uses the primary display instead of specifying one.

Parameters
Xthe SDL_DisplayID of the display to use.
Since
This macro is available since SDL 3.2.0.
See also
SDL_SetWindowPosition

Definition at line 249 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_MASK

#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u

A magic value used with SDL_WINDOWPOS_UNDEFINED.

Generally this macro isn't used directly, but rather through SDL_WINDOWPOS_UNDEFINED or SDL_WINDOWPOS_UNDEFINED_DISPLAY.

Since
This macro is available since SDL 3.2.0.
See also
SDL_SetWindowPosition

Definition at line 235 of file SDL_video.h.

Typedef Documentation

◆ SDL_DisplayID

typedef Uint32 SDL_DisplayID

CategoryVideo

SDL's video subsystem is largely interested in abstracting window management from the underlying operating system. You can create windows, manage them in various ways, set them fullscreen, and get events when interesting things happen with them, such as the mouse or keyboard interacting with a window.

The video subsystem is also interested in abstracting away some platform-specific differences in OpenGL: context creation, swapping buffers, etc. This may be crucial to your app, but also you are not required to use OpenGL at all. In fact, SDL can provide rendering to those windows as well, either with an easy-to-use 2D API or with a more-powerful GPU API . Of course, it can simply get out of your way and give you the window handles you need to use Vulkan, Direct3D, Metal, or whatever else you like directly, too.

The video subsystem covers a lot of functionality, out of necessity, so it is worth perusing the list of functions just to see what's available, but most apps can get by with simply creating a window and listening for events, so start with SDL_CreateWindow() and SDL_PollEvent(). This is a unique ID for a display for the time it is connected to the system, and is never reused for the lifetime of the application.

If the display is disconnected and reconnected, it will get a new ID.

The value 0 is an invalid ID.

Since
This datatype is available since SDL 3.2.0.

Definition at line 75 of file SDL_video.h.

◆ SDL_DisplayModeData

typedef struct SDL_DisplayModeData SDL_DisplayModeData

Internal display mode data.

This lives as a field in SDL_DisplayMode, as opaque data.

Since
This struct is available since SDL 3.2.0.
See also
SDL_DisplayMode

Definition at line 126 of file SDL_video.h.

◆ SDL_EGLAttrib

typedef intptr_t SDL_EGLAttrib

An EGL attribute, used when creating an EGL context.

Since
This datatype is available since SDL 3.2.0.

Definition at line 388 of file SDL_video.h.

◆ SDL_EGLAttribArrayCallback

typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void *userdata)

EGL platform attribute initialization callback.

This is called when SDL is attempting to create an EGL context, to let the app add extra attributes to its eglGetPlatformDisplay() call.

The callback should return a pointer to an EGL attribute array terminated with EGL_NONE. If this function returns NULL, the SDL_CreateWindow process will fail gracefully.

The returned pointer should be allocated with SDL_malloc() and will be passed to SDL_free().

The arrays returned by each callback will be appended to the existing attribute arrays defined by SDL.

Parameters
userdataan app-controlled pointer that is passed to the callback.
Returns
a newly-allocated array of attributes, terminated with EGL_NONE.
Since
This datatype is available since SDL 3.2.0.
See also
SDL_EGL_SetAttributeCallbacks

Definition at line 420 of file SDL_video.h.

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

Opaque type for an EGL config.

Since
This datatype is available since SDL 3.2.0.

Definition at line 374 of file SDL_video.h.

◆ SDL_EGLDisplay

typedef void* SDL_EGLDisplay

Opaque type for an EGL display.

Since
This datatype is available since SDL 3.2.0.

Definition at line 367 of file SDL_video.h.

◆ SDL_EGLint

typedef int SDL_EGLint

An EGL integer attribute, used when creating an EGL surface.

Since
This datatype is available since SDL 3.2.0.

Definition at line 395 of file SDL_video.h.

◆ SDL_EGLIntArrayCallback

typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void *userdata, SDL_EGLDisplay display, SDL_EGLConfig config)

EGL surface/context attribute initialization callback types.

This is called when SDL is attempting to create an EGL surface, to let the app add extra attributes to its eglCreateWindowSurface() or eglCreateContext calls.

For convenience, the EGLDisplay and EGLConfig to use are provided to the callback.

The callback should return a pointer to an EGL attribute array terminated with EGL_NONE. If this function returns NULL, the SDL_CreateWindow process will fail gracefully.

The returned pointer should be allocated with SDL_malloc() and will be passed to SDL_free().

The arrays returned by each callback will be appended to the existing attribute arrays defined by SDL.

Parameters
userdataan app-controlled pointer that is passed to the callback.
displaythe EGL display to be used.
configthe EGL config to be used.
Returns
a newly-allocated array of attributes, terminated with EGL_NONE.
Since
This datatype is available since SDL 3.2.0.
See also
SDL_EGL_SetAttributeCallbacks

Definition at line 451 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Opaque type for an EGL surface.

Since
This datatype is available since SDL 3.2.0.

Definition at line 381 of file SDL_video.h.

◆ SDL_GLContext

typedef struct SDL_GLContextState* SDL_GLContext

An opaque handle to an OpenGL context.

Since
This datatype is available since SDL 3.2.0.
See also
SDL_GL_CreateContext
SDL_GL_SetAttribute
SDL_GL_MakeCurrent
SDL_GL_DestroyContext

Definition at line 360 of file SDL_video.h.

◆ SDL_GLContextFlag

typedef Uint32 SDL_GLContextFlag

Possible flags to be set for the SDL_GL_CONTEXT_FLAGS attribute.

Since
This datatype is available since SDL 3.2.0.

Definition at line 519 of file SDL_video.h.

◆ SDL_GLContextReleaseFlag

typedef Uint32 SDL_GLContextReleaseFlag

Possible values to be set for the SDL_GL_CONTEXT_RELEASE_BEHAVIOR attribute.

Since
This datatype is available since SDL 3.2.0.

Definition at line 533 of file SDL_video.h.

◆ SDL_GLContextResetNotification

typedef Uint32 SDL_GLContextResetNotification

Possible values to be set SDL_GL_CONTEXT_RESET_NOTIFICATION attribute.

Since
This datatype is available since SDL 3.2.0.

Definition at line 544 of file SDL_video.h.

◆ SDL_GLProfile

typedef Uint32 SDL_GLProfile

Possible values to be set for the SDL_GL_CONTEXT_PROFILE_MASK attribute.

Since
This datatype is available since SDL 3.2.0.

Definition at line 507 of file SDL_video.h.

◆ SDL_HitTest

typedef SDL_HitTestResult(* SDL_HitTest) (SDL_Window *win, const SDL_Point *area, void *data)

Callback used for hit-testing.

Parameters
winthe SDL_Window where hit-testing was set on.
areaan SDL_Point which should be hit-tested.
datawhat was passed as callback_data to SDL_SetWindowHitTest().
Returns
an SDL_HitTestResult value.
See also
SDL_SetWindowHitTest

Definition at line 2852 of file SDL_video.h.

◆ SDL_Window

typedef struct SDL_Window SDL_Window

The struct used as an opaque handle to a window.

Since
This struct is available since SDL 3.2.0.
See also
SDL_CreateWindow

Definition at line 175 of file SDL_video.h.

◆ SDL_WindowFlags

typedef Uint64 SDL_WindowFlags

The flags on a window.

These cover a lot of true/false, or on/off, window state. Some of it is immutable after being set through SDL_CreateWindow(), some of it can be changed on existing windows by the app, and some of it might be altered by the user or system outside of the app's control.

When creating windows with SDL_WINDOW_RESIZABLE, SDL will constrain resizable windows to the dimensions recommended by the compositor to fit it within the usable desktop space, although some compositors will do this automatically without intervention as well. Use SDL_SetWindowResizable after creation instead if you wish to create a window with a specific size.

Since
This datatype is available since SDL 3.2.0.
See also
SDL_GetWindowFlags

Definition at line 195 of file SDL_video.h.

◆ SDL_WindowID

typedef Uint32 SDL_WindowID

This is a unique ID for a window.

The value 0 is an invalid ID.

Since
This datatype is available since SDL 3.2.0.

Definition at line 84 of file SDL_video.h.

Enumeration Type Documentation

◆ SDL_DisplayOrientation

enum SDL_DisplayOrientation

Display orientation values; the way a display is rotated.

Since
This enum is available since SDL 3.2.0.
Enumerator
SDL_ORIENTATION_UNKNOWN 

The display orientation can't be determined

SDL_ORIENTATION_LANDSCAPE 

The display is in landscape mode, with the right side up, relative to portrait mode

SDL_ORIENTATION_LANDSCAPE_FLIPPED 

The display is in landscape mode, with the left side up, relative to portrait mode

SDL_ORIENTATION_PORTRAIT 

The display is in portrait mode

SDL_ORIENTATION_PORTRAIT_FLIPPED 

The display is in portrait mode, upside down

Definition at line 159 of file SDL_video.h.

160{
161 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
162 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
163 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
164 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
165 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
166} SDL_DisplayOrientation;
SDL_ORIENTATION_LANDSCAPE
@ SDL_ORIENTATION_LANDSCAPE
Definition SDL_video.h:162
SDL_ORIENTATION_PORTRAIT
@ SDL_ORIENTATION_PORTRAIT
Definition SDL_video.h:164
SDL_ORIENTATION_PORTRAIT_FLIPPED
@ SDL_ORIENTATION_PORTRAIT_FLIPPED
Definition SDL_video.h:165
SDL_ORIENTATION_LANDSCAPE_FLIPPED
@ SDL_ORIENTATION_LANDSCAPE_FLIPPED
Definition SDL_video.h:163
SDL_ORIENTATION_UNKNOWN
@ SDL_ORIENTATION_UNKNOWN
Definition SDL_video.h:161

◆ SDL_FlashOperation

enum SDL_FlashOperation

Window flash operation.

Since
This enum is available since SDL 3.2.0.
Enumerator
SDL_FLASH_CANCEL 

Cancel any window flash state

SDL_FLASH_BRIEFLY 

Flash the window briefly to get attention

SDL_FLASH_UNTIL_FOCUSED 

Flash the window until it gets focus

Definition at line 328 of file SDL_video.h.

329{
330 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
331 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
332 SDL_FLASH_UNTIL_FOCUSED /**< Flash the window until it gets focus */
333} SDL_FlashOperation;

◆ SDL_GLAttr

enum SDL_GLAttr

An enumeration of OpenGL configuration attributes.

While you can set most OpenGL attributes normally, the attributes listed above must be known before SDL creates the window that will be used with the OpenGL context. These attributes are set and read with SDL_GL_SetAttribute() and SDL_GL_GetAttribute().

In some cases, these attributes are minimum requests; the GL does not promise to give you exactly what you asked for. It's possible to ask for a 16-bit depth buffer and get a 24-bit one instead, for example, or to ask for no stencil buffer and still have one available. Context creation should fail if the GL can't provide your requested attributes at a minimum, but you should check to see exactly what you got.

Since
This enum is available since SDL 3.2.0.
Enumerator
SDL_GL_RED_SIZE 

the minimum number of bits for the red channel of the color buffer; defaults to 8.

SDL_GL_GREEN_SIZE 

the minimum number of bits for the green channel of the color buffer; defaults to 8.

SDL_GL_BLUE_SIZE 

the minimum number of bits for the blue channel of the color buffer; defaults to 8.

SDL_GL_ALPHA_SIZE 

the minimum number of bits for the alpha channel of the color buffer; defaults to 8.

SDL_GL_BUFFER_SIZE 

the minimum number of bits for frame buffer size; defaults to 0.

SDL_GL_DOUBLEBUFFER 

whether the output is single or double buffered; defaults to double buffering on.

SDL_GL_DEPTH_SIZE 

the minimum number of bits in the depth buffer; defaults to 16.

SDL_GL_STENCIL_SIZE 

the minimum number of bits in the stencil buffer; defaults to 0.

SDL_GL_ACCUM_RED_SIZE 

the minimum number of bits for the red channel of the accumulation buffer; defaults to 0.

SDL_GL_ACCUM_GREEN_SIZE 

the minimum number of bits for the green channel of the accumulation buffer; defaults to 0.

SDL_GL_ACCUM_BLUE_SIZE 

the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0.

SDL_GL_ACCUM_ALPHA_SIZE 

the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0.

SDL_GL_STEREO 

whether the output is stereo 3D; defaults to off.

SDL_GL_MULTISAMPLEBUFFERS 

the number of buffers used for multisample anti-aliasing; defaults to 0.

SDL_GL_MULTISAMPLESAMPLES 

the number of samples used around the current pixel used for multisample anti-aliasing.

SDL_GL_ACCELERATED_VISUAL 

set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either.

SDL_GL_RETAINED_BACKING 

not used (deprecated).

SDL_GL_CONTEXT_MAJOR_VERSION 

OpenGL context major version.

SDL_GL_CONTEXT_MINOR_VERSION 

OpenGL context minor version.

SDL_GL_CONTEXT_FLAGS 

some combination of 0 or more of elements of the SDL_GLContextFlag enumeration; defaults to 0.

SDL_GL_CONTEXT_PROFILE_MASK 

type of GL context (Core, Compatibility, ES). See SDL_GLProfile; default value depends on platform.

SDL_GL_SHARE_WITH_CURRENT_CONTEXT 

OpenGL context sharing; defaults to 0.

SDL_GL_FRAMEBUFFER_SRGB_CAPABLE 

requests sRGB-capable visual if 1. Defaults to -1 ("don't care"). This is a request; GL drivers might not comply!

SDL_GL_CONTEXT_RELEASE_BEHAVIOR 

sets context the release behavior. See SDL_GLContextReleaseFlag; defaults to FLUSH.

SDL_GL_CONTEXT_RESET_NOTIFICATION 

set context reset notification. See SDL_GLContextResetNotification; defaults to NO_NOTIFICATION.

SDL_GL_CONTEXT_NO_ERROR 
SDL_GL_FLOATBUFFERS 
SDL_GL_EGL_PLATFORM 

Definition at line 470 of file SDL_video.h.

471{
472 SDL_GL_RED_SIZE, /**< the minimum number of bits for the red channel of the color buffer; defaults to 8. */
473 SDL_GL_GREEN_SIZE, /**< the minimum number of bits for the green channel of the color buffer; defaults to 8. */
474 SDL_GL_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the color buffer; defaults to 8. */
475 SDL_GL_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the color buffer; defaults to 8. */
476 SDL_GL_BUFFER_SIZE, /**< the minimum number of bits for frame buffer size; defaults to 0. */
477 SDL_GL_DOUBLEBUFFER, /**< whether the output is single or double buffered; defaults to double buffering on. */
478 SDL_GL_DEPTH_SIZE, /**< the minimum number of bits in the depth buffer; defaults to 16. */
479 SDL_GL_STENCIL_SIZE, /**< the minimum number of bits in the stencil buffer; defaults to 0. */
480 SDL_GL_ACCUM_RED_SIZE, /**< the minimum number of bits for the red channel of the accumulation buffer; defaults to 0. */
481 SDL_GL_ACCUM_GREEN_SIZE, /**< the minimum number of bits for the green channel of the accumulation buffer; defaults to 0. */
482 SDL_GL_ACCUM_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0. */
483 SDL_GL_ACCUM_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0. */
484 SDL_GL_STEREO, /**< whether the output is stereo 3D; defaults to off. */
485 SDL_GL_MULTISAMPLEBUFFERS, /**< the number of buffers used for multisample anti-aliasing; defaults to 0. */
486 SDL_GL_MULTISAMPLESAMPLES, /**< the number of samples used around the current pixel used for multisample anti-aliasing. */
487 SDL_GL_ACCELERATED_VISUAL, /**< set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either. */
488 SDL_GL_RETAINED_BACKING, /**< not used (deprecated). */
489 SDL_GL_CONTEXT_MAJOR_VERSION, /**< OpenGL context major version. */
490 SDL_GL_CONTEXT_MINOR_VERSION, /**< OpenGL context minor version. */
491 SDL_GL_CONTEXT_FLAGS, /**< some combination of 0 or more of elements of the SDL_GLContextFlag enumeration; defaults to 0. */
492 SDL_GL_CONTEXT_PROFILE_MASK, /**< type of GL context (Core, Compatibility, ES). See SDL_GLProfile; default value depends on platform. */
493 SDL_GL_SHARE_WITH_CURRENT_CONTEXT, /**< OpenGL context sharing; defaults to 0. */
494 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, /**< requests sRGB-capable visual if 1. Defaults to -1 ("don't care"). This is a request; GL drivers might not comply! */
495 SDL_GL_CONTEXT_RELEASE_BEHAVIOR, /**< sets context the release behavior. See SDL_GLContextReleaseFlag; defaults to FLUSH. */
496 SDL_GL_CONTEXT_RESET_NOTIFICATION, /**< set context reset notification. See SDL_GLContextResetNotification; defaults to NO_NOTIFICATION. */
497 SDL_GL_CONTEXT_NO_ERROR,
498 SDL_GL_FLOATBUFFERS,
499 SDL_GL_EGL_PLATFORM
500} SDL_GLAttr;

◆ SDL_HitTestResult

enum SDL_HitTestResult

Possible return values from the SDL_HitTest callback.

\threadsafety This function should only be called on the main thread.

Since
This enum is available since SDL 3.2.0.
See also
SDL_HitTest
Enumerator
SDL_HITTEST_NORMAL 

Region is normal. No special properties.

SDL_HITTEST_DRAGGABLE 

Region can drag entire window.

SDL_HITTEST_RESIZE_TOPLEFT 

Region is the resizable top-left corner border.

SDL_HITTEST_RESIZE_TOP 

Region is the resizable top border.

SDL_HITTEST_RESIZE_TOPRIGHT 

Region is the resizable top-right corner border.

SDL_HITTEST_RESIZE_RIGHT 

Region is the resizable right border.

SDL_HITTEST_RESIZE_BOTTOMRIGHT 

Region is the resizable bottom-right corner border.

SDL_HITTEST_RESIZE_BOTTOM 

Region is the resizable bottom border.

SDL_HITTEST_RESIZE_BOTTOMLEFT 

Region is the resizable bottom-left corner border.

SDL_HITTEST_RESIZE_LEFT 

Region is the resizable left border.

Definition at line 2828 of file SDL_video.h.

2829{
2830 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
2831 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
2832 SDL_HITTEST_RESIZE_TOPLEFT, /**< Region is the resizable top-left corner border. */
2833 SDL_HITTEST_RESIZE_TOP, /**< Region is the resizable top border. */
2834 SDL_HITTEST_RESIZE_TOPRIGHT, /**< Region is the resizable top-right corner border. */
2835 SDL_HITTEST_RESIZE_RIGHT, /**< Region is the resizable right border. */
2836 SDL_HITTEST_RESIZE_BOTTOMRIGHT, /**< Region is the resizable bottom-right corner border. */
2837 SDL_HITTEST_RESIZE_BOTTOM, /**< Region is the resizable bottom border. */
2838 SDL_HITTEST_RESIZE_BOTTOMLEFT, /**< Region is the resizable bottom-left corner border. */
2839 SDL_HITTEST_RESIZE_LEFT /**< Region is the resizable left border. */
2840} SDL_HitTestResult;

◆ SDL_ProgressState

enum SDL_ProgressState

Window progress state

Since
This enum is available since SDL 3.2.8.
Enumerator
SDL_PROGRESS_STATE_INVALID 

An invalid progress state indicating an error; check SDL_GetError()

SDL_PROGRESS_STATE_NONE 

No progress bar is shown

SDL_PROGRESS_STATE_INDETERMINATE 

The progress bar is shown in a indeterminate state

SDL_PROGRESS_STATE_NORMAL 

The progress bar is shown in a normal state

SDL_PROGRESS_STATE_PAUSED 

The progress bar is shown in a paused state

SDL_PROGRESS_STATE_ERROR 

The progress bar is shown in a state indicating the application had an error

Definition at line 340 of file SDL_video.h.

341{
342 SDL_PROGRESS_STATE_INVALID = -1, /**< An invalid progress state indicating an error; check SDL_GetError() */
343 SDL_PROGRESS_STATE_NONE, /**< No progress bar is shown */
344 SDL_PROGRESS_STATE_INDETERMINATE, /**< The progress bar is shown in a indeterminate state */
345 SDL_PROGRESS_STATE_NORMAL, /**< The progress bar is shown in a normal state */
346 SDL_PROGRESS_STATE_PAUSED, /**< The progress bar is shown in a paused state */
347 SDL_PROGRESS_STATE_ERROR /**< The progress bar is shown in a state indicating the application had an error */
348} SDL_ProgressState;

◆ SDL_SystemTheme

enum SDL_SystemTheme

System theme.

Since
This enum is available since SDL 3.2.0.
Enumerator
SDL_SYSTEM_THEME_UNKNOWN 

Unknown system theme

SDL_SYSTEM_THEME_LIGHT 

Light colored system theme

SDL_SYSTEM_THEME_DARK 

Dark colored system theme

Definition at line 110 of file SDL_video.h.

111{
112 SDL_SYSTEM_THEME_UNKNOWN, /**< Unknown system theme */
113 SDL_SYSTEM_THEME_LIGHT, /**< Light colored system theme */
114 SDL_SYSTEM_THEME_DARK /**< Dark colored system theme */
115} SDL_SystemTheme;
SDL_SYSTEM_THEME_LIGHT
@ SDL_SYSTEM_THEME_LIGHT
Definition SDL_video.h:113
SDL_SYSTEM_THEME_UNKNOWN
@ SDL_SYSTEM_THEME_UNKNOWN
Definition SDL_video.h:112
SDL_SYSTEM_THEME_DARK
@ SDL_SYSTEM_THEME_DARK
Definition SDL_video.h:114

Function Documentation

◆ SDL_CreatePopupWindow()

SDL_Window * SDL_CreatePopupWindow ( SDL_Window *  parent,
int  offset_x,
int  offset_y,
int  w,
int  h,
SDL_WindowFlags  flags 
)
extern

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.

Parameters
parentthe parent of the window, must not be NULL.
offset_xthe x position of the popup window relative to the origin of the parent.
offset_ythe y position of the popup window relative to the origin of the parent window.
wthe width of the window.
hthe height of the window.
flagsSDL_WINDOW_TOOLTIP or SDL_WINDOW_POPUP_MENU, and zero or more additional SDL_WindowFlags OR'd together.
Returns
the window that was created or NULL on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_CreateWindow
SDL_CreateWindowWithProperties
SDL_DestroyWindow
SDL_GetWindowParent

◆ SDL_CreateWindow()

SDL_Window * SDL_CreateWindow ( const char *  title,
int  w,
int  h,
SDL_WindowFlags  flags 
)
extern

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.

Parameters
titlethe title of the window, in UTF-8 encoding.
wthe width of the window.
hthe height of the window.
flags0, or one or more SDL_WindowFlags OR'd together.
Returns
the window that was created or NULL on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_CreateWindowAndRenderer
SDL_CreatePopupWindow
SDL_CreateWindowWithProperties
SDL_DestroyWindow

◆ SDL_CreateWindowWithProperties()

SDL_Window * SDL_CreateWindowWithProperties ( SDL_PropertiesID  props)
extern

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](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](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().

Parameters
propsthe properties to use.
Returns
the window that was created or NULL on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_CreateProperties
SDL_CreateWindow
SDL_DestroyWindow

◆ SDL_DestroyWindow()

void SDL_DestroyWindow ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to destroy.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_CreatePopupWindow
SDL_CreateWindow
SDL_CreateWindowWithProperties

◆ SDL_DestroyWindowSurface()

bool SDL_DestroyWindowSurface ( SDL_Window *  window)
extern

Destroy the surface associated with the window.

Parameters
windowthe window to update.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowSurface
SDL_WindowHasSurface

◆ SDL_DisableScreenSaver()

bool SDL_DisableScreenSaver ( void  )
extern

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.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_EnableScreenSaver
SDL_ScreenSaverEnabled

◆ SDL_EGL_GetCurrentConfig()

SDL_EGLConfig SDL_EGL_GetCurrentConfig ( void  )
extern

Get the currently active EGL config.

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_EGL_GetCurrentDisplay()

SDL_EGLDisplay SDL_EGL_GetCurrentDisplay ( void  )
extern

Get the currently active EGL display.

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_EGL_GetProcAddress()

SDL_FunctionPointer SDL_EGL_GetProcAddress ( const char *  proc)
extern

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.

Parameters
procthe name of an EGL function.
Returns
a pointer to the named EGL function. The returned pointer should be cast to the appropriate function signature.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_EGL_GetCurrentDisplay

◆ SDL_EGL_GetWindowSurface()

SDL_EGLSurface SDL_EGL_GetWindowSurface ( SDL_Window *  window)
extern

Get the EGL surface associated with the window.

Parameters
windowthe window to query.
Returns
the EGLSurface pointer associated with the window, or NULL on failure.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_EGL_SetAttributeCallbacks()

void SDL_EGL_SetAttributeCallbacks ( SDL_EGLAttribArrayCallback  platformAttribCallback,
SDL_EGLIntArrayCallback  surfaceAttribCallback,
SDL_EGLIntArrayCallback  contextAttribCallback,
void *  userdata 
)
extern

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.

Parameters
platformAttribCallbackcallback for attributes to pass to eglGetPlatformDisplay. May be NULL.
surfaceAttribCallbackcallback for attributes to pass to eglCreateSurface. May be NULL.
contextAttribCallbackcallback for attributes to pass to eglCreateContext. May be NULL.
userdataa pointer that is passed to the callbacks.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_EnableScreenSaver()

bool SDL_EnableScreenSaver ( void  )
extern

Allow the screen to be blanked by a screen saver.

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_DisableScreenSaver
SDL_ScreenSaverEnabled

◆ SDL_FlashWindow()

bool SDL_FlashWindow ( SDL_Window *  window,
SDL_FlashOperation  operation 
)
extern

Request a window to demand attention from the user.

Parameters
windowthe window to be flashed.
operationthe operation to perform.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetClosestFullscreenDisplayMode()

bool SDL_GetClosestFullscreenDisplayMode ( SDL_DisplayID  displayID,
int  w,
int  h,
float  refresh_rate,
bool  include_high_density_modes,
SDL_DisplayMode *  closest 
)
extern

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.

Parameters
displayIDthe instance ID of the display to query.
wthe width in pixels of the desired display mode.
hthe height in pixels of the desired display mode.
refresh_ratethe refresh rate of the desired display mode, or 0.0f for the desktop refresh rate.
include_high_density_modesboolean to include high density modes in the search.
closesta pointer filled in with the closest display mode equal to or larger than the desired mode.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplays
SDL_GetFullscreenDisplayModes

◆ SDL_GetCurrentDisplayMode()

const SDL_DisplayMode * SDL_GetCurrentDisplayMode ( SDL_DisplayID  displayID)
extern

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.

Parameters
displayIDthe instance ID of the display to query.
Returns
a pointer to the desktop display mode or NULL on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDesktopDisplayMode
SDL_GetDisplays

◆ SDL_GetCurrentDisplayOrientation()

SDL_DisplayOrientation SDL_GetCurrentDisplayOrientation ( SDL_DisplayID  displayID)
extern

Get the orientation of a display.

Parameters
displayIDthe instance ID of the display to query.
Returns
the SDL_DisplayOrientation enum value of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplays

◆ SDL_GetCurrentVideoDriver()

const char * SDL_GetCurrentVideoDriver ( void  )
extern

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.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetNumVideoDrivers
SDL_GetVideoDriver

◆ SDL_GetDesktopDisplayMode()

const SDL_DisplayMode * SDL_GetDesktopDisplayMode ( SDL_DisplayID  displayID)
extern

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.

Parameters
displayIDthe instance ID of the display to query.
Returns
a pointer to the desktop display mode or NULL on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetCurrentDisplayMode
SDL_GetDisplays

◆ SDL_GetDisplayBounds()

bool SDL_GetDisplayBounds ( SDL_DisplayID  displayID,
SDL_Rect *  rect 
)
extern

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.

Parameters
displayIDthe instance ID of the display to query.
rectthe SDL_Rect structure filled in with the display bounds.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplayUsableBounds
SDL_GetDisplays

◆ SDL_GetDisplayContentScale()

float SDL_GetDisplayContentScale ( SDL_DisplayID  displayID)
extern

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.

Parameters
displayIDthe instance ID of the display to query.
Returns
the content scale of the display, or 0.0f on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowDisplayScale
SDL_GetDisplays

◆ SDL_GetDisplayForPoint()

SDL_DisplayID SDL_GetDisplayForPoint ( const SDL_Point *  point)
extern

Get the display containing a point.

Parameters
pointthe point to query.
Returns
the instance ID of the display containing the point or 0 on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplayBounds
SDL_GetDisplays

◆ SDL_GetDisplayForRect()

SDL_DisplayID SDL_GetDisplayForRect ( const SDL_Rect *  rect)
extern

Get the display primarily containing a rect.

Parameters
rectthe rect to query.
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.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplayBounds
SDL_GetDisplays

◆ SDL_GetDisplayForWindow()

SDL_DisplayID SDL_GetDisplayForWindow ( SDL_Window *  window)
extern

Get the display associated with a window.

Parameters
windowthe window to query.
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.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplayBounds
SDL_GetDisplays

◆ SDL_GetDisplayName()

const char * SDL_GetDisplayName ( SDL_DisplayID  displayID)
extern

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

Parameters
displayIDthe instance ID of the display to query.
Returns
the name of a display or NULL on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplays

◆ SDL_GetDisplayProperties()

SDL_PropertiesID SDL_GetDisplayProperties ( SDL_DisplayID  displayID)
extern

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
Parameters
displayIDthe instance ID of the display to query.
Returns
a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetDisplays()

SDL_DisplayID * SDL_GetDisplays ( int *  count)
extern

Get a list of currently connected displays.

Parameters
counta pointer filled in with the number of displays returned, may be NULL.
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.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetDisplayUsableBounds()

bool SDL_GetDisplayUsableBounds ( SDL_DisplayID  displayID,
SDL_Rect *  rect 
)
extern

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.

Parameters
displayIDthe instance ID of the display to query.
rectthe SDL_Rect structure filled in with the display bounds.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplayBounds
SDL_GetDisplays

◆ SDL_GetFullscreenDisplayModes()

SDL_DisplayMode ** SDL_GetFullscreenDisplayModes ( SDL_DisplayID  displayID,
int *  count 
)
extern

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
Parameters
displayIDthe instance ID of the display to query.
counta pointer filled in with the number of display modes returned, may be NULL.
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.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplays

◆ SDL_GetGrabbedWindow()

SDL_Window * SDL_GetGrabbedWindow ( void  )
extern

Get the window that currently has an input grab enabled.

Returns
the window if input is grabbed or NULL otherwise.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowMouseGrab
SDL_SetWindowKeyboardGrab

◆ SDL_GetNaturalDisplayOrientation()

SDL_DisplayOrientation SDL_GetNaturalDisplayOrientation ( SDL_DisplayID  displayID)
extern

Get the orientation of a display when it is unrotated.

Parameters
displayIDthe instance ID of the display to query.
Returns
the SDL_DisplayOrientation enum value of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplays

◆ SDL_GetNumVideoDrivers()

int SDL_GetNumVideoDrivers ( void  )
extern

Get the number of video drivers compiled into SDL.

Returns
the number of built in video drivers.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetVideoDriver

◆ SDL_GetPrimaryDisplay()

SDL_DisplayID SDL_GetPrimaryDisplay ( void  )
extern

Return the primary display.

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetDisplays

◆ SDL_GetSystemTheme()

SDL_SystemTheme SDL_GetSystemTheme ( void  )
extern

Get the current system theme.

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetVideoDriver()

const char * SDL_GetVideoDriver ( int  index)
extern

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.

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetNumVideoDrivers

◆ SDL_GetWindowAspectRatio()

bool SDL_GetWindowAspectRatio ( SDL_Window *  window,
float *  min_aspect,
float *  max_aspect 
)
extern

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

Parameters
windowthe window to query the width and height from.
min_aspecta pointer filled in with the minimum aspect ratio of the window, may be NULL.
max_aspecta pointer filled in with the maximum aspect ratio of the window, may be NULL.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowAspectRatio

◆ SDL_GetWindowBordersSize()

bool SDL_GetWindowBordersSize ( SDL_Window *  window,
int *  top,
int *  left,
int *  bottom,
int *  right 
)
extern

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.

Parameters
windowthe window to query the size values of the border (decorations) from.
toppointer to variable for storing the size of the top border; NULL is permitted.
leftpointer to variable for storing the size of the left border; NULL is permitted.
bottompointer to variable for storing the size of the bottom border; NULL is permitted.
rightpointer to variable for storing the size of the right border; NULL is permitted.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowSize

◆ SDL_GetWindowDisplayScale()

float SDL_GetWindowDisplayScale ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to query.
Returns
the display scale, or 0.0f on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetWindowFlags()

SDL_WindowFlags SDL_GetWindowFlags ( SDL_Window *  window)
extern

Get the window flags.

Parameters
windowthe window to query.
Returns
a mask of the SDL_WindowFlags associated with window.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_CreateWindow
SDL_HideWindow
SDL_MaximizeWindow
SDL_MinimizeWindow
SDL_SetWindowFullscreen
SDL_SetWindowMouseGrab
SDL_SetWindowFillDocument
SDL_ShowWindow

◆ SDL_GetWindowFromID()

SDL_Window * SDL_GetWindowFromID ( SDL_WindowID  id)
extern

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.

Parameters
idthe ID of the window.
Returns
the window associated with id or NULL if it doesn't exist; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowID

◆ SDL_GetWindowFullscreenMode()

const SDL_DisplayMode * SDL_GetWindowFullscreenMode ( SDL_Window *  window)
extern

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

Parameters
windowthe window to query.
Returns
a pointer to the exclusive fullscreen mode to use or NULL for borderless fullscreen desktop mode.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowFullscreenMode
SDL_SetWindowFullscreen

◆ SDL_GetWindowICCProfile()

void * SDL_GetWindowICCProfile ( SDL_Window *  window,
size_t *  size 
)
extern

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

Parameters
windowthe window to query.
sizethe size of the ICC profile.
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.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetWindowID()

SDL_WindowID SDL_GetWindowID ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to query.
Returns
the ID of the window on success or 0 on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowFromID

◆ SDL_GetWindowKeyboardGrab()

bool SDL_GetWindowKeyboardGrab ( SDL_Window *  window)
extern

Get a window's keyboard grab mode.

Parameters
windowthe window to query.
Returns
true if keyboard is grabbed, and false otherwise.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowKeyboardGrab

◆ SDL_GetWindowMaximumSize()

bool SDL_GetWindowMaximumSize ( SDL_Window *  window,
int *  w,
int *  h 
)
extern

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

Parameters
windowthe window to query.
wa pointer filled in with the maximum width of the window, may be NULL.
ha pointer filled in with the maximum height of the window, may be NULL.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowMinimumSize
SDL_SetWindowMaximumSize

◆ SDL_GetWindowMinimumSize()

bool SDL_GetWindowMinimumSize ( SDL_Window *  window,
int *  w,
int *  h 
)
extern

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

Parameters
windowthe window to query.
wa pointer filled in with the minimum width of the window, may be NULL.
ha pointer filled in with the minimum height of the window, may be NULL.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowMaximumSize
SDL_SetWindowMinimumSize

◆ SDL_GetWindowMouseGrab()

bool SDL_GetWindowMouseGrab ( SDL_Window *  window)
extern

Get a window's mouse grab mode.

Parameters
windowthe window to query.
Returns
true if mouse is grabbed, and false otherwise.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowMouseRect
SDL_SetWindowMouseRect
SDL_SetWindowMouseGrab
SDL_SetWindowKeyboardGrab

◆ SDL_GetWindowMouseRect()

const SDL_Rect * SDL_GetWindowMouseRect ( SDL_Window *  window)
extern

Get the mouse confinement rectangle of a window.

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowMouseRect
SDL_GetWindowMouseGrab
SDL_SetWindowMouseGrab

◆ SDL_GetWindowOpacity()

float SDL_GetWindowOpacity ( SDL_Window *  window)
extern

Get the opacity of a window.

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

Parameters
windowthe window to get the current opacity value from.
Returns
the opacity, (0.0f - transparent, 1.0f - opaque), or -1.0f on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowOpacity

◆ SDL_GetWindowParent()

SDL_Window * SDL_GetWindowParent ( SDL_Window *  window)
extern

Get parent of a window.

Parameters
windowthe window to query.
Returns
the parent of the window on success or NULL if the window has no parent.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_CreatePopupWindow

◆ SDL_GetWindowPixelDensity()

float SDL_GetWindowPixelDensity ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to query.
Returns
the pixel density or 0.0f on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowDisplayScale

◆ SDL_GetWindowPixelFormat()

SDL_PixelFormat SDL_GetWindowPixelFormat ( SDL_Window *  window)
extern

Get the pixel format associated with the window.

Parameters
windowthe window to query.
Returns
the pixel format of the window on success or SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetWindowPosition()

bool SDL_GetWindowPosition ( SDL_Window *  window,
int *  x,
int *  y 
)
extern

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.

Parameters
windowthe window to query.
xa pointer filled in with the x position of the window, may be NULL.
ya pointer filled in with the y position of the window, may be NULL.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowPosition

◆ SDL_GetWindowProgressState()

SDL_ProgressState SDL_GetWindowProgressState ( SDL_Window *  window)
extern

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

Parameters
windowthe window to get the current progress state from.
Returns
the progress state, or SDL_PROGRESS_STATE_INVALID on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.4.0.

◆ SDL_GetWindowProgressValue()

float SDL_GetWindowProgressValue ( SDL_Window *  window)
extern

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

Parameters
windowthe window to get the current progress value from.
Returns
the progress value in the range of [0.0f - 1.0f], or -1.0f on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.4.0.

◆ SDL_GetWindowProperties()

SDL_PropertiesID SDL_GetWindowProperties ( SDL_Window *  window)
extern

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
Parameters
windowthe window to query.
Returns
a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetWindows()

SDL_Window ** SDL_GetWindows ( int *  count)
extern

Get a list of valid windows.

Parameters
counta pointer filled in with the number of windows returned, may be NULL.
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.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetWindowSafeArea()

bool SDL_GetWindowSafeArea ( SDL_Window *  window,
SDL_Rect *  rect 
)
extern

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.

Parameters
windowthe window to query.
recta pointer filled in with the client area that is safe for interactive content.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GetWindowSize()

bool SDL_GetWindowSize ( SDL_Window *  window,
int *  w,
int *  h 
)
extern

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.

Parameters
windowthe window to query the width and height from.
wa pointer filled in with the width of the window, may be NULL.
ha pointer filled in with the height of the window, may be NULL.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetRenderOutputSize
SDL_GetWindowSizeInPixels
SDL_SetWindowSize
SDL_EVENT_WINDOW_RESIZED

◆ SDL_GetWindowSizeInPixels()

bool SDL_GetWindowSizeInPixels ( SDL_Window *  window,
int *  w,
int *  h 
)
extern

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

Parameters
windowthe window from which the drawable size should be queried.
wa pointer to variable for storing the width in pixels, may be NULL.
ha pointer to variable for storing the height in pixels, may be NULL.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_CreateWindow
SDL_GetWindowSize

◆ SDL_GetWindowSurface()

SDL_Surface * SDL_GetWindowSurface ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to query.
Returns
the surface associated with the window, or NULL on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_DestroyWindowSurface
SDL_WindowHasSurface
SDL_UpdateWindowSurface
SDL_UpdateWindowSurfaceRects

◆ SDL_GetWindowSurfaceVSync()

bool SDL_GetWindowSurfaceVSync ( SDL_Window *  window,
int *  vsync 
)
extern

Get VSync for the window surface.

Parameters
windowthe window to query.
vsyncan int filled with the current vertical refresh sync interval. See SDL_SetWindowSurfaceVSync() for the meaning of the value.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowSurfaceVSync

◆ SDL_GetWindowTitle()

const char * SDL_GetWindowTitle ( SDL_Window *  window)
extern

Get the title of a window.

Parameters
windowthe window to query.
Returns
the title of the window in UTF-8 format or "" if there is no title.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowTitle

◆ SDL_GL_CreateContext()

SDL_GLContext SDL_GL_CreateContext ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to associate with the context.
Returns
the OpenGL context associated with window or NULL on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_DestroyContext
SDL_GL_MakeCurrent

◆ SDL_GL_DestroyContext()

bool SDL_GL_DestroyContext ( SDL_GLContext  context)
extern

Delete an OpenGL context.

Parameters
contextthe OpenGL context to be deleted.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_CreateContext

◆ SDL_GL_ExtensionSupported()

bool SDL_GL_ExtensionSupported ( const char *  extension)
extern

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.

Parameters
extensionthe name of the extension to check.
Returns
true if the extension is supported, false otherwise.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GL_GetAttribute()

bool SDL_GL_GetAttribute ( SDL_GLAttr  attr,
int *  value 
)
extern

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

Parameters
attran SDL_GLAttr enum value specifying the OpenGL attribute to get.
valuea pointer filled in with the current value of attr.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_ResetAttributes
SDL_GL_SetAttribute

◆ SDL_GL_GetCurrentContext()

SDL_GLContext SDL_GL_GetCurrentContext ( void  )
extern

Get the currently active OpenGL context.

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_MakeCurrent

◆ SDL_GL_GetCurrentWindow()

SDL_Window * SDL_GL_GetCurrentWindow ( void  )
extern

Get the currently active OpenGL window.

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GL_GetProcAddress()

SDL_FunctionPointer SDL_GL_GetProcAddress ( const char *  proc)
extern

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.
Parameters
procthe name of an OpenGL function.
Returns
a pointer to the named OpenGL function. The returned pointer should be cast to the appropriate function signature.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_ExtensionSupported
SDL_GL_LoadLibrary
SDL_GL_UnloadLibrary

◆ SDL_GL_GetSwapInterval()

bool SDL_GL_GetSwapInterval ( int *  interval)
extern

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.

Parameters
intervaloutput interval value. 0 if there is no vertical retrace synchronization, 1 if the buffer swap is synchronized with the vertical retrace, and -1 if late swaps happen immediately instead of waiting for the next retrace.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_SetSwapInterval

◆ SDL_GL_LoadLibrary()

bool SDL_GL_LoadLibrary ( const char *  path)
extern

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

Parameters
paththe platform dependent OpenGL library name, or NULL to open the default OpenGL library.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_GetProcAddress
SDL_GL_UnloadLibrary

◆ SDL_GL_MakeCurrent()

bool SDL_GL_MakeCurrent ( SDL_Window *  window,
SDL_GLContext  context 
)
extern

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

The context must have been created with a compatible window.

Parameters
windowthe window to associate with the context.
contextthe OpenGL context to associate with the window.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_CreateContext

◆ SDL_GL_ResetAttributes()

void SDL_GL_ResetAttributes ( void  )
extern

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

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_GetAttribute
SDL_GL_SetAttribute

◆ SDL_GL_SetAttribute()

bool SDL_GL_SetAttribute ( SDL_GLAttr  attr,
int  value 
)
extern

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.

Parameters
attran enum value specifying the OpenGL attribute to set.
valuethe desired value for the attribute.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_CreateContext
SDL_GL_GetAttribute
SDL_GL_ResetAttributes

◆ SDL_GL_SetSwapInterval()

bool SDL_GL_SetSwapInterval ( int  interval)
extern

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

Parameters
interval0 for immediate updates, 1 for updates synchronized with the vertical retrace, -1 for adaptive vsync.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_GetSwapInterval

◆ SDL_GL_SwapWindow()

bool SDL_GL_SwapWindow ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to change.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_GL_UnloadLibrary()

void SDL_GL_UnloadLibrary ( void  )
extern

Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GL_LoadLibrary

◆ SDL_HideWindow()

bool SDL_HideWindow ( SDL_Window *  window)
extern

Hide a window.

Parameters
windowthe window to hide.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_ShowWindow
SDL_WINDOW_HIDDEN

◆ SDL_MaximizeWindow()

bool SDL_MaximizeWindow ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to maximize.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_MinimizeWindow
SDL_RestoreWindow
SDL_SyncWindow

◆ SDL_MinimizeWindow()

bool SDL_MinimizeWindow ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to minimize.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_MaximizeWindow
SDL_RestoreWindow
SDL_SyncWindow

◆ SDL_RaiseWindow()

bool SDL_RaiseWindow ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to raise.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_RestoreWindow()

bool SDL_RestoreWindow ( SDL_Window *  window)
extern

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.

Parameters
windowthe window to restore.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_MaximizeWindow
SDL_MinimizeWindow
SDL_SyncWindow

◆ SDL_ScreenSaverEnabled()

bool SDL_ScreenSaverEnabled ( void  )
extern

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.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_DisableScreenSaver
SDL_EnableScreenSaver

◆ SDL_SetWindowAlwaysOnTop()

bool SDL_SetWindowAlwaysOnTop ( SDL_Window *  window,
bool  on_top 
)
extern

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.

Parameters
windowthe window of which to change the always on top state.
on_toptrue to set the window always on top, false to disable.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowAspectRatio()

bool SDL_SetWindowAspectRatio ( SDL_Window *  window,
float  min_aspect,
float  max_aspect 
)
extern

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.

Parameters
windowthe window to change.
min_aspectthe minimum aspect ratio of the window, or 0.0f for no limit.
max_aspectthe maximum aspect ratio of the window, or 0.0f for no limit.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowAspectRatio
SDL_SyncWindow

◆ SDL_SetWindowBordered()

bool SDL_SetWindowBordered ( SDL_Window *  window,
bool  bordered 
)
extern

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.

Parameters
windowthe window of which to change the border state.
borderedfalse to remove border, true to add border.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowFillDocument()

bool SDL_SetWindowFillDocument ( SDL_Window *  window,
bool  fill 
)
extern

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.

Parameters
windowthe window of which to change the fill-document state.
filltrue to set the window to fill the document, false to disable.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.4.0.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowFocusable()

bool SDL_SetWindowFocusable ( SDL_Window *  window,
bool  focusable 
)
extern

Set whether the window may have input focus.

Parameters
windowthe window to set focusable state.
focusabletrue to allow input focus, false to not allow input focus.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_SetWindowFullscreen()

bool SDL_SetWindowFullscreen ( SDL_Window *  window,
bool  fullscreen 
)
extern

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.

Parameters
windowthe window to change.
fullscreentrue for fullscreen mode, false for windowed mode.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowFullscreenMode
SDL_SetWindowFullscreenMode
SDL_SyncWindow
SDL_WINDOW_FULLSCREEN

◆ SDL_SetWindowFullscreenMode()

bool SDL_SetWindowFullscreenMode ( SDL_Window *  window,
const SDL_DisplayMode *  mode 
)
extern

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.

Parameters
windowthe window to affect.
modea pointer to the display mode to use, which can be NULL for borderless fullscreen desktop mode, or one of the fullscreen modes returned by SDL_GetFullscreenDisplayModes() to set an exclusive fullscreen mode.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowFullscreenMode
SDL_SetWindowFullscreen
SDL_SyncWindow

◆ SDL_SetWindowHitTest()

bool SDL_SetWindowHitTest ( SDL_Window *  window,
SDL_HitTest  callback,
void *  callback_data 
)
extern

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.

Parameters
windowthe window to set hit-testing on.
callbackthe function to call when doing a hit-test.
callback_dataan app-defined void pointer passed to callback.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_SetWindowIcon()

bool SDL_SetWindowIcon ( SDL_Window *  window,
SDL_Surface *  icon 
)
extern

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.

Parameters
windowthe window to change.
iconan SDL_Surface structure containing the icon for the window.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_AddSurfaceAlternateImage

◆ SDL_SetWindowKeyboardGrab()

bool SDL_SetWindowKeyboardGrab ( SDL_Window *  window,
bool  grabbed 
)
extern

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.

Parameters
windowthe window for which the keyboard grab mode should be set.
grabbedthis is true to grab keyboard, and false to release.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowKeyboardGrab
SDL_SetWindowMouseGrab

◆ SDL_SetWindowMaximumSize()

bool SDL_SetWindowMaximumSize ( SDL_Window *  window,
int  max_w,
int  max_h 
)
extern

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

Parameters
windowthe window to change.
max_wthe maximum width of the window, or 0 for no limit.
max_hthe maximum height of the window, or 0 for no limit.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowMaximumSize
SDL_SetWindowMinimumSize

◆ SDL_SetWindowMinimumSize()

bool SDL_SetWindowMinimumSize ( SDL_Window *  window,
int  min_w,
int  min_h 
)
extern

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

Parameters
windowthe window to change.
min_wthe minimum width of the window, or 0 for no limit.
min_hthe minimum height of the window, or 0 for no limit.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowMinimumSize
SDL_SetWindowMaximumSize

◆ SDL_SetWindowModal()

bool SDL_SetWindowModal ( SDL_Window *  window,
bool  modal 
)
extern

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.

Parameters
windowthe window on which to set the modal state.
modaltrue to toggle modal status on, false to toggle it off.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowParent
SDL_WINDOW_MODAL

◆ SDL_SetWindowMouseGrab()

bool SDL_SetWindowMouseGrab ( SDL_Window *  window,
bool  grabbed 
)
extern

Set a window's mouse grab mode.

Mouse grab confines the mouse cursor to the window.

Parameters
windowthe window for which the mouse grab mode should be set.
grabbedthis is true to grab mouse, and false to release.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowMouseRect
SDL_SetWindowMouseRect
SDL_SetWindowKeyboardGrab

◆ SDL_SetWindowMouseRect()

bool SDL_SetWindowMouseRect ( SDL_Window *  window,
const SDL_Rect *  rect 
)
extern

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.

Parameters
windowthe window that will be associated with the barrier.
recta rectangle area in window-relative coordinates. If NULL the barrier for the specified window will be destroyed.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowMouseRect
SDL_GetWindowMouseGrab
SDL_SetWindowMouseGrab

◆ SDL_SetWindowOpacity()

bool SDL_SetWindowOpacity ( SDL_Window *  window,
float  opacity 
)
extern

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.

Parameters
windowthe window which will be made transparent or opaque.
opacitythe opacity value (0.0f - transparent, 1.0f - opaque).
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowOpacity

◆ SDL_SetWindowParent()

bool SDL_SetWindowParent ( SDL_Window *  window,
SDL_Window *  parent 
)
extern

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.

Parameters
windowthe window that should become the child of a parent.
parentthe new parent window for the child window.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowModal

◆ SDL_SetWindowPosition()

bool SDL_SetWindowPosition ( SDL_Window *  window,
int  x,
int  y 
)
extern

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.

Parameters
windowthe window to reposition.
xthe x coordinate of the window, or SDL_WINDOWPOS_CENTERED or SDL_WINDOWPOS_UNDEFINED.
ythe y coordinate of the window, or SDL_WINDOWPOS_CENTERED or SDL_WINDOWPOS_UNDEFINED.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowPosition
SDL_SyncWindow

◆ SDL_SetWindowProgressState()

bool SDL_SetWindowProgressState ( SDL_Window *  window,
SDL_ProgressState  state 
)
extern

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

Parameters
windowthe window whose progress state is to be modified.
statethe progress state. SDL_PROGRESS_STATE_NONE stops displaying the progress bar.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.4.0.

◆ SDL_SetWindowProgressValue()

bool SDL_SetWindowProgressValue ( SDL_Window *  window,
float  value 
)
extern

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

Parameters
windowthe window whose progress value is to be modified.
valuethe progress value in the range of [0.0f - 1.0f]. If the value is outside the valid range, it gets clamped.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.4.0.

◆ SDL_SetWindowResizable()

bool SDL_SetWindowResizable ( SDL_Window *  window,
bool  resizable 
)
extern

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.

Parameters
windowthe window of which to change the resizable state.
resizabletrue to allow resizing, false to disallow.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowShape()

bool SDL_SetWindowShape ( SDL_Window *  window,
SDL_Surface *  shape 
)
extern

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.

Parameters
windowthe window.
shapethe surface representing the shape of the window, or NULL to remove any current shape.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_SetWindowSize()

bool SDL_SetWindowSize ( SDL_Window *  window,
int  w,
int  h 
)
extern

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.

Parameters
windowthe window to change.
wthe width of the window, must be > 0.
hthe height of the window, must be > 0.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowSize
SDL_SetWindowFullscreenMode
SDL_SyncWindow

◆ SDL_SetWindowSurfaceVSync()

bool SDL_SetWindowSurfaceVSync ( SDL_Window *  window,
int  vsync 
)
extern

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.

Parameters
windowthe window.
vsyncthe vertical refresh sync interval.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowSurfaceVSync

◆ SDL_SetWindowTitle()

bool SDL_SetWindowTitle ( SDL_Window *  window,
const char *  title 
)
extern

Set the title of a window.

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

Parameters
windowthe window to change.
titlethe desired window title in UTF-8 format.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowTitle

◆ SDL_ShowWindow()

bool SDL_ShowWindow ( SDL_Window *  window)
extern

Show a window.

Parameters
windowthe window to show.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_HideWindow
SDL_RaiseWindow

◆ SDL_ShowWindowSystemMenu()

bool SDL_ShowWindowSystemMenu ( SDL_Window *  window,
int  x,
int  y 
)
extern

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.

Parameters
windowthe window for which the menu will be displayed.
xthe x coordinate of the menu, relative to the origin (top-left) of the client area.
ythe y coordinate of the menu, relative to the origin (top-left) of the client area.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.

◆ SDL_SyncWindow()

bool SDL_SyncWindow ( SDL_Window *  window)
extern

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.

Parameters
windowthe window for which to wait for the pending state to be applied.
Returns
true on success or false if the operation timed out before the window was in the requested state.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_SetWindowSize
SDL_SetWindowPosition
SDL_SetWindowFullscreen
SDL_MinimizeWindow
SDL_MaximizeWindow
SDL_RestoreWindow
SDL_HINT_VIDEO_SYNC_WINDOW_OPERATIONS

◆ SDL_UpdateWindowSurface()

bool SDL_UpdateWindowSurface ( SDL_Window *  window)
extern

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

Parameters
windowthe window to update.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowSurface
SDL_UpdateWindowSurfaceRects

◆ SDL_UpdateWindowSurfaceRects()

bool SDL_UpdateWindowSurfaceRects ( SDL_Window *  window,
const SDL_Rect *  rects,
int  numrects 
)
extern

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.

Parameters
windowthe window to update.
rectsan array of SDL_Rect structures representing areas of the surface to copy, in pixels.
numrectsthe number of rectangles.
Returns
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowSurface
SDL_UpdateWindowSurface

◆ SDL_WindowHasSurface()

bool SDL_WindowHasSurface ( SDL_Window *  window)
extern

Return whether the window has a surface associated with it.

Parameters
windowthe window to query.
Returns
true if there is a surface associated with the window, or false otherwise.

\threadsafety This function should only be called on the main thread.

Since
This function is available since SDL 3.2.0.
See also
SDL_GetWindowSurface