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_ALWAYS_ON_TOP   SDL_UINT64_C(0x0000000000008000)
 
#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   "always_on_top"
 
#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN   "borderless"
 
#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN   "focusable"
 
#define SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN   "external_graphics_context"
 
#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN   "fullscreen"
 
#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER   "height"
 
#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN   "hidden"
 
#define SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN   "high_pixel_density"
 
#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN   "maximized"
 
#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN   "menu"
 
#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN   "metal"
 
#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN   "minimized"
 
#define SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN   "modal"
 
#define SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN   "mouse_grabbed"
 
#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN   "opengl"
 
#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER   "parent"
 
#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN   "resizable"
 
#define SDL_PROP_WINDOW_CREATE_TITLE_STRING   "title"
 
#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN   "transparent"
 
#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN   "tooltip"
 
#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN   "utility"
 
#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN   "vulkan"
 
#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER   "width"
 
#define SDL_PROP_WINDOW_CREATE_X_NUMBER   "x"
 
#define SDL_PROP_WINDOW_CREATE_Y_NUMBER   "y"
 
#define SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER   "cocoa.window"
 
#define SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER   "cocoa.view"
 
#define SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN   "wayland.surface_role_custom"
 
#define SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN   "wayland.create_egl_window"
 
#define SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER   "wayland.wl_surface"
 
#define SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER   "win32.hwnd"
 
#define SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER   "win32.pixel_format_hwnd"
 
#define SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER   "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)
 
int SDL_GetDisplayBounds (SDL_DisplayID displayID, SDL_Rect *rect)
 
int 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)
 
int 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)
 
int 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)
 
int SDL_SetWindowTitle (SDL_Window *window, const char *title)
 
const char * SDL_GetWindowTitle (SDL_Window *window)
 
int SDL_SetWindowIcon (SDL_Window *window, SDL_Surface *icon)
 
int SDL_SetWindowPosition (SDL_Window *window, int x, int y)
 
int SDL_GetWindowPosition (SDL_Window *window, int *x, int *y)
 
int SDL_SetWindowSize (SDL_Window *window, int w, int h)
 
int SDL_GetWindowSize (SDL_Window *window, int *w, int *h)
 
int SDL_GetWindowSafeArea (SDL_Window *window, SDL_Rect *rect)
 
int SDL_SetWindowAspectRatio (SDL_Window *window, float min_aspect, float max_aspect)
 
int SDL_GetWindowAspectRatio (SDL_Window *window, float *min_aspect, float *max_aspect)
 
int SDL_GetWindowBordersSize (SDL_Window *window, int *top, int *left, int *bottom, int *right)
 
int SDL_GetWindowSizeInPixels (SDL_Window *window, int *w, int *h)
 
int SDL_SetWindowMinimumSize (SDL_Window *window, int min_w, int min_h)
 
int SDL_GetWindowMinimumSize (SDL_Window *window, int *w, int *h)
 
int SDL_SetWindowMaximumSize (SDL_Window *window, int max_w, int max_h)
 
int SDL_GetWindowMaximumSize (SDL_Window *window, int *w, int *h)
 
int SDL_SetWindowBordered (SDL_Window *window, SDL_bool bordered)
 
int SDL_SetWindowResizable (SDL_Window *window, SDL_bool resizable)
 
int SDL_SetWindowAlwaysOnTop (SDL_Window *window, SDL_bool on_top)
 
int SDL_ShowWindow (SDL_Window *window)
 
int SDL_HideWindow (SDL_Window *window)
 
int SDL_RaiseWindow (SDL_Window *window)
 
int SDL_MaximizeWindow (SDL_Window *window)
 
int SDL_MinimizeWindow (SDL_Window *window)
 
int SDL_RestoreWindow (SDL_Window *window)
 
int SDL_SetWindowFullscreen (SDL_Window *window, SDL_bool fullscreen)
 
int SDL_SyncWindow (SDL_Window *window)
 
SDL_bool SDL_WindowHasSurface (SDL_Window *window)
 
SDL_SurfaceSDL_GetWindowSurface (SDL_Window *window)
 
int SDL_SetWindowSurfaceVSync (SDL_Window *window, int vsync)
 
int SDL_GetWindowSurfaceVSync (SDL_Window *window, int *vsync)
 
