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