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