SDL 3.0
SDL_video.h File Reference
+ 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_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_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_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_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_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_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_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_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_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 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_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_GLprofile {
  SDL_GL_CONTEXT_PROFILE_CORE = 0x0001 ,
  SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002 ,
  SDL_GL_CONTEXT_PROFILE_ES = 0x0004
}
 
enum  SDL_GLcontextFlag {
  SDL_GL_CONTEXT_DEBUG_FLAG = 0x0001 ,
  SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002 ,
  SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG = 0x0004 ,
  SDL_GL_CONTEXT_RESET_ISOLATION_FLAG = 0x0008
}
 
enum  SDL_GLcontextReleaseFlag {
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE = 0x0000 ,
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH = 0x0001
}
 
enum  SDL_GLContextResetNotification {
  SDL_GL_CONTEXT_RESET_NO_NOTIFICATION = 0x0000 ,
  SDL_GL_CONTEXT_RESET_LOSE_CONTEXT = 0x0001
}
 
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_DisplayIDSDL_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 *mode)
 
const SDL_DisplayModeSDL_GetDesktopDisplayMode (SDL_DisplayID displayID)
 
const SDL_DisplayModeSDL_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_DisplayModeSDL_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_WindowSDL_CreateWindow (const char *title, int w, int h, SDL_WindowFlags flags)
 
SDL_WindowSDL_CreatePopupWindow (SDL_Window *parent, int offset_x, int offset_y, int w, int h, SDL_WindowFlags flags)
 
SDL_WindowSDL_CreateWindowWithProperties (SDL_PropertiesID props)
 
SDL_WindowID SDL_GetWindowID (SDL_Window *window)
 
SDL_WindowSDL_GetWindowFromID (SDL_WindowID id)
 
SDL_WindowSDL_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_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_SurfaceSDL_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_WindowSDL_GetGrabbedWindow (void)
 
bool SDL_SetWindowMouseRect (SDL_Window *window, const SDL_Rect *rect)
 
const SDL_RectSDL_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)
 
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_WindowSDL_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_PROP_DISPLAY_HDR_ENABLED_BOOLEAN

#define SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN   "SDL.display.HDR_enabled"

Definition at line 524 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 525 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.

Definition at line 101 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 1340 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 1339 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 1350 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 1349 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 1142 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 1143 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 1169 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 1168 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 1145 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 1146 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 1144 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 1147 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 1148 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 1149 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 1150 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 1151 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 1152 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 1153 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 1154 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 1155 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 1156 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 1157 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 1158 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 1159 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 1160 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 1162 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 1161 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 1163 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 1164 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 1171 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 1170 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 1172 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 1165 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 1173 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 1174 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 1175 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 1166 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 1167 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 1336 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 1338 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 1346 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 1347 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 1348 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 1337 of file SDL_video.h.

◆ SDL_PROP_WINDOW_SHAPE_POINTER

#define SDL_PROP_WINDOW_SHAPE_POINTER   "SDL.window.shape"

Definition at line 1335 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 1342 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 1343 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 1344 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 1345 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 1341 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 1351 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 1353 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 1352 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 1357 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 1359 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 1358 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 1363 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 1364 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 1360 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 1362 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 1361 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 1355 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 1354 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 1356 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 1365 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 1366 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 1367 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 197 of file SDL_video.h.

◆ SDL_WINDOW_BORDERLESS

#define SDL_WINDOW_BORDERLESS   SDL_UINT64_C(0x0000000000000010)

no window decoration

Definition at line 185 of file SDL_video.h.

◆ SDL_WINDOW_EXTERNAL

#define SDL_WINDOW_EXTERNAL   SDL_UINT64_C(0x0000000000000800)

window not created by SDL

Definition at line 192 of file SDL_video.h.

◆ SDL_WINDOW_FULLSCREEN

#define SDL_WINDOW_FULLSCREEN   SDL_UINT64_C(0x0000000000000001)

window is in fullscreen mode

Definition at line 181 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 184 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 194 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 190 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 201 of file SDL_video.h.

◆ SDL_WINDOW_MAXIMIZED

#define SDL_WINDOW_MAXIMIZED   SDL_UINT64_C(0x0000000000000080)

window is maximized

Definition at line 188 of file SDL_video.h.

◆ SDL_WINDOW_METAL

#define SDL_WINDOW_METAL   SDL_UINT64_C(0x0000000020000000)

window usable for Metal view

Definition at line 203 of file SDL_video.h.

◆ SDL_WINDOW_MINIMIZED

#define SDL_WINDOW_MINIMIZED   SDL_UINT64_C(0x0000000000000040)

window is minimized

Definition at line 187 of file SDL_video.h.

◆ SDL_WINDOW_MODAL

#define SDL_WINDOW_MODAL   SDL_UINT64_C(0x0000000000001000)

