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