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   "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_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_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   "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_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_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 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, Uint32 flags)
 
SDL_WindowSDL_CreatePopupWindow (SDL_Window *parent, int offset_x, int offset_y, int w, int h, Uint32 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)
 
Uint32 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_HasWindowSurface (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_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_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER

#define SDL_PROP_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER   "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 1113 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 1112 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 1120 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 1119 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 937 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN   "borderless"

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

◆ SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN   "focusable"

Definition at line 939 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN   "fullscreen"

Definition at line 940 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER

#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER   "height"

Definition at line 941 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN   "hidden"

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

◆ SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN   "maximized"

Definition at line 944 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN   "menu"

Definition at line 945 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN   "metal"

Definition at line 946 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN   "minimized"

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

◆ SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN   "opengl"

Definition at line 949 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_PARENT_POINTER

#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER   "parent"

Definition at line 950 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN   "resizable"

Definition at line 951 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TITLE_STRING

#define SDL_PROP_WINDOW_CREATE_TITLE_STRING   "title"

Definition at line 952 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN   "tooltip"

Definition at line 954 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN   "transparent"

Definition at line 953 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN   "utility"

Definition at line 955 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN

#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN   "vulkan"

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

◆ SDL_PROP_WINDOW_CREATE_WAYLAND_SCALE_TO_DISPLAY

#define SDL_PROP_WINDOW_CREATE_WAYLAND_SCALE_TO_DISPLAY   "wayland.scale_to_display"

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

◆ SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER

#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER   "width"

Definition at line 957 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 966 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 967 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 968 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_X_NUMBER

#define SDL_PROP_WINDOW_CREATE_X_NUMBER   "x"

Definition at line 958 of file SDL_video.h.

◆ SDL_PROP_WINDOW_CREATE_Y_NUMBER

#define SDL_PROP_WINDOW_CREATE_Y_NUMBER   "y"

Definition at line 959 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 1116 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 1117 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 1118 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 1115 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 1114 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 1121 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 1123 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 1122 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 1128 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 1130 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 1129 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 1133 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 1134 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 1131 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 1132 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 1126 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 1125 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 1127 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 1124 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 1135 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 1136 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 1137 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 158 of file SDL_video.h.

◆ SDL_WINDOW_BORDERLESS

#define SDL_WINDOW_BORDERLESS   0x00000010U

no window decoration

Definition at line 148 of file SDL_video.h.

◆ SDL_WINDOW_EXTERNAL

#define SDL_WINDOW_EXTERNAL   0x00000800U

window not created by SDL

Definition at line 155 of file SDL_video.h.

◆ SDL_WINDOW_FULLSCREEN

#define SDL_WINDOW_FULLSCREEN   0x00000001U

The flags on a window

See also
SDL_GetWindowFlags window is in fullscreen mode

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

◆ SDL_WINDOW_INPUT_FOCUS

#define SDL_WINDOW_INPUT_FOCUS   0x00000200U

window has input focus

Definition at line 153 of file SDL_video.h.

◆ SDL_WINDOW_KEYBOARD_GRABBED

#define SDL_WINDOW_KEYBOARD_GRABBED   0x00100000U

window has grabbed keyboard input

Definition at line 162 of file SDL_video.h.

◆ SDL_WINDOW_MAXIMIZED

#define SDL_WINDOW_MAXIMIZED   0x00000080U

window is maximized

Definition at line 151 of file SDL_video.h.

◆ SDL_WINDOW_METAL

#define SDL_WINDOW_METAL   0x20000000U

window usable for Metal view

Definition at line 164 of file SDL_video.h.

◆ SDL_WINDOW_MINIMIZED

#define SDL_WINDOW_MINIMIZED   0x00000040U

window is minimized

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

◆ SDL_WINDOW_MOUSE_FOCUS

#define SDL_WINDOW_MOUSE_FOCUS   0x00000400U

window has mouse focus

Definition at line 154 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_GRABBED

#define SDL_WINDOW_MOUSE_GRABBED   0x00000100U

window has grabbed mouse input

Definition at line 152 of file SDL_video.h.

◆ SDL_WINDOW_NOT_FOCUSABLE

#define SDL_WINDOW_NOT_FOCUSABLE   0x80000000U

window should not be focusable

Definition at line 166 of file SDL_video.h.

◆ SDL_WINDOW_OCCLUDED

#define SDL_WINDOW_OCCLUDED   0x00000004U

window is occluded

Definition at line 146 of file SDL_video.h.

◆ SDL_WINDOW_OPENGL

#define SDL_WINDOW_OPENGL   0x00000002U

window usable with OpenGL context

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

◆ SDL_WINDOW_RESIZABLE

#define SDL_WINDOW_RESIZABLE   0x00000020U

window can be resized

Definition at line 149 of file SDL_video.h.

◆ SDL_WINDOW_TOOLTIP

#define SDL_WINDOW_TOOLTIP   0x00040000U

window should be treated as a tooltip

Definition at line 160 of file SDL_video.h.

◆ SDL_WINDOW_TRANSPARENT

#define SDL_WINDOW_TRANSPARENT   0x40000000U

window with transparent buffer

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

◆ SDL_WINDOW_VULKAN

#define SDL_WINDOW_VULKAN   0x10000000U

window usable for Vulkan surface

Definition at line 163 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 182 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

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

◆ SDL_WINDOWPOS_ISCENTERED

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

Definition at line 183 of file SDL_video.h.

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

◆ SDL_WINDOWPOS_ISUNDEFINED

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

Definition at line 174 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 173 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

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

◆ SDL_EGLAttribArrayCallback

typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void)

EGL attribute initialization callback types.

Definition at line 213 of file SDL_video.h.

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

Definition at line 205 of file SDL_video.h.

◆ SDL_EGLDisplay

typedef void* SDL_EGLDisplay

Opaque EGL types.

Definition at line 204 of file SDL_video.h.

◆ SDL_EGLint

typedef int SDL_EGLint

Definition at line 208 of file SDL_video.h.

◆ SDL_EGLIntArrayCallback

typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)

Definition at line 214 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Definition at line 206 of file SDL_video.h.

◆ SDL_GLContext

typedef void* SDL_GLContext

An opaque handle to an OpenGL context.

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

◆ SDL_Window

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

190{
191 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
192 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
193 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 219 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 258 of file SDL_video.h.

◆ SDL_GLcontextReleaseFlag

Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 

Definition at line 266 of file SDL_video.h.

◆ SDL_GLContextResetNotification

Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 

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

252{
255 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 2041 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,
Uint32  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,
Uint32  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_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 - 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_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_HasWindowSurface

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

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

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

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

SDL_bool SDL_HasWindowSurface ( 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

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