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_WINRT_WINDOW_POINTER   "SDL.window.winrt.window"
 
#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)
 
typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)
 
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)
 
SDL_bool SDL_GetDisplayBounds (SDL_DisplayID displayID, SDL_Rect *rect)
 
SDL_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)
 
SDL_bool SDL_GetClosestFullscreenDisplayMode (SDL_DisplayID displayID, int w, int h, float refresh_rate, SDL_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)
 
SDL_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)
 
SDL_bool SDL_SetWindowTitle (SDL_Window *window, const char *title)
 
const char * SDL_GetWindowTitle (SDL_Window *window)
 
SDL_bool SDL_SetWindowIcon (SDL_Window *window, SDL_Surface *icon)
 
SDL_bool SDL_SetWindowPosition (SDL_Window *window, int x, int y)
 
SDL_bool SDL_GetWindowPosition (SDL_Window *window, int *x, int *y)
 
SDL_bool SDL_SetWindowSize (SDL_Window *window, int w, int h)
 
SDL_bool SDL_GetWindowSize (SDL_Window *window, int *w, int *h)
 
SDL_bool SDL_GetWindowSafeArea (SDL_Window *window, SDL_Rect *rect)
 
SDL_bool SDL_SetWindowAspectRatio (SDL_Window *window, float min_aspect, float max_aspect)
 
SDL_bool SDL_GetWindowAspectRatio (SDL_Window *window, float *min_aspect, float *max_aspect)
 
SDL_bool SDL_GetWindowBordersSize (SDL_Window *window, int *top, int *left, int *bottom, int *right)
 
SDL_bool SDL_GetWindowSizeInPixels (SDL_Window *window, int *w, int *h)
 
SDL_bool SDL_SetWindowMinimumSize (SDL_Window *window, int min_w, int min_h)
 
SDL_bool SDL_GetWindowMinimumSize (SDL_Window *window, int *w, int *h)
 
SDL_bool SDL_SetWindowMaximumSize (SDL_Window *window, int max_w, int max_h)
 
SDL_bool SDL_GetWindowMaximumSize (SDL_Window *window, int *w, int *h)
 
SDL_bool SDL_SetWindowBordered (SDL_Window *window, SDL_bool bordered)
 
SDL_bool SDL_SetWindowResizable (SDL_Window *window, SDL_bool resizable)
 
SDL_bool SDL_SetWindowAlwaysOnTop (SDL_Window *window, SDL_bool on_top)
 
SDL_bool SDL_ShowWindow (SDL_Window *window)
 
SDL_bool SDL_HideWindow (SDL_Window *window)
 
SDL_bool SDL_RaiseWindow (SDL_Window *window)
 
SDL_bool SDL_MaximizeWindow (SDL_Window *window)
 
SDL_bool SDL_MinimizeWindow (SDL_Window *window)
 
SDL_bool SDL_RestoreWindow (SDL_Window *window)
 
SDL_bool SDL_SetWindowFullscreen (SDL_Window *window, SDL_bool fullscreen)
 
SDL_bool SDL_SyncWindow (SDL_Window *window)
 
SDL_bool SDL_WindowHasSurface (SDL_Window *window)
 
SDL_SurfaceSDL_GetWindowSurface (SDL_Window *window)
 
SDL_bool SDL_SetWindowSurfaceVSync (SDL_Window *window, int vsync)
 
SDL_bool SDL_GetWindowSurfaceVSync (SDL_Window *window, int *vsync)
 
SDL_bool SDL_UpdateWindowSurface (SDL_Window *window)
 
SDL_bool SDL_UpdateWindowSurfaceRects (SDL_Window *window, const SDL_Rect *rects, int numrects)
 
SDL_bool SDL_DestroyWindowSurface (SDL_Window *window)
 
SDL_bool SDL_SetWindowKeyboardGrab (SDL_Window *window, SDL_bool grabbed)
 
SDL_bool SDL_SetWindowMouseGrab (SDL_Window *window, SDL_bool grabbed)
 
SDL_bool SDL_GetWindowKeyboardGrab (SDL_Window *window)
 
SDL_bool SDL_GetWindowMouseGrab (SDL_Window *window)
 
SDL_WindowSDL_GetGrabbedWindow (void)
 
SDL_bool SDL_SetWindowMouseRect (SDL_Window *window, const SDL_Rect *rect)
 
const SDL_RectSDL_GetWindowMouseRect (SDL_Window *window)
 