int SDL_UpdateWindowSurface (SDL_Window *window)
 
int SDL_UpdateWindowSurfaceRects (SDL_Window *window, const SDL_Rect *rects, int numrects)
 
int SDL_DestroyWindowSurface (SDL_Window *window)
 
int SDL_SetWindowKeyboardGrab (SDL_Window *window, SDL_bool grabbed)
 
int 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)
 
int SDL_SetWindowMouseRect (SDL_Window *window, const SDL_Rect *rect)
 
const SDL_RectSDL_GetWindowMouseRect (SDL_Window *window)
 
int SDL_SetWindowOpacity (SDL_Window *window, float opacity)
 
float SDL_GetWindowOpacity (SDL_Window *window)
 
int SDL_SetWindowModalFor (SDL_Window *modal_window, SDL_Window *parent_window)
 
int SDL_SetWindowFocusable (SDL_Window *window, SDL_bool focusable)
 
int SDL_ShowWindowSystemMenu (SDL_Window *window, int x, int y)
 
int SDL_SetWindowHitTest (SDL_Window *window, SDL_HitTest callback, void *callback_data)
 
int SDL_SetWindowShape (SDL_Window *window, SDL_Surface *shape)
 
int SDL_FlashWindow (SDL_Window *window, SDL_FlashOperation operation)
 
void SDL_DestroyWindow (SDL_Window *window)
 
SDL_bool SDL_ScreenSaverEnabled (void)
 
int SDL_EnableScreenSaver (void)
 
int SDL_DisableScreenSaver (void)
 
OpenGL support functions
int 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)
 
int SDL_GL_SetAttribute (SDL_GLattr attr, int value)
 
int SDL_GL_GetAttribute (SDL_GLattr attr, int *value)
 
SDL_GLContext SDL_GL_CreateContext (SDL_Window *window)
 
int 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)
 
int SDL_GL_SetSwapInterval (int interval)
 
int SDL_GL_GetSwapInterval (int *interval)
 
int SDL_GL_SwapWindow (SDL_Window *window)
 
int 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 438 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 439 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 63 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 1257 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 1256 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 1267 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 1266 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN   "always_on_top"

Definition at line 1055 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN   "borderless"

Definition at line 1056 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER

#define SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER   "cocoa.view"

Definition at line 1081 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER

#define SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER   "cocoa.window"

Definition at line 1080 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN   "external_graphics_context"

Definition at line 1058 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN   "focusable"

Definition at line 1057 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN   "fullscreen"

Definition at line 1059 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER

#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER   "height"

Definition at line 1060 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN   "hidden"

Definition at line 1061 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN   "high_pixel_density"

Definition at line 1062 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN   "maximized"

Definition at line 1063 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN   "menu"

Definition at line 1064 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN   "metal"

Definition at line 1065 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN   "minimized"

Definition at line 1066 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN   "modal"

Definition at line 1067 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN   "mouse_grabbed"

Definition at line 1068 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN   "opengl"

Definition at line 1069 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_PARENT_POINTER

#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER   "parent"

Definition at line 1070 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN   "resizable"

Definition at line 1071 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TITLE_STRING

#define SDL_PROP_WINDOW_CREATE_TITLE_STRING   "title"

Definition at line 1072 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN   "tooltip"

Definition at line 1074 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN   "transparent"

Definition at line 1073 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN   "utility"

Definition at line 1075 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN   "vulkan"

Definition at line 1076 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN   "wayland.create_egl_window"

Definition at line 1083 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN   "wayland.surface_role_custom"

Definition at line 1082 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER

#define SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER   "wayland.wl_surface"

Definition at line 1084 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER

#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER   "width"

Definition at line 1077 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER

#define SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER   "win32.hwnd"

Definition at line 1085 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER

#define SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER   "win32.pixel_format_hwnd"

Definition at line 1086 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER

#define SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER   "x11.window"

Definition at line 1087 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_X_NUMBER

#define SDL_PROP_WINDOW_CREATE_X_NUMBER   "x"

Definition at line 1078 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_Y_NUMBER

#define SDL_PROP_WINDOW_CREATE_Y_NUMBER   "y"

Definition at line 1079 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 1253 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 1255 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 1263 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 1264 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 1265 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 1254 of file SDL_video.h.

