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_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_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_SetWindowGrab (SDL_Window *window, SDL_bool grabbed)
 
int SDL_SetWindowKeyboardGrab (SDL_Window *window, SDL_bool grabbed)
 
int SDL_SetWindowMouseGrab (SDL_Window *window, SDL_bool grabbed)
 
SDL_bool SDL_GetWindowGrab (SDL_Window *window)
 
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 355 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 357 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 356 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"

Global video properties

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

Definition at line 61 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 1115 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 1114 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 1122 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 1121 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 932 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN   "borderless"

Definition at line 933 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 957 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 956 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 935 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN   "focusable"

Definition at line 934 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN   "fullscreen"

Definition at line 936 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER

#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER   "height"

Definition at line 937 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN   "hidden"

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

◆ SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN   "maximized"

Definition at line 940 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN   "menu"

Definition at line 941 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN   "metal"

Definition at line 942 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN   "minimized"

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

◆ SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN   "opengl"

Definition at line 945 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_PARENT_POINTER

#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER   "parent"

Definition at line 946 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN   "resizable"

Definition at line 947 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TITLE_STRING

#define SDL_PROP_WINDOW_CREATE_TITLE_STRING   "title"

Definition at line 948 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN   "tooltip"

Definition at line 950 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN   "transparent"

Definition at line 949 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN   "utility"

Definition at line 951 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN   "vulkan"

Definition at line 952 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 960 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 958 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 959 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 961 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER

#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER   "width"

Definition at line 953 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 962 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 963 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 964 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_X_NUMBER

#define SDL_PROP_WINDOW_CREATE_X_NUMBER   "x"

Definition at line 954 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_Y_NUMBER

#define SDL_PROP_WINDOW_CREATE_Y_NUMBER   "y"

Definition at line 955 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 1118 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 1119 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 1120 of file SDL_video.h.

◆ SDL_PROP_WINDOW_SHAPE_POINTER

#define SDL_PROP_WINDOW_SHAPE_POINTER   "SDL.window.shape"

Definition at line 1113 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 1117 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 1116 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 1123 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 1125 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 1124 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 1130 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 1132 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 1131 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 1136 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 1137 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 1133 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 1135 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 1134 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 1128 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 1127 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 1129 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 1126 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 1138 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 1139 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 1140 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 131 of file SDL_video.h.

◆ SDL_WINDOW_BORDERLESS

#define SDL_WINDOW_BORDERLESS   0x00000010U

no window decoration

Definition at line 121 of file SDL_video.h.

◆ SDL_WINDOW_EXTERNAL

#define SDL_WINDOW_EXTERNAL   0x00000800U

window not created by SDL

Definition at line 128 of file SDL_video.h.

◆ SDL_WINDOW_FULLSCREEN

#define SDL_WINDOW_FULLSCREEN   0x00000001U

window is in fullscreen mode

Definition at line 117 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 120 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 129 of file SDL_video.h.

◆ SDL_WINDOW_INPUT_FOCUS

#define SDL_WINDOW_INPUT_FOCUS   0x00000200U

window has input focus

Definition at line 126 of file SDL_video.h.

◆ SDL_WINDOW_KEYBOARD_GRABBED

#define SDL_WINDOW_KEYBOARD_GRABBED   0x00100000U

window has grabbed keyboard input

Definition at line 135 of file SDL_video.h.

◆ SDL_WINDOW_MAXIMIZED

#define SDL_WINDOW_MAXIMIZED   0x00000080U

window is maximized

Definition at line 124 of file SDL_video.h.

◆ SDL_WINDOW_METAL

#define SDL_WINDOW_METAL   0x20000000U

window usable for Metal view

Definition at line 137 of file SDL_video.h.

◆ SDL_WINDOW_MINIMIZED

#define SDL_WINDOW_MINIMIZED   0x00000040U

window is minimized

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

◆ SDL_WINDOW_MOUSE_FOCUS

#define SDL_WINDOW_MOUSE_FOCUS   0x00000400U

window has mouse focus

Definition at line 127 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_GRABBED

#define SDL_WINDOW_MOUSE_GRABBED   0x00000100U

window has grabbed mouse input

Definition at line 125 of file SDL_video.h.

◆ SDL_WINDOW_NOT_FOCUSABLE

#define SDL_WINDOW_NOT_FOCUSABLE   0x80000000U

window should not be focusable

Definition at line 139 of file SDL_video.h.

◆ SDL_WINDOW_OCCLUDED

#define SDL_WINDOW_OCCLUDED   0x00000004U

window is occluded

Definition at line 119 of file SDL_video.h.

◆ SDL_WINDOW_OPENGL

#define SDL_WINDOW_OPENGL   0x00000002U

window usable with OpenGL context

Definition at line 118 of file SDL_video.h.

◆ SDL_WINDOW_POPUP_MENU

#define SDL_WINDOW_POPUP_MENU   0x00080000U

window should be treated as a popup menu

Definition at line 134 of file SDL_video.h.

◆ SDL_WINDOW_RESIZABLE

#define SDL_WINDOW_RESIZABLE   0x00000020U

window can be resized

Definition at line 122 of file SDL_video.h.

◆ SDL_WINDOW_TOOLTIP

