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