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

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_WINDOW_ALWAYS_ON_TOP

#define SDL_WINDOW_ALWAYS_ON_TOP   0x00008000U

window should always be above others

Definition at line 142 of file SDL_video.h.

◆ SDL_WINDOW_BORDERLESS

#define SDL_WINDOW_BORDERLESS   0x00000010U

no window decoration

Definition at line 132 of file SDL_video.h.

◆ SDL_WINDOW_EXTERNAL

#define SDL_WINDOW_EXTERNAL   0x00000800U

window not created by SDL

Definition at line 139 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 128 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 131 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 140 of file SDL_video.h.

◆ SDL_WINDOW_INPUT_FOCUS

#define SDL_WINDOW_INPUT_FOCUS   0x00000200U

window has input focus

Definition at line 137 of file SDL_video.h.

◆ SDL_WINDOW_KEYBOARD_GRABBED

#define SDL_WINDOW_KEYBOARD_GRABBED   0x00100000U

window has grabbed keyboard input

Definition at line 146 of file SDL_video.h.

◆ SDL_WINDOW_MAXIMIZED

#define SDL_WINDOW_MAXIMIZED   0x00000080U

window is maximized

Definition at line 135 of file SDL_video.h.

◆ SDL_WINDOW_METAL

#define SDL_WINDOW_METAL   0x20000000U

window usable for Metal view

Definition at line 148 of file SDL_video.h.

◆ SDL_WINDOW_MINIMIZED

#define SDL_WINDOW_MINIMIZED   0x00000040U

window is minimized

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

◆ SDL_WINDOW_MOUSE_FOCUS

#define SDL_WINDOW_MOUSE_FOCUS   0x00000400U

window has mouse focus

Definition at line 138 of file SDL_video.h.

◆ SDL_WINDOW_MOUSE_GRABBED

#define SDL_WINDOW_MOUSE_GRABBED   0x00000100U

window has grabbed mouse input

Definition at line 136 of file SDL_video.h.

◆ SDL_WINDOW_NOT_FOCUSABLE

#define SDL_WINDOW_NOT_FOCUSABLE   0x80000000U

window should not be focusable

Definition at line 150 of file SDL_video.h.

◆ SDL_WINDOW_OCCLUDED

#define SDL_WINDOW_OCCLUDED   0x00000004U

window is occluded

Definition at line 130 of file SDL_video.h.

◆ SDL_WINDOW_OPENGL

#define SDL_WINDOW_OPENGL   0x00000002U

window usable with OpenGL context

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

◆ SDL_WINDOW_RESIZABLE

#define SDL_WINDOW_RESIZABLE   0x00000020U

window can be resized

Definition at line 133 of file SDL_video.h.

◆ SDL_WINDOW_TOOLTIP

#define SDL_WINDOW_TOOLTIP   0x00040000U

window should be treated as a tooltip

Definition at line 144 of file SDL_video.h.

◆ SDL_WINDOW_TRANSPARENT

#define SDL_WINDOW_TRANSPARENT   0x40000000U

window with transparent buffer

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

◆ SDL_WINDOW_VULKAN

#define SDL_WINDOW_VULKAN   0x10000000U

window usable for Vulkan surface

Definition at line 147 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 166 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

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

◆ SDL_WINDOWPOS_ISCENTERED

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

Definition at line 167 of file SDL_video.h.

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

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 157 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

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

◆ SDL_EGLAttribArrayCallback

typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void)

EGL attribute initialization callback types.

Definition at line 197 of file SDL_video.h.

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

Definition at line 189 of file SDL_video.h.

◆ SDL_EGLDisplay

typedef void* SDL_EGLDisplay

Opaque EGL types.

Definition at line 188 of file SDL_video.h.

◆ SDL_EGLint

typedef int SDL_EGLint

Definition at line 192 of file SDL_video.h.

◆ SDL_EGLIntArrayCallback

typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)

Definition at line 198 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Definition at line 190 of file SDL_video.h.

◆ SDL_GLContext

typedef void* SDL_GLContext

An opaque handle to an OpenGL context.

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