#define SDL_WINDOW_TOOLTIP   0x00040000U

window should be treated as a tooltip

Definition at line 133 of file SDL_video.h.

◆ SDL_WINDOW_TRANSPARENT

#define SDL_WINDOW_TRANSPARENT   0x40000000U

window with transparent buffer

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

◆ SDL_WINDOW_VULKAN

#define SDL_WINDOW_VULKAN   0x10000000U

window usable for Vulkan surface

Definition at line 136 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 155 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

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

Definition at line 153 of file SDL_video.h.

◆ SDL_WINDOWPOS_ISCENTERED

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

Definition at line 156 of file SDL_video.h.

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

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 146 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

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

Definition at line 144 of file SDL_video.h.

Typedef Documentation

◆ SDL_DisplayID

Definition at line 44 of file SDL_video.h.

◆ SDL_EGLAttrib

typedef intptr_t SDL_EGLAttrib

Definition at line 180 of file SDL_video.h.

◆ SDL_EGLAttribArrayCallback

typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void)

EGL attribute initialization callback types.

Definition at line 186 of file SDL_video.h.

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

Definition at line 178 of file SDL_video.h.

◆ SDL_EGLDisplay

typedef void* SDL_EGLDisplay

Opaque EGL types.

Definition at line 177 of file SDL_video.h.

◆ SDL_EGLint

typedef int SDL_EGLint

Definition at line 181 of file SDL_video.h.

◆ SDL_EGLIntArrayCallback

typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)

Definition at line 187 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Definition at line 179 of file SDL_video.h.

◆ SDL_GLContext

typedef void* SDL_GLContext

An opaque handle to an OpenGL context.

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

◆ SDL_Window

typedef struct SDL_Window SDL_Window

The type used to identify a window

Definition at line 108 of file SDL_video.h.

◆ SDL_WindowFlags

The flags on a window

See also
SDL_GetWindowFlags

Definition at line 115 of file SDL_video.h.

◆ SDL_WindowID

Definition at line 45 of file SDL_video.h.

Enumeration Type Documentation

◆ SDL_DisplayOrientation

Display orientation

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

97{
98 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
99 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
100 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
101 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
102 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
@ SDL_ORIENTATION_LANDSCAPE
Definition SDL_video.h:99
@ SDL_ORIENTATION_PORTRAIT
Definition SDL_video.h:101
@ SDL_ORIENTATION_PORTRAIT_FLIPPED
Definition SDL_video.h:102
@ SDL_ORIENTATION_LANDSCAPE_FLIPPED
Definition SDL_video.h:100
@ SDL_ORIENTATION_UNKNOWN
Definition SDL_video.h:98

◆ SDL_FlashOperation

Window flash operation

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

163{
164 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
165 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
166 SDL_FLASH_UNTIL_FOCUSED /**< Flash the window until it gets focus */

◆ SDL_GLattr

enum SDL_GLattr

OpenGL configuration attributes

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

◆ SDL_GLcontextFlag

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

◆ SDL_GLcontextReleaseFlag

Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 

Definition at line 239 of file SDL_video.h.

◆ SDL_GLContextResetNotification

Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 

Definition at line 245 of file SDL_video.h.

◆ SDL_GLprofile

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

225{
228 SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */

◆ SDL_HitTestResult

Possible return values from the SDL_HitTest callback.

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

Definition at line 2044 of file SDL_video.h.

◆ SDL_SystemTheme

System theme

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

67{
68 SDL_SYSTEM_THEME_UNKNOWN, /**< Unknown system theme */
69 SDL_SYSTEM_THEME_LIGHT, /**< Light colored system theme */
70 SDL_SYSTEM_THEME_DARK /**< Dark colored system theme */
@ SDL_SYSTEM_THEME_LIGHT
Definition SDL_video.h:69
@ SDL_SYSTEM_THEME_UNKNOWN
Definition SDL_video.h:68
@ SDL_SYSTEM_THEME_DARK
Definition SDL_video.h:70

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_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" and "menu" 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 docs/README-wayland.md for more information on using custom surfaces.
  • SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN - true if the application wants an associatedwl_egl_windowobject 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 docs/README-wayland.md 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.

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 since SDL 2.0.2. Before SDL 2.0.2 the screensaver was enabled by default.

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 displays 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_GetWindowGrab
SDL_SetWindowGrab

◆ 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_SetWindowGrab
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_GetWindowGrab()

SDL_bool SDL_GetWindowGrab ( SDL_Window window)
extern

Get a window's input grab mode.

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

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

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

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

◆ 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 since SDL 2.0.2. Before SDL 2.0.2 the screensaver was enabled 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_SetWindowGrab()

int SDL_SetWindowGrab ( SDL_Window window,
SDL_bool  grabbed 
)
extern

Set a window's input grab mode.

When input is grabbed, the mouse is confined to the window. This function will also grab the keyboard if SDL_HINT_GRAB_KEYBOARD is set. To grab the keyboard without also grabbing the mouse, use SDL_SetWindowKeyboardGrab().

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 input grab mode should be set
grabbedSDL_TRUE to grab input or SDL_FALSE to release input
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_GetGrabbedWindow
SDL_GetWindowGrab

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

◆ 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 for another window.

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_SetWindowGrab

◆ 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