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