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