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   0x00000001U
 
#define SDL_WINDOW_OPENGL   0x00000002U
 
#define SDL_WINDOW_OCCLUDED   0x00000004U
 
#define SDL_WINDOW_HIDDEN   0x00000008U
 
#define SDL_WINDOW_BORDERLESS   0x00000010U
 
#define SDL_WINDOW_RESIZABLE   0x00000020U
 
#define SDL_WINDOW_MINIMIZED   0x00000040U
 
#define SDL_WINDOW_MAXIMIZED   0x00000080U
 
#define SDL_WINDOW_MOUSE_GRABBED   0x00000100U
 
#define SDL_WINDOW_INPUT_FOCUS   0x00000200U
 
#define SDL_WINDOW_MOUSE_FOCUS   0x00000400U
 
#define SDL_WINDOW_EXTERNAL   0x00000800U
 
#define SDL_WINDOW_MODAL   0x00001000U
 
#define SDL_WINDOW_HIGH_PIXEL_DENSITY   0x00002000U
 
#define SDL_WINDOW_MOUSE_CAPTURE   0x00004000U
 
#define SDL_WINDOW_ALWAYS_ON_TOP   0x00008000U
 
#define SDL_WINDOW_UTILITY   0x00020000U
 
#define SDL_WINDOW_TOOLTIP   0x00040000U
 
#define SDL_WINDOW_POPUP_MENU   0x00080000U
 
#define SDL_WINDOW_KEYBOARD_GRABBED   0x00100000U
 
#define SDL_WINDOW_VULKAN   0x10000000U
 
#define SDL_WINDOW_METAL   0x20000000U
 
#define SDL_WINDOW_TRANSPARENT   0x40000000U
 
#define SDL_WINDOW_NOT_FOCUSABLE   0x80000000U
 
#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_SDR_WHITE_POINT_FLOAT   "SDL.display.SDR_white_point"
 
#define SDL_PROP_DISPLAY_HDR_HEADROOM_FLOAT   "SDL.display.HDR_headroom"
 
#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_SCALE_TO_DISPLAY_BOOLEAN   "wayland.scale_to_display"
 
#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_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_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"
 

Typedefs

typedef Uint32 SDL_DisplayID
 
typedef Uint32 SDL_WindowID
 
typedef struct SDL_Window SDL_Window
 
typedef Uint32 SDL_WindowFlags
 
typedef void * 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)
 
const SDL_DisplayMode ** SDL_GetFullscreenDisplayModes (SDL_DisplayID displayID, int *count)
 
const SDL_DisplayModeSDL_GetClosestFullscreenDisplayMode (SDL_DisplayID displayID, int w, int h, float refresh_rate, SDL_bool include_high_density_modes)
 
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)
 
Uint32 SDL_GetWindowPixelFormat (SDL_Window *window)
 
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_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_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)
 
int SDL_GetWindowOpacity (SDL_Window *window, float *out_opacity)
 
int SDL_SetWindowModalFor (SDL_Window *modal_window, SDL_Window *parent_window)
 