SDL_bool SDL_SetWindowOpacity (SDL_Window *window, float opacity)
 
float SDL_GetWindowOpacity (SDL_Window *window)
 
SDL_bool SDL_SetWindowModalFor (SDL_Window *modal_window, SDL_Window *parent_window)
 
SDL_bool SDL_SetWindowFocusable (SDL_Window *window, SDL_bool focusable)
 
SDL_bool SDL_ShowWindowSystemMenu (SDL_Window *window, int x, int y)
 
SDL_bool SDL_SetWindowHitTest (SDL_Window *window, SDL_HitTest callback, void *callback_data)
 
SDL_bool SDL_SetWindowShape (SDL_Window *window, SDL_Surface *shape)
 
SDL_bool SDL_FlashWindow (SDL_Window *window, SDL_FlashOperation operation)
 
void SDL_DestroyWindow (SDL_Window *window)
 
SDL_bool SDL_ScreenSaverEnabled (void)
 
SDL_bool SDL_EnableScreenSaver (void)
 
SDL_bool SDL_DisableScreenSaver (void)
 
OpenGL support functions
SDL_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)
 
SDL_bool SDL_GL_ExtensionSupported (const char *extension)
 
void SDL_GL_ResetAttributes (void)
 
SDL_bool SDL_GL_SetAttribute (SDL_GLattr attr, int value)
 
SDL_bool SDL_GL_GetAttribute (SDL_GLattr attr, int *value)
 
SDL_GLContext SDL_GL_CreateContext (SDL_Window *window)
 
SDL_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)
 
SDL_bool SDL_GL_SetSwapInterval (int interval)
 
SDL_bool SDL_GL_GetSwapInterval (int *interval)
 
SDL_bool SDL_GL_SwapWindow (SDL_Window *window)
 
SDL_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 455 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 456 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 80 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 1275 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 1274 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 1285 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 1284 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 1072 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 1073 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 1099 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 1098 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 1075 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 1076 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 1074 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 1077 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 1078 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 1079 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 1080 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 1081 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 1082 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 1083 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 1084 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 1085 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 1086 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 1087 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 1088 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 1089 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 1090 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 1092 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 1091 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 1093 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 1094 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 1101 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 1100 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 1102 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 1095 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 1103 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 1104 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 1105 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 1096 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 1097 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 1271 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 1273 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 1281 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 1282 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 1283 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 1272 of file SDL_video.h.

◆ SDL_PROP_WINDOW_SHAPE_POINTER

#define SDL_PROP_WINDOW_SHAPE_POINTER   "SDL.window.shape"

Definition at line 1270 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 1277 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 1278 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 1279 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 1280 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 1276 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 1286 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 1288 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 1287 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 1293 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 1295 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 1294 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 1299 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 1300 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 1296 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 1298 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 1297 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 1291 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 1290 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 1292 of file SDL_video.h.

◆ SDL_PROP_WINDOW_WINRT_WINDOW_POINTER

#define SDL_PROP_WINDOW_WINRT_WINDOW_POINTER   "SDL.window.winrt.window"

Definition at line 1289 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 1301 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 1302 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 1303 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 176 of file SDL_video.h.

◆ SDL_WINDOW_BORDERLESS

#define SDL_WINDOW_BORDERLESS   SDL_UINT64_C(0x0000000000000010)

no window decoration

Definition at line 164 of file SDL_video.h.

◆ SDL_WINDOW_EXTERNAL

#define SDL_WINDOW_EXTERNAL   SDL_UINT64_C(0x0000000000000800)

window not created by SDL

Definition at line 171 of file SDL_video.h.

◆ SDL_WINDOW_FULLSCREEN

#define SDL_WINDOW_FULLSCREEN   SDL_UINT64_C(0x0000000000000001)

window is in fullscreen mode

Definition at line 160 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 163 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 173 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 169 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 180 of file SDL_video.h.

◆ SDL_WINDOW_MAXIMIZED

#define SDL_WINDOW_MAXIMIZED   SDL_UINT64_C(0x0000000000000080)

window is maximized

Definition at line 167 of file SDL_video.h.

◆ SDL_WINDOW_METAL

#define SDL_WINDOW_METAL   SDL_UINT64_C(0x0000000020000000)

window usable for Metal view

Definition at line 182 of file SDL_video.h.

◆ SDL_WINDOW_MINIMIZED