81{
82 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
83 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
84 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
85 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
86 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
@ SDL_ORIENTATION_LANDSCAPE
Definition SDL_video.h:83
@ SDL_ORIENTATION_PORTRAIT
Definition SDL_video.h:85
@ SDL_ORIENTATION_PORTRAIT_FLIPPED
Definition SDL_video.h:86
@ SDL_ORIENTATION_LANDSCAPE_FLIPPED
Definition SDL_video.h:84
@ SDL_ORIENTATION_UNKNOWN
Definition SDL_video.h:82

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

174{
175 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
176 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
177 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 203 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 242 of file SDL_video.h.

◆ SDL_GLcontextReleaseFlag

Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 

Definition at line 250 of file SDL_video.h.

◆ SDL_GLContextResetNotification

Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 

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

236{
239 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 1916 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 50 of file SDL_video.h.

51{
52 SDL_SYSTEM_THEME_UNKNOWN, /**< Unknown system theme */
53 SDL_SYSTEM_THEME_LIGHT, /**< Light colored system theme */
54 SDL_SYSTEM_THEME_DARK /**< Dark colored system theme */
@ SDL_SYSTEM_THEME_LIGHT
Definition SDL_video.h:53
@ SDL_SYSTEM_THEME_UNKNOWN
Definition SDL_video.h:52
@ SDL_SYSTEM_THEME_DARK
Definition SDL_video.h:54

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:

  • "always-on-top" (boolean) - true if the window should be always on top
  • "borderless" (boolean) - true if the window has no window decoration
  • "focusable" (boolean) - true if the window should accept keyboard input (defaults true)
  • "fullscreen" (boolean) - true if the window should start in fullscreen mode at desktop resolution
  • "height" (number) - the height of the window
  • "hidden" (boolean) - true if the window should start hidden
  • "high-pixel-density" (boolean) - true if the window uses a high pixel density buffer if possible
  • "maximized" (boolean) - true if the window should start maximized
  • "menu" (boolean) - true if the window is a popup menu
  • "metal" (string) - true if the window will be used with Metal rendering
  • "minimized" (boolean) - true if the window should start minimized
  • "mouse-grabbed" (boolean) - true if the window starts with grabbed mouse focus
  • "opengl" (boolean) - true if the window will be used with OpenGL rendering
  • "parent" (pointer) - an SDL_Window that will be the parent of this window, required for windows with the "toolip" and "menu" properties
  • "resizable" (boolean) - true if the window should be resizable
  • "title" (string) - the title of the window, in UTF-8 encoding
  • "transparent" (string) - true if the window show transparent in the areas with alpha of 0
  • "tooltip" (boolean) - true if the window is a tooltip
  • "utility" (boolean) - true if the window is a utility window, not showing in the task bar and window list
  • "vulkan" (string) - true if the window will be used with Vulkan rendering
  • "width" (number) - the width of the window
  • "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.
  • "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.

On macOS:

  • "cocoa.window" (pointer) - the (__unsafe_unretained) NSWindow associated with the window, if you want to wrap an existing window.
  • "cocoa.view" (pointer) - the (__unsafe_unretained) NSView associated with the window, defaults to [window contentView]

On Windows:

  • "win32.hwnd" (pointer) - the HWND associated with the window, if you want to wrap an existing window.
  • "win32.pixel_format_hwnd" (pointer) - optional, another window to share pixel format with, useful for OpenGL windows

On X11:

  • "x11.window" (number) - the X11 Window associated with the window, if you want to wrap an existing window.

The SDL_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 fullscreen mode to use or NULL for 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.window.android.window" (pointer) - the ANativeWindow associated with the window
"SDL.window.android.surface" (pointer) - the EGLSurface associated with the window

On iOS:

"SDL.window.uikit.window" (pointer) - the (__unsafe_unretained) UIWindow associated with the window
"SDL.window.uikit.metal_view_tag" (number) - the NSInteger tag assocated with metal views on the window

On KMS/DRM:

"SDL.window.kmsdrm.dev_index" (number) - the device index associated with the window (e.g. the X in /dev/dri/cardX)
"SDL.window.kmsdrm.drm_fd" (number) - the DRM FD associated with the window
"SDL.window.kmsdrm.gbm_dev" (pointer) - the GBM device associated with the window

On macOS:

"SDL.window.cocoa.window" (pointer) - the (__unsafe_unretained) NSWindow associated with the window
"SDL.window.cocoa.metal_view_tag" (number) - the NSInteger tag assocated with metal views on the window

On Vivante:

"SDL.window.vivante.display" (pointer) - the EGLNativeDisplayType associated with the window
"SDL.window.vivante.window" (pointer) - the EGLNativeWindowType associated with the window
"SDL.window.vivante.surface" (pointer) - the EGLSurface associated with the window

On UWP:

"SDL.window.winrt.window" (pointer) - the IInspectable CoreWindow associated with the window

On Windows:

"SDL.window.win32.hwnd" (pointer) - the HWND associated with the window
"SDL.window.win32.hdc" (pointer) - the HDC associated with the window
"SDL.window.win32.instance" (pointer) - the HINSTANCE associated with the window

On Wayland:

"SDL.window.wayland.registry" (pointer) - the wl_registry associated with the window
"SDL.window.wayland.display" (pointer) - the wl_display associated with the window
"SDL.window.wayland.surface" (pointer) - the wl_surface associated with the window
"SDL.window.wayland.egl_window" (pointer) - the wl_egl_window associated with the window
"SDL.window.wayland.xdg_surface" (pointer) - the xdg_surface associated with the window
"SDL.window.wayland.xdg_toplevel" (pointer) - the xdg_toplevel role associated with the window
"SDL.window.wayland.xdg_popup" (pointer) - the xdg_popup role associated with the window
"SDL.window.wayland.xdg_positioner" (pointer) - the xdg_positioner associated with the window, in popup mode

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.

On X11:

"SDL.window.x11.display" (pointer) - the X11 Display associated with the window
"SDL.window.x11.screen" (number) - the screen number associated with the window
"SDL.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 fullscreen desktop mode, but a specific 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 desktop mode, or one of the fullscreen modes returned by SDL_GetFullscreenDisplayModes().
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().

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