window is modal

Definition at line 193 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 195 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 191 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 189 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 196 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 205 of file SDL_video.h.

◆ SDL_WINDOW_OCCLUDED

#define SDL_WINDOW_OCCLUDED   SDL_UINT64_C(0x0000000000000004)

window is occluded

Definition at line 183 of file SDL_video.h.

◆ SDL_WINDOW_OPENGL

#define SDL_WINDOW_OPENGL   SDL_UINT64_C(0x0000000000000002)

window usable with OpenGL context

Definition at line 182 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 200 of file SDL_video.h.

◆ SDL_WINDOW_RESIZABLE

#define SDL_WINDOW_RESIZABLE   SDL_UINT64_C(0x0000000000000020)

window can be resized

Definition at line 186 of file SDL_video.h.

◆ SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE

#define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE   (-1)

Definition at line 2061 of file SDL_video.h.

◆ SDL_WINDOW_SURFACE_VSYNC_DISABLED

#define SDL_WINDOW_SURFACE_VSYNC_DISABLED   0

Definition at line 2060 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 199 of file SDL_video.h.

◆ SDL_WINDOW_TRANSPARENT

#define SDL_WINDOW_TRANSPARENT   SDL_UINT64_C(0x0000000040000000)

window with transparent buffer

Definition at line 204 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 198 of file SDL_video.h.

◆ SDL_WINDOW_VULKAN

#define SDL_WINDOW_VULKAN   SDL_UINT64_C(0x0000000010000000)

window usable for Vulkan surface

Definition at line 202 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 226 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

Definition at line 225 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_MASK

#define SDL_WINDOWPOS_CENTERED_MASK   0x2FFF0000u

Used to indicate that the window position should be centered.

Since
This macro is available since SDL 3.0.0.

Definition at line 224 of file SDL_video.h.

◆ SDL_WINDOWPOS_ISCENTERED

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

Definition at line 227 of file SDL_video.h.

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

◆ SDL_WINDOWPOS_ISUNDEFINED

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

Definition at line 216 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 215 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

Definition at line 214 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_MASK

#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u

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

Since
This macro is available since SDL 3.0.0.

Definition at line 213 of file SDL_video.h.

Typedef Documentation

◆ 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.0.0.

Definition at line 75 of file SDL_video.h.

◆ SDL_DisplayModeData

Definition at line 116 of file SDL_video.h.

◆ SDL_EGLAttrib

typedef intptr_t SDL_EGLAttrib

Definition at line 259 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.0.0.
See also
SDL_EGL_SetAttributeCallbacks

Definition at line 285 of file SDL_video.h.

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

Definition at line 257 of file SDL_video.h.

◆ SDL_EGLDisplay

typedef void* SDL_EGLDisplay

Opaque EGL types.

Since
This datatype is available since SDL 3.0.0.

Definition at line 256 of file SDL_video.h.

◆ SDL_EGLint

typedef int SDL_EGLint

Definition at line 260 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.0.0.
See also
SDL_EGL_SetAttributeCallbacks

Definition at line 316 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Definition at line 258 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.0.0.
See also
SDL_GL_CreateContext

Definition at line 249 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 2398 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.0.0.
See also
SDL_CreateWindow

Definition at line 165 of file SDL_video.h.

◆ 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.

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

Definition at line 179 of file SDL_video.h.

◆ 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.0.0.

Definition at line 84 of file SDL_video.h.

Enumeration Type Documentation

◆ SDL_DisplayOrientation

Display orientation values; the way a display is rotated.

Since
This enum is available since SDL 3.0.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 149 of file SDL_video.h.