#define SDL_WINDOW_MINIMIZED   SDL_UINT64_C(0x0000000000000040)

window is minimized

Definition at line 166 of file SDL_video.h.

◆ SDL_WINDOW_MODAL

#define SDL_WINDOW_MODAL   SDL_UINT64_C(0x0000000000001000)

window is modal

Definition at line 172 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 174 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 170 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 168 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 175 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 184 of file SDL_video.h.

◆ SDL_WINDOW_OCCLUDED

#define SDL_WINDOW_OCCLUDED   SDL_UINT64_C(0x0000000000000004)

window is occluded

Definition at line 162 of file SDL_video.h.

◆ SDL_WINDOW_OPENGL

#define SDL_WINDOW_OPENGL   SDL_UINT64_C(0x0000000000000002)

window usable with OpenGL context

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

◆ SDL_WINDOW_RESIZABLE

#define SDL_WINDOW_RESIZABLE   SDL_UINT64_C(0x0000000000000020)

window can be resized

Definition at line 165 of file SDL_video.h.

◆ SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE

#define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE   (-1)

Definition at line 1998 of file SDL_video.h.

◆ SDL_WINDOW_SURFACE_VSYNC_DISABLED

#define SDL_WINDOW_SURFACE_VSYNC_DISABLED   0

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

◆ SDL_WINDOW_TRANSPARENT

#define SDL_WINDOW_TRANSPARENT   SDL_UINT64_C(0x0000000040000000)

window with transparent buffer

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

◆ SDL_WINDOW_VULKAN

#define SDL_WINDOW_VULKAN   SDL_UINT64_C(0x0000000010000000)

window usable for Vulkan surface

Definition at line 181 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 205 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

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

◆ SDL_WINDOWPOS_ISCENTERED

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

Definition at line 206 of file SDL_video.h.

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

◆ SDL_WINDOWPOS_ISUNDEFINED

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

Definition at line 195 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 194 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

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

Typedef Documentation

◆ SDL_DisplayID

CategoryVideo

SDL video functions. 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 54 of file SDL_video.h.

◆ SDL_DisplayModeData

Definition at line 95 of file SDL_video.h.

◆ SDL_EGLAttrib

typedef intptr_t SDL_EGLAttrib

Definition at line 238 of file SDL_video.h.

◆ SDL_EGLAttribArrayCallback

typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void)

EGL attribute initialization callback types.

Since
This datatype is available since SDL 3.0.0.

Definition at line 246 of file SDL_video.h.

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

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

◆ SDL_EGLint

typedef int SDL_EGLint

Definition at line 239 of file SDL_video.h.

◆ SDL_EGLIntArrayCallback

typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)

Definition at line 247 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Definition at line 237 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 228 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 2313 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 144 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 158 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 63 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 128 of file SDL_video.h.