◆ SDL_PROP_WINDOW_SHAPE_POINTER

#define SDL_PROP_WINDOW_SHAPE_POINTER   "SDL.window.shape"

Definition at line 1252 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 1259 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 1260 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 1261 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 1262 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 1258 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 1268 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 1270 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 1269 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 1275 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 1277 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 1276 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 1281 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 1282 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 1278 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 1280 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 1279 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 1273 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 1272 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 1274 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 1271 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 1283 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 1284 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 1285 of file SDL_video.h.

◆ SDL_WINDOW_ALWAYS_ON_TOP

#define SDL_WINDOW_ALWAYS_ON_TOP   SDL_UINT64_C(0x0000000000008000)

window should always be above others

Definition at line 158 of file SDL_video.h.

◆ SDL_WINDOW_BORDERLESS

#define SDL_WINDOW_BORDERLESS   SDL_UINT64_C(0x0000000000000010)

no window decoration

Definition at line 147 of file SDL_video.h.

◆ SDL_WINDOW_EXTERNAL

#define SDL_WINDOW_EXTERNAL   SDL_UINT64_C(0x0000000000000800)

window not created by SDL

Definition at line 154 of file SDL_video.h.

◆ SDL_WINDOW_FULLSCREEN

#define SDL_WINDOW_FULLSCREEN   SDL_UINT64_C(0x0000000000000001)

window is in fullscreen mode

Definition at line 143 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 146 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 156 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 152 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 162 of file SDL_video.h.

◆ SDL_WINDOW_MAXIMIZED

#define SDL_WINDOW_MAXIMIZED   SDL_UINT64_C(0x0000000000000080)

window is maximized

Definition at line 150 of file SDL_video.h.

◆ SDL_WINDOW_METAL

#define SDL_WINDOW_METAL   SDL_UINT64_C(0x0000000020000000)

window usable for Metal view

Definition at line 164 of file SDL_video.h.

◆ SDL_WINDOW_MINIMIZED

#define SDL_WINDOW_MINIMIZED   SDL_UINT64_C(0x0000000000000040)

window is minimized

Definition at line 149 of file SDL_video.h.

◆ SDL_WINDOW_MODAL

#define SDL_WINDOW_MODAL   SDL_UINT64_C(0x0000000000001000)

window is modal

Definition at line 155 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 157 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 153 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 151 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 166 of file SDL_video.h.

◆ SDL_WINDOW_OCCLUDED

#define SDL_WINDOW_OCCLUDED   SDL_UINT64_C(0x0000000000000004)

window is occluded

Definition at line 145 of file SDL_video.h.

◆ SDL_WINDOW_OPENGL

#define SDL_WINDOW_OPENGL   SDL_UINT64_C(0x0000000000000002)

window usable with OpenGL context

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

◆ SDL_WINDOW_RESIZABLE

#define SDL_WINDOW_RESIZABLE   SDL_UINT64_C(0x0000000000000020)

window can be resized

Definition at line 148 of file SDL_video.h.

◆ SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE

#define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE   (-1)

Definition at line 1971 of file SDL_video.h.

◆ SDL_WINDOW_SURFACE_VSYNC_DISABLED

#define SDL_WINDOW_SURFACE_VSYNC_DISABLED   0

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

◆ SDL_WINDOW_TRANSPARENT

#define SDL_WINDOW_TRANSPARENT   SDL_UINT64_C(0x0000000040000000)

window with transparent buffer

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

◆ SDL_WINDOW_VULKAN

#define SDL_WINDOW_VULKAN   SDL_UINT64_C(0x0000000010000000)

window usable for Vulkan surface

Definition at line 163 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 187 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

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

◆ SDL_WINDOWPOS_ISCENTERED

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

Definition at line 188 of file SDL_video.h.

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

◆ SDL_WINDOWPOS_ISUNDEFINED

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

Definition at line 177 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 176 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

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

Typedef Documentation

◆ SDL_DisplayID

CategoryVideo

SDL video functions.

Definition at line 45 of file SDL_video.h.

◆ SDL_DisplayModeData

Definition at line 78 of file SDL_video.h.

◆ SDL_EGLAttrib

typedef intptr_t SDL_EGLAttrib

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

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

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

◆ SDL_EGLint

typedef int SDL_EGLint

Definition at line 221 of file SDL_video.h.

