SDL 3.0
SDL_video.h File Reference
+ Include dependency graph for SDL_video.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SDL_DisplayMode
 

Macros

#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u
 
#define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)   (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
 
#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
 
#define SDL_WINDOWPOS_ISUNDEFINED(X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
 
#define SDL_WINDOWPOS_CENTERED_MASK   0x2FFF0000u
 
#define SDL_WINDOWPOS_CENTERED_DISPLAY(X)   (SDL_WINDOWPOS_CENTERED_MASK|(X))
 
#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)
 
#define SDL_WINDOWPOS_ISCENTERED(X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
 

Typedefs

typedef Uint32 SDL_DisplayID
 
typedef Uint32 SDL_WindowID
 
typedef struct SDL_Window SDL_Window
 
typedef void * SDL_GLContext
 
typedef void * SDL_EGLDisplay
 
typedef void * SDL_EGLConfig
 
typedef void * SDL_EGLSurface
 
typedef intptr_t SDL_EGLAttrib
 
typedef int SDL_EGLint
 
typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void)
 
typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)
 
typedef SDL_HitTestResult(* SDL_HitTest) (SDL_Window *win, const SDL_Point *area, void *data)
 

Enumerations

enum  SDL_SystemTheme {
  SDL_SYSTEM_THEME_UNKNOWN ,
  SDL_SYSTEM_THEME_LIGHT ,
  SDL_SYSTEM_THEME_DARK
}
 
enum  SDL_DisplayOrientation {
  SDL_ORIENTATION_UNKNOWN ,
  SDL_ORIENTATION_LANDSCAPE ,
  SDL_ORIENTATION_LANDSCAPE_FLIPPED ,
  SDL_ORIENTATION_PORTRAIT ,
  SDL_ORIENTATION_PORTRAIT_FLIPPED
}
 
enum  SDL_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_EXTERNAL = 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
}
 
enum  SDL_FlashOperation {
  SDL_FLASH_CANCEL ,
  SDL_FLASH_BRIEFLY ,
  SDL_FLASH_UNTIL_FOCUSED
}
 
enum  SDL_GLattr {
  SDL_GL_RED_SIZE ,
  SDL_GL_GREEN_SIZE ,
  SDL_GL_BLUE_SIZE ,
  SDL_GL_ALPHA_SIZE ,
  SDL_GL_BUFFER_SIZE ,
  SDL_GL_DOUBLEBUFFER ,
  SDL_GL_DEPTH_SIZE ,
  SDL_GL_STENCIL_SIZE ,
  SDL_GL_ACCUM_RED_SIZE ,
  SDL_GL_ACCUM_GREEN_SIZE ,
  SDL_GL_ACCUM_BLUE_SIZE ,
  SDL_GL_ACCUM_ALPHA_SIZE ,
  SDL_GL_STEREO ,
  SDL_GL_MULTISAMPLEBUFFERS ,
  SDL_GL_MULTISAMPLESAMPLES ,
  SDL_GL_ACCELERATED_VISUAL ,
  SDL_GL_RETAINED_BACKING ,
  SDL_GL_CONTEXT_MAJOR_VERSION ,
  SDL_GL_CONTEXT_MINOR_VERSION ,
  SDL_GL_CONTEXT_FLAGS ,
  SDL_GL_CONTEXT_PROFILE_MASK ,
  SDL_GL_SHARE_WITH_CURRENT_CONTEXT ,
  SDL_GL_FRAMEBUFFER_SRGB_CAPABLE ,
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR ,
  SDL_GL_CONTEXT_RESET_NOTIFICATION ,
  SDL_GL_CONTEXT_NO_ERROR ,
  SDL_GL_FLOATBUFFERS ,
  SDL_GL_EGL_PLATFORM
}
 
enum  SDL_GLprofile {
  SDL_GL_CONTEXT_PROFILE_CORE = 0x0001 ,
  SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002 ,
  SDL_GL_CONTEXT_PROFILE_ES = 0x0004
}
 
enum  SDL_GLcontextFlag {
  SDL_GL_CONTEXT_DEBUG_FLAG = 0x0001 ,
  SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002 ,
  SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG = 0x0004 ,
  SDL_GL_CONTEXT_RESET_ISOLATION_FLAG = 0x0008
}
 
enum  SDL_GLcontextReleaseFlag {
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE = 0x0000 ,
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH = 0x0001
}
 
enum  SDL_GLContextResetNotification {
  SDL_GL_CONTEXT_RESET_NO_NOTIFICATION = 0x0000 ,
  SDL_GL_CONTEXT_RESET_LOSE_CONTEXT = 0x0001
}
 
enum  SDL_HitTestResult {
  SDL_HITTEST_NORMAL ,
  SDL_HITTEST_DRAGGABLE ,
  SDL_HITTEST_RESIZE_TOPLEFT ,
  SDL_HITTEST_RESIZE_TOP ,
  SDL_HITTEST_RESIZE_TOPRIGHT ,
  SDL_HITTEST_RESIZE_RIGHT ,
  SDL_HITTEST_RESIZE_BOTTOMRIGHT ,
  SDL_HITTEST_RESIZE_BOTTOM ,
  SDL_HITTEST_RESIZE_BOTTOMLEFT ,
  SDL_HITTEST_RESIZE_LEFT
}
 

Functions

int SDL_GetNumVideoDrivers (void)
 
const char * SDL_GetVideoDriver (int index)
 
const char * SDL_GetCurrentVideoDriver (void)
 
SDL_SystemTheme SDL_GetSystemTheme (void)
 
SDL_DisplayIDSDL_GetDisplays (int *count)
 
SDL_DisplayID SDL_GetPrimaryDisplay (void)
 
SDL_PropertiesID SDL_GetDisplayProperties (SDL_DisplayID displayID)
 
const char * SDL_GetDisplayName (SDL_DisplayID displayID)
 
int SDL_GetDisplayBounds (SDL_DisplayID displayID, SDL_Rect *rect)
 
int SDL_GetDisplayUsableBounds (SDL_DisplayID displayID, SDL_Rect *rect)
 
SDL_DisplayOrientation SDL_GetNaturalDisplayOrientation (SDL_DisplayID displayID)
 
SDL_DisplayOrientation SDL_GetCurrentDisplayOrientation (SDL_DisplayID displayID)
 
float SDL_GetDisplayContentScale (SDL_DisplayID displayID)
 
const SDL_DisplayMode ** SDL_GetFullscreenDisplayModes (SDL_DisplayID displayID, int *count)
 
const SDL_DisplayModeSDL_GetClosestFullscreenDisplayMode (SDL_DisplayID displayID, int w, int h, float refresh_rate, SDL_bool include_high_density_modes)
 
const SDL_DisplayModeSDL_GetDesktopDisplayMode (SDL_DisplayID displayID)
 
const SDL_DisplayModeSDL_GetCurrentDisplayMode (SDL_DisplayID displayID)
 
SDL_DisplayID SDL_GetDisplayForPoint (const SDL_Point *point)
 
SDL_DisplayID SDL_GetDisplayForRect (const SDL_Rect *rect)
 
SDL_DisplayID SDL_GetDisplayForWindow (SDL_Window *window)
 
float SDL_GetWindowPixelDensity (SDL_Window *window)
 
float SDL_GetWindowDisplayScale (SDL_Window *window)
 
int SDL_SetWindowFullscreenMode (SDL_Window *window, const SDL_DisplayMode *mode)
 
const SDL_DisplayModeSDL_GetWindowFullscreenMode (SDL_Window *window)
 
void * SDL_GetWindowICCProfile (SDL_Window *window, size_t *size)
 
Uint32 SDL_GetWindowPixelFormat (SDL_Window *window)
 
SDL_WindowSDL_CreateWindow (const char *title, int w, int h, Uint32 flags)
 
SDL_WindowSDL_CreatePopupWindow (SDL_Window *parent, int offset_x, int offset_y, int w, int h, Uint32 flags)
 
SDL_WindowSDL_CreateWindowWithProperties (SDL_PropertiesID props)
 
SDL_WindowID SDL_GetWindowID (SDL_Window *window)
 
SDL_WindowSDL_GetWindowFromID (SDL_WindowID id)
 
SDL_WindowSDL_GetWindowParent (SDL_Window *window)
 
SDL_PropertiesID SDL_GetWindowProperties (SDL_Window *window)
 
Uint32 SDL_GetWindowFlags (SDL_Window *window)
 
int SDL_SetWindowTitle (SDL_Window *window, const char *title)
 
const char * SDL_GetWindowTitle (SDL_Window *window)
 
int SDL_SetWindowIcon (SDL_Window *window, SDL_Surface *icon)
 
int SDL_SetWindowPosition (SDL_Window *window, int x, int y)
 
int SDL_GetWindowPosition (SDL_Window *window, int *x, int *y)
 
int SDL_SetWindowSize (SDL_Window *window, int w, int h)
 
int SDL_GetWindowSize (SDL_Window *window, int *w, int *h)
 
int SDL_GetWindowBordersSize (SDL_Window *window, int *top, int *left, int *bottom, int *right)
 
int SDL_GetWindowSizeInPixels (SDL_Window *window, int *w, int *h)
 
int SDL_SetWindowMinimumSize (SDL_Window *window, int min_w, int min_h)
 
int SDL_GetWindowMinimumSize (SDL_Window *window, int *w, int *h)
 
int SDL_SetWindowMaximumSize (SDL_Window *window, int max_w, int max_h)
 
int SDL_GetWindowMaximumSize (SDL_Window *window, int *w, int *h)
 
int SDL_SetWindowBordered (SDL_Window *window, SDL_bool bordered)
 
int SDL_SetWindowResizable (SDL_Window *window, SDL_bool resizable)
 
int SDL_SetWindowAlwaysOnTop (SDL_Window *window, SDL_bool on_top)
 
int SDL_ShowWindow (SDL_Window *window)
 
int SDL_HideWindow (SDL_Window *window)
 
int SDL_RaiseWindow (SDL_Window *window)
 
int SDL_MaximizeWindow (SDL_Window *window)
 
int SDL_MinimizeWindow (SDL_Window *window)
 
int SDL_RestoreWindow (SDL_Window *window)
 
int SDL_SetWindowFullscreen (SDL_Window *window, SDL_bool fullscreen)
 
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 170 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

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

◆ SDL_WINDOWPOS_ISCENTERED

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

Definition at line 171 of file SDL_video.h.

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

◆ SDL_WINDOWPOS_ISUNDEFINED

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

Definition at line 162 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 161 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

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

Typedef Documentation

◆ SDL_DisplayID

Definition at line 44 of file SDL_video.h.

◆ SDL_EGLAttrib

typedef intptr_t SDL_EGLAttrib

Definition at line 195 of file SDL_video.h.

◆ SDL_EGLAttribArrayCallback

typedef SDL_EGLAttrib *(* SDL_EGLAttribArrayCallback) (void)

EGL attribute initialization callback types.

Definition at line 201 of file SDL_video.h.

◆ SDL_EGLConfig

typedef void* SDL_EGLConfig

Definition at line 193 of file SDL_video.h.

◆ SDL_EGLDisplay

typedef void* SDL_EGLDisplay

Opaque EGL types.

Definition at line 192 of file SDL_video.h.

◆ SDL_EGLint

typedef int SDL_EGLint

Definition at line 196 of file SDL_video.h.

◆ SDL_EGLIntArrayCallback

typedef SDL_EGLint *(* SDL_EGLIntArrayCallback) (void)

Definition at line 202 of file SDL_video.h.

◆ SDL_EGLSurface

typedef void* SDL_EGLSurface

Definition at line 194 of file SDL_video.h.

◆ SDL_GLContext

typedef void* SDL_GLContext

An opaque handle to an OpenGL context.

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

◆ SDL_Window

◆ SDL_WindowID

Definition at line 45 of file SDL_video.h.

Enumeration Type Documentation

◆ SDL_DisplayOrientation

Display orientation

Enumerator
SDL_ORIENTATION_UNKNOWN 

The display orientation can't be determined

SDL_ORIENTATION_LANDSCAPE 

The display is in landscape mode, with the right side up, relative to portrait mode

SDL_ORIENTATION_LANDSCAPE_FLIPPED 

The display is in landscape mode, with the left side up, relative to portrait mode

SDL_ORIENTATION_PORTRAIT 

The display is in portrait mode

SDL_ORIENTATION_PORTRAIT_FLIPPED 

The display is in portrait mode, upside down

Definition at line 80 of file SDL_video.h.

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

◆ SDL_FlashOperation

Window flash operation

Enumerator
SDL_FLASH_CANCEL 

Cancel any window flash state

SDL_FLASH_BRIEFLY 

Flash the window briefly to get attention

SDL_FLASH_UNTIL_FOCUSED 

Flash the window until it gets focus

Definition at line 177 of file SDL_video.h.

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

◆ SDL_GLcontextReleaseFlag

Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 

Definition at line 254 of file SDL_video.h.

◆ SDL_GLContextResetNotification

Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 

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

240{
243 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 1785 of file SDL_video.h.

◆ SDL_SystemTheme

System theme

Enumerator
SDL_SYSTEM_THEME_UNKNOWN 

Unknown system theme

SDL_SYSTEM_THEME_LIGHT 

Light colored system theme

SDL_SYSTEM_THEME_DARK 

Dark colored system theme

Definition at line 50 of file SDL_video.h.

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

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

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

SDL_WINDOW_POPUP_MENU 

window should be treated as a popup menu

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

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

Function Documentation

◆ SDL_CreatePopupWindow()

SDL_Window * SDL_CreatePopupWindow ( SDL_Window parent,
int  offset_x,
int  offset_y,
int  w,
int  h,
Uint32  flags 
)
extern

Create a child popup window of the specified parent window.

'flags' must contain exactly one of the following: - 'SDL_WINDOW_TOOLTIP': The popup window is a tooltip and will not pass any input events. - 'SDL_WINDOW_POPUP_MENU': The popup window is a popup menu. The topmost popup menu will implicitly gain the keyboard focus.

The following flags are not relevant to popup window creation and will be ignored:

  • 'SDL_WINDOW_MINIMIZED'
  • 'SDL_WINDOW_MAXIMIZED'
  • 'SDL_WINDOW_FULLSCREEN'
  • 'SDL_WINDOW_BORDERLESS'

The parent parameter must be non-null and a valid window. The parent of a popup window can be either a regular, toplevel window, or another popup window.

Popup windows cannot be minimized, maximized, made fullscreen, raised, flash, be made a modal window, be the parent of a modal window, or grab the mouse and/or keyboard. Attempts to do so will fail.

Popup windows implicitly do not have a border/decorations and do not appear on the taskbar/dock or in lists of windows such as alt-tab menus.

If a parent window is hidden, any child popup windows will be recursively hidden as well. Child popup windows not explicitly hidden will be restored when the parent is shown.

If the parent window is destroyed, any child popup windows will be recursively destroyed as well.

Parameters
parentthe parent of the window, must not be NULL
offset_xthe x position of the popup window relative to the origin of the parent
offset_ythe y position of the popup window relative to the origin of the parent window
wthe width of the window
hthe height of the window
flagsSDL_WINDOW_TOOLTIP or SDL_WINDOW_POPUP MENU, and zero or more additional SDL_WindowFlags OR'd together.
Returns
the window that was created or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_CreateWindow
SDL_CreateWindowWithProperties
SDL_DestroyWindow
SDL_GetWindowParent

◆ SDL_CreateWindow()

SDL_Window * SDL_CreateWindow ( const char *  title,
int  w,
int  h,
Uint32  flags 
)
extern

Create a window with the specified dimensions and flags.

flags may be any of the following OR'd together:

  • SDL_WINDOW_FULLSCREEN: fullscreen window at desktop resolution
  • SDL_WINDOW_OPENGL: window usable with an OpenGL context
  • SDL_WINDOW_VULKAN: window usable with a Vulkan instance
  • SDL_WINDOW_METAL: window usable with a Metal instance
  • SDL_WINDOW_HIDDEN: window is not visible
  • SDL_WINDOW_BORDERLESS: no window decoration
  • SDL_WINDOW_RESIZABLE: window can be resized
  • SDL_WINDOW_MINIMIZED: window is minimized
  • SDL_WINDOW_MAXIMIZED: window is maximized
  • SDL_WINDOW_MOUSE_GRABBED: window has grabbed mouse focus

The SDL_Window is implicitly shown if SDL_WINDOW_HIDDEN is not set.

On Apple's macOS, you must set the NSHighResolutionCapable Info.plist property to YES, otherwise you will not receive a High-DPI OpenGL canvas.

The window pixel size may differ from its window coordinate size if the window is on a high pixel density display. Use SDL_GetWindowSize() to query the client area's size in window coordinates, and SDL_GetWindowSizeInPixels() or SDL_GetRenderOutputSize() to query the drawable size in pixels. Note that the drawable size can vary after the window is created and should be queried again if you get an SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event.

If the window is created with any of the SDL_WINDOW_OPENGL or SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the corresponding UnloadLibrary function is called by SDL_DestroyWindow().

If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver, SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail.

If SDL_WINDOW_METAL is specified on an OS that does not support Metal, SDL_CreateWindow() will fail.

On non-Apple devices, SDL requires you to either not link to the Vulkan loader or link to a dynamic library version. This limitation may be removed in a future version of SDL.

Parameters
titlethe title of the window, in UTF-8 encoding
wthe width of the window
hthe height of the window
flags0, or one or more SDL_WindowFlags OR'd together
Returns
the window that was created or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_CreatePopupWindow
SDL_CreateWindowWithProperties
SDL_DestroyWindow

◆ SDL_CreateWindowWithProperties()

SDL_Window * SDL_CreateWindowWithProperties ( SDL_PropertiesID  props)
extern

Create a window with the specified properties.

These are the supported properties:

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

On macOS:

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

On Windows:

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

On X11:

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

The SDL_Window is implicitly shown if the "hidden" property is not set.

Windows with the "tooltip" and "menu" properties are popup windows and have the behaviors and guidelines outlined in SDL_CreatePopupWindow().

Parameters
propsthe properties to use
Returns
the window that was created or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_CreateWindow
SDL_DestroyWindow

◆ SDL_DestroyWindow()

void SDL_DestroyWindow ( SDL_Window window)
extern

Destroy a window.

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

Parameters
windowthe window to destroy
Since
This function is available since SDL 3.0.0.
See also
SDL_CreatePopupWindow
SDL_CreateWindow
SDL_CreateWindowWithProperties

◆ SDL_DestroyWindowSurface()

int SDL_DestroyWindowSurface ( SDL_Window window)
extern

Destroy the surface associated with the window.

Parameters
windowthe window to update
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowSurface
SDL_HasWindowSurface

◆ SDL_DisableScreenSaver()

int SDL_DisableScreenSaver ( void  )
extern

Prevent the screen from being blanked by a screen saver.

If you disable the screensaver, it is automatically re-enabled when SDL quits.

The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2 the screensaver was enabled by default.

Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_EnableScreenSaver
SDL_ScreenSaverEnabled

◆ SDL_EGL_GetCurrentEGLConfig()

SDL_EGLConfig SDL_EGL_GetCurrentEGLConfig ( void  )
extern

Get the currently active EGL config.

Returns
the currently active EGL config or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_EGL_GetCurrentEGLDisplay()

SDL_EGLDisplay SDL_EGL_GetCurrentEGLDisplay ( void  )
extern

Get the currently active EGL display.

Returns
the currently active EGL display or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_EGL_GetProcAddress()

SDL_FunctionPointer SDL_EGL_GetProcAddress ( const char *  proc)
extern

Get an EGL library function by name.

If an EGL library is loaded, this function allows applications to get entry points for EGL functions. This is useful to provide to an EGL API and extension loader.

Parameters
procthe name of an EGL function
Returns
a pointer to the named EGL function. The returned pointer should be cast to the appropriate function signature.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_GetCurrentEGLDisplay

◆ SDL_EGL_GetWindowEGLSurface()

SDL_EGLSurface SDL_EGL_GetWindowEGLSurface ( SDL_Window window)
extern

Get the EGL surface associated with the window.

Parameters
windowthe window to query
Returns
the EGLSurface pointer associated with the window, or NULL on failure.
Since
This function is available since SDL 3.0.0.

◆ SDL_EGL_SetEGLAttributeCallbacks()

void SDL_EGL_SetEGLAttributeCallbacks ( SDL_EGLAttribArrayCallback  platformAttribCallback,
SDL_EGLIntArrayCallback  surfaceAttribCallback,
SDL_EGLIntArrayCallback  contextAttribCallback 
)
extern

Sets the callbacks for defining custom EGLAttrib arrays for EGL initialization.

Each callback should return a pointer to an EGL attribute array terminated with EGL_NONE. Callbacks may return NULL pointers to signal an error, which will cause the SDL_CreateWindow process to fail gracefully.

The arrays returned by each callback will be appended to the existing attribute arrays defined by SDL.

NOTE: These callback pointers will be reset after SDL_GL_ResetAttributes.

Parameters
platformAttribCallbackCallback for attributes to pass to eglGetPlatformDisplay.
surfaceAttribCallbackCallback for attributes to pass to eglCreateSurface.
contextAttribCallbackCallback for attributes to pass to eglCreateContext.
Since
This function is available since SDL 3.0.0.

◆ SDL_EnableScreenSaver()

int SDL_EnableScreenSaver ( void  )
extern

Allow the screen to be blanked by a screen saver.

Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_DisableScreenSaver
SDL_ScreenSaverEnabled

◆ SDL_FlashWindow()

int SDL_FlashWindow ( SDL_Window window,
SDL_FlashOperation  operation 
)
extern

Request a window to demand attention from the user.

Parameters
windowthe window to be flashed
operationthe flash operation
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetClosestFullscreenDisplayMode()

const SDL_DisplayMode * SDL_GetClosestFullscreenDisplayMode ( SDL_DisplayID  displayID,
int  w,
int  h,
float  refresh_rate,
SDL_bool  include_high_density_modes 
)
extern

Get the closest match to the requested display mode.

The available display modes are scanned and closest is filled in with the closest mode matching the requested mode and returned. The mode format and refresh rate default to the desktop mode if they are set to 0. The modes are scanned with size being first priority, format being second priority, and finally checking the refresh rate. If all the available modes are too small, then NULL is returned.

Parameters
displayIDthe instance ID of the display to query
wthe width in pixels of the desired display mode
hthe height in pixels of the desired display mode
refresh_ratethe refresh rate of the desired display mode, or 0.0f for the desktop refresh rate
include_high_density_modesBoolean to include high density modes in the search
Returns
a pointer to the closest display mode equal to or larger than the desired mode, or NULL on error; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplays
SDL_GetFullscreenDisplayModes

◆ SDL_GetCurrentDisplayMode()

const SDL_DisplayMode * SDL_GetCurrentDisplayMode ( SDL_DisplayID  displayID)
extern

Get information about the current display mode.

There's a difference between this function and SDL_GetDesktopDisplayMode() when SDL runs fullscreen and has changed the resolution. In that case this function will return the current display mode, and not the previous native display mode.

Parameters
displayIDthe instance ID of the display to query
Returns
a pointer to the desktop display mode or NULL on error; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDesktopDisplayMode
SDL_GetDisplays

◆ SDL_GetCurrentDisplayOrientation()

SDL_DisplayOrientation SDL_GetCurrentDisplayOrientation ( SDL_DisplayID  displayID)
extern

Get the orientation of a display.

Parameters
displayIDthe instance ID of the display to query
Returns
The SDL_DisplayOrientation enum value of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplays

◆ SDL_GetCurrentVideoDriver()

const char * SDL_GetCurrentVideoDriver ( void  )
extern

Get the name of the currently initialized video driver.

Returns
the name of the current video driver or NULL if no driver has been initialized.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetNumVideoDrivers
SDL_GetVideoDriver

◆ SDL_GetDesktopDisplayMode()

const SDL_DisplayMode * SDL_GetDesktopDisplayMode ( SDL_DisplayID  displayID)
extern

Get information about the desktop's display mode.

There's a difference between this function and SDL_GetCurrentDisplayMode() when SDL runs fullscreen and has changed the resolution. In that case this function will return the previous native display mode, and not the current display mode.

Parameters
displayIDthe instance ID of the display to query
Returns
a pointer to the desktop display mode or NULL on error; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetCurrentDisplayMode
SDL_GetDisplays

◆ SDL_GetDisplayBounds()

int SDL_GetDisplayBounds ( SDL_DisplayID  displayID,
SDL_Rect rect 
)
extern

Get the desktop area represented by a display.

The primary display is always located at (0,0).

Parameters
displayIDthe instance ID of the display to query
rectthe SDL_Rect structure filled in with the display bounds
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplayUsableBounds
SDL_GetDisplays

◆ SDL_GetDisplayContentScale()

float SDL_GetDisplayContentScale ( SDL_DisplayID  displayID)
extern

Get the content scale of a display.

The content scale is the expected scale for content based on the DPI settings of the display. For example, a 4K display might have a 2.0 (200%) display scale, which means that the user expects UI elements to be twice as big on this display, to aid in readability.

Parameters
displayIDthe instance ID of the display to query
Returns
The content scale of the display, or 0.0f on error; call SDL_GetError() for more details.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplays

◆ SDL_GetDisplayForPoint()

SDL_DisplayID SDL_GetDisplayForPoint ( const SDL_Point point)
extern

Get the display containing a point.

Parameters
pointthe point to query
Returns
the instance ID of the display containing the point or 0 on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplayBounds
SDL_GetDisplays

◆ SDL_GetDisplayForRect()

SDL_DisplayID SDL_GetDisplayForRect ( const SDL_Rect rect)
extern

Get the display primarily containing a rect.

Parameters
rectthe rect to query
Returns
the instance ID of the display entirely containing the rect or closest to the center of the rect on success or 0 on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplayBounds
SDL_GetDisplays

◆ SDL_GetDisplayForWindow()

SDL_DisplayID SDL_GetDisplayForWindow ( SDL_Window window)
extern

Get the display associated with a window.

Parameters
windowthe window to query
Returns
the instance ID of the display containing the center of the window on success or 0 on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplayBounds
SDL_GetDisplays

◆ SDL_GetDisplayName()

const char * SDL_GetDisplayName ( SDL_DisplayID  displayID)
extern

Get the name of a display in UTF-8 encoding.

Parameters
displayIDthe instance ID of the display to query
Returns
the name of a display or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplays

◆ SDL_GetDisplayProperties()

SDL_PropertiesID SDL_GetDisplayProperties ( SDL_DisplayID  displayID)
extern

Get the properties associated with a display.

Parameters
displayIDthe instance ID of the display to query
Returns
a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetProperty
SDL_SetProperty

◆ SDL_GetDisplays()

SDL_DisplayID * SDL_GetDisplays ( int *  count)
extern

Get a list of currently connected displays.

Parameters
counta pointer filled in with the number of displays returned
Returns
a 0 terminated array of display instance IDs which should be freed with SDL_free(), or NULL on error; call SDL_GetError() for more details.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetDisplayUsableBounds()

int SDL_GetDisplayUsableBounds ( SDL_DisplayID  displayID,
SDL_Rect rect 
)
extern

Get the usable desktop area represented by a display, in screen coordinates.

This is the same area as SDL_GetDisplayBounds() reports, but with portions reserved by the system removed. For example, on Apple's macOS, this subtracts the area occupied by the menu bar and dock.

Setting a window to be fullscreen generally bypasses these unusable areas, so these are good guidelines for the maximum space available to a non-fullscreen window.

Parameters
displayIDthe instance ID of the display to query
rectthe SDL_Rect structure filled in with the display bounds
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplayBounds
SDL_GetDisplays

◆ SDL_GetFullscreenDisplayModes()

const SDL_DisplayMode ** SDL_GetFullscreenDisplayModes ( SDL_DisplayID  displayID,
int *  count 
)
extern

Get a list of fullscreen display modes available on a display.

The display modes are sorted in this priority:

  • w -> largest to smallest
  • h -> largest to smallest
  • bits per pixel -> more colors to fewer colors
  • packed pixel layout -> largest to smallest
  • refresh rate -> highest to lowest
  • pixel density -> lowest to highest
Parameters
displayIDthe instance ID of the display to query
counta pointer filled in with the number of displays returned
Returns
a NULL terminated array of display mode pointers which should be freed with SDL_free(), or NULL on error; call SDL_GetError() for more details.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplays

◆ SDL_GetGrabbedWindow()

SDL_Window * SDL_GetGrabbedWindow ( void  )
extern

Get the window that currently has an input grab enabled.

Returns
the window if input is grabbed or NULL otherwise.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowGrab
SDL_SetWindowGrab

◆ SDL_GetNaturalDisplayOrientation()

SDL_DisplayOrientation SDL_GetNaturalDisplayOrientation ( SDL_DisplayID  displayID)
extern

Get the orientation of a display when it is unrotated.

Parameters
displayIDthe instance ID of the display to query
Returns
The SDL_DisplayOrientation enum value of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplays

◆ SDL_GetNumVideoDrivers()

int SDL_GetNumVideoDrivers ( void  )
extern

Get the number of video drivers compiled into SDL.

Returns
a number >= 1 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetVideoDriver

◆ SDL_GetPrimaryDisplay()

SDL_DisplayID SDL_GetPrimaryDisplay ( void  )
extern

Return the primary display.

Returns
the instance ID of the primary display on success or 0 on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetDisplays

◆ SDL_GetSystemTheme()

SDL_SystemTheme SDL_GetSystemTheme ( void  )
extern

Get the current system theme

Returns
the current system theme, light, dark, or unknown
Since
This function is available since SDL 3.0.0.

◆ SDL_GetVideoDriver()

const char * SDL_GetVideoDriver ( int  index)
extern

Get the name of a built in video driver.

The video drivers are presented in the order in which they are normally checked during initialization.

Parameters
indexthe index of a video driver
Returns
the name of the video driver with the given index.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetNumVideoDrivers

◆ SDL_GetWindowBordersSize()

int SDL_GetWindowBordersSize ( SDL_Window window,
int *  top,
int *  left,
int *  bottom,
int *  right 
)
extern

Get the size of a window's borders (decorations) around the client area.

Note: If this function fails (returns -1), the size values will be initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the window in question was borderless.

Note: This function may fail on systems where the window has not yet been decorated by the display server (for example, immediately after calling SDL_CreateWindow). It is recommended that you wait at least until the window has been presented and composited, so that the window system has a chance to decorate the window and provide the border dimensions to SDL.

This function also returns -1 if getting the information is not supported.

Parameters
windowthe window to query the size values of the border (decorations) from
toppointer to variable for storing the size of the top border; NULL is permitted
leftpointer to variable for storing the size of the left border; NULL is permitted
bottompointer to variable for storing the size of the bottom border; NULL is permitted
rightpointer to variable for storing the size of the right border; NULL is permitted
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowSize

◆ SDL_GetWindowDisplayScale()

float SDL_GetWindowDisplayScale ( SDL_Window window)
extern

Get the content display scale relative to a window's pixel size.

This is a combination of the window pixel density and the display content scale, and is the expected scale for displaying content in this window. For example, if a 3840x2160 window had a display scale of 2.0, the user expects the content to take twice as many pixels and be the same physical size as if it were being displayed in a 1920x1080 window with a display scale of 1.0.

Conceptually this value corresponds to the scale display setting, and is updated when that setting is changed, or the window moves to a display with a different scale setting.

Parameters
windowthe window to query
Returns
the display scale, or 0.0f on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetWindowFlags()

Uint32 SDL_GetWindowFlags ( SDL_Window window)
extern

Get the window flags.

Parameters
windowthe window to query
Returns
a mask of the SDL_WindowFlags associated with window
Since
This function is available since SDL 3.0.0.
See also
SDL_CreateWindow
SDL_HideWindow
SDL_MaximizeWindow
SDL_MinimizeWindow
SDL_SetWindowFullscreen
SDL_SetWindowGrab
SDL_ShowWindow

◆ SDL_GetWindowFromID()

SDL_Window * SDL_GetWindowFromID ( SDL_WindowID  id)
extern

Get a window from a stored ID.

The numeric ID is what SDL_WindowEvent references, and is necessary to map these events to specific SDL_Window objects.

Parameters
idthe ID of the window
Returns
the window associated with id or NULL if it doesn't exist; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowID

◆ SDL_GetWindowFullscreenMode()

const SDL_DisplayMode * SDL_GetWindowFullscreenMode ( SDL_Window window)
extern

Query the display mode to use when a window is visible at fullscreen.

Parameters
windowthe window to query
Returns
a pointer to the fullscreen mode to use or NULL for desktop mode
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowFullscreenMode
SDL_SetWindowFullscreen

◆ SDL_GetWindowGrab()

SDL_bool SDL_GetWindowGrab ( SDL_Window window)
extern

Get a window's input grab mode.

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

◆ SDL_GetWindowICCProfile()

void * SDL_GetWindowICCProfile ( SDL_Window window,
size_t *  size 
)
extern

Get the raw ICC profile data for the screen the window is currently on.

Data returned should be freed with SDL_free.

Parameters
windowthe window to query
sizethe size of the ICC profile
Returns
the raw ICC profile data on success or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetWindowID()

SDL_WindowID SDL_GetWindowID ( SDL_Window window)
extern

Get the numeric ID of a window.

The numeric ID is what SDL_WindowEvent references, and is necessary to map these events to specific SDL_Window objects.

Parameters
windowthe window to query
Returns
the ID of the window on success or 0 on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowFromID

◆ SDL_GetWindowKeyboardGrab()

SDL_bool SDL_GetWindowKeyboardGrab ( SDL_Window window)
extern

Get a window's keyboard grab mode.

Parameters
windowthe window to query
Returns
SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowKeyboardGrab
SDL_GetWindowGrab

◆ SDL_GetWindowMaximumSize()

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

Get the maximum size of a window's client area.

Parameters
windowthe window to query
wa pointer filled in with the maximum width of the window, may be NULL
ha pointer filled in with the maximum height of the window, may be NULL
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowMinimumSize
SDL_SetWindowMaximumSize

◆ SDL_GetWindowMinimumSize()

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

Get the minimum size of a window's client area.

Parameters
windowthe window to query
wa pointer filled in with the minimum width of the window, may be NULL
ha pointer filled in with the minimum height of the window, may be NULL
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowMaximumSize
SDL_SetWindowMinimumSize

◆ SDL_GetWindowMouseGrab()

SDL_bool SDL_GetWindowMouseGrab ( SDL_Window window)
extern

Get a window's mouse grab mode.

Parameters
windowthe window to query
Returns
SDL_TRUE if mouse is grabbed, and SDL_FALSE otherwise.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowKeyboardGrab
SDL_GetWindowGrab

◆ SDL_GetWindowMouseRect()

const SDL_Rect * SDL_GetWindowMouseRect ( SDL_Window window)
extern

Get the mouse confinement rectangle of a window.

Parameters
windowThe window to query
Returns
A pointer to the mouse confinement rectangle of a window, or NULL if there isn't one.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowMouseRect

◆ SDL_GetWindowOpacity()

int SDL_GetWindowOpacity ( SDL_Window window,
float *  out_opacity 
)
extern

Get the opacity of a window.

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

The parameter opacity is ignored if it is NULL.

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

Parameters
windowthe window to get the current opacity value from
out_opacitythe float filled in (0.0f - transparent, 1.0f - opaque)
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowOpacity

◆ SDL_GetWindowParent()

SDL_Window * SDL_GetWindowParent ( SDL_Window window)
extern

Get parent of a window.

Parameters
windowthe window to query
Returns
the parent of the window on success or NULL if the window has no parent.
Since
This function is available since SDL 3.0.0.
See also
SDL_CreatePopupWindow

◆ SDL_GetWindowPixelDensity()

float SDL_GetWindowPixelDensity ( SDL_Window window)
extern

Get the pixel density of a window.

This is a ratio of pixel size to window size. For example, if the window is 1920x1080 and it has a high density back buffer of 3840x2160 pixels, it would have a pixel density of 2.0.

Parameters
windowthe window to query
Returns
the pixel density or 0.0f on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowDisplayScale

◆ SDL_GetWindowPixelFormat()

Uint32 SDL_GetWindowPixelFormat ( SDL_Window window)
extern

Get the pixel format associated with the window.

Parameters
windowthe window to query
Returns
the pixel format of the window on success or SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetWindowPosition()

int SDL_GetWindowPosition ( SDL_Window window,
int *  x,
int *  y 
)
extern

Get the position of a window.

If you do not need the value for one of the positions a NULL may be passed in the x or y parameter.

Parameters
windowthe window to query
xa pointer filled in with the x position of the window, may be NULL
ya pointer filled in with the y position of the window, may be NULL
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowPosition

◆ SDL_GetWindowProperties()

SDL_PropertiesID SDL_GetWindowProperties ( SDL_Window window)
extern

Get the properties associated with a window.

The following read-only properties are provided by SDL:

On Android:

"SDL.window.android.window" (pointer) - the ANativeWindow associated with the window
"SDL.window.android.surface" (pointer) - the EGLSurface associated with the window

On iOS:

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

On KMS/DRM:

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

On macOS:

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

On Vivante:

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

On UWP:

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

On Windows:

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

On Wayland:

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

Note: The xdg_* window objects do not internally persist across window show/hide calls. They will be null if the window is hidden and must be queried each time it is shown.

On X11:

"SDL.window.x11.display" (pointer) - the X11 Display associated with the window
"SDL.window.x11.screen" (number) - the screen number associated with the window
"SDL.window.x11.window" (number) - the X11 Window associated with the window
Parameters
windowthe window to query
Returns
a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetProperty
SDL_SetProperty

◆ SDL_GetWindowSize()

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

Get the size of a window's client area.

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

The window pixel size may differ from its window coordinate size if the window is on a high pixel density display. Use SDL_GetWindowSizeInPixels() or SDL_GetRenderOutputSize() to get the real client area size in pixels.

Parameters
windowthe window to query the width and height from
wa pointer filled in with the width of the window, may be NULL
ha pointer filled in with the height of the window, may be NULL
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetRenderOutputSize
SDL_GetWindowSizeInPixels
SDL_SetWindowSize

◆ SDL_GetWindowSizeInPixels()

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

Get the size of a window's client area, in pixels.

Parameters
windowthe window from which the drawable size should be queried
wa pointer to variable for storing the width in pixels, may be NULL
ha pointer to variable for storing the height in pixels, may be NULL
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_CreateWindow
SDL_GetWindowSize

◆ SDL_GetWindowSurface()

SDL_Surface * SDL_GetWindowSurface ( SDL_Window window)
extern

Get the SDL surface associated with the window.

A new surface will be created with the optimal format for the window, if necessary. This surface will be freed when the window is destroyed. Do not free this surface.

This surface will be invalidated if the window is resized. After resizing a window this function must be called again to return a valid surface.

You may not combine this with 3D or the rendering API on this window.

This function is affected by SDL_HINT_FRAMEBUFFER_ACCELERATION.

Parameters
windowthe window to query
Returns
the surface associated with the window, or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_DestroyWindowSurface
SDL_HasWindowSurface
SDL_UpdateWindowSurface
SDL_UpdateWindowSurfaceRects

◆ SDL_GetWindowTitle()

const char * SDL_GetWindowTitle ( SDL_Window window)
extern

Get the title of a window.

Parameters
windowthe window to query
Returns
the title of the window in UTF-8 format or "" if there is no title.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetWindowTitle

◆ SDL_GL_CreateContext()

SDL_GLContext SDL_GL_CreateContext ( SDL_Window window)
extern

Create an OpenGL context for an OpenGL window, and make it current.

Windows users new to OpenGL should note that, for historical reasons, GL functions added after OpenGL version 1.1 are not available by default. Those functions must be loaded at run-time, either with an OpenGL extension-handling library or with SDL_GL_GetProcAddress() and its related functions.

SDL_GLContext is an alias for void *. It's opaque to the application.

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

◆ SDL_GL_DeleteContext()

int SDL_GL_DeleteContext ( SDL_GLContext  context)
extern

Delete an OpenGL context.

Parameters
contextthe OpenGL context to be deleted
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_CreateContext

◆ SDL_GL_ExtensionSupported()

SDL_bool SDL_GL_ExtensionSupported ( const char *  extension)
extern

Check if an OpenGL extension is supported for the current context.

This function operates on the current GL context; you must have created a context and it must be current before calling this function. Do not assume that all contexts you create will have the same set of extensions available, or that recreating an existing context will offer the same extensions again.

While it's probably not a massive overhead, this function is not an O(1) operation. Check the extensions you care about after creating the GL context and save that information somewhere instead of calling the function every time you need to know.

Parameters
extensionthe name of the extension to check
Returns
SDL_TRUE if the extension is supported, SDL_FALSE otherwise.
Since
This function is available since SDL 3.0.0.

◆ SDL_GL_GetAttribute()

int SDL_GL_GetAttribute ( SDL_GLattr  attr,
int *  value 
)
extern

Get the actual value for an attribute from the current context.

Parameters
attran SDL_GLattr enum value specifying the OpenGL attribute to get
valuea pointer filled in with the current value of attr
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_ResetAttributes
SDL_GL_SetAttribute

◆ SDL_GL_GetCurrentContext()

SDL_GLContext SDL_GL_GetCurrentContext ( void  )
extern

Get the currently active OpenGL context.

Returns
the currently active OpenGL context or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_MakeCurrent

◆ SDL_GL_GetCurrentWindow()

SDL_Window * SDL_GL_GetCurrentWindow ( void  )
extern

Get the currently active OpenGL window.

Returns
the currently active OpenGL window on success or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GL_GetProcAddress()

SDL_FunctionPointer SDL_GL_GetProcAddress ( const char *  proc)
extern

Get an OpenGL function by name.

If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all GL functions must be retrieved this way. Usually this is used to retrieve function pointers to OpenGL extensions.

There are some quirks to looking up OpenGL functions that require some extra care from the application. If you code carefully, you can handle these quirks without any platform-specific code, though:

  • On Windows, function pointers are specific to the current GL context; this means you need to have created a GL context and made it current before calling SDL_GL_GetProcAddress(). If you recreate your context or create a second context, you should assume that any existing function pointers aren't valid to use with it. This is (currently) a Windows-specific limitation, and in practice lots of drivers don't suffer this limitation, but it is still the way the wgl API is documented to work and you should expect crashes if you don't respect it. Store a copy of the function pointers that comes and goes with context lifespan.
  • On X11, function pointers returned by this function are valid for any context, and can even be looked up before a context is created at all. This means that, for at least some common OpenGL implementations, if you look up a function that doesn't exist, you'll get a non-NULL result that is NOT safe to call. You must always make sure the function is actually available for a given GL context before calling it, by checking for the existence of the appropriate extension with SDL_GL_ExtensionSupported(), or verifying that the version of OpenGL you're using offers the function as core functionality.
  • Some OpenGL drivers, on all platforms, will return NULL if a function isn't supported, but you can't count on this behavior. Check for extensions you use, and if you get a NULL anyway, act as if that extension wasn't available. This is probably a bug in the driver, but you can code defensively for this scenario anyhow.
  • Just because you're on Linux/Unix, don't assume you'll be using X11. Next-gen display servers are waiting to replace it, and may or may not make the same promises about function pointers.
  • OpenGL function pointers must be declared APIENTRY as in the example code. This will ensure the proper calling convention is followed on platforms where this matters (Win32) thereby avoiding stack corruption.
Parameters
procthe name of an OpenGL function
Returns
a pointer to the named OpenGL function. The returned pointer should be cast to the appropriate function signature.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_ExtensionSupported
SDL_GL_LoadLibrary
SDL_GL_UnloadLibrary

◆ SDL_GL_GetSwapInterval()

int SDL_GL_GetSwapInterval ( int *  interval)
extern

Get the swap interval for the current OpenGL context.

If the system can't determine the swap interval, or there isn't a valid current context, this function will set *interval to 0 as a safe default.

Parameters
intervalOutput interval value. 0 if there is no vertical retrace synchronization, 1 if the buffer swap is synchronized with the vertical retrace, and -1 if late swaps happen immediately instead of waiting for the next retrace
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_SetSwapInterval

◆ SDL_GL_LoadLibrary()

int SDL_GL_LoadLibrary ( const char *  path)
extern

Dynamically load an OpenGL library.

This should be done after initializing the video driver, but before creating any OpenGL windows. If no OpenGL library is loaded, the default library will be loaded upon creation of the first OpenGL window.

If you do this, you need to retrieve all of the GL functions used in your program from the dynamic library using SDL_GL_GetProcAddress().

Parameters
paththe platform dependent OpenGL library name, or NULL to open the default OpenGL library
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_GetProcAddress
SDL_GL_UnloadLibrary

◆ SDL_GL_MakeCurrent()

int SDL_GL_MakeCurrent ( SDL_Window window,
SDL_GLContext  context 
)
extern

Set up an OpenGL context for rendering into an OpenGL window.

The context must have been created with a compatible window.

Parameters
windowthe window to associate with the context
contextthe OpenGL context to associate with the window
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_CreateContext

◆ SDL_GL_ResetAttributes()

void SDL_GL_ResetAttributes ( void  )
extern

Reset all previously set OpenGL context attributes to their default values.

Since
This function is available since SDL 3.0.0.
See also
SDL_GL_GetAttribute
SDL_GL_SetAttribute

◆ SDL_GL_SetAttribute()

int SDL_GL_SetAttribute ( SDL_GLattr  attr,
int  value 
)
extern

Set an OpenGL window attribute before window creation.

This function sets the OpenGL attribute attr to value. The requested attributes should be set before creating an OpenGL window. You should use SDL_GL_GetAttribute() to check the values after creating the OpenGL context, since the values obtained can differ from the requested ones.

Parameters
attran SDL_GLattr enum value specifying the OpenGL attribute to set
valuethe desired value for the attribute
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_GetAttribute
SDL_GL_ResetAttributes

◆ SDL_GL_SetSwapInterval()

int SDL_GL_SetSwapInterval ( int  interval)
extern

Set the swap interval for the current OpenGL context.

Some systems allow specifying -1 for the interval, to enable adaptive vsync. Adaptive vsync works the same as vsync, but if you've already missed the vertical retrace for a given frame, it swaps buffers immediately, which might be less jarring for the user during occasional framerate drops. If an application requests adaptive vsync and the system does not support it, this function will fail and return -1. In such a case, you should probably retry the call with 1 for the interval.

Adaptive vsync is implemented for some glX drivers with GLX_EXT_swap_control_tear, and for some Windows drivers with WGL_EXT_swap_control_tear.

Read more on the Khronos wiki: https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync

Parameters
interval0 for immediate updates, 1 for updates synchronized with the vertical retrace, -1 for adaptive vsync
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GL_GetSwapInterval

◆ SDL_GL_SwapWindow()

int SDL_GL_SwapWindow ( SDL_Window window)
extern

Update a window with OpenGL rendering.

This is used with double-buffered OpenGL contexts, which are the default.

On macOS, make sure you bind 0 to the draw framebuffer before swapping the window, otherwise nothing will happen. If you aren't using glBindFramebuffer(), this is the default and you won't have to do anything extra.

Parameters
windowthe window to change
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.

◆ SDL_GL_UnloadLibrary()

void SDL_GL_UnloadLibrary ( void  )
extern

Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().

Since
This function is available since SDL 3.0.0.
See also
SDL_GL_LoadLibrary

◆ SDL_HasWindowSurface()

SDL_bool SDL_HasWindowSurface ( SDL_Window window)
extern

Return whether the window has a surface associated with it.

Parameters
windowthe window to query
Returns
SDL_TRUE if there is a surface associated with the window, or SDL_FALSE otherwise.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetWindowSurface

◆ SDL_HideWindow()

int SDL_HideWindow ( SDL_Window window)
extern

Hide a window.

Parameters
windowthe window to hide
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_ShowWindow

◆ SDL_MaximizeWindow()

int SDL_MaximizeWindow ( SDL_Window window)
extern

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