129{
130 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
131 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
132 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
133 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
134 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
@ SDL_ORIENTATION_LANDSCAPE
Definition SDL_video.h:131
@ SDL_ORIENTATION_PORTRAIT
Definition SDL_video.h:133
@ SDL_ORIENTATION_PORTRAIT_FLIPPED
Definition SDL_video.h:134
@ SDL_ORIENTATION_LANDSCAPE_FLIPPED
Definition SDL_video.h:132
@ SDL_ORIENTATION_UNKNOWN
Definition SDL_video.h:130

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

215{
216 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
217 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
218 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 266 of file SDL_video.h.

267{
268 SDL_GL_RED_SIZE, /**< the minimum number of bits for the red channel of the color buffer; defaults to 3. */
269 SDL_GL_GREEN_SIZE, /**< the minimum number of bits for the green channel of the color buffer; defaults to 3. */
270 SDL_GL_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the color buffer; defaults to 2. */
271 SDL_GL_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the color buffer; defaults to 0. */
272 SDL_GL_BUFFER_SIZE, /**< the minimum number of bits for frame buffer size; defaults to 0. */
273 SDL_GL_DOUBLEBUFFER, /**< whether the output is single or double buffered; defaults to double buffering on. */
274 SDL_GL_DEPTH_SIZE, /**< the minimum number of bits in the depth buffer; defaults to 16. */
275 SDL_GL_STENCIL_SIZE, /**< the minimum number of bits in the stencil buffer; defaults to 0. */
276 SDL_GL_ACCUM_RED_SIZE, /**< the minimum number of bits for the red channel of the accumulation buffer; defaults to 0. */
277 SDL_GL_ACCUM_GREEN_SIZE, /**< the minimum number of bits for the green channel of the accumulation buffer; defaults to 0. */
278 SDL_GL_ACCUM_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0. */
279 SDL_GL_ACCUM_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0. */
280 SDL_GL_STEREO, /**< whether the output is stereo 3D; defaults to off. */
281 SDL_GL_MULTISAMPLEBUFFERS, /**< the number of buffers used for multisample anti-aliasing; defaults to 0. */
282 SDL_GL_MULTISAMPLESAMPLES, /**< the number of samples used around the current pixel used for multisample anti-aliasing. */
283 SDL_GL_ACCELERATED_VISUAL, /**< set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either. */
284 SDL_GL_RETAINED_BACKING, /**< not used (deprecated). */
285 SDL_GL_CONTEXT_MAJOR_VERSION, /**< OpenGL context major version. */
286 SDL_GL_CONTEXT_MINOR_VERSION, /**< OpenGL context minor version. */
287 SDL_GL_CONTEXT_FLAGS, /**< some combination of 0 or more of elements of the SDL_GLcontextFlag enumeration; defaults to 0. */
288 SDL_GL_CONTEXT_PROFILE_MASK, /**< type of GL context (Core, Compatibility, ES). See SDL_GLprofile; default value depends on platform. */
289 SDL_GL_SHARE_WITH_CURRENT_CONTEXT, /**< OpenGL context sharing; defaults to 0. */
290 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, /**< requests sRGB capable visual; defaults to 0. */
291 SDL_GL_CONTEXT_RELEASE_BEHAVIOR, /**< sets context the release behavior. See SDL_GLcontextReleaseFlag; defaults to FLUSH. */
292 SDL_GL_CONTEXT_RESET_NOTIFICATION, /**< set context reset notification. See SDL_GLContextResetNotification; defaults to NO_NOTIFICATION. */
296} 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 315 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 329 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 340 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 303 of file SDL_video.h.

304{
307 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 2289 of file SDL_video.h.

2290{
2291 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
2292 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
2293 SDL_HITTEST_RESIZE_TOPLEFT, /**< Region is the resizable top-left corner border. */
2294 SDL_HITTEST_RESIZE_TOP, /**< Region is the resizable top border. */
2295 SDL_HITTEST_RESIZE_TOPRIGHT, /**< Region is the resizable top-right corner border. */
2296 SDL_HITTEST_RESIZE_RIGHT, /**< Region is the resizable right border. */
2297 SDL_HITTEST_RESIZE_BOTTOMRIGHT, /**< Region is the resizable bottom-right corner border. */
2298 SDL_HITTEST_RESIZE_BOTTOM, /**< Region is the resizable bottom border. */
2299 SDL_HITTEST_RESIZE_BOTTOMLEFT, /**< Region is the resizable bottom-left corner border. */
2300 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 87 of file SDL_video.h.

88{
89 SDL_SYSTEM_THEME_UNKNOWN, /**< Unknown system theme */
90 SDL_SYSTEM_THEME_LIGHT, /**< Light colored system theme */
91 SDL_SYSTEM_THEME_DARK /**< Dark colored system theme */
@ SDL_SYSTEM_THEME_LIGHT
Definition SDL_video.h:90
@ SDL_SYSTEM_THEME_UNKNOWN
Definition SDL_video.h:89
@ SDL_SYSTEM_THEME_DARK
Definition SDL_video.h:91

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

SDL_bool SDL_DestroyWindowSurface ( SDL_Window window)
extern

Destroy the surface associated with the window.

Parameters
windowthe window to update.
Returns
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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 
)
extern

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

Each callback should return a pointer to an EGL attribute array terminated with EGL_NONE. Callbacks may return NULL pointers to signal an error, which will cause the SDL_CreateWindow process to fail gracefully.

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

NOTE: These callback pointers will be reset after SDL_GL_ResetAttributes.

Parameters
platformAttribCallbackcallback for attributes to pass to eglGetPlatformDisplay.
surfaceAttribCallbackcallback for attributes to pass to eglCreateSurface.
contextAttribCallbackcallback for attributes to pass to eglCreateContext.
Since
This function is available since SDL 3.0.0.

◆ SDL_EnableScreenSaver()

SDL_bool SDL_EnableScreenSaver ( void  )
extern

Allow the screen to be blanked by a screen saver.

Returns
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetClosestFullscreenDisplayMode()

SDL_bool SDL_GetClosestFullscreenDisplayMode ( SDL_DisplayID  displayID,
int  w,
int  h,
float  refresh_rate,
SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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 -1), 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 -1 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
SDL_TRUE on success or SDL_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()

SDL_bool SDL_GetWindowKeyboardGrab ( SDL_Window window)
extern

Get a window's keyboard grab mode.

Parameters
windowthe window to query.
Returns
SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowKeyboardGrab

◆ SDL_GetWindowMaximumSize()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_bool SDL_GetWindowMouseGrab ( SDL_Window window)
extern

Get a window's mouse grab mode.

Parameters
windowthe window to query.
Returns
SDL_TRUE if mouse is grabbed, and SDL_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()

SDL_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
SDL_TRUE on success or SDL_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 UWP:

  • SDL_PROP_WINDOW_WINRT_WINDOW_POINTER: the IInspectable CoreWindow 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()

SDL_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
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetWindowSize()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_bool SDL_GL_DestroyContext ( SDL_GLContext  context)
extern

Delete an OpenGL context.

Parameters
contextthe OpenGL context to be deleted.
Returns
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE if the extension is supported, SDL_FALSE otherwise.
Since
This function is available since SDL 3.0.0.

◆ SDL_GL_GetAttribute()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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 SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_bool SDL_HideWindow ( SDL_Window window)
extern

Hide a window.

Parameters
windowthe window to hide.
Returns
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_RestoreWindow()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE if the screensaver is enabled, SDL_FALSE if it is disabled.
Since
This function is available since SDL 3.0.0.
See also
SDL_DisableScreenSaver
SDL_EnableScreenSaver

◆ SDL_SetWindowAlwaysOnTop()

SDL_bool SDL_SetWindowAlwaysOnTop ( SDL_Window window,
SDL_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_topSDL_TRUE to set the window always on top, SDL_FALSE to disable.
Returns
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_bool SDL_SetWindowBordered ( SDL_Window window,
SDL_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.
borderedSDL_FALSE to remove border, SDL_TRUE to add border.
Returns
SDL_TRUE on success or SDL_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()

SDL_bool SDL_SetWindowFocusable ( SDL_Window window,
SDL_bool  focusable 
)
extern

Set whether the window may have input focus.

Parameters
windowthe window to set focusable state.
focusableSDL_TRUE to allow input focus, SDL_FALSE to not allow input focus.
Returns
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowFullscreen()

SDL_bool SDL_SetWindowFullscreen ( SDL_Window window,
SDL_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.
fullscreenSDL_TRUE for fullscreen mode, SDL_FALSE for windowed mode.
Returns
SDL_TRUE on success or SDL_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()

SDL_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_WINDOOW_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
SDL_TRUE on success or SDL_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()

SDL_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 SDL_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
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowIcon()

SDL_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
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowKeyboardGrab()

SDL_bool SDL_SetWindowKeyboardGrab ( SDL_Window window,
SDL_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 SDL_TRUE to grab keyboard, and SDL_FALSE to release.
Returns
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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_SetWindowModalFor()

SDL_bool SDL_SetWindowModalFor ( SDL_Window modal_window,
SDL_Window parent_window 
)
extern

Set the window as a modal to a parent window.

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

Setting a window as modal to a parent that is a descendent of the modal window results in undefined behavior.

Parameters
modal_windowthe window that should be set modal.
parent_windowthe parent window for the modal window.
Returns
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowMouseGrab()

SDL_bool SDL_SetWindowMouseGrab ( SDL_Window window,
SDL_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 SDL_TRUE to grab mouse, and SDL_FALSE to release.
Returns
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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 -1 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
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowOpacity

◆ SDL_SetWindowPosition()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_bool SDL_SetWindowResizable ( SDL_Window window,
SDL_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.
resizableSDL_TRUE to allow resizing, SDL_FALSE to disallow.
Returns
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowSize()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_bool SDL_ShowWindow ( SDL_Window window)
extern

Show a window.

Parameters
windowthe window to show.
Returns
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SyncWindow()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_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
SDL_TRUE on success or SDL_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()

SDL_bool SDL_WindowHasSurface ( SDL_Window window)
extern

Return whether the window has a surface associated with it.

Parameters
windowthe window to query.
Returns
SDL_TRUE if there is a surface associated with the window, or SDL_FALSE otherwise.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowSurface