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 * - "always-on-top" (boolean) - true if the window should be always on top
813 * - "borderless" (boolean) - true if the window has no window decoration
814 * - "focusable" (boolean) - true if the window should accept keyboard input
815 * (defaults true)
816 * - "fullscreen" (boolean) - true if the window should start in fullscreen
817 * mode at desktop resolution
818 * - "height" (number) - the height of the window
819 * - "hidden" (boolean) - true if the window should start hidden
820 * - "high-pixel-density" (boolean) - true if the window uses a high pixel
821 * density buffer if possible
822 * - "maximized" (boolean) - true if the window should start maximized
823 * - "menu" (boolean) - true if the window is a popup menu
824 * - "metal" (string) - true if the window will be used with Metal rendering
825 * - "minimized" (boolean) - true if the window should start minimized
826 * - "mouse-grabbed" (boolean) - true if the window starts with grabbed mouse
827 * focus
828 * - "opengl" (boolean) - true if the window will be used with OpenGL
829 * rendering
830 * - "parent" (pointer) - an SDL_Window that will be the parent of this
831 * window, required for windows with the "toolip" and "menu" properties
832 * - "resizable" (boolean) - true if the window should be resizable
833 * - "title" (string) - the title of the window, in UTF-8 encoding
834 * - "transparent" (string) - true if the window show transparent in the areas
835 * with alpha of 0
836 * - "tooltip" (boolean) - true if the window is a tooltip
837 * - "utility" (boolean) - true if the window is a utility window, not showing
838 * in the task bar and window list
839 * - "vulkan" (string) - true if the window will be used with Vulkan rendering
840 * - "width" (number) - the width of the window
841 * - "x" (number) - the x position of the window, or `SDL_WINDOWPOS_CENTERED`,
842 * defaults to `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for
843 * windows with the "parent" property set.
844 * - "y" (number) - the y position of the window, or `SDL_WINDOWPOS_CENTERED`,
845 * defaults to `SDL_WINDOWPOS_UNDEFINED`. This is relative to the parent for
846 * windows with the "parent" property set.
847 *
848 * On macOS:
849 *
850 * - "cocoa.window" (pointer) - the (__unsafe_unretained) NSWindow associated
851 * with the window, if you want to wrap an existing window.
852 * - "cocoa.view" (pointer) - the (__unsafe_unretained) NSView associated with
853 * the window, defaults to [window contentView]
854 *
855 * On Windows:
856 *
857 * - "win32.hwnd" (pointer) - the HWND associated with the window, if you want
858 * to wrap an existing window.
859 * - "win32.pixel_format_hwnd" (pointer) - optional, another window to share
860 * pixel format with, useful for OpenGL windows
861 *
862 * On X11:
863 *
864 * - "x11.window" (number) - the X11 Window associated with the window, if you
865 * want to wrap an existing window.
866 *
867 * The SDL_Window is implicitly shown if the "hidden" property is not set.
868 *
869 * Windows with the "tooltip" and "menu" properties are popup windows and have
870 * the behaviors and guidelines outlined in `SDL_CreatePopupWindow()`.
871 *
872 * \param props the properties to use
873 * \returns the window that was created or NULL on failure; call
874 * SDL_GetError() for more information.
875 *
876 * \since This function is available since SDL 3.0.0.
877 *
878 * \sa SDL_CreateWindow
879 * \sa SDL_DestroyWindow
880 */
882
883/**
884 * Get the numeric ID of a window.
885 *
886 * The numeric ID is what SDL_WindowEvent references, and is necessary to map
887 * these events to specific SDL_Window objects.
888 *
889 * \param window the window to query
890 * \returns the ID of the window on success or 0 on failure; call
891 * SDL_GetError() for more information.
892 *
893 * \since This function is available since SDL 3.0.0.
894 *
895 * \sa SDL_GetWindowFromID
896 */
897extern DECLSPEC SDL_WindowID SDLCALL SDL_GetWindowID(SDL_Window *window);
898
899/**
900 * Get a window from a stored ID.
901 *
902 * The numeric ID is what SDL_WindowEvent references, and is necessary to map
903 * these events to specific SDL_Window objects.
904 *
905 * \param id the ID of the window
906 * \returns the window associated with `id` or NULL if it doesn't exist; call
907 * SDL_GetError() for more information.
908 *
909 * \since This function is available since SDL 3.0.0.
910 *
911 * \sa SDL_GetWindowID
912 */
913extern DECLSPEC SDL_Window *SDLCALL SDL_GetWindowFromID(SDL_WindowID id);
914
915/**
916 * Get parent of a window.
917 *
918 * \param window the window to query
919 * \returns the parent of the window on success or NULL if the window has no
920 * parent.
921 *
922 * \since This function is available since SDL 3.0.0.
923 *
924 * \sa SDL_CreatePopupWindow
925 */
926extern DECLSPEC SDL_Window *SDLCALL SDL_GetWindowParent(SDL_Window *window);
927
928/**
929 * Get the properties associated with a window.
930 *
931 * The following read-only properties are provided by SDL:
932 *
933 * On Android:
934 *
935 * ```
936 * "SDL.window.android.window" (pointer) - the ANativeWindow associated with the window
937 * "SDL.window.android.surface" (pointer) - the EGLSurface associated with the window
938 * ```
939 *
940 * On iOS:
941 *
942 * ```
943 * "SDL.window.uikit.window" (pointer) - the (__unsafe_unretained) UIWindow associated with the window
944 * "SDL.window.uikit.metal_view_tag" (number) - the NSInteger tag assocated with metal views on the window
945 * ```
946 *
947 * On KMS/DRM:
948 *
949 * ```
950 * "SDL.window.kmsdrm.dev_index" (number) - the device index associated with the window (e.g. the X in /dev/dri/cardX)
951 * "SDL.window.kmsdrm.drm_fd" (number) - the DRM FD associated with the window
952 * "SDL.window.kmsdrm.gbm_dev" (pointer) - the GBM device associated with the window
953 * ```
954 *
955 * On macOS:
956 *
957 * ```
958 * "SDL.window.cocoa.window" (pointer) - the (__unsafe_unretained) NSWindow associated with the window
959 * "SDL.window.cocoa.metal_view_tag" (number) - the NSInteger tag assocated with metal views on the window
960 * ```
961 *
962 * On Vivante:
963 *
964 * ```
965 * "SDL.window.vivante.display" (pointer) - the EGLNativeDisplayType associated with the window
966 * "SDL.window.vivante.window" (pointer) - the EGLNativeWindowType associated with the window
967 * "SDL.window.vivante.surface" (pointer) - the EGLSurface associated with the window
968 * ```
969 *
970 * On UWP:
971 *
972 * ```
973 * "SDL.window.winrt.window" (pointer) - the IInspectable CoreWindow associated with the window
974 * ```
975 *
976 * On Windows:
977 *
978 * ```
979 * "SDL.window.win32.hwnd" (pointer) - the HWND associated with the window
980 * "SDL.window.win32.hdc" (pointer) - the HDC associated with the window
981 * "SDL.window.win32.instance" (pointer) - the HINSTANCE associated with the window
982 * ```
983 *
984 * On Wayland:
985 *
986 * ```
987 * "SDL.window.wayland.registry" (pointer) - the wl_registry associated with the window
988 * "SDL.window.wayland.display" (pointer) - the wl_display associated with the window
989 * "SDL.window.wayland.surface" (pointer) - the wl_surface associated with the window
990 * "SDL.window.wayland.egl_window" (pointer) - the wl_egl_window associated with the window
991 * "SDL.window.wayland.xdg_surface" (pointer) - the xdg_surface associated with the window
992 * "SDL.window.wayland.xdg_toplevel" (pointer) - the xdg_toplevel role associated with the window
993 * "SDL.window.wayland.xdg_popup" (pointer) - the xdg_popup role associated with the window
994 * "SDL.window.wayland.xdg_positioner" (pointer) - the xdg_positioner associated with the window, in popup mode
995 * ```
996 *
997 * Note: The xdg_* window objects do not internally persist across window
998 * show/hide calls. They will be null if the window is hidden and must be
999 * queried each time it is shown.
1000 *
1001 * On X11:
1002 *
1003 * ```
1004 * "SDL.window.x11.display" (pointer) - the X11 Display associated with the window
1005 * "SDL.window.x11.screen" (number) - the screen number associated with the window
1006 * "SDL.window.x11.window" (number) - the X11 Window associated with the window
1007 * ```
1008 *
1009 * \param window the window to query
1010 * \returns a valid property ID on success or 0 on failure; call
1011 * SDL_GetError() for more information.
1012 *
1013 * \since This function is available since SDL 3.0.0.
1014 *
1015 * \sa SDL_GetProperty
1016 * \sa SDL_SetProperty
1017 */
1018extern DECLSPEC SDL_PropertiesID SDLCALL SDL_GetWindowProperties(SDL_Window *window);
1019
1020/**
1021 * Get the window flags.
1022 *
1023 * \param window the window to query
1024 * \returns a mask of the SDL_WindowFlags associated with `window`
1025 *
1026 * \since This function is available since SDL 3.0.0.
1027 *
1028 * \sa SDL_CreateWindow
1029 * \sa SDL_HideWindow
1030 * \sa SDL_MaximizeWindow
1031 * \sa SDL_MinimizeWindow
1032 * \sa SDL_SetWindowFullscreen
1033 * \sa SDL_SetWindowGrab
1034 * \sa SDL_ShowWindow
1035 */
1036extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window *window);
1037
1038/**
1039 * Set the title of a window.
1040 *
1041 * This string is expected to be in UTF-8 encoding.
1042 *
1043 * \param window the window to change
1044 * \param title the desired window title in UTF-8 format
1045 * \returns 0 on success or a negative error code on failure; call
1046 * SDL_GetError() for more information.
1047 *
1048 * \since This function is available since SDL 3.0.0.
1049 *
1050 * \sa SDL_GetWindowTitle
1051 */
1052extern DECLSPEC int SDLCALL SDL_SetWindowTitle(SDL_Window *window, const char *title);
1053
1054/**
1055 * Get the title of a window.
1056 *
1057 * \param window the window to query
1058 * \returns the title of the window in UTF-8 format or "" if there is no
1059 * title.
1060 *
1061 * \since This function is available since SDL 3.0.0.
1062 *
1063 * \sa SDL_SetWindowTitle
1064 */
1065extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window *window);
1066
1067/**
1068 * Set the icon for a window.
1069 *
1070 * \param window the window to change
1071 * \param icon an SDL_Surface structure containing the icon for the window
1072 * \returns 0 on success or a negative error code on failure; call
1073 * SDL_GetError() for more information.
1074 *
1075 * \since This function is available since SDL 3.0.0.
1076 */
1077extern DECLSPEC int SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon);
1078
1079/**
1080 * Request that the window's position be set.
1081 *
1082 * If, at the time of this request, the window is in a fixed-size state such
1083 * as maximized, this request may be deferred until the window returns to a
1084 * resizable state.
1085 *
1086 * This can be used to reposition fullscreen-desktop windows onto a different
1087 * display, however, exclusive fullscreen windows are locked to a specific
1088 * display and can only be repositioned programmatically via
1089 * SDL_SetWindowFullscreenMode().
1090 *
1091 * On some windowing systems this request is asynchronous and the new
1092 * coordinates may not have have been applied immediately upon the return of
1093 * this function. If an immediate change is required, call SDL_SyncWindow() to
1094 * block until the changes have taken effect.
1095 *
1096 * When the window position changes, an SDL_EVENT_WINDOW_MOVED event will be
1097 * emitted with the window's new coordinates. Note that the new coordinates
1098 * may not match the exact coordinates requested, as some windowing systems
1099 * can restrict the position of the window in certain scenarios (e.g.
1100 * constraining the position so the window is always within desktop bounds).
1101 * Additionally, as this is just a request, it can be denied by the windowing
1102 * system.
1103 *
1104 * \param window the window to reposition
1105 * \param x the x coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
1106 * `SDL_WINDOWPOS_UNDEFINED`
1107 * \param y the y coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
1108 * `SDL_WINDOWPOS_UNDEFINED`
1109 * \returns 0 on success or a negative error code on failure; call
1110 * SDL_GetError() for more information.
1111 *
1112 * \since This function is available since SDL 3.0.0.
1113 *
1114 * \sa SDL_GetWindowPosition
1115 * \sa SDL_SyncWindow
1116 */
1117extern DECLSPEC int SDLCALL SDL_SetWindowPosition(SDL_Window *window, int x, int y);
1118
1119/**
1120 * Get the position of a window.
1121 *
1122 * This is the current position of the window as last reported by the
1123 * windowing system.
1124 *
1125 * If you do not need the value for one of the positions a NULL may be passed
1126 * in the `x` or `y` parameter.
1127 *
1128 * \param window the window to query
1129 * \param x a pointer filled in with the x position of the window, may be NULL
1130 * \param y a pointer filled in with the y position of the window, may be NULL
1131 * \returns 0 on success or a negative error code on failure; call
1132 * SDL_GetError() for more information.
1133 *
1134 * \since This function is available since SDL 3.0.0.
1135 *
1136 * \sa SDL_SetWindowPosition
1137 */
1138extern DECLSPEC int SDLCALL SDL_GetWindowPosition(SDL_Window *window, int *x, int *y);
1139
1140/**
1141 * Request that the size of a window's client area be set.
1142 *
1143 * NULL can safely be passed as the `w` or `h` parameter if the width or
1144 * height value is not desired.
1145 *
1146 * If, at the time of this request, the window in a fixed-size state, such as
1147 * maximized or fullscreen, the request will be deferred until the window
1148 * exits this state and becomes resizable again.
1149 *
1150 * To change the fullscreen mode of a window, use
1151 * SDL_SetWindowFullscreenMode()
1152 *
1153 * On some windowing systems, this request is asynchronous and the new window
1154 * size may not have have been applied immediately upon the return of this
1155 * function. If an immediate change is required, call SDL_SyncWindow() to
1156 * block until the changes have taken effect.
1157 *
1158 * When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will be
1159 * emitted with the new window dimensions. Note that the new dimensions may
1160 * not match the exact size requested, as some windowing systems can restrict
1161 * the window size in certain scenarios (e.g. constraining the size of the
1162 * content area to remain within the usable desktop bounds). Additionally, as
1163 * this is just a request, it can be denied by the windowing system.
1164 *
1165 * \param window the window to change
1166 * \param w the width of the window, must be > 0
1167 * \param h the height of the window, must be > 0
1168 * \returns 0 on success or a negative error code on failure; call
1169 * SDL_GetError() for more information.
1170 *
1171 * \since This function is available since SDL 3.0.0.
1172 *
1173 * \sa SDL_GetWindowSize
1174 * \sa SDL_SetWindowFullscreenMode
1175 * \sa SDL_SyncWindow
1176 */
1177extern DECLSPEC int SDLCALL SDL_SetWindowSize(SDL_Window *window, int w, int h);
1178
1179/**
1180 * Get the size of a window's client area.
1181 *
1182 * NULL can safely be passed as the `w` or `h` parameter if the width or
1183 * height value is not desired.
1184 *
1185 * The window pixel size may differ from its window coordinate size if the
1186 * window is on a high pixel density display. Use SDL_GetWindowSizeInPixels()
1187 * or SDL_GetRenderOutputSize() to get the real client area size in pixels.
1188 *
1189 * \param window the window to query the width and height from
1190 * \param w a pointer filled in with the width of the window, may be NULL
1191 * \param h a pointer filled in with the height of the window, may be NULL
1192 * \returns 0 on success or a negative error code on failure; call
1193 * SDL_GetError() for more information.
1194 *
1195 * \since This function is available since SDL 3.0.0.
1196 *
1197 * \sa SDL_GetRenderOutputSize
1198 * \sa SDL_GetWindowSizeInPixels
1199 * \sa SDL_SetWindowSize
1200 */
1201extern DECLSPEC int SDLCALL SDL_GetWindowSize(SDL_Window *window, int *w, int *h);
1202
1203/**
1204 * Get the size of a window's borders (decorations) around the client area.
1205 *
1206 * Note: If this function fails (returns -1), the size values will be
1207 * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the
1208 * window in question was borderless.
1209 *
1210 * Note: This function may fail on systems where the window has not yet been
1211 * decorated by the display server (for example, immediately after calling
1212 * SDL_CreateWindow). It is recommended that you wait at least until the
1213 * window has been presented and composited, so that the window system has a
1214 * chance to decorate the window and provide the border dimensions to SDL.
1215 *
1216 * This function also returns -1 if getting the information is not supported.
1217 *
1218 * \param window the window to query the size values of the border
1219 * (decorations) from
1220 * \param top pointer to variable for storing the size of the top border; NULL
1221 * is permitted
1222 * \param left pointer to variable for storing the size of the left border;
1223 * NULL is permitted
1224 * \param bottom pointer to variable for storing the size of the bottom
1225 * border; NULL is permitted
1226 * \param right pointer to variable for storing the size of the right border;
1227 * NULL is permitted
1228 * \returns 0 on success or a negative error code on failure; call
1229 * SDL_GetError() for more information.
1230 *
1231 * \since This function is available since SDL 3.0.0.
1232 *
1233 * \sa SDL_GetWindowSize
1234 */
1235extern DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right);
1236
1237/**
1238 * Get the size of a window's client area, in pixels.
1239 *
1240 * \param window the window from which the drawable size should be queried
1241 * \param w a pointer to variable for storing the width in pixels, may be NULL
1242 * \param h a pointer to variable for storing the height in pixels, may be
1243 * NULL
1244 * \returns 0 on success or a negative error code on failure; call
1245 * SDL_GetError() for more information.
1246 *
1247 * \since This function is available since SDL 3.0.0.
1248 *
1249 * \sa SDL_CreateWindow
1250 * \sa SDL_GetWindowSize
1251 */
1252extern DECLSPEC int SDLCALL SDL_GetWindowSizeInPixels(SDL_Window *window, int *w, int *h);
1253
1254/**
1255 * Set the minimum size of a window's client area.
1256 *
1257 * \param window the window to change
1258 * \param min_w the minimum width of the window, or 0 for no limit
1259 * \param min_h the minimum height of the window, or 0 for no limit
1260 * \returns 0 on success or a negative error code on failure; call
1261 * SDL_GetError() for more information.
1262 *
1263 * \since This function is available since SDL 3.0.0.
1264 *
1265 * \sa SDL_GetWindowMinimumSize
1266 * \sa SDL_SetWindowMaximumSize
1267 */
1268extern DECLSPEC int SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window, int min_w, int min_h);
1269
1270/**
1271 * Get the minimum size of a window's client area.
1272 *
1273 * \param window the window to query
1274 * \param w a pointer filled in with the minimum width of the window, may be
1275 * NULL
1276 * \param h a pointer filled in with the minimum height of the window, may be
1277 * NULL
1278 * \returns 0 on success or a negative error code on failure; call
1279 * SDL_GetError() for more information.
1280 *
1281 * \since This function is available since SDL 3.0.0.
1282 *
1283 * \sa SDL_GetWindowMaximumSize
1284 * \sa SDL_SetWindowMinimumSize
1285 */
1286extern DECLSPEC int SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window, int *w, int *h);
1287
1288/**
1289 * Set the maximum size of a window's client area.
1290 *
1291 * \param window the window to change
1292 * \param max_w the maximum width of the window, or 0 for no limit
1293 * \param max_h the maximum height of the window, or 0 for no limit
1294 * \returns 0 on success or a negative error code on failure; call
1295 * SDL_GetError() for more information.
1296 *
1297 * \since This function is available since SDL 3.0.0.
1298 *
1299 * \sa SDL_GetWindowMaximumSize
1300 * \sa SDL_SetWindowMinimumSize
1301 */
1302extern DECLSPEC int SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window, int max_w, int max_h);
1303
1304/**
1305 * Get the maximum size of a window's client area.
1306 *
1307 * \param window the window to query
1308 * \param w a pointer filled in with the maximum width of the window, may be
1309 * NULL
1310 * \param h a pointer filled in with the maximum height of the window, may be
1311 * NULL
1312 * \returns 0 on success or a negative error code on failure; call
1313 * SDL_GetError() for more information.
1314 *
1315 * \since This function is available since SDL 3.0.0.
1316 *
1317 * \sa SDL_GetWindowMinimumSize
1318 * \sa SDL_SetWindowMaximumSize
1319 */
1320extern DECLSPEC int SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window, int *w, int *h);
1321
1322/**
1323 * Set the border state of a window.
1324 *
1325 * This will add or remove the window's `SDL_WINDOW_BORDERLESS` flag and add
1326 * or remove the border from the actual window. This is a no-op if the
1327 * window's border already matches the requested state.
1328 *
1329 * You can't change the border state of a fullscreen window.
1330 *
1331 * \param window the window of which to change the border state
1332 * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border
1333 * \returns 0 on success or a negative error code on failure; call
1334 * SDL_GetError() for more information.
1335 *
1336 * \since This function is available since SDL 3.0.0.
1337 *
1338 * \sa SDL_GetWindowFlags
1339 */
1340extern DECLSPEC int SDLCALL SDL_SetWindowBordered(SDL_Window *window, SDL_bool bordered);
1341
1342/**
1343 * Set the user-resizable state of a window.
1344 *
1345 * This will add or remove the window's `SDL_WINDOW_RESIZABLE` flag and
1346 * allow/disallow user resizing of the window. This is a no-op if the window's
1347 * resizable state already matches the requested state.
1348 *
1349 * You can't change the resizable state of a fullscreen window.
1350 *
1351 * \param window the window of which to change the resizable state
1352 * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow
1353 * \returns 0 on success or a negative error code on failure; call
1354 * SDL_GetError() for more information.
1355 *
1356 * \since This function is available since SDL 3.0.0.
1357 *
1358 * \sa SDL_GetWindowFlags
1359 */
1360extern DECLSPEC int SDLCALL SDL_SetWindowResizable(SDL_Window *window, SDL_bool resizable);
1361
1362/**
1363 * Set the window to always be above the others.
1364 *
1365 * This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP` flag. This
1366 * will bring the window to the front and keep the window above the rest.
1367 *
1368 * \param window The window of which to change the always on top state
1369 * \param on_top SDL_TRUE to set the window always on top, SDL_FALSE to
1370 * disable
1371 * \returns 0 on success or a negative error code on failure; call
1372 * SDL_GetError() for more information.
1373 *
1374 * \since This function is available since SDL 3.0.0.
1375 *
1376 * \sa SDL_GetWindowFlags
1377 */
1378extern DECLSPEC int SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window *window, SDL_bool on_top);
1379
1380/**
1381 * Show a window.
1382 *
1383 * \param window the window to show
1384 * \returns 0 on success or a negative error code on failure; call
1385 * SDL_GetError() for more information.
1386 *
1387 * \since This function is available since SDL 3.0.0.
1388 *
1389 * \sa SDL_HideWindow
1390 * \sa SDL_RaiseWindow
1391 */
1392extern DECLSPEC int SDLCALL SDL_ShowWindow(SDL_Window *window);
1393
1394/**
1395 * Hide a window.
1396 *
1397 * \param window the window to hide
1398 * \returns 0 on success or a negative error code on failure; call
1399 * SDL_GetError() for more information.
1400 *
1401 * \since This function is available since SDL 3.0.0.
1402 *
1403 * \sa SDL_ShowWindow
1404 */
1405extern DECLSPEC int SDLCALL SDL_HideWindow(SDL_Window *window);
1406
1407/**
1408 * Raise a window above other windows and set the input focus.
1409 *
1410 * \param window the window to raise
1411 * \returns 0 on success or a negative error code on failure; call
1412 * SDL_GetError() for more information.
1413 *
1414 * \since This function is available since SDL 3.0.0.
1415 */
1416extern DECLSPEC int SDLCALL SDL_RaiseWindow(SDL_Window *window);
1417
1418/**
1419 * Request that the window be made as large as possible.
1420 *
1421 * Non-resizable windows can't be maximized. The window must have the
1422 * SDL_WINDOW_RESIZABLE flag set, or this will have no effect.
1423 *
1424 * On some windowing systems this request is asynchronous and the new window
1425 * state may not have have been applied immediately upon the return of this
1426 * function. If an immediate change is required, call SDL_SyncWindow() to
1427 * block until the changes have taken effect.
1428 *
1429 * When the window state changes, an SDL_EVENT_WINDOW_MAXIMIZED event will be
1430 * emitted. Note that, as this is just a request, the windowing system can
1431 * deny the state change.
1432 *
1433 * When maximizing a window, whether the constraints set via
1434 * SDL_SetWindowMaximumSize() are honored depends on the policy of the window
1435 * manager. Win32 and macOS enforce the constraints when maximizing, while X11
1436 * and Wayland window managers may vary.
1437 *
1438 * \param window the window to maximize
1439 * \returns 0 on success or a negative error code on failure; call
1440 * SDL_GetError() for more information.
1441 *
1442 * \since This function is available since SDL 3.0.0.
1443 *
1444 * \sa SDL_MinimizeWindow
1445 * \sa SDL_RestoreWindow
1446 * \sa SDL_SyncWindow
1447 */
1448extern DECLSPEC int SDLCALL SDL_MaximizeWindow(SDL_Window *window);
1449
1450/**
1451 * Request that the window be minimized to an iconic representation.
1452 *
1453 * On some windowing systems this request is asynchronous and the new window
1454 * state may not have have been applied immediately upon the return of this
1455 * function. If an immediate change is required, call SDL_SyncWindow() to
1456 * block until the changes have taken effect.
1457 *
1458 * When the window state changes, an SDL_EVENT_WINDOW_MINIMIZED event will be
1459 * emitted. Note that, as this is just a request, the windowing system can
1460 * deny the state change.
1461 *
1462 * \param window the window to minimize
1463 * \returns 0 on success or a negative error code on failure; call
1464 * SDL_GetError() for more information.
1465 *
1466 * \since This function is available since SDL 3.0.0.
1467 *
1468 * \sa SDL_MaximizeWindow
1469 * \sa SDL_RestoreWindow
1470 * \sa SDL_SyncWindow
1471 */
1472extern DECLSPEC int SDLCALL SDL_MinimizeWindow(SDL_Window *window);
1473
1474/**
1475 * Request that the size and position of a minimized or maximized window be
1476 * restored.
1477 *
1478 * On some windowing systems this request is asynchronous and the new window
1479 * state may not have have been applied immediately upon the return of this
1480 * function. If an immediate change is required, call SDL_SyncWindow() to
1481 * block until the changes have taken effect.
1482 *
1483 * When the window state changes, an SDL_EVENT_WINDOW_RESTORED event will be
1484 * emitted. Note that, as this is just a request, the windowing system can
1485 * deny the state change.
1486 *
1487 * \param window the window to restore
1488 * \returns 0 on success or a negative error code on failure; call
1489 * SDL_GetError() for more information.
1490 *
1491 * \since This function is available since SDL 3.0.0.
1492 *
1493 * \sa SDL_MaximizeWindow
1494 * \sa SDL_MinimizeWindow
1495 * \sa SDL_SyncWindow
1496 */
1497extern DECLSPEC int SDLCALL SDL_RestoreWindow(SDL_Window *window);
1498
1499/**
1500 * Request that the window's fullscreen state be changed.
1501 *
1502 * By default a window in fullscreen state uses fullscreen desktop mode, but a
1503 * specific display mode can be set using SDL_SetWindowFullscreenMode().
1504 *
1505 * On some windowing systems this request is asynchronous and the new
1506 * fullscreen state may not have have been applied immediately upon the return
1507 * of this function. If an immediate change is required, call SDL_SyncWindow()
1508 * to block until the changes have taken effect.
1509 *
1510 * When the window state changes, an SDL_EVENT_WINDOW_ENTER_FULLSCREEN or
1511 * SDL_EVENT_WINDOW_LEAVE_FULLSCREEN event will be emitted. Note that, as this
1512 * is just a request, it can be denied by the windowing system.
1513 *
1514 * \param window the window to change
1515 * \param fullscreen SDL_TRUE for fullscreen mode, SDL_FALSE for windowed mode
1516 * \returns 0 on success or a negative error code on failure; call
1517 * SDL_GetError() for more information.
1518 *
1519 * \since This function is available since SDL 3.0.0.
1520 *
1521 * \sa SDL_GetWindowFullscreenMode
1522 * \sa SDL_SetWindowFullscreenMode
1523 * \sa SDL_SyncWindow
1524 */
1525extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, SDL_bool fullscreen);
1526
1527/**
1528 * Block until any pending window state is finalized.
1529 *
1530 * On asynchronous windowing systems, this acts as a synchronization barrier
1531 * for pending window state. It will attempt to wait until any pending window
1532 * state has been applied and is guaranteed to return within finite time. Note
1533 * that for how long it can potentially block depends on the underlying window
1534 * system, as window state changes may involve somewhat lengthy animations
1535 * that must complete before the window is in its final requested state.
1536 *
1537 * On windowing systems where changes are immediate, this does nothing.
1538 *
1539 * \param window the window for which to wait for the pending state to be
1540 * applied
1541 * \returns 0 on success, a positive value if the operation timed out before
1542 * the window was in the requested state, or a negative error code on
1543 * failure; call SDL_GetError() for more information.
1544 *
1545 * \since This function is available since SDL 3.0.0.
1546 *
1547 * \sa SDL_SetWindowSize
1548 * \sa SDL_SetWindowPosition
1549 * \sa SDL_SetWindowFullscreen
1550 * \sa SDL_MinimizeWindow
1551 * \sa SDL_MaximizeWindow
1552 * \sa SDL_RestoreWindow
1553 */
1554extern DECLSPEC int SDLCALL SDL_SyncWindow(SDL_Window *window);
1555
1556/**
1557 * Return whether the window has a surface associated with it.
1558 *
1559 * \param window the window to query
1560 * \returns SDL_TRUE if there is a surface associated with the window, or
1561 * SDL_FALSE otherwise.
1562 *
1563 * \since This function is available since SDL 3.0.0.
1564 *
1565 * \sa SDL_GetWindowSurface
1566 */
1567extern DECLSPEC SDL_bool SDLCALL SDL_HasWindowSurface(SDL_Window *window);
1568
1569/**
1570 * Get the SDL surface associated with the window.
1571 *
1572 * A new surface will be created with the optimal format for the window, if
1573 * necessary. This surface will be freed when the window is destroyed. Do not
1574 * free this surface.
1575 *
1576 * This surface will be invalidated if the window is resized. After resizing a
1577 * window this function must be called again to return a valid surface.
1578 *
1579 * You may not combine this with 3D or the rendering API on this window.
1580 *
1581 * This function is affected by `SDL_HINT_FRAMEBUFFER_ACCELERATION`.
1582 *
1583 * \param window the window to query
1584 * \returns the surface associated with the window, or NULL on failure; call
1585 * SDL_GetError() for more information.
1586 *
1587 * \since This function is available since SDL 3.0.0.
1588 *
1589 * \sa SDL_DestroyWindowSurface
1590 * \sa SDL_HasWindowSurface
1591 * \sa SDL_UpdateWindowSurface
1592 * \sa SDL_UpdateWindowSurfaceRects
1593 */
1594extern DECLSPEC SDL_Surface *SDLCALL SDL_GetWindowSurface(SDL_Window *window);
1595
1596/**
1597 * Copy the window surface to the screen.
1598 *
1599 * This is the function you use to reflect any changes to the surface on the
1600 * screen.
1601 *
1602 * This function is equivalent to the SDL 1.2 API SDL_Flip().
1603 *
1604 * \param window the window to update
1605 * \returns 0 on success or a negative error code on failure; call
1606 * SDL_GetError() for more information.
1607 *
1608 * \since This function is available since SDL 3.0.0.
1609 *
1610 * \sa SDL_GetWindowSurface
1611 * \sa SDL_UpdateWindowSurfaceRects
1612 */
1613extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window *window);
1614
1615/**
1616 * Copy areas of the window surface to the screen.
1617 *
1618 * This is the function you use to reflect changes to portions of the surface
1619 * on the screen.
1620 *
1621 * This function is equivalent to the SDL 1.2 API SDL_UpdateRects().
1622 *
1623 * \param window the window to update
1624 * \param rects an array of SDL_Rect structures representing areas of the
1625 * surface to copy, in pixels
1626 * \param numrects the number of rectangles
1627 * \returns 0 on success or a negative error code on failure; call
1628 * SDL_GetError() for more information.
1629 *
1630 * \since This function is available since SDL 3.0.0.
1631 *
1632 * \sa SDL_GetWindowSurface
1633 * \sa SDL_UpdateWindowSurface
1634 */
1635extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects);
1636
1637/**
1638 * Destroy the surface associated with the window.
1639 *
1640 * \param window the window to update
1641 * \returns 0 on success or a negative error code on failure; call
1642 * SDL_GetError() for more information.
1643 *
1644 * \since This function is available since SDL 3.0.0.
1645 *
1646 * \sa SDL_GetWindowSurface
1647 * \sa SDL_HasWindowSurface
1648 */
1649extern DECLSPEC int SDLCALL SDL_DestroyWindowSurface(SDL_Window *window);
1650
1651/**
1652 * Set a window's input grab mode.
1653 *
1654 * When input is grabbed, the mouse is confined to the window. This function
1655 * will also grab the keyboard if `SDL_HINT_GRAB_KEYBOARD` is set. To grab the
1656 * keyboard without also grabbing the mouse, use SDL_SetWindowKeyboardGrab().
1657 *
1658 * If the caller enables a grab while another window is currently grabbed, the
1659 * other window loses its grab in favor of the caller's window.
1660 *
1661 * \param window the window for which the input grab mode should be set
1662 * \param grabbed SDL_TRUE to grab input or SDL_FALSE to release input
1663 * \returns 0 on success or a negative error code on failure; call
1664 * SDL_GetError() for more information.
1665 *
1666 * \since This function is available since SDL 3.0.0.
1667 *
1668 * \sa SDL_GetGrabbedWindow
1669 * \sa SDL_GetWindowGrab
1670 */
1671extern DECLSPEC int SDLCALL SDL_SetWindowGrab(SDL_Window *window, SDL_bool grabbed);
1672
1673/**
1674 * Set a window's keyboard grab mode.
1675 *
1676 * Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or
1677 * the Meta/Super key. Note that not all system keyboard shortcuts can be
1678 * captured by applications (one example is Ctrl+Alt+Del on Windows).
1679 *
1680 * This is primarily intended for specialized applications such as VNC clients
1681 * or VM frontends. Normal games should not use keyboard grab.
1682 *
1683 * When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the
1684 * window is full-screen to ensure the user is not trapped in your
1685 * application. If you have a custom keyboard shortcut to exit fullscreen
1686 * mode, you may suppress this behavior with
1687 * `SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED`.
1688 *
1689 * If the caller enables a grab while another window is currently grabbed, the
1690 * other window loses its grab in favor of the caller's window.
1691 *
1692 * \param window The window for which the keyboard grab mode should be set.
1693 * \param grabbed This is SDL_TRUE to grab keyboard, and SDL_FALSE to release.
1694 * \returns 0 on success or a negative error code on failure; call
1695 * SDL_GetError() for more information.
1696 *
1697 * \since This function is available since SDL 3.0.0.
1698 *
1699 * \sa SDL_GetWindowKeyboardGrab
1700 * \sa SDL_SetWindowMouseGrab
1701 * \sa SDL_SetWindowGrab
1702 */
1703extern DECLSPEC int SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window *window, SDL_bool grabbed);
1704
1705/**
1706 * Set a window's mouse grab mode.
1707 *
1708 * Mouse grab confines the mouse cursor to the window.
1709 *
1710 * \param window The window for which the mouse grab mode should be set.
1711 * \param grabbed This is SDL_TRUE to grab mouse, and SDL_FALSE to release.
1712 * \returns 0 on success or a negative error code on failure; call
1713 * SDL_GetError() for more information.
1714 *
1715 * \since This function is available since SDL 3.0.0.
1716 *
1717 * \sa SDL_GetWindowMouseGrab
1718 * \sa SDL_SetWindowKeyboardGrab
1719 * \sa SDL_SetWindowGrab
1720 */
1721extern DECLSPEC int SDLCALL SDL_SetWindowMouseGrab(SDL_Window *window, SDL_bool grabbed);
1722
1723/**
1724 * Get a window's input grab mode.
1725 *
1726 * \param window the window to query
1727 * \returns SDL_TRUE if input is grabbed, SDL_FALSE otherwise.
1728 *
1729 * \since This function is available since SDL 3.0.0.
1730 *
1731 * \sa SDL_SetWindowGrab
1732 */
1733extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window *window);
1734
1735/**
1736 * Get a window's keyboard grab mode.
1737 *
1738 * \param window the window to query
1739 * \returns SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise.
1740 *
1741 * \since This function is available since SDL 3.0.0.
1742 *
1743 * \sa SDL_SetWindowKeyboardGrab
1744 * \sa SDL_GetWindowGrab
1745 */
1746extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window *window);
1747
1748/**
1749 * Get a window's mouse grab mode.
1750 *
1751 * \param window the window to query
1752 * \returns SDL_TRUE if mouse is grabbed, and SDL_FALSE otherwise.
1753 *
1754 * \since This function is available since SDL 3.0.0.
1755 *
1756 * \sa SDL_SetWindowKeyboardGrab
1757 * \sa SDL_GetWindowGrab
1758 */
1759extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowMouseGrab(SDL_Window *window);
1760
1761/**
1762 * Get the window that currently has an input grab enabled.
1763 *
1764 * \returns the window if input is grabbed or NULL otherwise.
1765 *
1766 * \since This function is available since SDL 3.0.0.
1767 *
1768 * \sa SDL_GetWindowGrab
1769 * \sa SDL_SetWindowGrab
1770 */
1771extern DECLSPEC SDL_Window *SDLCALL SDL_GetGrabbedWindow(void);
1772
1773/**
1774 * Confines the cursor to the specified area of a window.
1775 *
1776 * Note that this does NOT grab the cursor, it only defines the area a cursor
1777 * is restricted to when the window has mouse focus.
1778 *
1779 * \param window The window that will be associated with the barrier.
1780 * \param rect A rectangle area in window-relative coordinates. If NULL the
1781 * barrier for the specified window will be destroyed.
1782 * \returns 0 on success or a negative error code on failure; call
1783 * SDL_GetError() for more information.
1784 *
1785 * \since This function is available since SDL 3.0.0.
1786 *
1787 * \sa SDL_GetWindowMouseRect
1788 * \sa SDL_SetWindowMouseGrab
1789 */
1790extern DECLSPEC int SDLCALL SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect);
1791
1792/**
1793 * Get the mouse confinement rectangle of a window.
1794 *
1795 * \param window The window to query
1796 * \returns A pointer to the mouse confinement rectangle of a window, or NULL
1797 * if there isn't one.
1798 *
1799 * \since This function is available since SDL 3.0.0.
1800 *
1801 * \sa SDL_SetWindowMouseRect
1802 */
1803extern DECLSPEC const SDL_Rect *SDLCALL SDL_GetWindowMouseRect(SDL_Window *window);
1804
1805/**
1806 * Set the opacity for a window.
1807 *
1808 * The parameter `opacity` will be clamped internally between 0.0f
1809 * (transparent) and 1.0f (opaque).
1810 *
1811 * This function also returns -1 if setting the opacity isn't supported.
1812 *
1813 * \param window the window which will be made transparent or opaque
1814 * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque)
1815 * \returns 0 on success or a negative error code on failure; call
1816 * SDL_GetError() for more information.
1817 *
1818 * \since This function is available since SDL 3.0.0.
1819 *
1820 * \sa SDL_GetWindowOpacity
1821 */
1822extern DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window *window, float opacity);
1823
1824/**
1825 * Get the opacity of a window.
1826 *
1827 * If transparency isn't supported on this platform, opacity will be reported
1828 * as 1.0f without error.
1829 *
1830 * The parameter `opacity` is ignored if it is NULL.
1831 *
1832 * This function also returns -1 if an invalid window was provided.
1833 *
1834 * \param window the window to get the current opacity value from
1835 * \param out_opacity the float filled in (0.0f - transparent, 1.0f - opaque)
1836 * \returns 0 on success or a negative error code on failure; call
1837 * SDL_GetError() for more information.
1838 *
1839 * \since This function is available since SDL 3.0.0.
1840 *
1841 * \sa SDL_SetWindowOpacity
1842 */
1843extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window *window, float *out_opacity);
1844
1845/**
1846 * Set the window as a modal for another window.
1847 *
1848 * \param modal_window the window that should be set modal
1849 * \param parent_window the parent window for the modal window
1850 * \returns 0 on success or a negative error code on failure; call
1851 * SDL_GetError() for more information.
1852 *
1853 * \since This function is available since SDL 3.0.0.
1854 */
1855extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window *modal_window, SDL_Window *parent_window);
1856
1857/**
1858 * Explicitly set input focus to the window.
1859 *
1860 * You almost certainly want SDL_RaiseWindow() instead of this function. Use
1861 * this with caution, as you might give focus to a window that is completely
1862 * obscured by other windows.
1863 *
1864 * \param window the window that should get the input focus
1865 * \returns 0 on success or a negative error code on failure; call
1866 * SDL_GetError() for more information.
1867 *
1868 * \since This function is available since SDL 3.0.0.
1869 *
1870 * \sa SDL_RaiseWindow
1871 */
1872extern DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window *window);
1873
1874/**
1875 * Set whether the window may have input focus.
1876 *
1877 * \param window the window to set focusable state
1878 * \param focusable SDL_TRUE to allow input focus, SDL_FALSE to not allow
1879 * input focus
1880 * \returns 0 on success or a negative error code on failure; call
1881 * SDL_GetError() for more information.
1882 *
1883 * \since This function is available since SDL 3.0.0.
1884 */
1885extern DECLSPEC int SDLCALL SDL_SetWindowFocusable(SDL_Window *window, SDL_bool focusable);
1886
1887
1888/**
1889 * Display the system-level window menu.
1890 *
1891 * This default window menu is provided by the system and on some platforms
1892 * provides functionality for setting or changing privileged state on the
1893 * window, such as moving it between workspaces or displays, or toggling the
1894 * always-on-top property.
1895 *
1896 * On platforms or desktops where this is unsupported, this function does
1897 * nothing.
1898 *
1899 * \param window the window for which the menu will be displayed
1900 * \param x the x coordinate of the menu, relative to the origin (top-left) of
1901 * the client area
1902 * \param y the y coordinate of the menu, relative to the origin (top-left) of
1903 * the client area
1904 * \returns 0 on success or a negative error code on failure; call
1905 * SDL_GetError() for more information.
1906 *
1907 * \since This function is available since SDL 3.0.0.
1908 */
1909extern DECLSPEC int SDLCALL SDL_ShowWindowSystemMenu(SDL_Window *window, int x, int y);
1910
1911/**
1912 * Possible return values from the SDL_HitTest callback.
1913 *
1914 * \sa SDL_HitTest
1915 */
1929
1930/**
1931 * Callback used for hit-testing.
1932 *
1933 * \param win the SDL_Window where hit-testing was set on
1934 * \param area an SDL_Point which should be hit-tested
1935 * \param data what was passed as `callback_data` to SDL_SetWindowHitTest()
1936 * \returns an SDL_HitTestResult value.
1937 *
1938 * \sa SDL_SetWindowHitTest
1939 */
1941 const SDL_Point *area,
1942 void *data);
1943
1944/**
1945 * Provide a callback that decides if a window region has special properties.
1946 *
1947 * Normally windows are dragged and resized by decorations provided by the
1948 * system window manager (a title bar, borders, etc), but for some apps, it
1949 * makes sense to drag them from somewhere else inside the window itself; for
1950 * example, one might have a borderless window that wants to be draggable from
1951 * any part, or simulate its own title bar, etc.
1952 *
1953 * This function lets the app provide a callback that designates pieces of a
1954 * given window as special. This callback is run during event processing if we
1955 * need to tell the OS to treat a region of the window specially; the use of
1956 * this callback is known as "hit testing."
1957 *
1958 * Mouse input may not be delivered to your application if it is within a
1959 * special area; the OS will often apply that input to moving the window or
1960 * resizing the window and not deliver it to the application.
1961 *
1962 * Specifying NULL for a callback disables hit-testing. Hit-testing is
1963 * disabled by default.
1964 *
1965 * Platforms that don't support this functionality will return -1
1966 * unconditionally, even if you're attempting to disable hit-testing.
1967 *
1968 * Your callback may fire at any time, and its firing does not indicate any
1969 * specific behavior (for example, on Windows, this certainly might fire when
1970 * the OS is deciding whether to drag your window, but it fires for lots of
1971 * other reasons, too, some unrelated to anything you probably care about _and
1972 * when the mouse isn't actually at the location it is testing_). Since this
1973 * can fire at any time, you should try to keep your callback efficient,
1974 * devoid of allocations, etc.
1975 *
1976 * \param window the window to set hit-testing on
1977 * \param callback the function to call when doing a hit-test
1978 * \param callback_data an app-defined void pointer passed to **callback**
1979 * \returns 0 on success or a negative error code on failure; call
1980 * SDL_GetError() for more information.
1981 *
1982 * \since This function is available since SDL 3.0.0.
1983 */
1984extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data);
1985
1986/**
1987 * Request a window to demand attention from the user.
1988 *
1989 * \param window the window to be flashed
1990 * \param operation the flash operation
1991 * \returns 0 on success or a negative error code on failure; call
1992 * SDL_GetError() for more information.
1993 *
1994 * \since This function is available since SDL 3.0.0.
1995 */
1996extern DECLSPEC int SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation);
1997
1998/**
1999 * Destroy a window.
2000 *
2001 * If `window` is NULL, this function will return immediately after setting
2002 * the SDL error message to "Invalid window". See SDL_GetError().
2003 *
2004 * \param window the window to destroy
2005 *
2006 * \since This function is available since SDL 3.0.0.
2007 *
2008 * \sa SDL_CreatePopupWindow
2009 * \sa SDL_CreateWindow
2010 * \sa SDL_CreateWindowWithProperties
2011 */
2012extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window *window);
2013
2014
2015/**
2016 * Check whether the screensaver is currently enabled.
2017 *
2018 * The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2
2019 * the screensaver was enabled by default.
2020 *
2021 * The default can also be changed using `SDL_HINT_VIDEO_ALLOW_SCREENSAVER`.
2022 *
2023 * \returns SDL_TRUE if the screensaver is enabled, SDL_FALSE if it is
2024 * disabled.
2025 *
2026 * \since This function is available since SDL 3.0.0.
2027 *
2028 * \sa SDL_DisableScreenSaver
2029 * \sa SDL_EnableScreenSaver
2030 */
2031extern DECLSPEC SDL_bool SDLCALL SDL_ScreenSaverEnabled(void);
2032
2033/**
2034 * Allow the screen to be blanked by a screen saver.
2035 *
2036 * \returns 0 on success or a negative error code on failure; call
2037 * SDL_GetError() for more information.
2038 *
2039 * \since This function is available since SDL 3.0.0.
2040 *
2041 * \sa SDL_DisableScreenSaver
2042 * \sa SDL_ScreenSaverEnabled
2043 */
2044extern DECLSPEC int SDLCALL SDL_EnableScreenSaver(void);
2045
2046/**
2047 * Prevent the screen from being blanked by a screen saver.
2048 *
2049 * If you disable the screensaver, it is automatically re-enabled when SDL
2050 * quits.
2051 *
2052 * The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2
2053 * the screensaver was enabled by default.
2054 *
2055 * \returns 0 on success or a negative error code on failure; call
2056 * SDL_GetError() for more information.
2057 *
2058 * \since This function is available since SDL 3.0.0.
2059 *
2060 * \sa SDL_EnableScreenSaver
2061 * \sa SDL_ScreenSaverEnabled
2062 */
2063extern DECLSPEC int SDLCALL SDL_DisableScreenSaver(void);
2064
2065
2066/**
2067 * \name OpenGL support functions
2068 */
2069/* @{ */
2070
2071/**
2072 * Dynamically load an OpenGL library.
2073 *
2074 * This should be done after initializing the video driver, but before
2075 * creating any OpenGL windows. If no OpenGL library is loaded, the default
2076 * library will be loaded upon creation of the first OpenGL window.
2077 *
2078 * If you do this, you need to retrieve all of the GL functions used in your
2079 * program from the dynamic library using SDL_GL_GetProcAddress().
2080 *
2081 * \param path the platform dependent OpenGL library name, or NULL to open the
2082 * default OpenGL library
2083 * \returns 0 on success or a negative error code on failure; call
2084 * SDL_GetError() for more information.
2085 *
2086 * \since This function is available since SDL 3.0.0.
2087 *
2088 * \sa SDL_GL_GetProcAddress
2089 * \sa SDL_GL_UnloadLibrary
2090 */
2091extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
2092
2093/**
2094 * Get an OpenGL function by name.
2095 *
2096 * If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all
2097 * GL functions must be retrieved this way. Usually this is used to retrieve
2098 * function pointers to OpenGL extensions.
2099 *
2100 * There are some quirks to looking up OpenGL functions that require some
2101 * extra care from the application. If you code carefully, you can handle
2102 * these quirks without any platform-specific code, though:
2103 *
2104 * - On Windows, function pointers are specific to the current GL context;
2105 * this means you need to have created a GL context and made it current
2106 * before calling SDL_GL_GetProcAddress(). If you recreate your context or
2107 * create a second context, you should assume that any existing function
2108 * pointers aren't valid to use with it. This is (currently) a
2109 * Windows-specific limitation, and in practice lots of drivers don't suffer
2110 * this limitation, but it is still the way the wgl API is documented to
2111 * work and you should expect crashes if you don't respect it. Store a copy
2112 * of the function pointers that comes and goes with context lifespan.
2113 * - On X11, function pointers returned by this function are valid for any
2114 * context, and can even be looked up before a context is created at all.
2115 * This means that, for at least some common OpenGL implementations, if you
2116 * look up a function that doesn't exist, you'll get a non-NULL result that
2117 * is _NOT_ safe to call. You must always make sure the function is actually
2118 * available for a given GL context before calling it, by checking for the
2119 * existence of the appropriate extension with SDL_GL_ExtensionSupported(),
2120 * or verifying that the version of OpenGL you're using offers the function
2121 * as core functionality.
2122 * - Some OpenGL drivers, on all platforms, *will* return NULL if a function
2123 * isn't supported, but you can't count on this behavior. Check for
2124 * extensions you use, and if you get a NULL anyway, act as if that
2125 * extension wasn't available. This is probably a bug in the driver, but you
2126 * can code defensively for this scenario anyhow.
2127 * - Just because you're on Linux/Unix, don't assume you'll be using X11.
2128 * Next-gen display servers are waiting to replace it, and may or may not
2129 * make the same promises about function pointers.
2130 * - OpenGL function pointers must be declared `APIENTRY` as in the example
2131 * code. This will ensure the proper calling convention is followed on
2132 * platforms where this matters (Win32) thereby avoiding stack corruption.
2133 *
2134 * \param proc the name of an OpenGL function
2135 * \returns a pointer to the named OpenGL function. The returned pointer
2136 * should be cast to the appropriate function signature.
2137 *
2138 * \since This function is available since SDL 3.0.0.
2139 *
2140 * \sa SDL_GL_ExtensionSupported
2141 * \sa SDL_GL_LoadLibrary
2142 * \sa SDL_GL_UnloadLibrary
2143 */
2144extern DECLSPEC SDL_FunctionPointer SDLCALL SDL_GL_GetProcAddress(const char *proc);
2145
2146/**
2147 * Get an EGL library function by name.
2148 *
2149 * If an EGL library is loaded, this function allows applications to get entry
2150 * points for EGL functions. This is useful to provide to an EGL API and
2151 * extension loader.
2152 *
2153 * \param proc the name of an EGL function
2154 * \returns a pointer to the named EGL function. The returned pointer should
2155 * be cast to the appropriate function signature.
2156 *
2157 * \since This function is available since SDL 3.0.0.
2158 *
2159 * \sa SDL_GL_GetCurrentEGLDisplay
2160 */
2161extern DECLSPEC SDL_FunctionPointer SDLCALL SDL_EGL_GetProcAddress(const char *proc);
2162
2163/**
2164 * Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
2165 *
2166 * \since This function is available since SDL 3.0.0.
2167 *
2168 * \sa SDL_GL_LoadLibrary
2169 */
2170extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
2171
2172/**
2173 * Check if an OpenGL extension is supported for the current context.
2174 *
2175 * This function operates on the current GL context; you must have created a
2176 * context and it must be current before calling this function. Do not assume
2177 * that all contexts you create will have the same set of extensions
2178 * available, or that recreating an existing context will offer the same
2179 * extensions again.
2180 *
2181 * While it's probably not a massive overhead, this function is not an O(1)
2182 * operation. Check the extensions you care about after creating the GL
2183 * context and save that information somewhere instead of calling the function
2184 * every time you need to know.
2185 *
2186 * \param extension the name of the extension to check
2187 * \returns SDL_TRUE if the extension is supported, SDL_FALSE otherwise.
2188 *
2189 * \since This function is available since SDL 3.0.0.
2190 */
2191extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char *extension);
2192
2193/**
2194 * Reset all previously set OpenGL context attributes to their default values.
2195 *
2196 * \since This function is available since SDL 3.0.0.
2197 *
2198 * \sa SDL_GL_GetAttribute
2199 * \sa SDL_GL_SetAttribute
2200 */
2201extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
2202
2203/**
2204 * Set an OpenGL window attribute before window creation.
2205 *
2206 * This function sets the OpenGL attribute `attr` to `value`. The requested
2207 * attributes should be set before creating an OpenGL window. You should use
2208 * SDL_GL_GetAttribute() to check the values after creating the OpenGL
2209 * context, since the values obtained can differ from the requested ones.
2210 *
2211 * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to set
2212 * \param value the desired value for the attribute
2213 * \returns 0 on success or a negative error code on failure; call
2214 * SDL_GetError() for more information.
2215 *
2216 * \since This function is available since SDL 3.0.0.
2217 *
2218 * \sa SDL_GL_GetAttribute
2219 * \sa SDL_GL_ResetAttributes
2220 */
2221extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
2222
2223/**
2224 * Get the actual value for an attribute from the current context.
2225 *
2226 * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to get
2227 * \param value a pointer filled in with the current value of `attr`
2228 * \returns 0 on success or a negative error code on failure; call
2229 * SDL_GetError() for more information.
2230 *
2231 * \since This function is available since SDL 3.0.0.
2232 *
2233 * \sa SDL_GL_ResetAttributes
2234 * \sa SDL_GL_SetAttribute
2235 */
2236extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
2237
2238/**
2239 * Create an OpenGL context for an OpenGL window, and make it current.
2240 *
2241 * Windows users new to OpenGL should note that, for historical reasons, GL
2242 * functions added after OpenGL version 1.1 are not available by default.
2243 * Those functions must be loaded at run-time, either with an OpenGL
2244 * extension-handling library or with SDL_GL_GetProcAddress() and its related
2245 * functions.
2246 *
2247 * SDL_GLContext is an alias for `void *`. It's opaque to the application.
2248 *
2249 * \param window the window to associate with the context
2250 * \returns the OpenGL context associated with `window` or NULL on error; call
2251 * SDL_GetError() for more details.
2252 *
2253 * \since This function is available since SDL 3.0.0.
2254 *
2255 * \sa SDL_GL_DeleteContext
2256 * \sa SDL_GL_MakeCurrent
2257 */
2258extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *window);
2259
2260/**
2261 * Set up an OpenGL context for rendering into an OpenGL window.
2262 *
2263 * The context must have been created with a compatible window.
2264 *
2265 * \param window the window to associate with the context
2266 * \param context the OpenGL context to associate with the window
2267 * \returns 0 on success or a negative error code on failure; call
2268 * SDL_GetError() for more information.
2269 *
2270 * \since This function is available since SDL 3.0.0.
2271 *
2272 * \sa SDL_GL_CreateContext
2273 */
2274extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext context);
2275
2276/**
2277 * Get the currently active OpenGL window.
2278 *
2279 * \returns the currently active OpenGL window on success or NULL on failure;
2280 * call SDL_GetError() for more information.
2281 *
2282 * \since This function is available since SDL 3.0.0.
2283 */
2284extern DECLSPEC SDL_Window *SDLCALL SDL_GL_GetCurrentWindow(void);
2285
2286/**
2287 * Get the currently active OpenGL context.
2288 *
2289 * \returns the currently active OpenGL context or NULL on failure; call
2290 * SDL_GetError() for more information.
2291 *
2292 * \since This function is available since SDL 3.0.0.
2293 *
2294 * \sa SDL_GL_MakeCurrent
2295 */
2296extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
2297
2298/**
2299 * Get the currently active EGL display.
2300 *
2301 * \returns the currently active EGL display or NULL on failure; call
2302 * SDL_GetError() for more information.
2303 *
2304 * \since This function is available since SDL 3.0.0.
2305 */
2306extern DECLSPEC SDL_EGLDisplay SDLCALL SDL_EGL_GetCurrentEGLDisplay(void);
2307
2308/**
2309 * Get the currently active EGL config.
2310 *
2311 * \returns the currently active EGL config or NULL on failure; call
2312 * SDL_GetError() for more information.
2313 *
2314 * \since This function is available since SDL 3.0.0.
2315 */
2316extern DECLSPEC SDL_EGLConfig SDLCALL SDL_EGL_GetCurrentEGLConfig(void);
2317
2318/**
2319 * Get the EGL surface associated with the window.
2320 *
2321 * \param window the window to query
2322 * \returns the EGLSurface pointer associated with the window, or NULL on
2323 * failure.
2324 *
2325 * \since This function is available since SDL 3.0.0.
2326 */
2328
2329/**
2330 * Sets the callbacks for defining custom EGLAttrib arrays for EGL
2331 * initialization.
2332 *
2333 * Each callback should return a pointer to an EGL attribute array terminated
2334 * with EGL_NONE. Callbacks may return NULL pointers to signal an error, which
2335 * will cause the SDL_CreateWindow process to fail gracefully.
2336 *
2337 * The arrays returned by each callback will be appended to the existing
2338 * attribute arrays defined by SDL.
2339 *
2340 * NOTE: These callback pointers will be reset after SDL_GL_ResetAttributes.
2341 *
2342 * \param platformAttribCallback Callback for attributes to pass to
2343 * eglGetPlatformDisplay.
2344 * \param surfaceAttribCallback Callback for attributes to pass to
2345 * eglCreateSurface.
2346 * \param contextAttribCallback Callback for attributes to pass to
2347 * eglCreateContext.
2348 *
2349 * \since This function is available since SDL 3.0.0.
2350 */
2351extern DECLSPEC void SDLCALL SDL_EGL_SetEGLAttributeCallbacks(SDL_EGLAttribArrayCallback platformAttribCallback,
2352 SDL_EGLIntArrayCallback surfaceAttribCallback,
2353 SDL_EGLIntArrayCallback contextAttribCallback);
2354
2355/**
2356 * Set the swap interval for the current OpenGL context.
2357 *
2358 * Some systems allow specifying -1 for the interval, to enable adaptive
2359 * vsync. Adaptive vsync works the same as vsync, but if you've already missed
2360 * the vertical retrace for a given frame, it swaps buffers immediately, which
2361 * might be less jarring for the user during occasional framerate drops. If an
2362 * application requests adaptive vsync and the system does not support it,
2363 * this function will fail and return -1. In such a case, you should probably
2364 * retry the call with 1 for the interval.
2365 *
2366 * Adaptive vsync is implemented for some glX drivers with
2367 * GLX_EXT_swap_control_tear, and for some Windows drivers with
2368 * WGL_EXT_swap_control_tear.
2369 *
2370 * Read more on the Khronos wiki:
2371 * https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync
2372 *
2373 * \param interval 0 for immediate updates, 1 for updates synchronized with
2374 * the vertical retrace, -1 for adaptive vsync
2375 * \returns 0 on success or a negative error code on failure; call
2376 * SDL_GetError() for more information.
2377 *
2378 * \since This function is available since SDL 3.0.0.
2379 *
2380 * \sa SDL_GL_GetSwapInterval
2381 */
2382extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
2383
2384/**
2385 * Get the swap interval for the current OpenGL context.
2386 *
2387 * If the system can't determine the swap interval, or there isn't a valid
2388 * current context, this function will set *interval to 0 as a safe default.
2389 *
2390 * \param interval Output interval value. 0 if there is no vertical retrace
2391 * synchronization, 1 if the buffer swap is synchronized with
2392 * the vertical retrace, and -1 if late swaps happen
2393 * immediately instead of waiting for the next retrace
2394 * \returns 0 on success or a negative error code on failure; call
2395 * SDL_GetError() for more information.
2396 *
2397 * \since This function is available since SDL 3.0.0.
2398 *
2399 * \sa SDL_GL_SetSwapInterval
2400 */
2401extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(int *interval);
2402
2403/**
2404 * Update a window with OpenGL rendering.
2405 *
2406 * This is used with double-buffered OpenGL contexts, which are the default.
2407 *
2408 * On macOS, make sure you bind 0 to the draw framebuffer before swapping the
2409 * window, otherwise nothing will happen. If you aren't using
2410 * glBindFramebuffer(), this is the default and you won't have to do anything
2411 * extra.
2412 *
2413 * \param window the window to change
2414 * \returns 0 on success or a negative error code on failure; call
2415 * SDL_GetError() for more information.
2416 *
2417 * \since This function is available since SDL 3.0.0.
2418 */
2419extern DECLSPEC int SDLCALL SDL_GL_SwapWindow(SDL_Window *window);
2420
2421/**
2422 * Delete an OpenGL context.
2423 *
2424 * \param context the OpenGL context to be deleted
2425 * \returns 0 on success or a negative error code on failure; call
2426 * SDL_GetError() for more information.
2427 *
2428 * \since This function is available since SDL 3.0.0.
2429 *
2430 * \sa SDL_GL_CreateContext
2431 */
2432extern DECLSPEC int SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
2433
2434/* @} *//* OpenGL support functions */
2435
2436
2437/* Ends C function definitions when using C++ */
2438#ifdef __cplusplus
2439}
2440#endif
2441#include <SDL3/SDL_close_code.h>
2442
2443#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:1917
@ SDL_HITTEST_DRAGGABLE
Definition SDL_video.h:1919
@ SDL_HITTEST_RESIZE_LEFT
Definition SDL_video.h:1927
@ SDL_HITTEST_RESIZE_TOP
Definition SDL_video.h:1921
@ SDL_HITTEST_RESIZE_TOPRIGHT
Definition SDL_video.h:1922
@ SDL_HITTEST_NORMAL
Definition SDL_video.h:1918
@ SDL_HITTEST_RESIZE_BOTTOM
Definition SDL_video.h:1925
@ SDL_HITTEST_RESIZE_BOTTOMRIGHT
Definition SDL_video.h:1924
@ SDL_HITTEST_RESIZE_BOTTOMLEFT
Definition SDL_video.h:1926
@ SDL_HITTEST_RESIZE_RIGHT
Definition SDL_video.h:1923
@ SDL_HITTEST_RESIZE_TOPLEFT
Definition SDL_video.h:1920
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:1940
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