int SDL_SetWindowInputFocus (SDL_Window *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_GetCurrentEGLDisplay (void)
 
SDL_EGLConfig SDL_EGL_GetCurrentEGLConfig (void)
 
SDL_EGLSurface SDL_EGL_GetWindowEGLSurface (SDL_Window *window)
 
void SDL_EGL_SetEGLAttributeCallbacks (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_DeleteContext (SDL_GLContext context)
 

Detailed Description

Header file for SDL video functions.

Definition in file SDL_video.h.

Macro Definition Documentation

◆ SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN

#define SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN   "SDL.display.HDR_enabled"

Definition at line 422 of file SDL_video.h.

◆ SDL_PROP_DISPLAY_HDR_HEADROOM_FLOAT

#define SDL_PROP_DISPLAY_HDR_HEADROOM_FLOAT   "SDL.display.HDR_headroom"

Definition at line 424 of file SDL_video.h.

◆ SDL_PROP_DISPLAY_SDR_WHITE_POINT_FLOAT

#define SDL_PROP_DISPLAY_SDR_WHITE_POINT_FLOAT   "SDL.display.SDR_white_point"

Definition at line 423 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"

Definition at line 62 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 1186 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 1185 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 1193 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 1192 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 1002 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN   "borderless"

Definition at line 1003 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 1028 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 1027 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 1005 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN   "focusable"

Definition at line 1004 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN   "fullscreen"

Definition at line 1006 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER

#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER   "height"

Definition at line 1007 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN   "hidden"

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

◆ SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN   "maximized"

Definition at line 1010 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN   "menu"

Definition at line 1011 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN   "metal"

Definition at line 1012 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN   "minimized"

Definition at line 1013 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN   "modal"

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

◆ SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN   "opengl"

Definition at line 1016 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_PARENT_POINTER

#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER   "parent"

Definition at line 1017 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN   "resizable"

Definition at line 1018 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TITLE_STRING

#define SDL_PROP_WINDOW_CREATE_TITLE_STRING   "title"

Definition at line 1019 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN   "tooltip"

Definition at line 1021 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN   "transparent"

Definition at line 1020 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN   "utility"

Definition at line 1022 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN   "vulkan"

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

◆ SDL_PROP_WINDOW_CREATE_WAYLAND_SCALE_TO_DISPLAY_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_WAYLAND_SCALE_TO_DISPLAY_BOOLEAN   "wayland.scale_to_display"

Definition at line 1029 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 1030 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 1032 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER

#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER   "width"

Definition at line 1024 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 1033 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 1034 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 1035 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_X_NUMBER

#define SDL_PROP_WINDOW_CREATE_X_NUMBER   "x"

Definition at line 1025 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_Y_NUMBER

#define SDL_PROP_WINDOW_CREATE_Y_NUMBER   "y"

Definition at line 1026 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 1189 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 1190 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 1191 of file SDL_video.h.

◆ SDL_PROP_WINDOW_SHAPE_POINTER

#define SDL_PROP_WINDOW_SHAPE_POINTER   "SDL.window.shape"

Definition at line 1184 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 1188 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 1187 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 1194 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 1196 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 1195 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 1201 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 1203 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 1202 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 1207 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 1208 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 1204 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 1206 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 1205 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 1199 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 1198 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 1200 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 1197 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 1209 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 1210 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 1211 of file SDL_video.h.

◆ SDL_WINDOW_ALWAYS_ON_TOP

#define SDL_WINDOW_ALWAYS_ON_TOP   0x00008000U

window should always be above others

Definition at line 150 of file SDL_video.h.

◆ SDL_WINDOW_BORDERLESS

#define SDL_WINDOW_BORDERLESS   0x00000010U

no window decoration

Definition at line 139 of file SDL_video.h.

◆ SDL_WINDOW_EXTERNAL

#define SDL_WINDOW_EXTERNAL   0x00000800U

window not created by SDL

Definition at line 146 of file SDL_video.h.

◆ SDL_WINDOW_FULLSCREEN

#define SDL_WINDOW_FULLSCREEN   0x00000001U

window is in fullscreen mode

Definition at line 135 of file SDL_video.h.

◆ SDL_WINDOW_HIDDEN

#define SDL_WINDOW_HIDDEN   0x00000008U

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

◆ SDL_WINDOW_HIGH_PIXEL_DENSITY

#define SDL_WINDOW_HIGH_PIXEL_DENSITY   0x00002000U

window uses high pixel density back buffer if possible

Definition at line 148 of file SDL_video.h.

◆ SDL_WINDOW_INPUT_FOCUS

#define SDL_WINDOW_INPUT_FOCUS   0x00000200U

window has input focus

Definition at line 144 of file SDL_video.h.

◆ SDL_WINDOW_KEYBOARD_GRABBED

#define SDL_WINDOW_KEYBOARD_GRABBED   0x00100000U

window has grabbed keyboard input

Definition at line 154 of file SDL_video.h.

◆ SDL_WINDOW_MAXIMIZED

#define SDL_WINDOW_MAXIMIZED   0x00000080U

window is maximized

Definition at line 142 of file SDL_video.h.

◆ SDL_WINDOW_METAL

#define SDL_WINDOW_METAL   0x20000000U

window usable for Metal view

Definition at line 156 of file SDL_video.h.

◆ SDL_WINDOW_MINIMIZED

#define SDL_WINDOW_MINIMIZED   0x00000040U

window is minimized

Definition at line 141 of file SDL_video.h.

◆ SDL_WINDOW_MODAL

#define SDL_WINDOW_MODAL   0x00001000U

window is modal

Definition at line 147 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_CAPTURE

#define SDL_WINDOW_MOUSE_CAPTURE   0x00004000U

window has mouse captured (unrelated to MOUSE_GRABBED)

Definition at line 149 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_FOCUS

#define SDL_WINDOW_MOUSE_FOCUS   0x00000400U

window has mouse focus

Definition at line 145 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_GRABBED

#define SDL_WINDOW_MOUSE_GRABBED   0x00000100U

window has grabbed mouse input

Definition at line 143 of file SDL_video.h.

◆ SDL_WINDOW_NOT_FOCUSABLE

#define SDL_WINDOW_NOT_FOCUSABLE   0x80000000U

window should not be focusable

Definition at line 158 of file SDL_video.h.

◆ SDL_WINDOW_OCCLUDED

#define SDL_WINDOW_OCCLUDED   0x00000004U

window is occluded

Definition at line 137 of file SDL_video.h.

◆ SDL_WINDOW_OPENGL

#define SDL_WINDOW_OPENGL   0x00000002U

window usable with OpenGL context

Definition at line 136 of file SDL_video.h.

◆ SDL_WINDOW_POPUP_MENU

#define SDL_WINDOW_POPUP_MENU   0x00080000U

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

Definition at line 153 of file SDL_video.h.

◆ SDL_WINDOW_RESIZABLE

#define SDL_WINDOW_RESIZABLE   0x00000020U

window can be resized

Definition at line 140 of file SDL_video.h.

◆ SDL_WINDOW_TOOLTIP

#define SDL_WINDOW_TOOLTIP   0x00040000U

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

Definition at line 152 of file SDL_video.h.

◆ SDL_WINDOW_TRANSPARENT

#define SDL_WINDOW_TRANSPARENT   0x40000000U

window with transparent buffer

Definition at line 157 of file SDL_video.h.

◆ SDL_WINDOW_UTILITY

#define SDL_WINDOW_UTILITY   0x00020000U

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

Definition at line 151 of file SDL_video.h.

◆ SDL_WINDOW_VULKAN

#define SDL_WINDOW_VULKAN   0x10000000U

window usable for Vulkan surface

Definition at line 155 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 179 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

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

◆ SDL_WINDOWPOS_ISCENTERED

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

Definition at line 180 of file SDL_video.h.

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

◆ SDL_WINDOWPOS_ISUNDEFINED

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

Definition at line 169 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 168 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

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

Typedef Documentation

◆ SDL_DisplayID

Definition at line 45 of file SDL_video.h.

◆ SDL_EGLAttrib

typedef intptr_t SDL_EGLAttrib

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

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

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

◆ SDL_EGLint

typedef int SDL_EGLint

Definition at line 211 of file SDL_video.h.

◆ SDL_EGLIntArrayCallback

typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)

Definition at line 219 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Definition at line 209 of file SDL_video.h.

◆ SDL_GLContext

typedef void* SDL_GLContext

An opaque handle to an OpenGL context.

Since
This datatype is available since SDL 3.0.0.

Definition at line 200 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 2110 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 119 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 133 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 103 of file SDL_video.h.

104{
105 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
106 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
107 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
108 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
109 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
@ SDL_ORIENTATION_LANDSCAPE
Definition SDL_video.h:106
@ SDL_ORIENTATION_PORTRAIT
Definition SDL_video.h:108
@ SDL_ORIENTATION_PORTRAIT_FLIPPED
Definition SDL_video.h:109
@ SDL_ORIENTATION_LANDSCAPE_FLIPPED
Definition SDL_video.h:107
@ SDL_ORIENTATION_UNKNOWN
Definition SDL_video.h:105

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

189{
190 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
191 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
192 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 238 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 287 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 301 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 312 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 275 of file SDL_video.h.

276{
279 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 2086 of file SDL_video.h.

2087{
2088 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
2089 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
2090 SDL_HITTEST_RESIZE_TOPLEFT, /**< Region is the resizable top-left corner border. */
2091 SDL_HITTEST_RESIZE_TOP, /**< Region is the resizable top border. */
2092 SDL_HITTEST_RESIZE_TOPRIGHT, /**< Region is the resizable top-right corner border. */
2093 SDL_HITTEST_RESIZE_RIGHT, /**< Region is the resizable right border. */
2094 SDL_HITTEST_RESIZE_BOTTOMRIGHT, /**< Region is the resizable bottom-right corner border. */
2095 SDL_HITTEST_RESIZE_BOTTOM, /**< Region is the resizable bottom border. */
2096 SDL_HITTEST_RESIZE_BOTTOMLEFT, /**< Region is the resizable bottom-left corner border. */
2097 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 69 of file SDL_video.h.

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

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_VULKAN: window usable with a Vulkan instance
  • SDL_WINDOW_METAL: window usable with a Metal instance
  • 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

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.

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_SCALE_TO_DISPLAY_BOOLEAN - true if the window should use forced scaling designed to produce 1:1 pixel mapping if not flagged as being DPI-aware. This is intended to allow legacy applications to be displayed without desktop scaling being applied, and has issues with certain display configurations, as this forces the window to behave in a way that Wayland desktops were not designed to accommodate. Potential issues include, but are not limited to: rounding errors can result when odd window sizes/scales are used, the window may be unusably small, the window may jump in visible size at times, the window may appear to be larger than the desktop space, and possible loss of cursor precision can occur. New applications should be designed with proper DPI awareness and handling instead of enabling this.
  • 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().

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.

If window is NULL, this function will return immediately after setting the SDL error message to "Invalid window". See SDL_GetError().

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

SDL_EGLConfig SDL_EGL_GetCurrentEGLConfig ( 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_GetCurrentEGLDisplay()

SDL_EGLDisplay SDL_EGL_GetCurrentEGLDisplay ( 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_GL_GetCurrentEGLDisplay

◆ SDL_EGL_GetWindowEGLSurface()

SDL_EGLSurface SDL_EGL_GetWindowEGLSurface ( 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_SetEGLAttributeCallbacks()

void SDL_EGL_SetEGLAttributeCallbacks ( 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 flash operation
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()

const SDL_DisplayMode * SDL_GetClosestFullscreenDisplayMode ( SDL_DisplayID  displayID,
int  w,
int  h,
float  refresh_rate,
SDL_bool  include_high_density_modes 
)
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
Returns
a pointer to the closest display mode equal to or larger than the desired mode, or NULL on error; 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 error; 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.

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 error; 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 error; call SDL_GetError() for more details.
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 property can change dynamically when SDL_EVENT_DISPLAY_HDR_STATE_CHANGED is sent.
  • SDL_PROP_DISPLAY_SDR_WHITE_POINT_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_DISPLAY_HDR_STATE_CHANGED is sent.
  • SDL_PROP_DISPLAY_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_DISPLAY_HDR_STATE_CHANGED is sent.
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.
See also
SDL_GetProperty
SDL_SetProperty

◆ 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
Returns
a 0 terminated array of display instance IDs which should be freed with SDL_free(), or NULL on error; call SDL_GetError() for more details.
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()

const 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
Returns
a NULL terminated array of display mode pointers which should be freed with SDL_free(), or NULL on error; call SDL_GetError() for more details.
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.

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

Data returned should be freed with SDL_free.

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

int SDL_GetWindowOpacity ( SDL_Window window,
float *  out_opacity 
)
extern

Get the opacity of a window.

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

The parameter opacity is ignored if it is NULL.

This function also returns -1 if an invalid window was provided.

Parameters
windowthe window to get the current opacity value from
out_opacitythe float filled in (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_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()

Uint32 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

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

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.
See also
SDL_GetProperty
SDL_GetNumberProperty

◆ SDL_GetWindowSize()

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

Get the size of a window's client area.

NULL can safely be passed as the w or h parameter if the width or height value is not desired.

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_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 an alias for void *. It's opaque to the application.

Parameters
windowthe window to associate with the context
Returns
the OpenGL context associated with window or NULL on error; call SDL_GetError() for more details.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_DeleteContext
SDL_GL_MakeCurrent

◆ SDL_GL_DeleteContext()

int SDL_GL_DeleteContext ( 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

Raise a window above other windows and set the input focus.

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

int SDL_SetWindowInputFocus ( SDL_Window window)
extern

Explicitly set input focus to the window.

You almost certainly want SDL_RaiseWindow() instead of this function. Use this with caution, as you might give focus to a window that is completely obscured by other windows.

Parameters
windowthe window that should get the 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.
See also
SDL_RaiseWindow

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

NULL can safely be passed as the w or h parameter if the width or height value is not desired.

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