◆ SDL_EGLIntArrayCallback

typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)

Definition at line 229 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Definition at line 219 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 210 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 2286 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 127 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 141 of file SDL_video.h.

◆ SDL_WindowID

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

112{
113 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
114 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
115 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
116 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
117 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
@ SDL_ORIENTATION_LANDSCAPE
Definition SDL_video.h:114
@ SDL_ORIENTATION_PORTRAIT
Definition SDL_video.h:116
@ SDL_ORIENTATION_PORTRAIT_FLIPPED
Definition SDL_video.h:117
@ SDL_ORIENTATION_LANDSCAPE_FLIPPED
Definition SDL_video.h:115
@ SDL_ORIENTATION_UNKNOWN
Definition SDL_video.h:113

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

197{
198 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
199 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
200 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 
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 

Definition at line 248 of file SDL_video.h.

◆ 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 297 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 311 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 322 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 285 of file SDL_video.h.

286{
289 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 2262 of file SDL_video.h.

2263{
2264 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
2265 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
2266 SDL_HITTEST_RESIZE_TOPLEFT, /**< Region is the resizable top-left corner border. */
2267 SDL_HITTEST_RESIZE_TOP, /**< Region is the resizable top border. */
2268 SDL_HITTEST_RESIZE_TOPRIGHT, /**< Region is the resizable top-right corner border. */
2269 SDL_HITTEST_RESIZE_RIGHT, /**< Region is the resizable right border. */
2270 SDL_HITTEST_RESIZE_BOTTOMRIGHT, /**< Region is the resizable bottom-right corner border. */
2271 SDL_HITTEST_RESIZE_BOTTOM, /**< Region is the resizable bottom border. */
2272 SDL_HITTEST_RESIZE_BOTTOMLEFT, /**< Region is the resizable bottom-left corner border. */
2273 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 70 of file SDL_video.h.

71{
72 SDL_SYSTEM_THEME_UNKNOWN, /**< Unknown system theme */
73 SDL_SYSTEM_THEME_LIGHT, /**< Light colored system theme */
74 SDL_SYSTEM_THEME_DARK /**< Dark colored system theme */
@ SDL_SYSTEM_THEME_LIGHT
Definition SDL_video.h:73
@ SDL_SYSTEM_THEME_UNKNOWN
Definition SDL_video.h:72
@ SDL_SYSTEM_THEME_DARK
Definition SDL_video.h:74

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

int SDL_DestroyWindowSurface ( SDL_Window window)
extern

Destroy the surface associated with the window.

Parameters
windowthe window to update.
Returns
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int SDL_EnableScreenSaver ( void  )
extern

Allow the screen to be blanked by a screen saver.

Returns
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetClosestFullscreenDisplayMode()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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
a number >= 1 on success or a negative error code on failure; call SDL_GetError() for more information.
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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowAspectRatio

◆ SDL_GetWindowBordersSize()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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 a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetWindowSize()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int SDL_GL_DestroyContext ( SDL_GLContext  context)
extern

Delete an OpenGL context.

Parameters
contextthe OpenGL context to be deleted.
Returns
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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 -1. 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int SDL_HideWindow ( SDL_Window window)
extern

Hide a window.

Parameters
windowthe window to hide.
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_ShowWindow

◆ SDL_MaximizeWindow()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_RestoreWindow()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowAspectRatio()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowFocusable()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowFullscreen()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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 -1 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowIcon()

int SDL_SetWindowIcon ( SDL_Window window,
SDL_Surface icon 
)
extern

Set the icon for a window.

Parameters
windowthe window to change.
iconan SDL_Surface structure containing the icon for the window.
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowKeyboardGrab()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowMouseGrab()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowOpacity

◆ SDL_SetWindowPosition()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowShape()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SetWindowSize()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowSurfaceVSync

◆ SDL_SetWindowTitle()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowTitle

◆ SDL_ShowWindow()

int SDL_ShowWindow ( SDL_Window window)
extern

Show a window.

Parameters
windowthe window to show.
Returns
0 on success or a negative error code 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()

int 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
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_SyncWindow()

int 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
0 on success, a positive value if the operation timed out before the window was in the requested state, or a negative error code on failure; call SDL_GetError() for more information.
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()

int 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
0 on success or a negative error code 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()

int 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
0 on success or a negative error code 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