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