SDL 3.0
SDL_video.h File Reference

Header file for SDL video functions. More...

+ 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
 The structure that defines a display mode. More...
 

Macros

#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u
 Used to indicate that you don't care what the window position is.
 
#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
 Used to indicate that the window position should be centered.
 
#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
 The type used to identify a window.
 
typedef void * SDL_GLContext
 An opaque handle to an OpenGL context.
 
typedef void * SDL_EGLDisplay
 Opaque EGL types.
 
typedef void * SDL_EGLConfig
 
typedef void * SDL_EGLSurface
 
typedef intptr_t SDL_EGLAttrib
 
typedef int SDL_EGLint
 
typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void)
 EGL attribute initialization callback types.
 
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
}
 System theme. More...
 
enum  SDL_DisplayOrientation {
  SDL_ORIENTATION_UNKNOWN ,
  SDL_ORIENTATION_LANDSCAPE ,
  SDL_ORIENTATION_LANDSCAPE_FLIPPED ,
  SDL_ORIENTATION_PORTRAIT ,
  SDL_ORIENTATION_PORTRAIT_FLIPPED
}
 Display orientation. More...
 
enum  SDL_WindowFlags {
  SDL_WINDOW_FULLSCREEN = 0x00000001 ,
  SDL_WINDOW_OPENGL = 0x00000002 ,
  SDL_WINDOW_OCCLUDED = 0x00000004 ,
  SDL_WINDOW_HIDDEN = 0x00000008 ,
  SDL_WINDOW_BORDERLESS = 0x00000010 ,
  SDL_WINDOW_RESIZABLE = 0x00000020 ,
  SDL_WINDOW_MINIMIZED = 0x00000040 ,
  SDL_WINDOW_MAXIMIZED = 0x00000080 ,
  SDL_WINDOW_MOUSE_GRABBED = 0x00000100 ,
  SDL_WINDOW_INPUT_FOCUS = 0x00000200 ,
  SDL_WINDOW_MOUSE_FOCUS = 0x00000400 ,
  SDL_WINDOW_FOREIGN = 0x00000800 ,
  SDL_WINDOW_HIGH_PIXEL_DENSITY = 0x00002000 ,
  SDL_WINDOW_MOUSE_CAPTURE = 0x00004000 ,
  SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000 ,
  SDL_WINDOW_UTILITY = 0x00020000 ,
  SDL_WINDOW_TOOLTIP = 0x00040000 ,
  SDL_WINDOW_POPUP_MENU = 0x00080000 ,
  SDL_WINDOW_KEYBOARD_GRABBED = 0x00100000 ,
  SDL_WINDOW_VULKAN = 0x10000000 ,
  SDL_WINDOW_METAL = 0x20000000 ,
  SDL_WINDOW_TRANSPARENT = 0x40000000 ,
  SDL_WINDOW_NOT_FOCUSABLE = 0x80000000
}
 The flags on a window. More...
 
enum  SDL_FlashOperation {
  SDL_FLASH_CANCEL ,
  SDL_FLASH_BRIEFLY ,
  SDL_FLASH_UNTIL_FOCUSED
}
 Window flash operation. More...
 
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
}
 OpenGL configuration attributes. More...
 
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)
 
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_CreateWindowWithPosition (const char *title, int x, int y, 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_CreateWindowFrom (const void *data)
 
SDL_WindowID SDL_GetWindowID (SDL_Window *window)
 
SDL_WindowSDL_GetWindowFromID (SDL_WindowID id)
 
SDL_WindowSDL_GetWindowParent (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)
 
void * SDL_SetWindowData (SDL_Window *window, const char *name, void *userdata)
 
void * SDL_GetWindowData (SDL_Window *window, const char *name)
 
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)
 
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_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 172 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

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

◆ SDL_WINDOWPOS_ISCENTERED

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

Definition at line 173 of file SDL_video.h.

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

◆ SDL_WINDOWPOS_ISUNDEFINED

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

Definition at line 164 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 163 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

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

Typedef Documentation

◆ SDL_DisplayID

Definition at line 43 of file SDL_video.h.

◆ SDL_EGLAttrib

typedef intptr_t SDL_EGLAttrib

Definition at line 197 of file SDL_video.h.

◆ SDL_EGLAttribArrayCallback

typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void)

EGL attribute initialization callback types.

Definition at line 203 of file SDL_video.h.

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

Definition at line 195 of file SDL_video.h.

◆ SDL_EGLDisplay

typedef void* SDL_EGLDisplay

Opaque EGL types.

Definition at line 194 of file SDL_video.h.

◆ SDL_EGLint

typedef int SDL_EGLint

Definition at line 198 of file SDL_video.h.

◆ SDL_EGLIntArrayCallback

typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)

Definition at line 204 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Definition at line 196 of file SDL_video.h.

◆ SDL_GLContext

typedef void* SDL_GLContext

An opaque handle to an OpenGL context.

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

◆ SDL_Window

◆ SDL_WindowID

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

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

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

180{
181 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
182 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
183 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 209 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 248 of file SDL_video.h.

◆ SDL_GLcontextReleaseFlag

Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 

Definition at line 256 of file SDL_video.h.

◆ SDL_GLContextResetNotification

Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 

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

242{
245 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 1722 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 49 of file SDL_video.h.

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

◆ SDL_WindowFlags

The flags on a window.

See also
SDL_GetWindowFlags()
Enumerator
SDL_WINDOW_FULLSCREEN 

window is in fullscreen mode

SDL_WINDOW_OPENGL 

window usable with OpenGL context

SDL_WINDOW_OCCLUDED 

window is occluded

SDL_WINDOW_HIDDEN 

window is neither mapped onto the desktop nor shown in the taskbar/dock/window list; SDL_ShowWindow() is required for it to become 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 input

SDL_WINDOW_INPUT_FOCUS 

window has input focus

SDL_WINDOW_MOUSE_FOCUS 

window has mouse focus

SDL_WINDOW_FOREIGN 

window not created by SDL

SDL_WINDOW_HIGH_PIXEL_DENSITY 

window uses high pixel density back buffer if possible

SDL_WINDOW_MOUSE_CAPTURE 

window has mouse captured (unrelated to MOUSE_GRABBED)

SDL_WINDOW_ALWAYS_ON_TOP 

window should always be above others

SDL_WINDOW_UTILITY 

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

SDL_WINDOW_TOOLTIP 

window should be treated as a tooltip and must be created using SDL_CreatePopupWindow()

SDL_WINDOW_POPUP_MENU 

window should be treated as a popup menu and must be created using SDL_CreatePopupWindow()

SDL_WINDOW_KEYBOARD_GRABBED 

window has grabbed keyboard input

SDL_WINDOW_VULKAN 

window usable for Vulkan surface

SDL_WINDOW_METAL 

window usable for Metal view

SDL_WINDOW_TRANSPARENT 

window with transparent buffer

SDL_WINDOW_NOT_FOCUSABLE 

window should not be focusable

Definition at line 130 of file SDL_video.h.

131{
132 SDL_WINDOW_FULLSCREEN = 0x00000001, /**< window is in fullscreen mode */
133 SDL_WINDOW_OPENGL = 0x00000002, /**< window usable with OpenGL context */
134 SDL_WINDOW_OCCLUDED = 0x00000004, /**< window is occluded */
135 SDL_WINDOW_HIDDEN = 0x00000008, /**< window is neither mapped onto the desktop nor shown in the taskbar/dock/window list; SDL_ShowWindow() is required for it to become visible */
136 SDL_WINDOW_BORDERLESS = 0x00000010, /**< no window decoration */
137 SDL_WINDOW_RESIZABLE = 0x00000020, /**< window can be resized */
138 SDL_WINDOW_MINIMIZED = 0x00000040, /**< window is minimized */
139 SDL_WINDOW_MAXIMIZED = 0x00000080, /**< window is maximized */
140 SDL_WINDOW_MOUSE_GRABBED = 0x00000100, /**< window has grabbed mouse input */
141 SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */
142 SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
143 SDL_WINDOW_FOREIGN = 0x00000800, /**< window not created by SDL */
144 SDL_WINDOW_HIGH_PIXEL_DENSITY = 0x00002000, /**< window uses high pixel density back buffer if possible */
145 SDL_WINDOW_MOUSE_CAPTURE = 0x00004000, /**< window has mouse captured (unrelated to MOUSE_GRABBED) */
146 SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000, /**< window should always be above others */
147 SDL_WINDOW_UTILITY = 0x00020000, /**< window should be treated as a utility window, not showing in the task bar and window list */
148 SDL_WINDOW_TOOLTIP = 0x00040000, /**< window should be treated as a tooltip and must be created using SDL_CreatePopupWindow() */
149 SDL_WINDOW_POPUP_MENU = 0x00080000, /**< window should be treated as a popup menu and must be created using SDL_CreatePopupWindow() */
150 SDL_WINDOW_KEYBOARD_GRABBED = 0x00100000, /**< window has grabbed keyboard input */
151 SDL_WINDOW_VULKAN = 0x10000000, /**< window usable for Vulkan surface */
152 SDL_WINDOW_METAL = 0x20000000, /**< window usable for Metal view */
153 SDL_WINDOW_TRANSPARENT = 0x40000000, /**< window with transparent buffer */
154 SDL_WINDOW_NOT_FOCUSABLE = 0x80000000, /**< window should not be focusable */
155
SDL_WindowFlags
The flags on a window.
Definition SDL_video.h:131
@ SDL_WINDOW_HIGH_PIXEL_DENSITY
Definition SDL_video.h:144
@ SDL_WINDOW_FOREIGN
Definition SDL_video.h:143
@ SDL_WINDOW_TOOLTIP
Definition SDL_video.h:148
@ SDL_WINDOW_ALWAYS_ON_TOP
Definition SDL_video.h:146
@ SDL_WINDOW_MOUSE_CAPTURE
Definition SDL_video.h:145
@ SDL_WINDOW_VULKAN
Definition SDL_video.h:151
@ SDL_WINDOW_OPENGL
Definition SDL_video.h:133
@ SDL_WINDOW_MINIMIZED
Definition SDL_video.h:138
@ SDL_WINDOW_UTILITY
Definition SDL_video.h:147
@ SDL_WINDOW_MOUSE_FOCUS
Definition SDL_video.h:142
@ SDL_WINDOW_RESIZABLE
Definition SDL_video.h:137
@ SDL_WINDOW_KEYBOARD_GRABBED
Definition SDL_video.h:150
@ SDL_WINDOW_NOT_FOCUSABLE
Definition SDL_video.h:154
@ SDL_WINDOW_FULLSCREEN
Definition SDL_video.h:132
@ SDL_WINDOW_MAXIMIZED
Definition SDL_video.h:139
@ SDL_WINDOW_TRANSPARENT
Definition SDL_video.h:153
@ SDL_WINDOW_METAL
Definition SDL_video.h:152
@ SDL_WINDOW_HIDDEN
Definition SDL_video.h:135
@ SDL_WINDOW_MOUSE_GRABBED
Definition SDL_video.h:140
@ SDL_WINDOW_POPUP_MENU
Definition SDL_video.h:149
@ SDL_WINDOW_OCCLUDED
Definition SDL_video.h:134
@ SDL_WINDOW_BORDERLESS
Definition SDL_video.h:136
@ SDL_WINDOW_INPUT_FOCUS
Definition SDL_video.h:141

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

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_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 set fullscreen, the width and height parameters w and h will not be used. However, invalid size parameters (e.g. too large) may still fail. Window size is actually limited to 16384 x 16384 for all platforms at window creation.

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_CreateWindowFrom
SDL_CreateWindowWithPosition
SDL_DestroyWindow

◆ SDL_CreateWindowFrom()

SDL_Window * SDL_CreateWindowFrom ( const void *  data)
extern

Create an SDL window from an existing native window.

In some cases (e.g. OpenGL) and on some platforms (e.g. Microsoft Windows) the hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT needs to be configured before using SDL_CreateWindowFrom().

Parameters
dataa pointer to driver-dependent window creation data, typically your native window cast to a void*
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_CreateWindowWithPosition()

SDL_Window * SDL_CreateWindowWithPosition ( const char *  title,
int  x,
int  y,
int  w,
int  h,
Uint32  flags 
)
extern

Create a window with the specified position, 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 set fullscreen, the width and height parameters w and h will not be used. However, invalid size parameters (e.g. too large) may still fail. Window size is actually limited to 16384 x 16384 for all platforms at window creation.

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
xthe x position of the window, or SDL_WINDOWPOS_CENTERED
ythe y position of the window, or SDL_WINDOWPOS_CENTERED
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_CreateWindow
SDL_CreateWindowFrom
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_CreateWindow
SDL_CreateWindowFrom

◆ 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_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_GetWindowData()

void * SDL_GetWindowData ( SDL_Window window,
const char *  name 
)
extern

Retrieve the data pointer associated with a window.

Parameters
windowthe window to query
namethe name of the pointer
Returns
the value associated with name.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowData

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

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

Make a window as large as possible.

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

int SDL_MinimizeWindow ( SDL_Window window)
extern

Minimize a window to an iconic representation.

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

Restore the size and position of a minimized or maximized window.

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

void * SDL_SetWindowData ( SDL_Window window,
const char *  name,
void *  userdata 
)
extern

Associate an arbitrary named pointer with a window.

name is case-sensitive.

Parameters
windowthe window to associate with the pointer
namethe name of the pointer
userdatathe associated pointer
Returns
the previous value associated with name.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowData

◆ 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

Set a window's fullscreen state.

By default a window in fullscreen state uses fullscreen desktop mode, but a specific display mode can be set using SDL_SetWindowFullscreenMode().

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

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

Set the position of a window.

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

Set the size of a window's client area.

This only affects the size of the window when not in fullscreen mode. To change the fullscreen mode of a window, use SDL_SetWindowFullscreenMode()

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