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