1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2025 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 * # CategoryVideo
24 *
25 * SDL's video subsystem is largely interested in abstracting window
26 * management from the underlying operating system. You can create windows,
27 * manage them in various ways, set them fullscreen, and get events when
28 * interesting things happen with them, such as the mouse or keyboard
29 * interacting with a window.
30 *
31 * The video subsystem is also interested in abstracting away some
32 * platform-specific differences in OpenGL: context creation, swapping
33 * buffers, etc. This may be crucial to your app, but also you are not
34 * required to use OpenGL at all. In fact, SDL can provide rendering to those
35 * windows as well, either with an easy-to-use
36 * [2D API](https://wiki.libsdl.org/SDL3/CategoryRender)
37 * or with a more-powerful
38 * [GPU API](https://wiki.libsdl.org/SDL3/CategoryGPU)
39 * . Of course, it can simply get out of your way and give you the window
40 * handles you need to use Vulkan, Direct3D, Metal, or whatever else you like
41 * directly, too.
42 *
43 * The video subsystem covers a lot of functionality, out of necessity, so it
44 * is worth perusing the list of functions just to see what's available, but
45 * most apps can get by with simply creating a window and listening for
46 * events, so start with SDL_CreateWindow() and SDL_PollEvent().
47 */
48
49#ifndef SDL_video_h_
50#define SDL_video_h_
51
52#include <SDL3/SDL_stdinc.h>
53#include <SDL3/SDL_error.h>
54#include <SDL3/SDL_pixels.h>
55#include <SDL3/SDL_properties.h>
56#include <SDL3/SDL_rect.h>
57#include <SDL3/SDL_surface.h>
58
59#include <SDL3/SDL_begin_code.h>
60/* Set up for C function definitions, even when using C++ */
61#ifdef __cplusplus
62extern "C" {
63#endif
64
65/**
66 * This is a unique ID for a display for the time it is connected to the
67 * system, and is never reused for the lifetime of the application.
68 *
69 * If the display is disconnected and reconnected, it will get a new ID.
70 *
71 * The value 0 is an invalid ID.
72 *
73 * \since This datatype is available since SDL 3.2.0.
74 */
75typedef Uint32 SDL_DisplayID;
76
77/**
78 * This is a unique ID for a window.
79 *
80 * The value 0 is an invalid ID.
81 *
82 * \since This datatype is available since SDL 3.2.0.
83 */
84typedef Uint32 SDL_WindowID;
85
86/* Global video properties... */
87
88/**
89 * The pointer to the global `wl_display` object used by the Wayland video
90 * backend.
91 *
92 * Can be set before the video subsystem is initialized to import an external
93 * `wl_display` object from an application or toolkit for use in SDL, or read
94 * after initialization to export the `wl_display` used by the Wayland video
95 * backend. Setting this property after the video subsystem has been
96 * initialized has no effect, and reading it when the video subsystem is
97 * uninitialized will either return the user provided value, if one was set
98 * prior to initialization, or NULL. See docs/README-wayland.md for more
99 * information.
100 */
101#define SDL_PROP_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER "SDL.video.wayland.wl_display"
102
103/**
104 * System theme.
105 *
106 * \since This enum is available since SDL 3.2.0.
107 */
108typedef enum SDL_SystemTheme
109{
110 SDL_SYSTEM_THEME_UNKNOWN, /**< Unknown system theme */
111 SDL_SYSTEM_THEME_LIGHT, /**< Light colored system theme */
112 SDL_SYSTEM_THEME_DARK /**< Dark colored system theme */
113} SDL_SystemTheme;
114
115/**
116 * Internal display mode data.
117 *
118 * This lives as a field in SDL_DisplayMode, as opaque data.
119 *
120 * \since This struct is available since SDL 3.2.0.
121 *
122 * \sa SDL_DisplayMode
123 */
124typedef struct SDL_DisplayModeData SDL_DisplayModeData;
125
126/**
127 * The structure that defines a display mode.
128 *
129 * \since This struct is available since SDL 3.2.0.
130 *
131 * \sa SDL_GetFullscreenDisplayModes
132 * \sa SDL_GetDesktopDisplayMode
133 * \sa SDL_GetCurrentDisplayMode
134 * \sa SDL_SetWindowFullscreenMode
135 * \sa SDL_GetWindowFullscreenMode
136 */
137typedef struct SDL_DisplayMode
138{
139 SDL_DisplayID displayID; /**< the display this mode is associated with */
140 SDL_PixelFormat format; /**< pixel format */
141 int w; /**< width */
142 int h; /**< height */
143 float pixel_density; /**< scale converting size to pixels (e.g. a 1920x1080 mode with 2.0 scale would have 3840x2160 pixels) */
144 float refresh_rate; /**< refresh rate (or 0.0f for unspecified) */
145 int refresh_rate_numerator; /**< precise refresh rate numerator (or 0 for unspecified) */
146 int refresh_rate_denominator; /**< precise refresh rate denominator */
147
148 SDL_DisplayModeData *internal; /**< Private */
149
150} SDL_DisplayMode;
151
152/**
153 * Display orientation values; the way a display is rotated.
154 *
155 * \since This enum is available since SDL 3.2.0.
156 */
157typedef enum SDL_DisplayOrientation
158{
159 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
160 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
161 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
162 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
163 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
164} SDL_DisplayOrientation;
165
166/**
167 * The struct used as an opaque handle to a window.
168 *
169 * \since This struct is available since SDL 3.2.0.
170 *
171 * \sa SDL_CreateWindow
172 */
173typedef struct SDL_Window SDL_Window;
174
175/**
176 * The flags on a window.
177 *
178 * These cover a lot of true/false, or on/off, window state. Some of it is
179 * immutable after being set through SDL_CreateWindow(), some of it can be
180 * changed on existing windows by the app, and some of it might be altered by
181 * the user or system outside of the app's control.
182 *
183 * \since This datatype is available since SDL 3.2.0.
184 *
185 * \sa SDL_GetWindowFlags
186 */
187typedef Uint64 SDL_WindowFlags;
188
189#define SDL_WINDOW_FULLSCREEN SDL_UINT64_C(0x0000000000000001) /**< window is in fullscreen mode */
190#define SDL_WINDOW_OPENGL SDL_UINT64_C(0x0000000000000002) /**< window usable with OpenGL context */
191#define SDL_WINDOW_OCCLUDED SDL_UINT64_C(0x0000000000000004) /**< window is occluded */
192#define SDL_WINDOW_HIDDEN SDL_UINT64_C(0x0000000000000008) /**< window is neither mapped onto the desktop nor shown in the taskbar/dock/window list; SDL_ShowWindow() is required for it to become visible */
193#define SDL_WINDOW_BORDERLESS SDL_UINT64_C(0x0000000000000010) /**< no window decoration */
194#define SDL_WINDOW_RESIZABLE SDL_UINT64_C(0x0000000000000020) /**< window can be resized */
195#define SDL_WINDOW_MINIMIZED SDL_UINT64_C(0x0000000000000040) /**< window is minimized */
196#define SDL_WINDOW_MAXIMIZED SDL_UINT64_C(0x0000000000000080) /**< window is maximized */
197#define SDL_WINDOW_MOUSE_GRABBED SDL_UINT64_C(0x0000000000000100) /**< window has grabbed mouse input */
198#define SDL_WINDOW_INPUT_FOCUS SDL_UINT64_C(0x0000000000000200) /**< window has input focus */
199#define SDL_WINDOW_MOUSE_FOCUS SDL_UINT64_C(0x0000000000000400) /**< window has mouse focus */
200#define SDL_WINDOW_EXTERNAL SDL_UINT64_C(0x0000000000000800) /**< window not created by SDL */
201#define SDL_WINDOW_MODAL SDL_UINT64_C(0x0000000000001000) /**< window is modal */
202#define SDL_WINDOW_HIGH_PIXEL_DENSITY SDL_UINT64_C(0x0000000000002000) /**< window uses high pixel density back buffer if possible */
203#define SDL_WINDOW_MOUSE_CAPTURE SDL_UINT64_C(0x0000000000004000) /**< window has mouse captured (unrelated to MOUSE_GRABBED) */
204#define SDL_WINDOW_MOUSE_RELATIVE_MODE SDL_UINT64_C(0x0000000000008000) /**< window has relative mode enabled */
205#define SDL_WINDOW_ALWAYS_ON_TOP SDL_UINT64_C(0x0000000000010000) /**< window should always be above others */
206#define SDL_WINDOW_UTILITY SDL_UINT64_C(0x0000000000020000) /**< window should be treated as a utility window, not showing in the task bar and window list */
207#define SDL_WINDOW_TOOLTIP SDL_UINT64_C(0x0000000000040000) /**< window should be treated as a tooltip and does not get mouse or keyboard focus, requires a parent window */
208#define SDL_WINDOW_POPUP_MENU SDL_UINT64_C(0x0000000000080000) /**< window should be treated as a popup menu, requires a parent window */
209#define SDL_WINDOW_KEYBOARD_GRABBED SDL_UINT64_C(0x0000000000100000) /**< window has grabbed keyboard input */
210#define SDL_WINDOW_VULKAN SDL_UINT64_C(0x0000000010000000) /**< window usable for Vulkan surface */
211#define SDL_WINDOW_METAL SDL_UINT64_C(0x0000000020000000) /**< window usable for Metal view */
212#define SDL_WINDOW_TRANSPARENT SDL_UINT64_C(0x0000000040000000) /**< window with transparent buffer */
213#define SDL_WINDOW_NOT_FOCUSABLE SDL_UINT64_C(0x0000000080000000) /**< window should not be focusable */
214
215
216/**
217 * A magic value used with SDL_WINDOWPOS_UNDEFINED.
218 *
219 * Generally this macro isn't used directly, but rather through
220 * SDL_WINDOWPOS_UNDEFINED or SDL_WINDOWPOS_UNDEFINED_DISPLAY.
221 *
222 * \since This macro is available since SDL 3.2.0.
223 */
224#define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000u
225
226/**
227 * Used to indicate that you don't care what the window position is.
228 *
229 * If you _really_ don't care, SDL_WINDOWPOS_UNDEFINED is the same, but always
230 * uses the primary display instead of specifying one.
231 *
232 * \param X the SDL_DisplayID of the display to use.
233 *
234 * \since This macro is available since SDL 3.2.0.
235 */
236#define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
237
238/**
239 * Used to indicate that you don't care what the window position/display is.
240 *
241 * This always uses the primary display.
242 *
243 * \since This macro is available since SDL 3.2.0.
244 */
245#define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
246
247/**
248 * A macro to test if the window position is marked as "undefined."
249 *
250 * \param X the window position value.
251 *
252 * \since This macro is available since SDL 3.2.0.
253 */
254#define SDL_WINDOWPOS_ISUNDEFINED(X) (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
255
256/**
257 * A magic value used with SDL_WINDOWPOS_CENTERED.
258 *
259 * Generally this macro isn't used directly, but rather through
260 * SDL_WINDOWPOS_CENTERED or SDL_WINDOWPOS_CENTERED_DISPLAY.
261 *
262 * \since This macro is available since SDL 3.2.0.
263 */
264#define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000u
265
266/**
267 * Used to indicate that the window position should be centered.
268 *
269 * SDL_WINDOWPOS_CENTERED is the same, but always uses the primary display
270 * instead of specifying one.
271 *
272 * \param X the SDL_DisplayID of the display to use.
273 *
274 * \since This macro is available since SDL 3.2.0.
275 */
276#define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK|(X))
277
278/**
279 * Used to indicate that the window position should be centered.
280 *
281 * This always uses the primary display.
282 *
283 * \since This macro is available since SDL 3.2.0.
284 */
285#define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0)
286
287/**
288 * A macro to test if the window position is marked as "centered."
289 *
290 * \param X the window position value.
291 *
292 * \since This macro is available since SDL 3.2.0.
293 */
294#define SDL_WINDOWPOS_ISCENTERED(X) \
295 (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
296
297
298/**
299 * Window flash operation.
300 *
301 * \since This enum is available since SDL 3.2.0.
302 */
303typedef enum SDL_FlashOperation
304{
305 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
306 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
307 SDL_FLASH_UNTIL_FOCUSED /**< Flash the window until it gets focus */
308} SDL_FlashOperation;
309
310/**
311 * An opaque handle to an OpenGL context.
312 *
313 * \since This datatype is available since SDL 3.2.0.
314 *
315 * \sa SDL_GL_CreateContext
316 */
317typedef struct SDL_GLContextState *SDL_GLContext;
318
319/**
320 * Opaque type for an EGL display.
321 *
322 * \since This datatype is available since SDL 3.2.0.
323 */
324typedef void *SDL_EGLDisplay;
325
326/**
327 * Opaque type for an EGL config.
328 *
329 * \since This datatype is available since SDL 3.2.0.
330 */
331typedef void *SDL_EGLConfig;
332
333/**
334 * Opaque type for an EGL surface.
335 *
336 * \since This datatype is available since SDL 3.2.0.
337 */
338typedef void *SDL_EGLSurface;
339
340/**
341 * An EGL attribute, used when creating an EGL context.
342 *
343 * \since This datatype is available since SDL 3.2.0.
344 */
345typedef intptr_t SDL_EGLAttrib;
346
347/**
348 * An EGL integer attribute, used when creating an EGL surface.
349 *
350 * \since This datatype is available since SDL 3.2.0.
351 */
352typedef int SDL_EGLint;
353
354/**
355 * EGL platform attribute initialization callback.
356 *
357 * This is called when SDL is attempting to create an EGL context, to let the
358 * app add extra attributes to its eglGetPlatformDisplay() call.
359 *
360 * The callback should return a pointer to an EGL attribute array terminated
361 * with `EGL_NONE`. If this function returns NULL, the SDL_CreateWindow
362 * process will fail gracefully.
363 *
364 * The returned pointer should be allocated with SDL_malloc() and will be
365 * passed to SDL_free().
366 *
367 * The arrays returned by each callback will be appended to the existing
368 * attribute arrays defined by SDL.
369 *
370 * \param userdata an app-controlled pointer that is passed to the callback.
371 * \returns a newly-allocated array of attributes, terminated with `EGL_NONE`.
372 *
373 * \since This datatype is available since SDL 3.2.0.
374 *
375 * \sa SDL_EGL_SetAttributeCallbacks
376 */
377typedef SDL_EGLAttrib *(SDLCALL *SDL_EGLAttribArrayCallback)(void *userdata);
378
379/**
380 * EGL surface/context attribute initialization callback types.
381 *
382 * This is called when SDL is attempting to create an EGL surface, to let the
383 * app add extra attributes to its eglCreateWindowSurface() or
384 * eglCreateContext calls.
385 *
386 * For convenience, the EGLDisplay and EGLConfig to use are provided to the
387 * callback.
388 *
389 * The callback should return a pointer to an EGL attribute array terminated
390 * with `EGL_NONE`. If this function returns NULL, the SDL_CreateWindow
391 * process will fail gracefully.
392 *
393 * The returned pointer should be allocated with SDL_malloc() and will be
394 * passed to SDL_free().
395 *
396 * The arrays returned by each callback will be appended to the existing
397 * attribute arrays defined by SDL.
398 *
399 * \param userdata an app-controlled pointer that is passed to the callback.
400 * \param display the EGL display to be used.
401 * \param config the EGL config to be used.
402 * \returns a newly-allocated array of attributes, terminated with `EGL_NONE`.
403 *
404 * \since This datatype is available since SDL 3.2.0.
405 *
406 * \sa SDL_EGL_SetAttributeCallbacks
407 */
408typedef SDL_EGLint *(SDLCALL *SDL_EGLIntArrayCallback)(void *userdata, SDL_EGLDisplay display, SDL_EGLConfig config);
409
410/**
411 * An enumeration of OpenGL configuration attributes.
412 *
413 * While you can set most OpenGL attributes normally, the attributes listed
414 * above must be known before SDL creates the window that will be used with
415 * the OpenGL context. These attributes are set and read with
416 * SDL_GL_SetAttribute() and SDL_GL_GetAttribute().
417 *
418 * In some cases, these attributes are minimum requests; the GL does not
419 * promise to give you exactly what you asked for. It's possible to ask for a
420 * 16-bit depth buffer and get a 24-bit one instead, for example, or to ask
421 * for no stencil buffer and still have one available. Context creation should
422 * fail if the GL can't provide your requested attributes at a minimum, but
423 * you should check to see exactly what you got.
424 *
425 * \since This enum is available since SDL 3.2.0.
426 */
427typedef enum SDL_GLAttr
428{
429 SDL_GL_RED_SIZE, /**< the minimum number of bits for the red channel of the color buffer; defaults to 3. */
430 SDL_GL_GREEN_SIZE, /**< the minimum number of bits for the green channel of the color buffer; defaults to 3. */
431 SDL_GL_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the color buffer; defaults to 2. */
432 SDL_GL_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the color buffer; defaults to 0. */
433 SDL_GL_BUFFER_SIZE, /**< the minimum number of bits for frame buffer size; defaults to 0. */
434 SDL_GL_DOUBLEBUFFER, /**< whether the output is single or double buffered; defaults to double buffering on. */
435 SDL_GL_DEPTH_SIZE, /**< the minimum number of bits in the depth buffer; defaults to 16. */
436 SDL_GL_STENCIL_SIZE, /**< the minimum number of bits in the stencil buffer; defaults to 0. */
437 SDL_GL_ACCUM_RED_SIZE, /**< the minimum number of bits for the red channel of the accumulation buffer; defaults to 0. */
438 SDL_GL_ACCUM_GREEN_SIZE, /**< the minimum number of bits for the green channel of the accumulation buffer; defaults to 0. */
439 SDL_GL_ACCUM_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0. */
440 SDL_GL_ACCUM_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0. */
441 SDL_GL_STEREO, /**< whether the output is stereo 3D; defaults to off. */
442 SDL_GL_MULTISAMPLEBUFFERS, /**< the number of buffers used for multisample anti-aliasing; defaults to 0. */
443 SDL_GL_MULTISAMPLESAMPLES, /**< the number of samples used around the current pixel used for multisample anti-aliasing. */
444 SDL_GL_ACCELERATED_VISUAL, /**< set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either. */
445 SDL_GL_RETAINED_BACKING, /**< not used (deprecated). */
446 SDL_GL_CONTEXT_MAJOR_VERSION, /**< OpenGL context major version. */
447 SDL_GL_CONTEXT_MINOR_VERSION, /**< OpenGL context minor version. */
448 SDL_GL_CONTEXT_FLAGS, /**< some combination of 0 or more of elements of the SDL_GLContextFlag enumeration; defaults to 0. */
449 SDL_GL_CONTEXT_PROFILE_MASK, /**< type of GL context (Core, Compatibility, ES). See SDL_GLProfile; default value depends on platform. */
450 SDL_GL_SHARE_WITH_CURRENT_CONTEXT, /**< OpenGL context sharing; defaults to 0. */
451 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, /**< requests sRGB capable visual; defaults to 0. */
452 SDL_GL_CONTEXT_RELEASE_BEHAVIOR, /**< sets context the release behavior. See SDL_GLContextReleaseFlag; defaults to FLUSH. */
453 SDL_GL_CONTEXT_RESET_NOTIFICATION, /**< set context reset notification. See SDL_GLContextResetNotification; defaults to NO_NOTIFICATION. */
454 SDL_GL_CONTEXT_NO_ERROR,
455 SDL_GL_FLOATBUFFERS,
456 SDL_GL_EGL_PLATFORM
457} SDL_GLAttr;
458
459/**
460 * Possible values to be set for the SDL_GL_CONTEXT_PROFILE_MASK attribute.
461 *
462 * \since This datatype is available since SDL 3.2.0.
463 */
464typedef Uint32 SDL_GLProfile;
465
466#define SDL_GL_CONTEXT_PROFILE_CORE 0x0001 /**< OpenGL Core Profile context */
467#define SDL_GL_CONTEXT_PROFILE_COMPATIBILITY 0x0002 /**< OpenGL Compatibility Profile context */
468#define SDL_GL_CONTEXT_PROFILE_ES 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
469
470
471/**
472 * Possible flags to be set for the SDL_GL_CONTEXT_FLAGS attribute.
473 *
474 * \since This datatype is available since SDL 3.2.0.
475 */
476typedef Uint32 SDL_GLContextFlag;
477
478#define SDL_GL_CONTEXT_DEBUG_FLAG 0x0001
479#define SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG 0x0002
480#define SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG 0x0004
481#define SDL_GL_CONTEXT_RESET_ISOLATION_FLAG 0x0008
482
483
484/**
485 * Possible values to be set for the SDL_GL_CONTEXT_RELEASE_BEHAVIOR
486 * attribute.
487 *
488 * \since This datatype is available since SDL 3.2.0.
489 */
490typedef Uint32 SDL_GLContextReleaseFlag;
491
492#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 0x0000
493#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 0x0001
494
495
496/**
497 * Possible values to be set SDL_GL_CONTEXT_RESET_NOTIFICATION attribute.
498 *
499 * \since This datatype is available since SDL 3.2.0.
500 */
501typedef Uint32 SDL_GLContextResetNotification;
502
503#define SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 0x0000
504#define SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 0x0001
505
506
507/* Function prototypes */
508
509/**
510 * Get the number of video drivers compiled into SDL.
511 *
512 * \returns the number of built in video drivers.
513 *
514 * \threadsafety This function should only be called on the main thread.
515 *
516 * \since This function is available since SDL 3.2.0.
517 *
518 * \sa SDL_GetVideoDriver
519 */
520extern SDL_DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
521
522/**
523 * Get the name of a built in video driver.
524 *
525 * The video drivers are presented in the order in which they are normally
526 * checked during initialization.
527 *
528 * The names of drivers are all simple, low-ASCII identifiers, like "cocoa",
529 * "x11" or "windows". These never have Unicode characters, and are not meant
530 * to be proper names.
531 *
532 * \param index the index of a video driver.
533 * \returns the name of the video driver with the given **index**.
534 *
535 * \threadsafety This function should only be called on the main thread.
536 *
537 * \since This function is available since SDL 3.2.0.
538 *
539 * \sa SDL_GetNumVideoDrivers
540 */
541extern SDL_DECLSPEC const char * SDLCALL SDL_GetVideoDriver(int index);
542
543/**
544 * Get the name of the currently initialized video driver.
545 *
546 * The names of drivers are all simple, low-ASCII identifiers, like "cocoa",
547 * "x11" or "windows". These never have Unicode characters, and are not meant
548 * to be proper names.
549 *
550 * \returns the name of the current video driver or NULL if no driver has been
551 * initialized.
552 *
553 * \threadsafety This function should only be called on the main thread.
554 *
555 * \since This function is available since SDL 3.2.0.
556 *
557 * \sa SDL_GetNumVideoDrivers
558 * \sa SDL_GetVideoDriver
559 */
560extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentVideoDriver(void);
561
562/**
563 * Get the current system theme.
564 *
565 * \returns the current system theme, light, dark, or unknown.
566 *
567 * \threadsafety This function should only be called on the main thread.
568 *
569 * \since This function is available since SDL 3.2.0.
570 */
571extern SDL_DECLSPEC SDL_SystemTheme SDLCALL SDL_GetSystemTheme(void);
572
573/**
574 * Get a list of currently connected displays.
575 *
576 * \param count a pointer filled in with the number of displays returned, may
577 * be NULL.
578 * \returns a 0 terminated array of display instance IDs or NULL on failure;
579 * call SDL_GetError() for more information. This should be freed
580 * with SDL_free() when it is no longer needed.
581 *
582 * \threadsafety This function should only be called on the main thread.
583 *
584 * \since This function is available since SDL 3.2.0.
585 */
586extern SDL_DECLSPEC SDL_DisplayID * SDLCALL SDL_GetDisplays(int *count);
587
588/**
589 * Return the primary display.
590 *
591 * \returns the instance ID of the primary display on success or 0 on failure;
592 * call SDL_GetError() for more information.
593 *
594 * \threadsafety This function should only be called on the main thread.
595 *
596 * \since This function is available since SDL 3.2.0.
597 *
598 * \sa SDL_GetDisplays
599 */
600extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetPrimaryDisplay(void);
601
602/**
603 * Get the properties associated with a display.
604 *
605 * The following read-only properties are provided by SDL:
606 *
607 * - `SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN`: true if the display has HDR
608 * headroom above the SDR white point. This is for informational and
609 * diagnostic purposes only, as not all platforms provide this information
610 * at the display level.
611 *
612 * On KMS/DRM:
613 *
614 * - `SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER`: the "panel
615 * orientation" property for the display in degrees of clockwise rotation.
616 * Note that this is provided only as a hint, and the application is
617 * responsible for any coordinate transformations needed to conform to the
618 * requested display orientation.
619 *
620 * \param displayID the instance ID of the display to query.
621 * \returns a valid property ID on success or 0 on failure; call
622 * SDL_GetError() for more information.
623 *
624 * \threadsafety This function should only be called on the main thread.
625 *
626 * \since This function is available since SDL 3.2.0.
627 */
628extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetDisplayProperties(SDL_DisplayID displayID);
629
630#define SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN "SDL.display.HDR_enabled"
631#define SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER "SDL.display.KMSDRM.panel_orientation"
632
633/**
634 * Get the name of a display in UTF-8 encoding.
635 *
636 * \param displayID the instance ID of the display to query.
637 * \returns the name of a display or NULL on failure; call SDL_GetError() for
638 * more information.
639 *
640 * \threadsafety This function should only be called on the main thread.
641 *
642 * \since This function is available since SDL 3.2.0.
643 *
644 * \sa SDL_GetDisplays
645 */
646extern SDL_DECLSPEC const char * SDLCALL SDL_GetDisplayName(SDL_DisplayID displayID);
647
648/**
649 * Get the desktop area represented by a display.
650 *
651 * The primary display is often located at (0,0), but may be placed at a
652 * different location depending on monitor layout.
653 *
654 * \param displayID the instance ID of the display to query.
655 * \param rect the SDL_Rect structure filled in with the display bounds.
656 * \returns true on success or false on failure; call SDL_GetError() for more
657 * information.
658 *
659 * \threadsafety This function should only be called on the main thread.
660 *
661 * \since This function is available since SDL 3.2.0.
662 *
663 * \sa SDL_GetDisplayUsableBounds
664 * \sa SDL_GetDisplays
665 */
666extern SDL_DECLSPEC bool SDLCALL SDL_GetDisplayBounds(SDL_DisplayID displayID, SDL_Rect *rect);
667
668/**
669 * Get the usable desktop area represented by a display, in screen
670 * coordinates.
671 *
672 * This is the same area as SDL_GetDisplayBounds() reports, but with portions
673 * reserved by the system removed. For example, on Apple's macOS, this
674 * subtracts the area occupied by the menu bar and dock.
675 *
676 * Setting a window to be fullscreen generally bypasses these unusable areas,
677 * so these are good guidelines for the maximum space available to a
678 * non-fullscreen window.
679 *
680 * \param displayID the instance ID of the display to query.
681 * \param rect the SDL_Rect structure filled in with the display bounds.
682 * \returns true on success or false on failure; call SDL_GetError() for more
683 * information.
684 *
685 * \threadsafety This function should only be called on the main thread.
686 *
687 * \since This function is available since SDL 3.2.0.
688 *
689 * \sa SDL_GetDisplayBounds
690 * \sa SDL_GetDisplays
691 */
692extern SDL_DECLSPEC bool SDLCALL SDL_GetDisplayUsableBounds(SDL_DisplayID displayID, SDL_Rect *rect);
693
694/**
695 * Get the orientation of a display when it is unrotated.
696 *
697 * \param displayID the instance ID of the display to query.
698 * \returns the SDL_DisplayOrientation enum value of the display, or
699 * `SDL_ORIENTATION_UNKNOWN` if it isn't available.
700 *
701 * \threadsafety This function should only be called on the main thread.
702 *
703 * \since This function is available since SDL 3.2.0.
704 *
705 * \sa SDL_GetDisplays
706 */
707extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetNaturalDisplayOrientation(SDL_DisplayID displayID);
708
709/**
710 * Get the orientation of a display.
711 *
712 * \param displayID the instance ID of the display to query.
713 * \returns the SDL_DisplayOrientation enum value of the display, or
714 * `SDL_ORIENTATION_UNKNOWN` if it isn't available.
715 *
716 * \threadsafety This function should only be called on the main thread.
717 *
718 * \since This function is available since SDL 3.2.0.
719 *
720 * \sa SDL_GetDisplays
721 */
722extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetCurrentDisplayOrientation(SDL_DisplayID displayID);
723
724/**
725 * Get the content scale of a display.
726 *
727 * The content scale is the expected scale for content based on the DPI
728 * settings of the display. For example, a 4K display might have a 2.0 (200%)
729 * display scale, which means that the user expects UI elements to be twice as
730 * big on this display, to aid in readability.
731 *
732 * After window creation, SDL_GetWindowDisplayScale() should be used to query
733 * the content scale factor for individual windows instead of querying the
734 * display for a window and calling this function, as the per-window content
735 * scale factor may differ from the base value of the display it is on,
736 * particularly on high-DPI and/or multi-monitor desktop configurations.
737 *
738 * \param displayID the instance ID of the display to query.
739 * \returns the content scale of the display, or 0.0f on failure; call
740 * SDL_GetError() for more information.
741 *
742 * \threadsafety This function should only be called on the main thread.
743 *
744 * \since This function is available since SDL 3.2.0.
745 *
746 * \sa SDL_GetWindowDisplayScale
747 * \sa SDL_GetDisplays
748 */
749extern SDL_DECLSPEC float SDLCALL SDL_GetDisplayContentScale(SDL_DisplayID displayID);
750
751/**
752 * Get a list of fullscreen display modes available on a display.
753 *
754 * The display modes are sorted in this priority:
755 *
756 * - w -> largest to smallest
757 * - h -> largest to smallest
758 * - bits per pixel -> more colors to fewer colors
759 * - packed pixel layout -> largest to smallest
760 * - refresh rate -> highest to lowest
761 * - pixel density -> lowest to highest
762 *
763 * \param displayID the instance ID of the display to query.
764 * \param count a pointer filled in with the number of display modes returned,
765 * may be NULL.
766 * \returns a NULL terminated array of display mode pointers or NULL on
767 * failure; call SDL_GetError() for more information. This is a
768 * single allocation that should be freed with SDL_free() when it is
769 * no longer needed.
770 *
771 * \threadsafety This function should only be called on the main thread.
772 *
773 * \since This function is available since SDL 3.2.0.
774 *
775 * \sa SDL_GetDisplays
776 */
777extern SDL_DECLSPEC SDL_DisplayMode ** SDLCALL SDL_GetFullscreenDisplayModes(SDL_DisplayID displayID, int *count);
778
779/**
780 * Get the closest match to the requested display mode.
781 *
782 * The available display modes are scanned and `closest` is filled in with the
783 * closest mode matching the requested mode and returned. The mode format and
784 * refresh rate default to the desktop mode if they are set to 0. The modes
785 * are scanned with size being first priority, format being second priority,
786 * and finally checking the refresh rate. If all the available modes are too
787 * small, then false is returned.
788 *
789 * \param displayID the instance ID of the display to query.
790 * \param w the width in pixels of the desired display mode.
791 * \param h the height in pixels of the desired display mode.
792 * \param refresh_rate the refresh rate of the desired display mode, or 0.0f
793 * for the desktop refresh rate.
794 * \param include_high_density_modes boolean to include high density modes in
795 * the search.
796 * \param closest a pointer filled in with the closest display mode equal to
797 * or larger than the desired mode.
798 * \returns true on success or false on failure; call SDL_GetError() for more
799 * information.
800 *
801 * \threadsafety This function should only be called on the main thread.
802 *
803 * \since This function is available since SDL 3.2.0.
804 *
805 * \sa SDL_GetDisplays
806 * \sa SDL_GetFullscreenDisplayModes
807 */
808extern SDL_DECLSPEC bool SDLCALL SDL_GetClosestFullscreenDisplayMode(SDL_DisplayID displayID, int w, int h, float refresh_rate, bool include_high_density_modes, SDL_DisplayMode *closest);
809
810/**
811 * Get information about the desktop's display mode.
812 *
813 * There's a difference between this function and SDL_GetCurrentDisplayMode()
814 * when SDL runs fullscreen and has changed the resolution. In that case this
815 * function will return the previous native display mode, and not the current
816 * display mode.
817 *
818 * \param displayID the instance ID of the display to query.
819 * \returns a pointer to the desktop display mode or NULL on failure; call
820 * SDL_GetError() for more information.
821 *
822 * \threadsafety This function should only be called on the main thread.
823 *
824 * \since This function is available since SDL 3.2.0.
825 *
826 * \sa SDL_GetCurrentDisplayMode
827 * \sa SDL_GetDisplays
828 */
829extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayID displayID);
830
831/**
832 * Get information about the current display mode.
833 *
834 * There's a difference between this function and SDL_GetDesktopDisplayMode()
835 * when SDL runs fullscreen and has changed the resolution. In that case this
836 * function will return the current display mode, and not the previous native
837 * display mode.
838 *
839 * \param displayID the instance ID of the display to query.
840 * \returns a pointer to the desktop display mode or NULL on failure; call
841 * SDL_GetError() for more information.
842 *
843 * \threadsafety This function should only be called on the main thread.
844 *
845 * \since This function is available since SDL 3.2.0.
846 *
847 * \sa SDL_GetDesktopDisplayMode
848 * \sa SDL_GetDisplays
849 */
850extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayID displayID);
851
852/**
853 * Get the display containing a point.
854 *
855 * \param point the point to query.
856 * \returns the instance ID of the display containing the point or 0 on
857 * failure; call SDL_GetError() for more information.
858 *
859 * \threadsafety This function should only be called on the main thread.
860 *
861 * \since This function is available since SDL 3.2.0.
862 *
863 * \sa SDL_GetDisplayBounds
864 * \sa SDL_GetDisplays
865 */
866extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForPoint(const SDL_Point *point);
867
868/**
869 * Get the display primarily containing a rect.
870 *
871 * \param rect the rect to query.
872 * \returns the instance ID of the display entirely containing the rect or
873 * closest to the center of the rect on success or 0 on failure; call
874 * SDL_GetError() for more information.
875 *
876 * \threadsafety This function should only be called on the main thread.
877 *
878 * \since This function is available since SDL 3.2.0.
879 *
880 * \sa SDL_GetDisplayBounds
881 * \sa SDL_GetDisplays
882 */
883extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForRect(const SDL_Rect *rect);
884
885/**
886 * Get the display associated with a window.
887 *
888 * \param window the window to query.
889 * \returns the instance ID of the display containing the center of the window
890 * on success or 0 on failure; call SDL_GetError() for more
891 * information.
892 *
893 * \threadsafety This function should only be called on the main thread.
894 *
895 * \since This function is available since SDL 3.2.0.
896 *
897 * \sa SDL_GetDisplayBounds
898 * \sa SDL_GetDisplays
899 */
900extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForWindow(SDL_Window *window);
901
902/**
903 * Get the pixel density of a window.
904 *
905 * This is a ratio of pixel size to window size. For example, if the window is
906 * 1920x1080 and it has a high density back buffer of 3840x2160 pixels, it
907 * would have a pixel density of 2.0.
908 *
909 * \param window the window to query.
910 * \returns the pixel density or 0.0f on failure; call SDL_GetError() for more
911 * information.
912 *
913 * \threadsafety This function should only be called on the main thread.
914 *
915 * \since This function is available since SDL 3.2.0.
916 *
917 * \sa SDL_GetWindowDisplayScale
918 */
919extern SDL_DECLSPEC float SDLCALL SDL_GetWindowPixelDensity(SDL_Window *window);
920
921/**
922 * Get the content display scale relative to a window's pixel size.
923 *
924 * This is a combination of the window pixel density and the display content
925 * scale, and is the expected scale for displaying content in this window. For
926 * example, if a 3840x2160 window had a display scale of 2.0, the user expects
927 * the content to take twice as many pixels and be the same physical size as
928 * if it were being displayed in a 1920x1080 window with a display scale of
929 * 1.0.
930 *
931 * Conceptually this value corresponds to the scale display setting, and is
932 * updated when that setting is changed, or the window moves to a display with
933 * a different scale setting.
934 *
935 * \param window the window to query.
936 * \returns the display scale, or 0.0f on failure; call SDL_GetError() for
937 * more information.
938 *
939 * \threadsafety This function should only be called on the main thread.
940 *
941 * \since This function is available since SDL 3.2.0.
942 */
943extern SDL_DECLSPEC float SDLCALL SDL_GetWindowDisplayScale(SDL_Window *window);
944
945/**
946 * Set the display mode to use when a window is visible and fullscreen.
947 *
948 * This only affects the display mode used when the window is fullscreen. To
949 * change the window size when the window is not fullscreen, use
950 * SDL_SetWindowSize().
951 *
952 * If the window is currently in the fullscreen state, this request is
953 * asynchronous on some windowing systems and the new mode dimensions may not
954 * be applied immediately upon the return of this function. If an immediate
955 * change is required, call SDL_SyncWindow() to block until the changes have
956 * taken effect.
957 *
958 * When the new mode takes effect, an SDL_EVENT_WINDOW_RESIZED and/or an
959 * SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event will be emitted with the new mode
960 * dimensions.
961 *
962 * \param window the window to affect.
963 * \param mode a pointer to the display mode to use, which can be NULL for
964 * borderless fullscreen desktop mode, or one of the fullscreen
965 * modes returned by SDL_GetFullscreenDisplayModes() to set an
966 * exclusive fullscreen mode.
967 * \returns true on success or false on failure; call SDL_GetError() for more
968 * information.
969 *
970 * \threadsafety This function should only be called on the main thread.
971 *
972 * \since This function is available since SDL 3.2.0.
973 *
974 * \sa SDL_GetWindowFullscreenMode
975 * \sa SDL_SetWindowFullscreen
976 * \sa SDL_SyncWindow
977 */
978extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFullscreenMode(SDL_Window *window, const SDL_DisplayMode *mode);
979
980/**
981 * Query the display mode to use when a window is visible at fullscreen.
982 *
983 * \param window the window to query.
984 * \returns a pointer to the exclusive fullscreen mode to use or NULL for
985 * borderless fullscreen desktop mode.
986 *
987 * \threadsafety This function should only be called on the main thread.
988 *
989 * \since This function is available since SDL 3.2.0.
990 *
991 * \sa SDL_SetWindowFullscreenMode
992 * \sa SDL_SetWindowFullscreen
993 */
994extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetWindowFullscreenMode(SDL_Window *window);
995
996/**
997 * Get the raw ICC profile data for the screen the window is currently on.
998 *
999 * \param window the window to query.
1000 * \param size the size of the ICC profile.
1001 * \returns the raw ICC profile data on success or NULL on failure; call
1002 * SDL_GetError() for more information. This should be freed with
1003 * SDL_free() when it is no longer needed.
1004 *
1005 * \threadsafety This function should only be called on the main thread.
1006 *
1007 * \since This function is available since SDL 3.2.0.
1008 */
1009extern SDL_DECLSPEC void * SDLCALL SDL_GetWindowICCProfile(SDL_Window *window, size_t *size);
1010
1011/**
1012 * Get the pixel format associated with the window.
1013 *
1014 * \param window the window to query.
1015 * \returns the pixel format of the window on success or
1016 * SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more
1017 * information.
1018 *
1019 * \threadsafety This function should only be called on the main thread.
1020 *
1021 * \since This function is available since SDL 3.2.0.
1022 */
1023extern SDL_DECLSPEC SDL_PixelFormat SDLCALL SDL_GetWindowPixelFormat(SDL_Window *window);
1024
1025/**
1026 * Get a list of valid windows.
1027 *
1028 * \param count a pointer filled in with the number of windows returned, may
1029 * be NULL.
1030 * \returns a NULL terminated array of SDL_Window pointers or NULL on failure;
1031 * call SDL_GetError() for more information. This is a single
1032 * allocation that should be freed with SDL_free() when it is no
1033 * longer needed.
1034 *
1035 * \threadsafety This function should only be called on the main thread.
1036 *
1037 * \since This function is available since SDL 3.2.0.
1038 */
1039extern SDL_DECLSPEC SDL_Window ** SDLCALL SDL_GetWindows(int *count);
1040
1041/**
1042 * Create a window with the specified dimensions and flags.
1043 *
1044 * `flags` may be any of the following OR'd together:
1045 *
1046 * - `SDL_WINDOW_FULLSCREEN`: fullscreen window at desktop resolution
1047 * - `SDL_WINDOW_OPENGL`: window usable with an OpenGL context
1048 * - `SDL_WINDOW_OCCLUDED`: window partially or completely obscured by another
1049 * window
1050 * - `SDL_WINDOW_HIDDEN`: window is not visible
1051 * - `SDL_WINDOW_BORDERLESS`: no window decoration
1052 * - `SDL_WINDOW_RESIZABLE`: window can be resized
1053 * - `SDL_WINDOW_MINIMIZED`: window is minimized
1054 * - `SDL_WINDOW_MAXIMIZED`: window is maximized
1055 * - `SDL_WINDOW_MOUSE_GRABBED`: window has grabbed mouse focus
1056 * - `SDL_WINDOW_INPUT_FOCUS`: window has input focus
1057 * - `SDL_WINDOW_MOUSE_FOCUS`: window has mouse focus
1058 * - `SDL_WINDOW_EXTERNAL`: window not created by SDL
1059 * - `SDL_WINDOW_MODAL`: window is modal
1060 * - `SDL_WINDOW_HIGH_PIXEL_DENSITY`: window uses high pixel density back
1061 * buffer if possible
1062 * - `SDL_WINDOW_MOUSE_CAPTURE`: window has mouse captured (unrelated to
1063 * MOUSE_GRABBED)
1064 * - `SDL_WINDOW_ALWAYS_ON_TOP`: window should always be above others
1065 * - `SDL_WINDOW_UTILITY`: window should be treated as a utility window, not
1066 * showing in the task bar and window list
1067 * - `SDL_WINDOW_TOOLTIP`: window should be treated as a tooltip and does not
1068 * get mouse or keyboard focus, requires a parent window
1069 * - `SDL_WINDOW_POPUP_MENU`: window should be treated as a popup menu,
1070 * requires a parent window
1071 * - `SDL_WINDOW_KEYBOARD_GRABBED`: window has grabbed keyboard input
1072 * - `SDL_WINDOW_VULKAN`: window usable with a Vulkan instance
1073 * - `SDL_WINDOW_METAL`: window usable with a Metal instance
1074 * - `SDL_WINDOW_TRANSPARENT`: window with transparent buffer
1075 * - `SDL_WINDOW_NOT_FOCUSABLE`: window should not be focusable
1076 *
1077 * The SDL_Window is implicitly shown if SDL_WINDOW_HIDDEN is not set.
1078 *
1079 * On Apple's macOS, you **must** set the NSHighResolutionCapable Info.plist
1080 * property to YES, otherwise you will not receive a High-DPI OpenGL canvas.
1081 *
1082 * The window pixel size may differ from its window coordinate size if the
1083 * window is on a high pixel density display. Use SDL_GetWindowSize() to query
1084 * the client area's size in window coordinates, and
1085 * SDL_GetWindowSizeInPixels() or SDL_GetRenderOutputSize() to query the
1086 * drawable size in pixels. Note that the drawable size can vary after the
1087 * window is created and should be queried again if you get an
1088 * SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event.
1089 *
1090 * If the window is created with any of the SDL_WINDOW_OPENGL or
1091 * SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function
1092 * (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the
1093 * corresponding UnloadLibrary function is called by SDL_DestroyWindow().
1094 *
1095 * If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver,
1096 * SDL_CreateWindow() will fail, because SDL_Vulkan_LoadLibrary() will fail.
1097 *
1098 * If SDL_WINDOW_METAL is specified on an OS that does not support Metal,
1099 * SDL_CreateWindow() will fail.
1100 *
1101 * If you intend to use this window with an SDL_Renderer, you should use
1102 * SDL_CreateWindowAndRenderer() instead of this function, to avoid window
1103 * flicker.
1104 *
1105 * On non-Apple devices, SDL requires you to either not link to the Vulkan
1106 * loader or link to a dynamic library version. This limitation may be removed
1107 * in a future version of SDL.
1108 *
1109 * \param title the title of the window, in UTF-8 encoding.
1110 * \param w the width of the window.
1111 * \param h the height of the window.
1112 * \param flags 0, or one or more SDL_WindowFlags OR'd together.
1113 * \returns the window that was created or NULL on failure; call
1114 * SDL_GetError() for more information.
1115 *
1116 * \threadsafety This function should only be called on the main thread.
1117 *
1118 * \since This function is available since SDL 3.2.0.
1119 *
1120 * \sa SDL_CreateWindowAndRenderer
1121 * \sa SDL_CreatePopupWindow
1122 * \sa SDL_CreateWindowWithProperties
1123 * \sa SDL_DestroyWindow
1124 */
1125extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title, int w, int h, SDL_WindowFlags flags);
1126
1127/**
1128 * Create a child popup window of the specified parent window.
1129 *
1130 * The flags parameter **must** contain at least one of the following:
1131 *
1132 * - `SDL_WINDOW_TOOLTIP`: The popup window is a tooltip and will not pass any
1133 * input events.
1134 * - `SDL_WINDOW_POPUP_MENU`: The popup window is a popup menu. The topmost
1135 * popup menu will implicitly gain the keyboard focus.
1136 *
1137 * The following flags are not relevant to popup window creation and will be
1138 * ignored:
1139 *
1140 * - `SDL_WINDOW_MINIMIZED`
1141 * - `SDL_WINDOW_MAXIMIZED`
1142 * - `SDL_WINDOW_FULLSCREEN`
1143 * - `SDL_WINDOW_BORDERLESS`
1144 *
1145 * The following flags are incompatible with popup window creation and will
1146 * cause it to fail:
1147 *
1148 * - `SDL_WINDOW_UTILITY`
1149 * - `SDL_WINDOW_MODAL`
1150 *
1151 * The parent parameter **must** be non-null and a valid window. The parent of
1152 * a popup window can be either a regular, toplevel window, or another popup
1153 * window.
1154 *
1155 * Popup windows cannot be minimized, maximized, made fullscreen, raised,
1156 * flash, be made a modal window, be the parent of a toplevel window, or grab
1157 * the mouse and/or keyboard. Attempts to do so will fail.
1158 *
1159 * Popup windows implicitly do not have a border/decorations and do not appear
1160 * on the taskbar/dock or in lists of windows such as alt-tab menus.
1161 *
1162 * If a parent window is hidden or destroyed, any child popup windows will be
1163 * recursively hidden or destroyed as well. Child popup windows not explicitly
1164 * hidden will be restored when the parent is shown.
1165 *
1166 * \param parent the parent of the window, must not be NULL.
1167 * \param offset_x the x position of the popup window relative to the origin
1168 * of the parent.
1169 * \param offset_y the y position of the popup window relative to the origin
1170 * of the parent window.
1171 * \param w the width of the window.
1172 * \param h the height of the window.
1173 * \param flags SDL_WINDOW_TOOLTIP or SDL_WINDOW_POPUP_MENU, and zero or more
1174 * additional SDL_WindowFlags OR'd together.
1175 * \returns the window that was created or NULL on failure; call
1176 * SDL_GetError() for more information.
1177 *
1178 * \threadsafety This function should only be called on the main thread.
1179 *
1180 * \since This function is available since SDL 3.2.0.
1181 *
1182 * \sa SDL_CreateWindow
1183 * \sa SDL_CreateWindowWithProperties
1184 * \sa SDL_DestroyWindow
1185 * \sa SDL_GetWindowParent
1186 */
1187extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreatePopupWindow(SDL_Window *parent, int offset_x, int offset_y, int w, int h, SDL_WindowFlags flags);
1188
1189/**
1190 * Create a window with the specified properties.
1191 *
1192 * These are the supported properties:
1193 *
1194 * - `SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN`: true if the window should
1195 * be always on top
1196 * - `SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN`: true if the window has no
1197 * window decoration
1198 * - `SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN`: true if the
1199 * window will be used with an externally managed graphics context.
1200 * - `SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN`: true if the window should
1201 * accept keyboard input (defaults true)
1202 * - `SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN`: true if the window should
1203 * start in fullscreen mode at desktop resolution
1204 * - `SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER`: the height of the window
1205 * - `SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN`: true if the window should start
1206 * hidden
1207 * - `SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN`: true if the window
1208 * uses a high pixel density buffer if possible
1209 * - `SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN`: true if the window should
1210 * start maximized
1211 * - `SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN`: true if the window is a popup menu
1212 * - `SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN`: true if the window will be used
1213 * with Metal rendering
1214 * - `SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN`: true if the window should
1215 * start minimized
1216 * - `SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN`: true if the window is modal to
1217 * its parent
1218 * - `SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN`: true if the window starts
1219 * with grabbed mouse focus
1220 * - `SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN`: true if the window will be used
1221 * with OpenGL rendering
1222 * - `SDL_PROP_WINDOW_CREATE_PARENT_POINTER`: an SDL_Window that will be the
1223 * parent of this window, required for windows with the "tooltip", "menu",
1224 * and "modal" properties
1225 * - `SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN`: true if the window should be
1226 * resizable
1227 * - `SDL_PROP_WINDOW_CREATE_TITLE_STRING`: the title of the window, in UTF-8
1228 * encoding
1229 * - `SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN`: true if the window show
1230 * transparent in the areas with alpha of 0
1231 * - `SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN`: true if the window is a tooltip
1232 * - `SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN`: true if the window is a utility
1233 * window, not showing in the task bar and window list
1234 * - `SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN`: true if the window will be used
1235 * with Vulkan rendering
1236 * - `SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER`: the width of the window
1237 * - `SDL_PROP_WINDOW_CREATE_X_NUMBER`: the x position of the window, or
1238 * `SDL_WINDOWPOS_CENTERED`, defaults to `SDL_WINDOWPOS_UNDEFINED`. This is
1239 * relative to the parent for windows with the "tooltip" or "menu" property
1240 * set.
1241 * - `SDL_PROP_WINDOW_CREATE_Y_NUMBER`: the y position of the window, or
1242 * `SDL_WINDOWPOS_CENTERED`, defaults to `SDL_WINDOWPOS_UNDEFINED`. This is
1243 * relative to the parent for windows with the "tooltip" or "menu" property
1244 * set.
1245 *
1246 * These are additional supported properties on macOS:
1247 *
1248 * - `SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER`: the
1249 * `(__unsafe_unretained)` NSWindow associated with the window, if you want
1250 * to wrap an existing window.
1251 * - `SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER`: the `(__unsafe_unretained)`
1252 * NSView associated with the window, defaults to `[window contentView]`
1253 *
1254 * These are additional supported properties on Wayland:
1255 *
1256 * - `SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN` - true if
1257 * the application wants to use the Wayland surface for a custom role and
1258 * does not want it attached to an XDG toplevel window. See
1259 * [README/wayland](README/wayland) for more information on using custom
1260 * surfaces.
1261 * - `SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN` - true if the
1262 * application wants an associated `wl_egl_window` object to be created and
1263 * attached to the window, even if the window does not have the OpenGL
1264 * property or `SDL_WINDOW_OPENGL` flag set.
1265 * - `SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER` - the wl_surface
1266 * associated with the window, if you want to wrap an existing window. See
1267 * [README/wayland](README/wayland) for more information.
1268 *
1269 * These are additional supported properties on Windows:
1270 *
1271 * - `SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER`: the HWND associated with the
1272 * window, if you want to wrap an existing window.
1273 * - `SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER`: optional,
1274 * another window to share pixel format with, useful for OpenGL windows
1275 *
1276 * These are additional supported properties with X11:
1277 *
1278 * - `SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER`: the X11 Window associated
1279 * with the window, if you want to wrap an existing window.
1280 *
1281 * The window is implicitly shown if the "hidden" property is not set.
1282 *
1283 * These are additional supported properties with Emscripten:
1284 *
1285 * - `SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID`: the id given to the canvas
1286 * element. This should start with a '#' sign
1287 * - `SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT`: override the
1288 * binding element for keyboard inputs for this canvas. The variable can be
1289 * one of:
1290 * - "#window": the javascript window object (default)
1291 * - "#document": the javascript document object
1292 * - "#screen": the javascript window.screen object
1293 * - "#canvas": the WebGL canvas element
1294 * - "#none": Don't bind anything at all
1295 * - any other string without a leading # sign applies to the element on the
1296 * page with that ID. Windows with the "tooltip" and "menu" properties are
1297 * popup windows and have the behaviors and guidelines outlined in
1298 * SDL_CreatePopupWindow().
1299 *
1300 * If this window is being created to be used with an SDL_Renderer, you should
1301 * not add a graphics API specific property
1302 * (`SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN`, etc), as SDL will handle that
1303 * internally when it chooses a renderer. However, SDL might need to recreate
1304 * your window at that point, which may cause the window to appear briefly,
1305 * and then flicker as it is recreated. The correct approach to this is to
1306 * create the window with the `SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN` property
1307 * set to true, then create the renderer, then show the window with
1308 * SDL_ShowWindow().
1309 *
1310 * \param props the properties to use.
1311 * \returns the window that was created or NULL on failure; call
1312 * SDL_GetError() for more information.
1313 *
1314 * \threadsafety This function should only be called on the main thread.
1315 *
1316 * \since This function is available since SDL 3.2.0.
1317 *
1318 * \sa SDL_CreateProperties
1319 * \sa SDL_CreateWindow
1320 * \sa SDL_DestroyWindow
1321 */
1322extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowWithProperties(SDL_PropertiesID props);
1323
1324#define SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN "SDL.window.create.always_on_top"
1325#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN "SDL.window.create.borderless"
1326#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN "SDL.window.create.focusable"
1327#define SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN "SDL.window.create.external_graphics_context"
1328#define SDL_PROP_WINDOW_CREATE_FLAGS_NUMBER "SDL.window.create.flags"
1329#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN "SDL.window.create.fullscreen"
1330#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER "SDL.window.create.height"
1331#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN "SDL.window.create.hidden"
1332#define SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN "SDL.window.create.high_pixel_density"
1333#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN "SDL.window.create.maximized"
1334#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN "SDL.window.create.menu"
1335#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN "SDL.window.create.metal"
1336#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN "SDL.window.create.minimized"
1337#define SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN "SDL.window.create.modal"
1338#define SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN "SDL.window.create.mouse_grabbed"
1339#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN "SDL.window.create.opengl"
1340#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER "SDL.window.create.parent"
1341#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN "SDL.window.create.resizable"
1342#define SDL_PROP_WINDOW_CREATE_TITLE_STRING "SDL.window.create.title"
1343#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN "SDL.window.create.transparent"
1344#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN "SDL.window.create.tooltip"
1345#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN "SDL.window.create.utility"
1346#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN "SDL.window.create.vulkan"
1347#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER "SDL.window.create.width"
1348#define SDL_PROP_WINDOW_CREATE_X_NUMBER "SDL.window.create.x"
1349#define SDL_PROP_WINDOW_CREATE_Y_NUMBER "SDL.window.create.y"
1350#define SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER "SDL.window.create.cocoa.window"
1351#define SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER "SDL.window.create.cocoa.view"
1352#define SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN "SDL.window.create.wayland.surface_role_custom"
1353#define SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN "SDL.window.create.wayland.create_egl_window"
1354#define SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER "SDL.window.create.wayland.wl_surface"
1355#define SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER "SDL.window.create.win32.hwnd"
1356#define SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER "SDL.window.create.win32.pixel_format_hwnd"
1357#define SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER "SDL.window.create.x11.window"
1358#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID "SDL.window.create.emscripten.canvas_id"
1359#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT "SDL.window.create.emscripten.keyboard_element"
1360
1361/**
1362 * Get the numeric ID of a window.
1363 *
1364 * The numeric ID is what SDL_WindowEvent references, and is necessary to map
1365 * these events to specific SDL_Window objects.
1366 *
1367 * \param window the window to query.
1368 * \returns the ID of the window on success or 0 on failure; call
1369 * SDL_GetError() for more information.
1370 *
1371 * \threadsafety This function should only be called on the main thread.
1372 *
1373 * \since This function is available since SDL 3.2.0.
1374 *
1375 * \sa SDL_GetWindowFromID
1376 */
1377extern SDL_DECLSPEC SDL_WindowID SDLCALL SDL_GetWindowID(SDL_Window *window);
1378
1379/**
1380 * Get a window from a stored ID.
1381 *
1382 * The numeric ID is what SDL_WindowEvent references, and is necessary to map
1383 * these events to specific SDL_Window objects.
1384 *
1385 * \param id the ID of the window.
1386 * \returns the window associated with `id` or NULL if it doesn't exist; call
1387 * SDL_GetError() for more information.
1388 *
1389 * \threadsafety This function should only be called on the main thread.
1390 *
1391 * \since This function is available since SDL 3.2.0.
1392 *
1393 * \sa SDL_GetWindowID
1394 */
1395extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(SDL_WindowID id);
1396
1397/**
1398 * Get parent of a window.
1399 *
1400 * \param window the window to query.
1401 * \returns the parent of the window on success or NULL if the window has no
1402 * parent.
1403 *
1404 * \threadsafety This function should only be called on the main thread.
1405 *
1406 * \since This function is available since SDL 3.2.0.
1407 *
1408 * \sa SDL_CreatePopupWindow
1409 */
1410extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetWindowParent(SDL_Window *window);
1411
1412/**
1413 * Get the properties associated with a window.
1414 *
1415 * The following read-only properties are provided by SDL:
1416 *
1417 * - `SDL_PROP_WINDOW_SHAPE_POINTER`: the surface associated with a shaped
1418 * window
1419 * - `SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN`: true if the window has HDR
1420 * headroom above the SDR white point. This property can change dynamically
1421 * when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
1422 * - `SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT`: the value of SDR white in the
1423 * SDL_COLORSPACE_SRGB_LINEAR colorspace. On Windows this corresponds to the
1424 * SDR white level in scRGB colorspace, and on Apple platforms this is
1425 * always 1.0 for EDR content. This property can change dynamically when
1426 * SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
1427 * - `SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT`: the additional high dynamic range
1428 * that can be displayed, in terms of the SDR white point. When HDR is not
1429 * enabled, this will be 1.0. This property can change dynamically when
1430 * SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
1431 *
1432 * On Android:
1433 *
1434 * - `SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER`: the ANativeWindow associated
1435 * with the window
1436 * - `SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER`: the EGLSurface associated with
1437 * the window
1438 *
1439 * On iOS:
1440 *
1441 * - `SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER`: the `(__unsafe_unretained)`
1442 * UIWindow associated with the window
1443 * - `SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER`: the NSInteger tag
1444 * associated with metal views on the window
1445 * - `SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER`: the OpenGL view's
1446 * framebuffer object. It must be bound when rendering to the screen using
1447 * OpenGL.
1448 * - `SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER`: the OpenGL view's
1449 * renderbuffer object. It must be bound when SDL_GL_SwapWindow is called.
1450 * - `SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER`: the OpenGL
1451 * view's resolve framebuffer, when MSAA is used.
1452 *
1453 * On KMS/DRM:
1454 *
1455 * - `SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER`: the device index associated
1456 * with the window (e.g. the X in /dev/dri/cardX)
1457 * - `SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER`: the DRM FD associated with the
1458 * window
1459 * - `SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER`: the GBM device associated
1460 * with the window
1461 *
1462 * On macOS:
1463 *
1464 * - `SDL_PROP_WINDOW_COCOA_WINDOW_POINTER`: the `(__unsafe_unretained)`
1465 * NSWindow associated with the window
1466 * - `SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER`: the NSInteger tag
1467 * assocated with metal views on the window
1468 *
1469 * On OpenVR:
1470 *
1471 * - `SDL_PROP_WINDOW_OPENVR_OVERLAY_ID`: the OpenVR Overlay Handle ID for the
1472 * associated overlay window.
1473 *
1474 * On Vivante:
1475 *
1476 * - `SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER`: the EGLNativeDisplayType
1477 * associated with the window
1478 * - `SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER`: the EGLNativeWindowType
1479 * associated with the window
1480 * - `SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER`: the EGLSurface associated with
1481 * the window
1482 *
1483 * On Windows:
1484 *
1485 * - `SDL_PROP_WINDOW_WIN32_HWND_POINTER`: the HWND associated with the window
1486 * - `SDL_PROP_WINDOW_WIN32_HDC_POINTER`: the HDC associated with the window
1487 * - `SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER`: the HINSTANCE associated with
1488 * the window
1489 *
1490 * On Wayland:
1491 *
1492 * Note: The `xdg_*` window objects do not internally persist across window
1493 * show/hide calls. They will be null if the window is hidden and must be
1494 * queried each time it is shown.
1495 *
1496 * - `SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER`: the wl_display associated with
1497 * the window
1498 * - `SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER`: the wl_surface associated with
1499 * the window
1500 * - `SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER`: the wp_viewport associated
1501 * with the window
1502 * - `SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER`: the wl_egl_window
1503 * associated with the window
1504 * - `SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER`: the xdg_surface associated
1505 * with the window
1506 * - `SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER`: the xdg_toplevel role
1507 * associated with the window
1508 * - 'SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING': the export
1509 * handle associated with the window
1510 * - `SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER`: the xdg_popup role
1511 * associated with the window
1512 * - `SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER`: the xdg_positioner
1513 * associated with the window, in popup mode
1514 *
1515 * On X11:
1516 *
1517 * - `SDL_PROP_WINDOW_X11_DISPLAY_POINTER`: the X11 Display associated with
1518 * the window
1519 * - `SDL_PROP_WINDOW_X11_SCREEN_NUMBER`: the screen number associated with
1520 * the window
1521 * - `SDL_PROP_WINDOW_X11_WINDOW_NUMBER`: the X11 Window associated with the
1522 * window
1523 *
1524 * \param window the window to query.
1525 * \returns a valid property ID on success or 0 on failure; call
1526 * SDL_GetError() for more information.
1527 *
1528 * \threadsafety This function should only be called on the main thread.
1529 *
1530 * \since This function is available since SDL 3.2.0.
1531 */
1532extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetWindowProperties(SDL_Window *window);
1533
1534#define SDL_PROP_WINDOW_SHAPE_POINTER "SDL.window.shape"
1535#define SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN "SDL.window.HDR_enabled"
1536#define SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT "SDL.window.SDR_white_level"
1537#define SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT "SDL.window.HDR_headroom"
1538#define SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER "SDL.window.android.window"
1539#define SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER "SDL.window.android.surface"
1540#define SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER "SDL.window.uikit.window"
1541#define SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER "SDL.window.uikit.metal_view_tag"
1542#define SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER "SDL.window.uikit.opengl.framebuffer"
1543#define SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER "SDL.window.uikit.opengl.renderbuffer"
1544#define SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER "SDL.window.uikit.opengl.resolve_framebuffer"
1545#define SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER "SDL.window.kmsdrm.dev_index"
1546#define SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER "SDL.window.kmsdrm.drm_fd"
1547#define SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER "SDL.window.kmsdrm.gbm_dev"
1548#define SDL_PROP_WINDOW_COCOA_WINDOW_POINTER "SDL.window.cocoa.window"
1549#define SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER "SDL.window.cocoa.metal_view_tag"
1550#define SDL_PROP_WINDOW_OPENVR_OVERLAY_ID "SDL.window.openvr.overlay_id"
1551#define SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER "SDL.window.vivante.display"
1552#define SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER "SDL.window.vivante.window"
1553#define SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER "SDL.window.vivante.surface"
1554#define SDL_PROP_WINDOW_WIN32_HWND_POINTER "SDL.window.win32.hwnd"
1555#define SDL_PROP_WINDOW_WIN32_HDC_POINTER "SDL.window.win32.hdc"
1556#define SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER "SDL.window.win32.instance"
1557#define SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER "SDL.window.wayland.display"
1558#define SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER "SDL.window.wayland.surface"
1559#define SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER "SDL.window.wayland.viewport"
1560#define SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER "SDL.window.wayland.egl_window"
1561#define SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER "SDL.window.wayland.xdg_surface"
1562#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER "SDL.window.wayland.xdg_toplevel"
1563#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING "SDL.window.wayland.xdg_toplevel_export_handle"
1564#define SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER "SDL.window.wayland.xdg_popup"
1565#define SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER "SDL.window.wayland.xdg_positioner"
1566#define SDL_PROP_WINDOW_X11_DISPLAY_POINTER "SDL.window.x11.display"
1567#define SDL_PROP_WINDOW_X11_SCREEN_NUMBER "SDL.window.x11.screen"
1568#define SDL_PROP_WINDOW_X11_WINDOW_NUMBER "SDL.window.x11.window"
1569
1570/**
1571 * Get the window flags.
1572 *
1573 * \param window the window to query.
1574 * \returns a mask of the SDL_WindowFlags associated with `window`.
1575 *
1576 * \threadsafety This function should only be called on the main thread.
1577 *
1578 * \since This function is available since SDL 3.2.0.
1579 *
1580 * \sa SDL_CreateWindow
1581 * \sa SDL_HideWindow
1582 * \sa SDL_MaximizeWindow
1583 * \sa SDL_MinimizeWindow
1584 * \sa SDL_SetWindowFullscreen
1585 * \sa SDL_SetWindowMouseGrab
1586 * \sa SDL_ShowWindow
1587 */
1588extern SDL_DECLSPEC SDL_WindowFlags SDLCALL SDL_GetWindowFlags(SDL_Window *window);
1589
1590/**
1591 * Set the title of a window.
1592 *
1593 * This string is expected to be in UTF-8 encoding.
1594 *
1595 * \param window the window to change.
1596 * \param title the desired window title in UTF-8 format.
1597 * \returns true on success or false on failure; call SDL_GetError() for more
1598 * information.
1599 *
1600 * \threadsafety This function should only be called on the main thread.
1601 *
1602 * \since This function is available since SDL 3.2.0.
1603 *
1604 * \sa SDL_GetWindowTitle
1605 */
1606extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowTitle(SDL_Window *window, const char *title);
1607
1608/**
1609 * Get the title of a window.
1610 *
1611 * \param window the window to query.
1612 * \returns the title of the window in UTF-8 format or "" if there is no
1613 * title.
1614 *
1615 * \threadsafety This function should only be called on the main thread.
1616 *
1617 * \since This function is available since SDL 3.2.0.
1618 *
1619 * \sa SDL_SetWindowTitle
1620 */
1621extern SDL_DECLSPEC const char * SDLCALL SDL_GetWindowTitle(SDL_Window *window);
1622
1623/**
1624 * Set the icon for a window.
1625 *
1626 * If this function is passed a surface with alternate representations, the
1627 * surface will be interpreted as the content to be used for 100% display
1628 * scale, and the alternate representations will be used for high DPI
1629 * situations. For example, if the original surface is 32x32, then on a 2x
1630 * macOS display or 200% display scale on Windows, a 64x64 version of the
1631 * image will be used, if available. If a matching version of the image isn't
1632 * available, the closest larger size image will be downscaled to the
1633 * appropriate size and be used instead, if available. Otherwise, the closest
1634 * smaller image will be upscaled and be used instead.
1635 *
1636 * \param window the window to change.
1637 * \param icon an SDL_Surface structure containing the icon for the window.
1638 * \returns true on success or false on failure; call SDL_GetError() for more
1639 * information.
1640 *
1641 * \threadsafety This function should only be called on the main thread.
1642 *
1643 * \since This function is available since SDL 3.2.0.
1644 */
1645extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon);
1646
1647/**
1648 * Request that the window's position be set.
1649 *
1650 * If the window is in an exclusive fullscreen or maximized state, this
1651 * request has no effect.
1652 *
1653 * This can be used to reposition fullscreen-desktop windows onto a different
1654 * display, however, as exclusive fullscreen windows are locked to a specific
1655 * display, they can only be repositioned programmatically via
1656 * SDL_SetWindowFullscreenMode().
1657 *
1658 * On some windowing systems this request is asynchronous and the new
1659 * coordinates may not have have been applied immediately upon the return of
1660 * this function. If an immediate change is required, call SDL_SyncWindow() to
1661 * block until the changes have taken effect.
1662 *
1663 * When the window position changes, an SDL_EVENT_WINDOW_MOVED event will be
1664 * emitted with the window's new coordinates. Note that the new coordinates
1665 * may not match the exact coordinates requested, as some windowing systems
1666 * can restrict the position of the window in certain scenarios (e.g.
1667 * constraining the position so the window is always within desktop bounds).
1668 * Additionally, as this is just a request, it can be denied by the windowing
1669 * system.
1670 *
1671 * \param window the window to reposition.
1672 * \param x the x coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
1673 * `SDL_WINDOWPOS_UNDEFINED`.
1674 * \param y the y coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
1675 * `SDL_WINDOWPOS_UNDEFINED`.
1676 * \returns true on success or false on failure; call SDL_GetError() for more
1677 * information.
1678 *
1679 * \threadsafety This function should only be called on the main thread.
1680 *
1681 * \since This function is available since SDL 3.2.0.
1682 *
1683 * \sa SDL_GetWindowPosition
1684 * \sa SDL_SyncWindow
1685 */
1686extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowPosition(SDL_Window *window, int x, int y);
1687
1688/**
1689 * Get the position of a window.
1690 *
1691 * This is the current position of the window as last reported by the
1692 * windowing system.
1693 *
1694 * If you do not need the value for one of the positions a NULL may be passed
1695 * in the `x` or `y` parameter.
1696 *
1697 * \param window the window to query.
1698 * \param x a pointer filled in with the x position of the window, may be
1699 * NULL.
1700 * \param y a pointer filled in with the y position of the window, may be
1701 * NULL.
1702 * \returns true on success or false on failure; call SDL_GetError() for more
1703 * information.
1704 *
1705 * \threadsafety This function should only be called on the main thread.
1706 *
1707 * \since This function is available since SDL 3.2.0.
1708 *
1709 * \sa SDL_SetWindowPosition
1710 */
1711extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowPosition(SDL_Window *window, int *x, int *y);
1712
1713/**
1714 * Request that the size of a window's client area be set.
1715 *
1716 * If the window is in a fullscreen or maximized state, this request has no
1717 * effect.
1718 *
1719 * To change the exclusive fullscreen mode of a window, use
1720 * SDL_SetWindowFullscreenMode().
1721 *
1722 * On some windowing systems, this request is asynchronous and the new window
1723 * size may not have have been applied immediately upon the return of this
1724 * function. If an immediate change is required, call SDL_SyncWindow() to
1725 * block until the changes have taken effect.
1726 *
1727 * When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will be
1728 * emitted with the new window dimensions. Note that the new dimensions may
1729 * not match the exact size requested, as some windowing systems can restrict
1730 * the window size in certain scenarios (e.g. constraining the size of the
1731 * content area to remain within the usable desktop bounds). Additionally, as
1732 * this is just a request, it can be denied by the windowing system.
1733 *
1734 * \param window the window to change.
1735 * \param w the width of the window, must be > 0.
1736 * \param h the height of the window, must be > 0.
1737 * \returns true on success or false on failure; call SDL_GetError() for more
1738 * information.
1739 *
1740 * \threadsafety This function should only be called on the main thread.
1741 *
1742 * \since This function is available since SDL 3.2.0.
1743 *
1744 * \sa SDL_GetWindowSize
1745 * \sa SDL_SetWindowFullscreenMode
1746 * \sa SDL_SyncWindow
1747 */
1748extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSize(SDL_Window *window, int w, int h);
1749
1750/**
1751 * Get the size of a window's client area.
1752 *
1753 * The window pixel size may differ from its window coordinate size if the
1754 * window is on a high pixel density display. Use SDL_GetWindowSizeInPixels()
1755 * or SDL_GetRenderOutputSize() to get the real client area size in pixels.
1756 *
1757 * \param window the window to query the width and height from.
1758 * \param w a pointer filled in with the width of the window, may be NULL.
1759 * \param h a pointer filled in with the height of the window, may be NULL.
1760 * \returns true on success or false on failure; call SDL_GetError() for more
1761 * information.
1762 *
1763 * \threadsafety This function should only be called on the main thread.
1764 *
1765 * \since This function is available since SDL 3.2.0.
1766 *
1767 * \sa SDL_GetRenderOutputSize
1768 * \sa SDL_GetWindowSizeInPixels
1769 * \sa SDL_SetWindowSize
1770 */
1771extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSize(SDL_Window *window, int *w, int *h);
1772
1773/**
1774 * Get the safe area for this window.
1775 *
1776 * Some devices have portions of the screen which are partially obscured or
1777 * not interactive, possibly due to on-screen controls, curved edges, camera
1778 * notches, TV overscan, etc. This function provides the area of the window
1779 * which is safe to have interactable content. You should continue rendering
1780 * into the rest of the window, but it should not contain visually important
1781 * or interactible content.
1782 *
1783 * \param window the window to query.
1784 * \param rect a pointer filled in with the client area that is safe for
1785 * interactive content.
1786 * \returns true on success or false on failure; call SDL_GetError() for more
1787 * information.
1788 *
1789 * \threadsafety This function should only be called on the main thread.
1790 *
1791 * \since This function is available since SDL 3.2.0.
1792 */
1793extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSafeArea(SDL_Window *window, SDL_Rect *rect);
1794
1795/**
1796 * Request that the aspect ratio of a window's client area be set.
1797 *
1798 * The aspect ratio is the ratio of width divided by height, e.g. 2560x1600
1799 * would be 1.6. Larger aspect ratios are wider and smaller aspect ratios are
1800 * narrower.
1801 *
1802 * If, at the time of this request, the window in a fixed-size state, such as
1803 * maximized or fullscreen, the request will be deferred until the window
1804 * exits this state and becomes resizable again.
1805 *
1806 * On some windowing systems, this request is asynchronous and the new window
1807 * aspect ratio may not have have been applied immediately upon the return of
1808 * this function. If an immediate change is required, call SDL_SyncWindow() to
1809 * block until the changes have taken effect.
1810 *
1811 * When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will be
1812 * emitted with the new window dimensions. Note that the new dimensions may
1813 * not match the exact aspect ratio requested, as some windowing systems can
1814 * restrict the window size in certain scenarios (e.g. constraining the size
1815 * of the content area to remain within the usable desktop bounds).
1816 * Additionally, as this is just a request, it can be denied by the windowing
1817 * system.
1818 *
1819 * \param window the window to change.
1820 * \param min_aspect the minimum aspect ratio of the window, or 0.0f for no
1821 * limit.
1822 * \param max_aspect the maximum aspect ratio of the window, or 0.0f for no
1823 * limit.
1824 * \returns true on success or false on failure; call SDL_GetError() for more
1825 * information.
1826 *
1827 * \threadsafety This function should only be called on the main thread.
1828 *
1829 * \since This function is available since SDL 3.2.0.
1830 *
1831 * \sa SDL_GetWindowAspectRatio
1832 * \sa SDL_SyncWindow
1833 */
1834extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAspectRatio(SDL_Window *window, float min_aspect, float max_aspect);
1835
1836/**
1837 * Get the size of a window's client area.
1838 *
1839 * \param window the window to query the width and height from.
1840 * \param min_aspect a pointer filled in with the minimum aspect ratio of the
1841 * window, may be NULL.
1842 * \param max_aspect a pointer filled in with the maximum aspect ratio of the
1843 * window, may be NULL.
1844 * \returns true on success or false on failure; call SDL_GetError() for more
1845 * information.
1846 *
1847 * \threadsafety This function should only be called on the main thread.
1848 *
1849 * \since This function is available since SDL 3.2.0.
1850 *
1851 * \sa SDL_SetWindowAspectRatio
1852 */
1853extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowAspectRatio(SDL_Window *window, float *min_aspect, float *max_aspect);
1854
1855/**
1856 * Get the size of a window's borders (decorations) around the client area.
1857 *
1858 * Note: If this function fails (returns false), the size values will be
1859 * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the
1860 * window in question was borderless.
1861 *
1862 * Note: This function may fail on systems where the window has not yet been
1863 * decorated by the display server (for example, immediately after calling
1864 * SDL_CreateWindow). It is recommended that you wait at least until the
1865 * window has been presented and composited, so that the window system has a
1866 * chance to decorate the window and provide the border dimensions to SDL.
1867 *
1868 * This function also returns false if getting the information is not
1869 * supported.
1870 *
1871 * \param window the window to query the size values of the border
1872 * (decorations) from.
1873 * \param top pointer to variable for storing the size of the top border; NULL
1874 * is permitted.
1875 * \param left pointer to variable for storing the size of the left border;
1876 * NULL is permitted.
1877 * \param bottom pointer to variable for storing the size of the bottom
1878 * border; NULL is permitted.
1879 * \param right pointer to variable for storing the size of the right border;
1880 * NULL is permitted.
1881 * \returns true on success or false on failure; call SDL_GetError() for more
1882 * information.
1883 *
1884 * \threadsafety This function should only be called on the main thread.
1885 *
1886 * \since This function is available since SDL 3.2.0.
1887 *
1888 * \sa SDL_GetWindowSize
1889 */
1890extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right);
1891
1892/**
1893 * Get the size of a window's client area, in pixels.
1894 *
1895 * \param window the window from which the drawable size should be queried.
1896 * \param w a pointer to variable for storing the width in pixels, may be
1897 * NULL.
1898 * \param h a pointer to variable for storing the height in pixels, may be
1899 * NULL.
1900 * \returns true on success or false on failure; call SDL_GetError() for more
1901 * information.
1902 *
1903 * \threadsafety This function should only be called on the main thread.
1904 *
1905 * \since This function is available since SDL 3.2.0.
1906 *
1907 * \sa SDL_CreateWindow
1908 * \sa SDL_GetWindowSize
1909 */
1910extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSizeInPixels(SDL_Window *window, int *w, int *h);
1911
1912/**
1913 * Set the minimum size of a window's client area.
1914 *
1915 * \param window the window to change.
1916 * \param min_w the minimum width of the window, or 0 for no limit.
1917 * \param min_h the minimum height of the window, or 0 for no limit.
1918 * \returns true on success or false on failure; call SDL_GetError() for more
1919 * information.
1920 *
1921 * \threadsafety This function should only be called on the main thread.
1922 *
1923 * \since This function is available since SDL 3.2.0.
1924 *
1925 * \sa SDL_GetWindowMinimumSize
1926 * \sa SDL_SetWindowMaximumSize
1927 */
1928extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window, int min_w, int min_h);
1929
1930/**
1931 * Get the minimum size of a window's client area.
1932 *
1933 * \param window the window to query.
1934 * \param w a pointer filled in with the minimum width of the window, may be
1935 * NULL.
1936 * \param h a pointer filled in with the minimum height of the window, may be
1937 * NULL.
1938 * \returns true on success or false on failure; call SDL_GetError() for more
1939 * information.
1940 *
1941 * \threadsafety This function should only be called on the main thread.
1942 *
1943 * \since This function is available since SDL 3.2.0.
1944 *
1945 * \sa SDL_GetWindowMaximumSize
1946 * \sa SDL_SetWindowMinimumSize
1947 */
1948extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window, int *w, int *h);
1949
1950/**
1951 * Set the maximum size of a window's client area.
1952 *
1953 * \param window the window to change.
1954 * \param max_w the maximum width of the window, or 0 for no limit.
1955 * \param max_h the maximum height of the window, or 0 for no limit.
1956 * \returns true on success or false on failure; call SDL_GetError() for more
1957 * information.
1958 *
1959 * \threadsafety This function should only be called on the main thread.
1960 *
1961 * \since This function is available since SDL 3.2.0.
1962 *
1963 * \sa SDL_GetWindowMaximumSize
1964 * \sa SDL_SetWindowMinimumSize
1965 */
1966extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window, int max_w, int max_h);
1967
1968/**
1969 * Get the maximum size of a window's client area.
1970 *
1971 * \param window the window to query.
1972 * \param w a pointer filled in with the maximum width of the window, may be
1973 * NULL.
1974 * \param h a pointer filled in with the maximum height of the window, may be
1975 * NULL.
1976 * \returns true on success or false on failure; call SDL_GetError() for more
1977 * information.
1978 *
1979 * \threadsafety This function should only be called on the main thread.
1980 *
1981 * \since This function is available since SDL 3.2.0.
1982 *
1983 * \sa SDL_GetWindowMinimumSize
1984 * \sa SDL_SetWindowMaximumSize
1985 */
1986extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window, int *w, int *h);
1987
1988/**
1989 * Set the border state of a window.
1990 *
1991 * This will add or remove the window's `SDL_WINDOW_BORDERLESS` flag and add
1992 * or remove the border from the actual window. This is a no-op if the
1993 * window's border already matches the requested state.
1994 *
1995 * You can't change the border state of a fullscreen window.
1996 *
1997 * \param window the window of which to change the border state.
1998 * \param bordered false to remove border, true to add border.
1999 * \returns true on success or false on failure; call SDL_GetError() for more
2000 * information.
2001 *
2002 * \threadsafety This function should only be called on the main thread.
2003 *
2004 * \since This function is available since SDL 3.2.0.
2005 *
2006 * \sa SDL_GetWindowFlags
2007 */
2008extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowBordered(SDL_Window *window, bool bordered);
2009
2010/**
2011 * Set the user-resizable state of a window.
2012 *
2013 * This will add or remove the window's `SDL_WINDOW_RESIZABLE` flag and
2014 * allow/disallow user resizing of the window. This is a no-op if the window's
2015 * resizable state already matches the requested state.
2016 *
2017 * You can't change the resizable state of a fullscreen window.
2018 *
2019 * \param window the window of which to change the resizable state.
2020 * \param resizable true to allow resizing, false to disallow.
2021 * \returns true on success or false on failure; call SDL_GetError() for more
2022 * information.
2023 *
2024 * \threadsafety This function should only be called on the main thread.
2025 *
2026 * \since This function is available since SDL 3.2.0.
2027 *
2028 * \sa SDL_GetWindowFlags
2029 */
2030extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowResizable(SDL_Window *window, bool resizable);
2031
2032/**
2033 * Set the window to always be above the others.
2034 *
2035 * This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP` flag. This
2036 * will bring the window to the front and keep the window above the rest.
2037 *
2038 * \param window the window of which to change the always on top state.
2039 * \param on_top true to set the window always on top, false to disable.
2040 * \returns true on success or false on failure; call SDL_GetError() for more
2041 * information.
2042 *
2043 * \threadsafety This function should only be called on the main thread.
2044 *
2045 * \since This function is available since SDL 3.2.0.
2046 *
2047 * \sa SDL_GetWindowFlags
2048 */
2049extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window *window, bool on_top);
2050
2051/**
2052 * Show a window.
2053 *
2054 * \param window the window to show.
2055 * \returns true on success or false on failure; call SDL_GetError() for more
2056 * information.
2057 *
2058 * \threadsafety This function should only be called on the main thread.
2059 *
2060 * \since This function is available since SDL 3.2.0.
2061 *
2062 * \sa SDL_HideWindow
2063 * \sa SDL_RaiseWindow
2064 */
2065extern SDL_DECLSPEC bool SDLCALL SDL_ShowWindow(SDL_Window *window);
2066
2067/**
2068 * Hide a window.
2069 *
2070 * \param window the window to hide.
2071 * \returns true on success or false on failure; call SDL_GetError() for more
2072 * information.
2073 *
2074 * \threadsafety This function should only be called on the main thread.
2075 *
2076 * \since This function is available since SDL 3.2.0.
2077 *
2078 * \sa SDL_ShowWindow
2079 * \sa SDL_WINDOW_HIDDEN
2080 */
2081extern SDL_DECLSPEC bool SDLCALL SDL_HideWindow(SDL_Window *window);
2082
2083/**
2084 * Request that a window be raised above other windows and gain the input
2085 * focus.
2086 *
2087 * The result of this request is subject to desktop window manager policy,
2088 * particularly if raising the requested window would result in stealing focus
2089 * from another application. If the window is successfully raised and gains
2090 * input focus, an SDL_EVENT_WINDOW_FOCUS_GAINED event will be emitted, and
2091 * the window will have the SDL_WINDOW_INPUT_FOCUS flag set.
2092 *
2093 * \param window the window to raise.
2094 * \returns true on success or false on failure; call SDL_GetError() for more
2095 * information.
2096 *
2097 * \threadsafety This function should only be called on the main thread.
2098 *
2099 * \since This function is available since SDL 3.2.0.
2100 */
2101extern SDL_DECLSPEC bool SDLCALL SDL_RaiseWindow(SDL_Window *window);
2102
2103/**
2104 * Request that the window be made as large as possible.
2105 *
2106 * Non-resizable windows can't be maximized. The window must have the
2107 * SDL_WINDOW_RESIZABLE flag set, or this will have no effect.
2108 *
2109 * On some windowing systems this request is asynchronous and the new window
2110 * state may not have have been applied immediately upon the return of this
2111 * function. If an immediate change is required, call SDL_SyncWindow() to
2112 * block until the changes have taken effect.
2113 *
2114 * When the window state changes, an SDL_EVENT_WINDOW_MAXIMIZED event will be
2115 * emitted. Note that, as this is just a request, the windowing system can
2116 * deny the state change.
2117 *
2118 * When maximizing a window, whether the constraints set via
2119 * SDL_SetWindowMaximumSize() are honored depends on the policy of the window
2120 * manager. Win32 and macOS enforce the constraints when maximizing, while X11
2121 * and Wayland window managers may vary.
2122 *
2123 * \param window the window to maximize.
2124 * \returns true on success or false on failure; call SDL_GetError() for more
2125 * information.
2126 *
2127 * \threadsafety This function should only be called on the main thread.
2128 *
2129 * \since This function is available since SDL 3.2.0.
2130 *
2131 * \sa SDL_MinimizeWindow
2132 * \sa SDL_RestoreWindow
2133 * \sa SDL_SyncWindow
2134 */
2135extern SDL_DECLSPEC bool SDLCALL SDL_MaximizeWindow(SDL_Window *window);
2136
2137/**
2138 * Request that the window be minimized to an iconic representation.
2139 *
2140 * If the window is in a fullscreen state, this request has no direct effect.
2141 * It may alter the state the window is returned to when leaving fullscreen.
2142 *
2143 * On some windowing systems this request is asynchronous and the new window
2144 * state may not have been applied immediately upon the return of this
2145 * function. If an immediate change is required, call SDL_SyncWindow() to
2146 * block until the changes have taken effect.
2147 *
2148 * When the window state changes, an SDL_EVENT_WINDOW_MINIMIZED event will be
2149 * emitted. Note that, as this is just a request, the windowing system can
2150 * deny the state change.
2151 *
2152 * \param window the window to minimize.
2153 * \returns true on success or false on failure; call SDL_GetError() for more
2154 * information.
2155 *
2156 * \threadsafety This function should only be called on the main thread.
2157 *
2158 * \since This function is available since SDL 3.2.0.
2159 *
2160 * \sa SDL_MaximizeWindow
2161 * \sa SDL_RestoreWindow
2162 * \sa SDL_SyncWindow
2163 */
2164extern SDL_DECLSPEC bool SDLCALL SDL_MinimizeWindow(SDL_Window *window);
2165
2166/**
2167 * Request that the size and position of a minimized or maximized window be
2168 * restored.
2169 *
2170 * If the window is in a fullscreen state, this request has no direct effect.
2171 * It may alter the state the window is returned to when leaving fullscreen.
2172 *
2173 * On some windowing systems this request is asynchronous and the new window
2174 * state may not have have been applied immediately upon the return of this
2175 * function. If an immediate change is required, call SDL_SyncWindow() to
2176 * block until the changes have taken effect.
2177 *
2178 * When the window state changes, an SDL_EVENT_WINDOW_RESTORED event will be
2179 * emitted. Note that, as this is just a request, the windowing system can
2180 * deny the state change.
2181 *
2182 * \param window the window to restore.
2183 * \returns true on success or false on failure; call SDL_GetError() for more
2184 * information.
2185 *
2186 * \threadsafety This function should only be called on the main thread.
2187 *
2188 * \since This function is available since SDL 3.2.0.
2189 *
2190 * \sa SDL_MaximizeWindow
2191 * \sa SDL_MinimizeWindow
2192 * \sa SDL_SyncWindow
2193 */
2194extern SDL_DECLSPEC bool SDLCALL SDL_RestoreWindow(SDL_Window *window);
2195
2196/**
2197 * Request that the window's fullscreen state be changed.
2198 *
2199 * By default a window in fullscreen state uses borderless fullscreen desktop
2200 * mode, but a specific exclusive display mode can be set using
2201 * SDL_SetWindowFullscreenMode().
2202 *
2203 * On some windowing systems this request is asynchronous and the new
2204 * fullscreen state may not have have been applied immediately upon the return
2205 * of this function. If an immediate change is required, call SDL_SyncWindow()
2206 * to block until the changes have taken effect.
2207 *
2208 * When the window state changes, an SDL_EVENT_WINDOW_ENTER_FULLSCREEN or
2209 * SDL_EVENT_WINDOW_LEAVE_FULLSCREEN event will be emitted. Note that, as this
2210 * is just a request, it can be denied by the windowing system.
2211 *
2212 * \param window the window to change.
2213 * \param fullscreen true for fullscreen mode, false for windowed mode.
2214 * \returns true on success or false on failure; call SDL_GetError() for more
2215 * information.
2216 *
2217 * \threadsafety This function should only be called on the main thread.
2218 *
2219 * \since This function is available since SDL 3.2.0.
2220 *
2221 * \sa SDL_GetWindowFullscreenMode
2222 * \sa SDL_SetWindowFullscreenMode
2223 * \sa SDL_SyncWindow
2224 * \sa SDL_WINDOW_FULLSCREEN
2225 */
2226extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, bool fullscreen);
2227
2228/**
2229 * Block until any pending window state is finalized.
2230 *
2231 * On asynchronous windowing systems, this acts as a synchronization barrier
2232 * for pending window state. It will attempt to wait until any pending window
2233 * state has been applied and is guaranteed to return within finite time. Note
2234 * that for how long it can potentially block depends on the underlying window
2235 * system, as window state changes may involve somewhat lengthy animations
2236 * that must complete before the window is in its final requested state.
2237 *
2238 * On windowing systems where changes are immediate, this does nothing.
2239 *
2240 * \param window the window for which to wait for the pending state to be
2241 * applied.
2242 * \returns true on success or false if the operation timed out before the
2243 * window was in the requested state.
2244 *
2245 * \threadsafety This function should only be called on the main thread.
2246 *
2247 * \since This function is available since SDL 3.2.0.
2248 *
2249 * \sa SDL_SetWindowSize
2250 * \sa SDL_SetWindowPosition
2251 * \sa SDL_SetWindowFullscreen
2252 * \sa SDL_MinimizeWindow
2253 * \sa SDL_MaximizeWindow
2254 * \sa SDL_RestoreWindow
2255 * \sa SDL_HINT_VIDEO_SYNC_WINDOW_OPERATIONS
2256 */
2257extern SDL_DECLSPEC bool SDLCALL SDL_SyncWindow(SDL_Window *window);
2258
2259/**
2260 * Return whether the window has a surface associated with it.
2261 *
2262 * \param window the window to query.
2263 * \returns true if there is a surface associated with the window, or false
2264 * otherwise.
2265 *
2266 * \threadsafety This function should only be called on the main thread.
2267 *
2268 * \since This function is available since SDL 3.2.0.
2269 *
2270 * \sa SDL_GetWindowSurface
2271 */
2272extern SDL_DECLSPEC bool SDLCALL SDL_WindowHasSurface(SDL_Window *window);
2273
2274/**
2275 * Get the SDL surface associated with the window.
2276 *
2277 * A new surface will be created with the optimal format for the window, if
2278 * necessary. This surface will be freed when the window is destroyed. Do not
2279 * free this surface.
2280 *
2281 * This surface will be invalidated if the window is resized. After resizing a
2282 * window this function must be called again to return a valid surface.
2283 *
2284 * You may not combine this with 3D or the rendering API on this window.
2285 *
2286 * This function is affected by `SDL_HINT_FRAMEBUFFER_ACCELERATION`.
2287 *
2288 * \param window the window to query.
2289 * \returns the surface associated with the window, or NULL on failure; call
2290 * SDL_GetError() for more information.
2291 *
2292 * \threadsafety This function should only be called on the main thread.
2293 *
2294 * \since This function is available since SDL 3.2.0.
2295 *
2296 * \sa SDL_DestroyWindowSurface
2297 * \sa SDL_WindowHasSurface
2298 * \sa SDL_UpdateWindowSurface
2299 * \sa SDL_UpdateWindowSurfaceRects
2300 */
2301extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window *window);
2302
2303/**
2304 * Toggle VSync for the window surface.
2305 *
2306 * When a window surface is created, vsync defaults to
2307 * SDL_WINDOW_SURFACE_VSYNC_DISABLED.
2308 *
2309 * The `vsync` parameter can be 1 to synchronize present with every vertical
2310 * refresh, 2 to synchronize present with every second vertical refresh, etc.,
2311 * SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync),
2312 * or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is
2313 * supported by every driver, so you should check the return value to see
2314 * whether the requested setting is supported.
2315 *
2316 * \param window the window.
2317 * \param vsync the vertical refresh sync interval.
2318 * \returns true on success or false on failure; call SDL_GetError() for more
2319 * information.
2320 *
2321 * \threadsafety This function should only be called on the main thread.
2322 *
2323 * \since This function is available since SDL 3.2.0.
2324 *
2325 * \sa SDL_GetWindowSurfaceVSync
2326 */
2327extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSurfaceVSync(SDL_Window *window, int vsync);
2328
2329#define SDL_WINDOW_SURFACE_VSYNC_DISABLED 0
2330#define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE (-1)
2331
2332/**
2333 * Get VSync for the window surface.
2334 *
2335 * \param window the window to query.
2336 * \param vsync an int filled with the current vertical refresh sync interval.
2337 * See SDL_SetWindowSurfaceVSync() for the meaning of the value.
2338 * \returns true on success or false on failure; call SDL_GetError() for more
2339 * information.
2340 *
2341 * \threadsafety This function should only be called on the main thread.
2342 *
2343 * \since This function is available since SDL 3.2.0.
2344 *
2345 * \sa SDL_SetWindowSurfaceVSync
2346 */
2347extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSurfaceVSync(SDL_Window *window, int *vsync);
2348
2349/**
2350 * Copy the window surface to the screen.
2351 *
2352 * This is the function you use to reflect any changes to the surface on the
2353 * screen.
2354 *
2355 * This function is equivalent to the SDL 1.2 API SDL_Flip().
2356 *
2357 * \param window the window to update.
2358 * \returns true on success or false on failure; call SDL_GetError() for more
2359 * information.
2360 *
2361 * \threadsafety This function should only be called on the main thread.
2362 *
2363 * \since This function is available since SDL 3.2.0.
2364 *
2365 * \sa SDL_GetWindowSurface
2366 * \sa SDL_UpdateWindowSurfaceRects
2367 */
2368extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurface(SDL_Window *window);
2369
2370/**
2371 * Copy areas of the window surface to the screen.
2372 *
2373 * This is the function you use to reflect changes to portions of the surface
2374 * on the screen.
2375 *
2376 * This function is equivalent to the SDL 1.2 API SDL_UpdateRects().
2377 *
2378 * Note that this function will update _at least_ the rectangles specified,
2379 * but this is only intended as an optimization; in practice, this might
2380 * update more of the screen (or all of the screen!), depending on what method
2381 * SDL uses to send pixels to the system.
2382 *
2383 * \param window the window to update.
2384 * \param rects an array of SDL_Rect structures representing areas of the
2385 * surface to copy, in pixels.
2386 * \param numrects the number of rectangles.
2387 * \returns true on success or false on failure; call SDL_GetError() for more
2388 * information.
2389 *
2390 * \threadsafety This function should only be called on the main thread.
2391 *
2392 * \since This function is available since SDL 3.2.0.
2393 *
2394 * \sa SDL_GetWindowSurface
2395 * \sa SDL_UpdateWindowSurface
2396 */
2397extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects);
2398
2399/**
2400 * Destroy the surface associated with the window.
2401 *
2402 * \param window the window to update.
2403 * \returns true on success or false on failure; call SDL_GetError() for more
2404 * information.
2405 *
2406 * \threadsafety This function should only be called on the main thread.
2407 *
2408 * \since This function is available since SDL 3.2.0.
2409 *
2410 * \sa SDL_GetWindowSurface
2411 * \sa SDL_WindowHasSurface
2412 */
2413extern SDL_DECLSPEC bool SDLCALL SDL_DestroyWindowSurface(SDL_Window *window);
2414
2415/**
2416 * Set a window's keyboard grab mode.
2417 *
2418 * Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or
2419 * the Meta/Super key. Note that not all system keyboard shortcuts can be
2420 * captured by applications (one example is Ctrl+Alt+Del on Windows).
2421 *
2422 * This is primarily intended for specialized applications such as VNC clients
2423 * or VM frontends. Normal games should not use keyboard grab.
2424 *
2425 * When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the
2426 * window is full-screen to ensure the user is not trapped in your
2427 * application. If you have a custom keyboard shortcut to exit fullscreen
2428 * mode, you may suppress this behavior with
2429 * `SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED`.
2430 *
2431 * If the caller enables a grab while another window is currently grabbed, the
2432 * other window loses its grab in favor of the caller's window.
2433 *
2434 * \param window the window for which the keyboard grab mode should be set.
2435 * \param grabbed this is true to grab keyboard, and false to release.
2436 * \returns true on success or false on failure; call SDL_GetError() for more
2437 * information.
2438 *
2439 * \threadsafety This function should only be called on the main thread.
2440 *
2441 * \since This function is available since SDL 3.2.0.
2442 *
2443 * \sa SDL_GetWindowKeyboardGrab
2444 * \sa SDL_SetWindowMouseGrab
2445 */
2446extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window *window, bool grabbed);
2447
2448/**
2449 * Set a window's mouse grab mode.
2450 *
2451 * Mouse grab confines the mouse cursor to the window.
2452 *
2453 * \param window the window for which the mouse grab mode should be set.
2454 * \param grabbed this is true to grab mouse, and false to release.
2455 * \returns true on success or false on failure; call SDL_GetError() for more
2456 * information.
2457 *
2458 * \threadsafety This function should only be called on the main thread.
2459 *
2460 * \since This function is available since SDL 3.2.0.
2461 *
2462 * \sa SDL_GetWindowMouseRect
2463 * \sa SDL_SetWindowMouseRect
2464 * \sa SDL_SetWindowMouseGrab
2465 * \sa SDL_SetWindowKeyboardGrab
2466 */
2467extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMouseGrab(SDL_Window *window, bool grabbed);
2468
2469/**
2470 * Get a window's keyboard grab mode.
2471 *
2472 * \param window the window to query.
2473 * \returns true if keyboard is grabbed, and false otherwise.
2474 *
2475 * \threadsafety This function should only be called on the main thread.
2476 *
2477 * \since This function is available since SDL 3.2.0.
2478 *
2479 * \sa SDL_SetWindowKeyboardGrab
2480 */
2481extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window *window);
2482
2483/**
2484 * Get a window's mouse grab mode.
2485 *
2486 * \param window the window to query.
2487 * \returns true if mouse is grabbed, and false otherwise.
2488 *
2489 * \threadsafety This function should only be called on the main thread.
2490 *
2491 * \since This function is available since SDL 3.2.0.
2492 *
2493 * \sa SDL_GetWindowMouseRect
2494 * \sa SDL_SetWindowMouseRect
2495 * \sa SDL_SetWindowMouseGrab
2496 * \sa SDL_SetWindowKeyboardGrab
2497 */
2498extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMouseGrab(SDL_Window *window);
2499
2500/**
2501 * Get the window that currently has an input grab enabled.
2502 *
2503 * \returns the window if input is grabbed or NULL otherwise.
2504 *
2505 * \threadsafety This function should only be called on the main thread.
2506 *
2507 * \since This function is available since SDL 3.2.0.
2508 *
2509 * \sa SDL_SetWindowMouseGrab
2510 * \sa SDL_SetWindowKeyboardGrab
2511 */
2512extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void);
2513
2514/**
2515 * Confines the cursor to the specified area of a window.
2516 *
2517 * Note that this does NOT grab the cursor, it only defines the area a cursor
2518 * is restricted to when the window has mouse focus.
2519 *
2520 * \param window the window that will be associated with the barrier.
2521 * \param rect a rectangle area in window-relative coordinates. If NULL the
2522 * barrier for the specified window will be destroyed.
2523 * \returns true on success or false on failure; call SDL_GetError() for more
2524 * information.
2525 *
2526 * \threadsafety This function should only be called on the main thread.
2527 *
2528 * \since This function is available since SDL 3.2.0.
2529 *
2530 * \sa SDL_GetWindowMouseRect
2531 * \sa SDL_GetWindowMouseGrab
2532 * \sa SDL_SetWindowMouseGrab
2533 */
2534extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect);
2535
2536/**
2537 * Get the mouse confinement rectangle of a window.
2538 *
2539 * \param window the window to query.
2540 * \returns a pointer to the mouse confinement rectangle of a window, or NULL
2541 * if there isn't one.
2542 *
2543 * \threadsafety This function should only be called on the main thread.
2544 *
2545 * \since This function is available since SDL 3.2.0.
2546 *
2547 * \sa SDL_SetWindowMouseRect
2548 * \sa SDL_GetWindowMouseGrab
2549 * \sa SDL_SetWindowMouseGrab
2550 */
2551extern SDL_DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window *window);
2552
2553/**
2554 * Set the opacity for a window.
2555 *
2556 * The parameter `opacity` will be clamped internally between 0.0f
2557 * (transparent) and 1.0f (opaque).
2558 *
2559 * This function also returns false if setting the opacity isn't supported.
2560 *
2561 * \param window the window which will be made transparent or opaque.
2562 * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque).
2563 * \returns true on success or false on failure; call SDL_GetError() for more
2564 * information.
2565 *
2566 * \threadsafety This function should only be called on the main thread.
2567 *
2568 * \since This function is available since SDL 3.2.0.
2569 *
2570 * \sa SDL_GetWindowOpacity
2571 */
2572extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowOpacity(SDL_Window *window, float opacity);
2573
2574/**
2575 * Get the opacity of a window.
2576 *
2577 * If transparency isn't supported on this platform, opacity will be returned
2578 * as 1.0f without error.
2579 *
2580 * \param window the window to get the current opacity value from.
2581 * \returns the opacity, (0.0f - transparent, 1.0f - opaque), or -1.0f on
2582 * failure; call SDL_GetError() for more information.
2583 *
2584 * \threadsafety This function should only be called on the main thread.
2585 *
2586 * \since This function is available since SDL 3.2.0.
2587 *
2588 * \sa SDL_SetWindowOpacity
2589 */
2590extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window);
2591
2592/**
2593 * Set the window as a child of a parent window.
2594 *
2595 * If the window is already the child of an existing window, it will be
2596 * reparented to the new owner. Setting the parent window to NULL unparents
2597 * the window and removes child window status.
2598 *
2599 * If a parent window is hidden or destroyed, the operation will be
2600 * recursively applied to child windows. Child windows hidden with the parent
2601 * that did not have their hidden status explicitly set will be restored when
2602 * the parent is shown.
2603 *
2604 * Attempting to set the parent of a window that is currently in the modal
2605 * state will fail. Use SDL_SetWindowModal() to cancel the modal status before
2606 * attempting to change the parent.
2607 *
2608 * Popup windows cannot change parents and attempts to do so will fail.
2609 *
2610 * Setting a parent window that is currently the sibling or descendent of the
2611 * child window results in undefined behavior.
2612 *
2613 * \param window the window that should become the child of a parent.
2614 * \param parent the new parent window for the child window.
2615 * \returns true on success or false on failure; call SDL_GetError() for more
2616 * information.
2617 *
2618 * \threadsafety This function should only be called on the main thread.
2619 *
2620 * \since This function is available since SDL 3.2.0.
2621 *
2622 * \sa SDL_SetWindowModal
2623 */
2624extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowParent(SDL_Window *window, SDL_Window *parent);
2625
2626/**
2627 * Toggle the state of the window as modal.
2628 *
2629 * To enable modal status on a window, the window must currently be the child
2630 * window of a parent, or toggling modal status on will fail.
2631 *
2632 * \param window the window on which to set the modal state.
2633 * \param modal true to toggle modal status on, false to toggle it off.
2634 * \returns true on success or false on failure; call SDL_GetError() for more
2635 * information.
2636 *
2637 * \threadsafety This function should only be called on the main thread.
2638 *
2639 * \since This function is available since SDL 3.2.0.
2640 *
2641 * \sa SDL_SetWindowParent
2642 * \sa SDL_WINDOW_MODAL
2643 */
2644extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowModal(SDL_Window *window, bool modal);
2645
2646/**
2647 * Set whether the window may have input focus.
2648 *
2649 * \param window the window to set focusable state.
2650 * \param focusable true to allow input focus, false to not allow input focus.
2651 * \returns true on success or false on failure; call SDL_GetError() for more
2652 * information.
2653 *
2654 * \threadsafety This function should only be called on the main thread.
2655 *
2656 * \since This function is available since SDL 3.2.0.
2657 */
2658extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFocusable(SDL_Window *window, bool focusable);
2659
2660
2661/**
2662 * Display the system-level window menu.
2663 *
2664 * This default window menu is provided by the system and on some platforms
2665 * provides functionality for setting or changing privileged state on the
2666 * window, such as moving it between workspaces or displays, or toggling the
2667 * always-on-top property.
2668 *
2669 * On platforms or desktops where this is unsupported, this function does
2670 * nothing.
2671 *
2672 * \param window the window for which the menu will be displayed.
2673 * \param x the x coordinate of the menu, relative to the origin (top-left) of
2674 * the client area.
2675 * \param y the y coordinate of the menu, relative to the origin (top-left) of
2676 * the client area.
2677 * \returns true on success or false on failure; call SDL_GetError() for more
2678 * information.
2679 *
2680 * \threadsafety This function should only be called on the main thread.
2681 *
2682 * \since This function is available since SDL 3.2.0.
2683 */
2684extern SDL_DECLSPEC bool SDLCALL SDL_ShowWindowSystemMenu(SDL_Window *window, int x, int y);
2685
2686/**
2687 * Possible return values from the SDL_HitTest callback.
2688 *
2689 * \threadsafety This function should only be called on the main thread.
2690 *
2691 * \since This enum is available since SDL 3.2.0.
2692 *
2693 * \sa SDL_HitTest
2694 */
2695typedef enum SDL_HitTestResult
2696{
2697 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
2698 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
2699 SDL_HITTEST_RESIZE_TOPLEFT, /**< Region is the resizable top-left corner border. */
2700 SDL_HITTEST_RESIZE_TOP, /**< Region is the resizable top border. */
2701 SDL_HITTEST_RESIZE_TOPRIGHT, /**< Region is the resizable top-right corner border. */
2702 SDL_HITTEST_RESIZE_RIGHT, /**< Region is the resizable right border. */
2703 SDL_HITTEST_RESIZE_BOTTOMRIGHT, /**< Region is the resizable bottom-right corner border. */
2704 SDL_HITTEST_RESIZE_BOTTOM, /**< Region is the resizable bottom border. */
2705 SDL_HITTEST_RESIZE_BOTTOMLEFT, /**< Region is the resizable bottom-left corner border. */
2706 SDL_HITTEST_RESIZE_LEFT /**< Region is the resizable left border. */
2707} SDL_HitTestResult;
2708
2709/**
2710 * Callback used for hit-testing.
2711 *
2712 * \param win the SDL_Window where hit-testing was set on.
2713 * \param area an SDL_Point which should be hit-tested.
2714 * \param data what was passed as `callback_data` to SDL_SetWindowHitTest().
2715 * \returns an SDL_HitTestResult value.
2716 *
2717 * \sa SDL_SetWindowHitTest
2718 */
2719typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
2720 const SDL_Point *area,
2721 void *data);
2722
2723/**
2724 * Provide a callback that decides if a window region has special properties.
2725 *
2726 * Normally windows are dragged and resized by decorations provided by the
2727 * system window manager (a title bar, borders, etc), but for some apps, it
2728 * makes sense to drag them from somewhere else inside the window itself; for
2729 * example, one might have a borderless window that wants to be draggable from
2730 * any part, or simulate its own title bar, etc.
2731 *
2732 * This function lets the app provide a callback that designates pieces of a
2733 * given window as special. This callback is run during event processing if we
2734 * need to tell the OS to treat a region of the window specially; the use of
2735 * this callback is known as "hit testing."
2736 *
2737 * Mouse input may not be delivered to your application if it is within a
2738 * special area; the OS will often apply that input to moving the window or
2739 * resizing the window and not deliver it to the application.
2740 *
2741 * Specifying NULL for a callback disables hit-testing. Hit-testing is
2742 * disabled by default.
2743 *
2744 * Platforms that don't support this functionality will return false
2745 * unconditionally, even if you're attempting to disable hit-testing.
2746 *
2747 * Your callback may fire at any time, and its firing does not indicate any
2748 * specific behavior (for example, on Windows, this certainly might fire when
2749 * the OS is deciding whether to drag your window, but it fires for lots of
2750 * other reasons, too, some unrelated to anything you probably care about _and
2751 * when the mouse isn't actually at the location it is testing_). Since this
2752 * can fire at any time, you should try to keep your callback efficient,
2753 * devoid of allocations, etc.
2754 *
2755 * \param window the window to set hit-testing on.
2756 * \param callback the function to call when doing a hit-test.
2757 * \param callback_data an app-defined void pointer passed to **callback**.
2758 * \returns true on success or false on failure; call SDL_GetError() for more
2759 * information.
2760 *
2761 * \threadsafety This function should only be called on the main thread.
2762 *
2763 * \since This function is available since SDL 3.2.0.
2764 */
2765extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data);
2766
2767/**
2768 * Set the shape of a transparent window.
2769 *
2770 * This sets the alpha channel of a transparent window and any fully
2771 * transparent areas are also transparent to mouse clicks. If you are using
2772 * something besides the SDL render API, then you are responsible for drawing
2773 * the alpha channel of the window to match the shape alpha channel to get
2774 * consistent cross-platform results.
2775 *
2776 * The shape is copied inside this function, so you can free it afterwards. If
2777 * your shape surface changes, you should call SDL_SetWindowShape() again to
2778 * update the window. This is an expensive operation, so should be done
2779 * sparingly.
2780 *
2781 * The window must have been created with the SDL_WINDOW_TRANSPARENT flag.
2782 *
2783 * \param window the window.
2784 * \param shape the surface representing the shape of the window, or NULL to
2785 * remove any current shape.
2786 * \returns true on success or false on failure; call SDL_GetError() for more
2787 * information.
2788 *
2789 * \threadsafety This function should only be called on the main thread.
2790 *
2791 * \since This function is available since SDL 3.2.0.
2792 */
2793extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surface *shape);
2794
2795/**
2796 * Request a window to demand attention from the user.
2797 *
2798 * \param window the window to be flashed.
2799 * \param operation the operation to perform.
2800 * \returns true on success or false on failure; call SDL_GetError() for more
2801 * information.
2802 *
2803 * \threadsafety This function should only be called on the main thread.
2804 *
2805 * \since This function is available since SDL 3.2.0.
2806 */
2807extern SDL_DECLSPEC bool SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation);
2808
2809/**
2810 * Destroy a window.
2811 *
2812 * Any child windows owned by the window will be recursively destroyed as
2813 * well.
2814 *
2815 * Note that on some platforms, the visible window may not actually be removed
2816 * from the screen until the SDL event loop is pumped again, even though the
2817 * SDL_Window is no longer valid after this call.
2818 *
2819 * \param window the window to destroy.
2820 *
2821 * \threadsafety This function should only be called on the main thread.
2822 *
2823 * \since This function is available since SDL 3.2.0.
2824 *
2825 * \sa SDL_CreatePopupWindow
2826 * \sa SDL_CreateWindow
2827 * \sa SDL_CreateWindowWithProperties
2828 */
2829extern SDL_DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window *window);
2830
2831
2832/**
2833 * Check whether the screensaver is currently enabled.
2834 *
2835 * The screensaver is disabled by default.
2836 *
2837 * The default can also be changed using `SDL_HINT_VIDEO_ALLOW_SCREENSAVER`.
2838 *
2839 * \returns true if the screensaver is enabled, false if it is disabled.
2840 *
2841 * \threadsafety This function should only be called on the main thread.
2842 *
2843 * \since This function is available since SDL 3.2.0.
2844 *
2845 * \sa SDL_DisableScreenSaver
2846 * \sa SDL_EnableScreenSaver
2847 */
2848extern SDL_DECLSPEC bool SDLCALL SDL_ScreenSaverEnabled(void);
2849
2850/**
2851 * Allow the screen to be blanked by a screen saver.
2852 *
2853 * \returns true on success or false on failure; call SDL_GetError() for more
2854 * information.
2855 *
2856 * \threadsafety This function should only be called on the main thread.
2857 *
2858 * \since This function is available since SDL 3.2.0.
2859 *
2860 * \sa SDL_DisableScreenSaver
2861 * \sa SDL_ScreenSaverEnabled
2862 */
2863extern SDL_DECLSPEC bool SDLCALL SDL_EnableScreenSaver(void);
2864
2865/**
2866 * Prevent the screen from being blanked by a screen saver.
2867 *
2868 * If you disable the screensaver, it is automatically re-enabled when SDL
2869 * quits.
2870 *
2871 * The screensaver is disabled by default, but this may by changed by
2872 * SDL_HINT_VIDEO_ALLOW_SCREENSAVER.
2873 *
2874 * \returns true on success or false on failure; call SDL_GetError() for more
2875 * information.
2876 *
2877 * \threadsafety This function should only be called on the main thread.
2878 *
2879 * \since This function is available since SDL 3.2.0.
2880 *
2881 * \sa SDL_EnableScreenSaver
2882 * \sa SDL_ScreenSaverEnabled
2883 */
2884extern SDL_DECLSPEC bool SDLCALL SDL_DisableScreenSaver(void);
2885
2886
2887/**
2888 * \name OpenGL support functions
2889 */
2890/* @{ */
2891
2892/**
2893 * Dynamically load an OpenGL library.
2894 *
2895 * This should be done after initializing the video driver, but before
2896 * creating any OpenGL windows. If no OpenGL library is loaded, the default
2897 * library will be loaded upon creation of the first OpenGL window.
2898 *
2899 * If you do this, you need to retrieve all of the GL functions used in your
2900 * program from the dynamic library using SDL_GL_GetProcAddress().
2901 *
2902 * \param path the platform dependent OpenGL library name, or NULL to open the
2903 * default OpenGL library.
2904 * \returns true on success or false on failure; call SDL_GetError() for more
2905 * information.
2906 *
2907 * \threadsafety This function should only be called on the main thread.
2908 *
2909 * \since This function is available since SDL 3.2.0.
2910 *
2911 * \sa SDL_GL_GetProcAddress
2912 * \sa SDL_GL_UnloadLibrary
2913 */
2914extern SDL_DECLSPEC bool SDLCALL SDL_GL_LoadLibrary(const char *path);
2915
2916/**
2917 * Get an OpenGL function by name.
2918 *
2919 * If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all
2920 * GL functions must be retrieved this way. Usually this is used to retrieve
2921 * function pointers to OpenGL extensions.
2922 *
2923 * There are some quirks to looking up OpenGL functions that require some
2924 * extra care from the application. If you code carefully, you can handle
2925 * these quirks without any platform-specific code, though:
2926 *
2927 * - On Windows, function pointers are specific to the current GL context;
2928 * this means you need to have created a GL context and made it current
2929 * before calling SDL_GL_GetProcAddress(). If you recreate your context or
2930 * create a second context, you should assume that any existing function
2931 * pointers aren't valid to use with it. This is (currently) a
2932 * Windows-specific limitation, and in practice lots of drivers don't suffer
2933 * this limitation, but it is still the way the wgl API is documented to
2934 * work and you should expect crashes if you don't respect it. Store a copy
2935 * of the function pointers that comes and goes with context lifespan.
2936 * - On X11, function pointers returned by this function are valid for any
2937 * context, and can even be looked up before a context is created at all.
2938 * This means that, for at least some common OpenGL implementations, if you
2939 * look up a function that doesn't exist, you'll get a non-NULL result that
2940 * is _NOT_ safe to call. You must always make sure the function is actually
2941 * available for a given GL context before calling it, by checking for the
2942 * existence of the appropriate extension with SDL_GL_ExtensionSupported(),
2943 * or verifying that the version of OpenGL you're using offers the function
2944 * as core functionality.
2945 * - Some OpenGL drivers, on all platforms, *will* return NULL if a function
2946 * isn't supported, but you can't count on this behavior. Check for
2947 * extensions you use, and if you get a NULL anyway, act as if that
2948 * extension wasn't available. This is probably a bug in the driver, but you
2949 * can code defensively for this scenario anyhow.
2950 * - Just because you're on Linux/Unix, don't assume you'll be using X11.
2951 * Next-gen display servers are waiting to replace it, and may or may not
2952 * make the same promises about function pointers.
2953 * - OpenGL function pointers must be declared `APIENTRY` as in the example
2954 * code. This will ensure the proper calling convention is followed on
2955 * platforms where this matters (Win32) thereby avoiding stack corruption.
2956 *
2957 * \param proc the name of an OpenGL function.
2958 * \returns a pointer to the named OpenGL function. The returned pointer
2959 * should be cast to the appropriate function signature.
2960 *
2961 * \threadsafety This function should only be called on the main thread.
2962 *
2963 * \since This function is available since SDL 3.2.0.
2964 *
2965 * \sa SDL_GL_ExtensionSupported
2966 * \sa SDL_GL_LoadLibrary
2967 * \sa SDL_GL_UnloadLibrary
2968 */
2969extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_GL_GetProcAddress(const char *proc);
2970
2971/**
2972 * Get an EGL library function by name.
2973 *
2974 * If an EGL library is loaded, this function allows applications to get entry
2975 * points for EGL functions. This is useful to provide to an EGL API and
2976 * extension loader.
2977 *
2978 * \param proc the name of an EGL function.
2979 * \returns a pointer to the named EGL function. The returned pointer should
2980 * be cast to the appropriate function signature.
2981 *
2982 * \threadsafety This function should only be called on the main thread.
2983 *
2984 * \since This function is available since SDL 3.2.0.
2985 *
2986 * \sa SDL_EGL_GetCurrentDisplay
2987 */
2988extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_EGL_GetProcAddress(const char *proc);
2989
2990/**
2991 * Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
2992 *
2993 * \threadsafety This function should only be called on the main thread.
2994 *
2995 * \since This function is available since SDL 3.2.0.
2996 *
2997 * \sa SDL_GL_LoadLibrary
2998 */
2999extern SDL_DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
3000
3001/**
3002 * Check if an OpenGL extension is supported for the current context.
3003 *
3004 * This function operates on the current GL context; you must have created a
3005 * context and it must be current before calling this function. Do not assume
3006 * that all contexts you create will have the same set of extensions
3007 * available, or that recreating an existing context will offer the same
3008 * extensions again.
3009 *
3010 * While it's probably not a massive overhead, this function is not an O(1)
3011 * operation. Check the extensions you care about after creating the GL
3012 * context and save that information somewhere instead of calling the function
3013 * every time you need to know.
3014 *
3015 * \param extension the name of the extension to check.
3016 * \returns true if the extension is supported, false otherwise.
3017 *
3018 * \threadsafety This function should only be called on the main thread.
3019 *
3020 * \since This function is available since SDL 3.2.0.
3021 */
3022extern SDL_DECLSPEC bool SDLCALL SDL_GL_ExtensionSupported(const char *extension);
3023
3024/**
3025 * Reset all previously set OpenGL context attributes to their default values.
3026 *
3027 * \threadsafety This function should only be called on the main thread.
3028 *
3029 * \since This function is available since SDL 3.2.0.
3030 *
3031 * \sa SDL_GL_GetAttribute
3032 * \sa SDL_GL_SetAttribute
3033 */
3034extern SDL_DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
3035
3036/**
3037 * Set an OpenGL window attribute before window creation.
3038 *
3039 * This function sets the OpenGL attribute `attr` to `value`. The requested
3040 * attributes should be set before creating an OpenGL window. You should use
3041 * SDL_GL_GetAttribute() to check the values after creating the OpenGL
3042 * context, since the values obtained can differ from the requested ones.
3043 *
3044 * \param attr an SDL_GLAttr enum value specifying the OpenGL attribute to
3045 * set.
3046 * \param value the desired value for the attribute.
3047 * \returns true on success or false on failure; call SDL_GetError() for more
3048 * information.
3049 *
3050 * \threadsafety This function should only be called on the main thread.
3051 *
3052 * \since This function is available since SDL 3.2.0.
3053 *
3054 * \sa SDL_GL_GetAttribute
3055 * \sa SDL_GL_ResetAttributes
3056 */
3057extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetAttribute(SDL_GLAttr attr, int value);
3058
3059/**
3060 * Get the actual value for an attribute from the current context.
3061 *
3062 * \param attr an SDL_GLAttr enum value specifying the OpenGL attribute to
3063 * get.
3064 * \param value a pointer filled in with the current value of `attr`.
3065 * \returns true on success or false on failure; call SDL_GetError() for more
3066 * information.
3067 *
3068 * \threadsafety This function should only be called on the main thread.
3069 *
3070 * \since This function is available since SDL 3.2.0.
3071 *
3072 * \sa SDL_GL_ResetAttributes
3073 * \sa SDL_GL_SetAttribute
3074 */
3075extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetAttribute(SDL_GLAttr attr, int *value);
3076
3077/**
3078 * Create an OpenGL context for an OpenGL window, and make it current.
3079 *
3080 * Windows users new to OpenGL should note that, for historical reasons, GL
3081 * functions added after OpenGL version 1.1 are not available by default.
3082 * Those functions must be loaded at run-time, either with an OpenGL
3083 * extension-handling library or with SDL_GL_GetProcAddress() and its related
3084 * functions.
3085 *
3086 * SDL_GLContext is opaque to the application.
3087 *
3088 * \param window the window to associate with the context.
3089 * \returns the OpenGL context associated with `window` or NULL on failure;
3090 * call SDL_GetError() for more information.
3091 *
3092 * \threadsafety This function should only be called on the main thread.
3093 *
3094 * \since This function is available since SDL 3.2.0.
3095 *
3096 * \sa SDL_GL_DestroyContext
3097 * \sa SDL_GL_MakeCurrent
3098 */
3099extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *window);
3100
3101/**
3102 * Set up an OpenGL context for rendering into an OpenGL window.
3103 *
3104 * The context must have been created with a compatible window.
3105 *
3106 * \param window the window to associate with the context.
3107 * \param context the OpenGL context to associate with the window.
3108 * \returns true on success or false on failure; call SDL_GetError() for more
3109 * information.
3110 *
3111 * \threadsafety This function should only be called on the main thread.
3112 *
3113 * \since This function is available since SDL 3.2.0.
3114 *
3115 * \sa SDL_GL_CreateContext
3116 */
3117extern SDL_DECLSPEC bool SDLCALL SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext context);
3118
3119/**
3120 * Get the currently active OpenGL window.
3121 *
3122 * \returns the currently active OpenGL window on success or NULL on failure;
3123 * call SDL_GetError() for more information.
3124 *
3125 * \threadsafety This function should only be called on the main thread.
3126 *
3127 * \since This function is available since SDL 3.2.0.
3128 */
3129extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GL_GetCurrentWindow(void);
3130
3131/**
3132 * Get the currently active OpenGL context.
3133 *
3134 * \returns the currently active OpenGL context or NULL on failure; call
3135 * SDL_GetError() for more information.
3136 *
3137 * \threadsafety This function should only be called on the main thread.
3138 *
3139 * \since This function is available since SDL 3.2.0.
3140 *
3141 * \sa SDL_GL_MakeCurrent
3142 */
3143extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
3144
3145/**
3146 * Get the currently active EGL display.
3147 *
3148 * \returns the currently active EGL display or NULL on failure; call
3149 * SDL_GetError() for more information.
3150 *
3151 * \threadsafety This function should only be called on the main thread.
3152 *
3153 * \since This function is available since SDL 3.2.0.
3154 */
3155extern SDL_DECLSPEC SDL_EGLDisplay SDLCALL SDL_EGL_GetCurrentDisplay(void);
3156
3157/**
3158 * Get the currently active EGL config.
3159 *
3160 * \returns the currently active EGL config or NULL on failure; call
3161 * SDL_GetError() for more information.
3162 *
3163 * \threadsafety This function should only be called on the main thread.
3164 *
3165 * \since This function is available since SDL 3.2.0.
3166 */
3167extern SDL_DECLSPEC SDL_EGLConfig SDLCALL SDL_EGL_GetCurrentConfig(void);
3168
3169/**
3170 * Get the EGL surface associated with the window.
3171 *
3172 * \param window the window to query.
3173 * \returns the EGLSurface pointer associated with the window, or NULL on
3174 * failure.
3175 *
3176 * \threadsafety This function should only be called on the main thread.
3177 *
3178 * \since This function is available since SDL 3.2.0.
3179 */
3180extern SDL_DECLSPEC SDL_EGLSurface SDLCALL SDL_EGL_GetWindowSurface(SDL_Window *window);
3181
3182/**
3183 * Sets the callbacks for defining custom EGLAttrib arrays for EGL
3184 * initialization.
3185 *
3186 * Callbacks that aren't needed can be set to NULL.
3187 *
3188 * NOTE: These callback pointers will be reset after SDL_GL_ResetAttributes.
3189 *
3190 * \param platformAttribCallback callback for attributes to pass to
3191 * eglGetPlatformDisplay. May be NULL.
3192 * \param surfaceAttribCallback callback for attributes to pass to
3193 * eglCreateSurface. May be NULL.
3194 * \param contextAttribCallback callback for attributes to pass to
3195 * eglCreateContext. May be NULL.
3196 * \param userdata a pointer that is passed to the callbacks.
3197 *
3198 * \threadsafety This function should only be called on the main thread.
3199 *
3200 * \since This function is available since SDL 3.2.0.
3201 */
3202extern SDL_DECLSPEC void SDLCALL SDL_EGL_SetAttributeCallbacks(SDL_EGLAttribArrayCallback platformAttribCallback,
3203 SDL_EGLIntArrayCallback surfaceAttribCallback,
3204 SDL_EGLIntArrayCallback contextAttribCallback, void *userdata);
3205
3206/**
3207 * Set the swap interval for the current OpenGL context.
3208 *
3209 * Some systems allow specifying -1 for the interval, to enable adaptive
3210 * vsync. Adaptive vsync works the same as vsync, but if you've already missed
3211 * the vertical retrace for a given frame, it swaps buffers immediately, which
3212 * might be less jarring for the user during occasional framerate drops. If an
3213 * application requests adaptive vsync and the system does not support it,
3214 * this function will fail and return false. In such a case, you should
3215 * probably retry the call with 1 for the interval.
3216 *
3217 * Adaptive vsync is implemented for some glX drivers with
3218 * GLX_EXT_swap_control_tear, and for some Windows drivers with
3219 * WGL_EXT_swap_control_tear.
3220 *
3221 * Read more on the Khronos wiki:
3222 * https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync
3223 *
3224 * \param interval 0 for immediate updates, 1 for updates synchronized with
3225 * the vertical retrace, -1 for adaptive vsync.
3226 * \returns true on success or false on failure; call SDL_GetError() for more
3227 * information.
3228 *
3229 * \threadsafety This function should only be called on the main thread.
3230 *
3231 * \since This function is available since SDL 3.2.0.
3232 *
3233 * \sa SDL_GL_GetSwapInterval
3234 */
3235extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetSwapInterval(int interval);
3236
3237/**
3238 * Get the swap interval for the current OpenGL context.
3239 *
3240 * If the system can't determine the swap interval, or there isn't a valid
3241 * current context, this function will set *interval to 0 as a safe default.
3242 *
3243 * \param interval output interval value. 0 if there is no vertical retrace
3244 * synchronization, 1 if the buffer swap is synchronized with
3245 * the vertical retrace, and -1 if late swaps happen
3246 * immediately instead of waiting for the next retrace.
3247 * \returns true on success or false on failure; call SDL_GetError() for more
3248 * information.
3249 *
3250 * \threadsafety This function should only be called on the main thread.
3251 *
3252 * \since This function is available since SDL 3.2.0.
3253 *
3254 * \sa SDL_GL_SetSwapInterval
3255 */
3256extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetSwapInterval(int *interval);
3257
3258/**
3259 * Update a window with OpenGL rendering.
3260 *
3261 * This is used with double-buffered OpenGL contexts, which are the default.
3262 *
3263 * On macOS, make sure you bind 0 to the draw framebuffer before swapping the
3264 * window, otherwise nothing will happen. If you aren't using
3265 * glBindFramebuffer(), this is the default and you won't have to do anything
3266 * extra.
3267 *
3268 * \param window the window to change.
3269 * \returns true on success or false on failure; call SDL_GetError() for more
3270 * information.
3271 *
3272 * \threadsafety This function should only be called on the main thread.
3273 *
3274 * \since This function is available since SDL 3.2.0.
3275 */
3276extern SDL_DECLSPEC bool SDLCALL SDL_GL_SwapWindow(SDL_Window *window);
3277
3278/**
3279 * Delete an OpenGL context.
3280 *
3281 * \param context the OpenGL context to be deleted.
3282 * \returns true on success or false on failure; call SDL_GetError() for more
3283 * information.
3284 *
3285 * \threadsafety This function should only be called on the main thread.
3286 *
3287 * \since This function is available since SDL 3.2.0.
3288 *
3289 * \sa SDL_GL_CreateContext
3290 */
3291extern SDL_DECLSPEC bool SDLCALL SDL_GL_DestroyContext(SDL_GLContext context);
3292
3293/* @} *//* OpenGL support functions */
3294
3295
3296/* Ends C function definitions when using C++ */
3297#ifdef __cplusplus
3298}
3299#endif
3300#include <SDL3/SDL_close_code.h>
3301
3302#endif /* SDL_video_h_ */
3303