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