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