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