150{
151 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
152 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
153 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
154 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
155 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
@ SDL_ORIENTATION_LANDSCAPE
Definition SDL_video.h:152
@ SDL_ORIENTATION_PORTRAIT
Definition SDL_video.h:154
@ SDL_ORIENTATION_PORTRAIT_FLIPPED
Definition SDL_video.h:155
@ SDL_ORIENTATION_LANDSCAPE_FLIPPED
Definition SDL_video.h:153
@ SDL_ORIENTATION_UNKNOWN
Definition SDL_video.h:151

◆ SDL_FlashOperation

Window flash operation.

Since
This enum is available since SDL 3.0.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 235 of file SDL_video.h.

236{
237 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
238 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
239 SDL_FLASH_UNTIL_FOCUSED /**< Flash the window until it gets focus */

◆ 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.0.0.
Enumerator
SDL_GL_RED_SIZE 

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

SDL_GL_GREEN_SIZE 

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

SDL_GL_BLUE_SIZE 

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

SDL_GL_ALPHA_SIZE 

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

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; defaults to 0.

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 335 of file SDL_video.h.

336{
337 SDL_GL_RED_SIZE, /**< the minimum number of bits for the red channel of the color buffer; defaults to 3. */
338 SDL_GL_GREEN_SIZE, /**< the minimum number of bits for the green channel of the color buffer; defaults to 3. */
339 SDL_GL_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the color buffer; defaults to 2. */
340 SDL_GL_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the color buffer; defaults to 0. */
341 SDL_GL_BUFFER_SIZE, /**< the minimum number of bits for frame buffer size; defaults to 0. */
342 SDL_GL_DOUBLEBUFFER, /**< whether the output is single or double buffered; defaults to double buffering on. */
343 SDL_GL_DEPTH_SIZE, /**< the minimum number of bits in the depth buffer; defaults to 16. */
344 SDL_GL_STENCIL_SIZE, /**< the minimum number of bits in the stencil buffer; defaults to 0. */
345 SDL_GL_ACCUM_RED_SIZE, /**< the minimum number of bits for the red channel of the accumulation buffer; defaults to 0. */
346 SDL_GL_ACCUM_GREEN_SIZE, /**< the minimum number of bits for the green channel of the accumulation buffer; defaults to 0. */
347 SDL_GL_ACCUM_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0. */
348 SDL_GL_ACCUM_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0. */
349 SDL_GL_STEREO, /**< whether the output is stereo 3D; defaults to off. */
350 SDL_GL_MULTISAMPLEBUFFERS, /**< the number of buffers used for multisample anti-aliasing; defaults to 0. */
351 SDL_GL_MULTISAMPLESAMPLES, /**< the number of samples used around the current pixel used for multisample anti-aliasing. */
352 SDL_GL_ACCELERATED_VISUAL, /**< set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either. */
353 SDL_GL_RETAINED_BACKING, /**< not used (deprecated). */
354 SDL_GL_CONTEXT_MAJOR_VERSION, /**< OpenGL context major version. */
355 SDL_GL_CONTEXT_MINOR_VERSION, /**< OpenGL context minor version. */
356 SDL_GL_CONTEXT_FLAGS, /**< some combination of 0 or more of elements of the SDL_GLcontextFlag enumeration; defaults to 0. */
357 SDL_GL_CONTEXT_PROFILE_MASK, /**< type of GL context (Core, Compatibility, ES). See SDL_GLprofile; default value depends on platform. */
358 SDL_GL_SHARE_WITH_CURRENT_CONTEXT, /**< OpenGL context sharing; defaults to 0. */
359 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, /**< requests sRGB capable visual; defaults to 0. */
360 SDL_GL_CONTEXT_RELEASE_BEHAVIOR, /**< sets context the release behavior. See SDL_GLcontextReleaseFlag; defaults to FLUSH. */
361 SDL_GL_CONTEXT_RESET_NOTIFICATION, /**< set context reset notification. See SDL_GLContextResetNotification; defaults to NO_NOTIFICATION. */
365} SDL_GLattr;

◆ SDL_GLcontextFlag

Possible values to be set for the SDL_GL_CONTEXT_FLAGS attribute.

Since
This enum is available since SDL 3.0.0.
Enumerator
SDL_GL_CONTEXT_DEBUG_FLAG 
SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG 
SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG 
SDL_GL_CONTEXT_RESET_ISOLATION_FLAG 

Definition at line 384 of file SDL_video.h.

◆ SDL_GLcontextReleaseFlag

Possible values to be set for the SDL_GL_CONTEXT_RELEASE_BEHAVIOR attribute.

Since
This enum is available since SDL 3.0.0.
Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 

Definition at line 398 of file SDL_video.h.

◆ SDL_GLContextResetNotification

Possible values to be set SDL_GL_CONTEXT_RESET_NOTIFICATION attribute.

Since
This enum is available since SDL 3.0.0.
Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 

Definition at line 409 of file SDL_video.h.

◆ SDL_GLprofile

Possible values to be set for the SDL_GL_CONTEXT_PROFILE_MASK attribute.

Since
This enum is available since SDL 3.0.0.
Enumerator
SDL_GL_CONTEXT_PROFILE_CORE 
SDL_GL_CONTEXT_PROFILE_COMPATIBILITY 
SDL_GL_CONTEXT_PROFILE_ES 

GLX_CONTEXT_ES2_PROFILE_BIT_EXT

Definition at line 372 of file SDL_video.h.

373{
376 SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */

◆ SDL_HitTestResult

Possible return values from the SDL_HitTest callback.

Since
This enum is available since SDL 3.0.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 2374 of file SDL_video.h.

2375{
2376 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
2377 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
2378 SDL_HITTEST_RESIZE_TOPLEFT, /**< Region is the resizable top-left corner border. */
2379 SDL_HITTEST_RESIZE_TOP, /**< Region is the resizable top border. */
2380 SDL_HITTEST_RESIZE_TOPRIGHT, /**< Region is the resizable top-right corner border. */
2381 SDL_HITTEST_RESIZE_RIGHT, /**< Region is the resizable right border. */
2382 SDL_HITTEST_RESIZE_BOTTOMRIGHT, /**< Region is the resizable bottom-right corner border. */
2383 SDL_HITTEST_RESIZE_BOTTOM, /**< Region is the resizable bottom border. */
2384 SDL_HITTEST_RESIZE_BOTTOMLEFT, /**< Region is the resizable bottom-left corner border. */
2385 SDL_HITTEST_RESIZE_LEFT /**< Region is the resizable left border. */

◆ SDL_SystemTheme

System theme.

Since
This enum is available since SDL 3.0.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 108 of file SDL_video.h.

109{
110 SDL_SYSTEM_THEME_UNKNOWN, /**< Unknown system theme */
111 SDL_SYSTEM_THEME_LIGHT, /**< Light colored system theme */
112 SDL_SYSTEM_THEME_DARK /**< Dark colored system theme */
@ SDL_SYSTEM_THEME_LIGHT
Definition SDL_video.h:111
@ SDL_SYSTEM_THEME_UNKNOWN
Definition SDL_video.h:110
@ SDL_SYSTEM_THEME_DARK
Definition SDL_video.h:112

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.

'flags' must contain exactly 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 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 modal 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.

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

If the parent window is destroyed, any child popup windows will be recursively destroyed as well.

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.
Since
This function is available since SDL 3.0.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.

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_OCCLUDED: window partially or completely obscured by another window
  • 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 is implicitly shown if SDL_WINDOW_HIDDEN is not set.

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.
Since
This function is available since SDL 3.0.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.

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_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 "toolip", "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 "parent" 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 "parent" 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 Wayland:

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

These are additional supported properties on Windows:

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

These are additional supported properties with X11:

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

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

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.
Since
This function is available since SDL 3.0.0.
See also
SDL_CreateProperties
SDL_CreateWindow
SDL_DestroyWindow

◆ SDL_DestroyWindow()

void SDL_DestroyWindow ( SDL_Window window)
extern

Destroy a window.

Any popups or modal windows owned by the window will be recursively destroyed as well.

Parameters
windowthe window to destroy.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetClosestFullscreenDisplayMode()

bool SDL_GetClosestFullscreenDisplayMode ( SDL_DisplayID  displayID,
int  w,
int  h,
float  refresh_rate,
bool  include_high_density_modes,
SDL_DisplayMode mode 
)
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 NULL 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.
modea 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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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 always located at (0,0).

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.
Since
This function is available since SDL 3.0.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.

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.
Since
This function is available since SDL 3.0.0.
See also
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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetNumVideoDrivers

◆ SDL_GetWindowAspectRatio()

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

Get the size 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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.
See also
SDL_CreateWindow
SDL_HideWindow
SDL_MaximizeWindow
SDL_MinimizeWindow
SDL_SetWindowFullscreen
SDL_SetWindowMouseGrab
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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.
See also
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.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowMouseRect

◆ 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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowPosition

◆ 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 assocated 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 assocated with metal views on the 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_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
Parameters
windowthe window to query.
Returns
a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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 interactible content. You should continue rendering into the rest of the window, but it should not contain visually important or interactible 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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetRenderOutputSize
SDL_GetWindowSizeInPixels
SDL_SetWindowSize

◆ 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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.

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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.

Since
This function is available since SDL 3.0.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 SDL_GLattr 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.
Since
This function is available since SDL 3.0.0.
See also
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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.

◆ SDL_GL_UnloadLibrary()

void SDL_GL_UnloadLibrary ( void  )
extern

Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().

Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.
See also
SDL_ShowWindow

◆ 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.
Since
This function is available since SDL 3.0.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.

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_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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.

◆ SDL_RestoreWindow()

bool SDL_RestoreWindow ( SDL_Window window)
extern

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

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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowFullscreenMode
SDL_SetWindowFullscreenMode
SDL_SyncWindow

◆ 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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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, 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.
Since
This function is available since SDL 3.0.0.

◆ 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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowParent

◆ 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.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowMouseGrab
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.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowMouseRect
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.
Since
This function is available since SDL 3.0.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.

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

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.
Since
This function is available since SDL 3.0.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, at the time of this request, the window is in a fixed-size state such as maximized, this request may be deferred until the window returns to a resizable state.

This can be used to reposition fullscreen-desktop windows onto a different display, however, exclusive fullscreen windows are locked to a specific display and 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.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowPosition
SDL_SyncWindow

◆ 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.
Since
This function is available since SDL 3.0.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 setting the alpha channel of the window yourself.

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.

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.
Since
This function is available since SDL 3.0.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, 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.

To change the 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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.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.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowSurface