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