2 Simple DirectMedia Layer
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.
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:
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.
25 * Header file for SDL video functions.
31 #include "SDL_stdinc.h"
32 #include "SDL_pixels.h"
34 #include "SDL_surface.h"
36 #include "begin_code.h"
37 /* Set up for C function definitions, even when using C++ */
43 * \brief The structure that defines a display mode
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()
55 Uint32 format; /**< pixel format */
58 int refresh_rate; /**< refresh rate (or zero for unspecified) */
59 void *driverdata; /**< driver-specific data, initialize to 0 */
63 * \brief The type used to identify a window
65 * \sa SDL_CreateWindow()
66 * \sa SDL_CreateWindowFrom()
67 * \sa SDL_DestroyWindow()
68 * \sa SDL_GetWindowData()
69 * \sa SDL_GetWindowFlags()
70 * \sa SDL_GetWindowGrab()
71 * \sa SDL_GetWindowPosition()
72 * \sa SDL_GetWindowSize()
73 * \sa SDL_GetWindowTitle()
74 * \sa SDL_HideWindow()
75 * \sa SDL_MaximizeWindow()
76 * \sa SDL_MinimizeWindow()
77 * \sa SDL_RaiseWindow()
78 * \sa SDL_RestoreWindow()
79 * \sa SDL_SetWindowData()
80 * \sa SDL_SetWindowFullscreen()
81 * \sa SDL_SetWindowGrab()
82 * \sa SDL_SetWindowIcon()
83 * \sa SDL_SetWindowPosition()
84 * \sa SDL_SetWindowSize()
85 * \sa SDL_SetWindowBordered()
86 * \sa SDL_SetWindowTitle()
87 * \sa SDL_ShowWindow()
89 typedef struct SDL_Window SDL_Window;
92 * \brief The flags on a window
94 * \sa SDL_GetWindowFlags()
98 SDL_WINDOW_FULLSCREEN = 0x00000001, /**< fullscreen window */
99 SDL_WINDOW_OPENGL = 0x00000002, /**< window usable with OpenGL context */
100 SDL_WINDOW_SHOWN = 0x00000004, /**< window is visible */
101 SDL_WINDOW_HIDDEN = 0x00000008, /**< window is not visible */
102 SDL_WINDOW_BORDERLESS = 0x00000010, /**< no window decoration */
103 SDL_WINDOW_RESIZABLE = 0x00000020, /**< window can be resized */
104 SDL_WINDOW_MINIMIZED = 0x00000040, /**< window is minimized */
105 SDL_WINDOW_MAXIMIZED = 0x00000080, /**< window is maximized */
106 SDL_WINDOW_INPUT_GRABBED = 0x00000100, /**< window has grabbed input focus */
107 SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */
108 SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
109 SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
110 SDL_WINDOW_FOREIGN = 0x00000800, /**< window not created by SDL */
111 SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000 /**< window should be created in high-DPI mode if supported */
115 * \brief Used to indicate that you don't care what the window position is.
117 #define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000
118 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
119 #define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
120 #define SDL_WINDOWPOS_ISUNDEFINED(X) \
121 (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
124 * \brief Used to indicate that the window position should be centered.
126 #define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000
127 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK|(X))
128 #define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0)
129 #define SDL_WINDOWPOS_ISCENTERED(X) \
130 (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
133 * \brief Event subtype for window events
137 SDL_WINDOWEVENT_NONE, /**< Never used */
138 SDL_WINDOWEVENT_SHOWN, /**< Window has been shown */
139 SDL_WINDOWEVENT_HIDDEN, /**< Window has been hidden */
140 SDL_WINDOWEVENT_EXPOSED, /**< Window has been exposed and should be
142 SDL_WINDOWEVENT_MOVED, /**< Window has been moved to data1, data2
144 SDL_WINDOWEVENT_RESIZED, /**< Window has been resized to data1xdata2 */
145 SDL_WINDOWEVENT_SIZE_CHANGED, /**< The window size has changed, either as a result of an API call or through the system or user changing the window size. */
146 SDL_WINDOWEVENT_MINIMIZED, /**< Window has been minimized */
147 SDL_WINDOWEVENT_MAXIMIZED, /**< Window has been maximized */
148 SDL_WINDOWEVENT_RESTORED, /**< Window has been restored to normal size
150 SDL_WINDOWEVENT_ENTER, /**< Window has gained mouse focus */
151 SDL_WINDOWEVENT_LEAVE, /**< Window has lost mouse focus */
152 SDL_WINDOWEVENT_FOCUS_GAINED, /**< Window has gained keyboard focus */
153 SDL_WINDOWEVENT_FOCUS_LOST, /**< Window has lost keyboard focus */
154 SDL_WINDOWEVENT_CLOSE /**< The window manager requests that the
159 * \brief An opaque handle to an OpenGL context.
161 typedef void *SDL_GLContext;
164 * \brief OpenGL configuration attributes
176 SDL_GL_ACCUM_RED_SIZE,
177 SDL_GL_ACCUM_GREEN_SIZE,
178 SDL_GL_ACCUM_BLUE_SIZE,
179 SDL_GL_ACCUM_ALPHA_SIZE,
181 SDL_GL_MULTISAMPLEBUFFERS,
182 SDL_GL_MULTISAMPLESAMPLES,
183 SDL_GL_ACCELERATED_VISUAL,
184 SDL_GL_RETAINED_BACKING,
185 SDL_GL_CONTEXT_MAJOR_VERSION,
186 SDL_GL_CONTEXT_MINOR_VERSION,
188 SDL_GL_CONTEXT_FLAGS,
189 SDL_GL_CONTEXT_PROFILE_MASK,
190 SDL_GL_SHARE_WITH_CURRENT_CONTEXT,
191 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE
196 SDL_GL_CONTEXT_PROFILE_CORE = 0x0001,
197 SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002,
198 SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /* GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
203 SDL_GL_CONTEXT_DEBUG_FLAG = 0x0001,
204 SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
205 SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG = 0x0004,
206 SDL_GL_CONTEXT_RESET_ISOLATION_FLAG = 0x0008
210 /* Function prototypes */
213 * \brief Get the number of video drivers compiled into SDL
215 * \sa SDL_GetVideoDriver()
217 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
220 * \brief Get the name of a built in video driver.
222 * \note The video drivers are presented in the order in which they are
223 * normally checked during initialization.
225 * \sa SDL_GetNumVideoDrivers()
227 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
230 * \brief Initialize the video subsystem, optionally specifying a video driver.
232 * \param driver_name Initialize a specific driver by name, or NULL for the
233 * default video driver.
235 * \return 0 on success, -1 on error
237 * This function initializes the video subsystem; setting up a connection
238 * to the window manager, etc, and determines the available display modes
239 * and pixel formats, but does not initialize a window or graphics mode.
241 * \sa SDL_VideoQuit()
243 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
246 * \brief Shuts down the video subsystem.
248 * This function closes all windows, and restores the original video mode.
250 * \sa SDL_VideoInit()
252 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
255 * \brief Returns the name of the currently initialized video driver.
257 * \return The name of the current video driver or NULL if no driver
258 * has been initialized
260 * \sa SDL_GetNumVideoDrivers()
261 * \sa SDL_GetVideoDriver()
263 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
266 * \brief Returns the number of available video displays.
268 * \sa SDL_GetDisplayBounds()
270 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
273 * \brief Get the name of a display in UTF-8 encoding
275 * \return The name of a display, or NULL for an invalid display index.
277 * \sa SDL_GetNumVideoDisplays()
279 extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
282 * \brief Get the desktop area represented by a display, with the primary
283 * display located at 0,0
285 * \return 0 on success, or -1 if the index is out of range.
287 * \sa SDL_GetNumVideoDisplays()
289 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
292 * \brief Returns the number of available display modes.
294 * \sa SDL_GetDisplayMode()
296 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
299 * \brief Fill in information about a specific display mode.
301 * \note The display modes are sorted in this priority:
302 * \li bits per pixel -> more colors to fewer colors
303 * \li width -> largest to smallest
304 * \li height -> largest to smallest
305 * \li refresh rate -> highest to lowest
307 * \sa SDL_GetNumDisplayModes()
309 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
310 SDL_DisplayMode * mode);
313 * \brief Fill in information about the desktop display mode.
315 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
318 * \brief Fill in information about the current display mode.
320 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
324 * \brief Get the closest match to the requested display mode.
326 * \param displayIndex The index of display from which mode should be queried.
327 * \param mode The desired display mode
328 * \param closest A pointer to a display mode to be filled in with the closest
329 * match of the available display modes.
331 * \return The passed in value \c closest, or NULL if no matching video mode
334 * The available display modes are scanned, and \c closest is filled in with the
335 * closest mode matching the requested mode and returned. The mode format and
336 * refresh_rate default to the desktop mode if they are 0. The modes are
337 * scanned with size being first priority, format being second priority, and
338 * finally checking the refresh_rate. If all the available modes are too
339 * small, then NULL is returned.
341 * \sa SDL_GetNumDisplayModes()
342 * \sa SDL_GetDisplayMode()
344 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
347 * \brief Get the display index associated with a window.
349 * \return the display index of the display containing the center of the
350 * window, or -1 on error.
352 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window);
355 * \brief Set the display mode used when a fullscreen window is visible.
357 * By default the window's dimensions and the desktop format and refresh rate
360 * \param window The window for which the display mode should be set.
361 * \param mode The mode to use, or NULL for the default mode.
363 * \return 0 on success, or -1 if setting the display mode failed.
365 * \sa SDL_GetWindowDisplayMode()
366 * \sa SDL_SetWindowFullscreen()
368 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
369 const SDL_DisplayMode
373 * \brief Fill in information about the display mode used when a fullscreen
376 * \sa SDL_SetWindowDisplayMode()
377 * \sa SDL_SetWindowFullscreen()
379 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
380 SDL_DisplayMode * mode);
383 * \brief Get the pixel format associated with the window.
385 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
388 * \brief Create a window with the specified position, dimensions, and flags.
390 * \param title The title of the window, in UTF-8 encoding.
391 * \param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
392 * ::SDL_WINDOWPOS_UNDEFINED.
393 * \param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
394 * ::SDL_WINDOWPOS_UNDEFINED.
395 * \param w The width of the window.
396 * \param h The height of the window.
397 * \param flags The flags for the window, a mask of any of the following:
398 * ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL,
399 * ::SDL_WINDOW_HIDDEN, ::SDL_WINDOW_BORDERLESS,
400 * ::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED,
401 * ::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_INPUT_GRABBED,
402 * ::SDL_WINDOW_ALLOW_HIGHDPI.
404 * \return The id of the window created, or zero if window creation failed.
406 * \sa SDL_DestroyWindow()
408 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
410 int h, Uint32 flags);
413 * \brief Create an SDL window from an existing native window.
415 * \param data A pointer to driver-dependent window creation data
417 * \return The id of the window created, or zero if window creation failed.
419 * \sa SDL_DestroyWindow()
421 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
424 * \brief Get the numeric ID of a window, for logging purposes.
426 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
429 * \brief Get a window from a stored ID, or NULL if it doesn't exist.
431 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
434 * \brief Get the window flags.
436 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
439 * \brief Set the title of a window, in UTF-8 format.
441 * \sa SDL_GetWindowTitle()
443 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
447 * \brief Get the title of a window, in UTF-8 format.
449 * \sa SDL_SetWindowTitle()
451 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
454 * \brief Set the icon for a window.
456 * \param window The window for which the icon should be set.
457 * \param icon The icon for the window.
459 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
463 * \brief Associate an arbitrary named pointer with a window.
465 * \param window The window to associate with the pointer.
466 * \param name The name of the pointer.
467 * \param userdata The associated pointer.
469 * \return The previous value associated with 'name'
471 * \note The name is case-sensitive.
473 * \sa SDL_GetWindowData()
475 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
480 * \brief Retrieve the data pointer associated with a window.
482 * \param window The window to query.
483 * \param name The name of the pointer.
485 * \return The value associated with 'name'
487 * \sa SDL_SetWindowData()
489 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
493 * \brief Set the position of a window.
495 * \param window The window to reposition.
496 * \param x The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
497 ::SDL_WINDOWPOS_UNDEFINED.
498 * \param y The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
499 ::SDL_WINDOWPOS_UNDEFINED.
501 * \note The window coordinate origin is the upper left of the display.
503 * \sa SDL_GetWindowPosition()
505 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
509 * \brief Get the position of a window.
511 * \param window The window to query.
512 * \param x Pointer to variable for storing the x position, may be NULL
513 * \param y Pointer to variable for storing the y position, may be NULL
515 * \sa SDL_SetWindowPosition()
517 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
521 * \brief Set the size of a window's client area.
523 * \param window The window to resize.
524 * \param w The width of the window, must be >0
525 * \param h The height of the window, must be >0
527 * \note You can't change the size of a fullscreen window, it automatically
528 * matches the size of the display mode.
530 * \sa SDL_GetWindowSize()
532 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
536 * \brief Get the size of a window's client area.
538 * \param window The window to query.
539 * \param w Pointer to variable for storing the width, may be NULL
540 * \param h Pointer to variable for storing the height, may be NULL
542 * \sa SDL_SetWindowSize()
544 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
548 * \brief Set the minimum size of a window's client area.
550 * \param window The window to set a new minimum size.
551 * \param min_w The minimum width of the window, must be >0
552 * \param min_h The minimum height of the window, must be >0
554 * \note You can't change the minimum size of a fullscreen window, it
555 * automatically matches the size of the display mode.
557 * \sa SDL_GetWindowMinimumSize()
558 * \sa SDL_SetWindowMaximumSize()
560 extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window,
561 int min_w, int min_h);
564 * \brief Get the minimum size of a window's client area.
566 * \param window The window to query.
567 * \param w Pointer to variable for storing the minimum width, may be NULL
568 * \param h Pointer to variable for storing the minimum height, may be NULL
570 * \sa SDL_GetWindowMaximumSize()
571 * \sa SDL_SetWindowMinimumSize()
573 extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window,
577 * \brief Set the maximum size of a window's client area.
579 * \param window The window to set a new maximum size.
580 * \param max_w The maximum width of the window, must be >0
581 * \param max_h The maximum height of the window, must be >0
583 * \note You can't change the maximum size of a fullscreen window, it
584 * automatically matches the size of the display mode.
586 * \sa SDL_GetWindowMaximumSize()
587 * \sa SDL_SetWindowMinimumSize()
589 extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window,
590 int max_w, int max_h);
593 * \brief Get the maximum size of a window's client area.
595 * \param window The window to query.
596 * \param w Pointer to variable for storing the maximum width, may be NULL
597 * \param h Pointer to variable for storing the maximum height, may be NULL
599 * \sa SDL_GetWindowMinimumSize()
600 * \sa SDL_SetWindowMaximumSize()
602 extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window,
606 * \brief Set the border state of a window.
608 * This will add or remove the window's SDL_WINDOW_BORDERLESS flag and
609 * add or remove the border from the actual window. This is a no-op if the
610 * window's border already matches the requested state.
612 * \param window The window of which to change the border state.
613 * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border.
615 * \note You can't change the border state of a fullscreen window.
617 * \sa SDL_GetWindowFlags()
619 extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window,
623 * \brief Show a window.
625 * \sa SDL_HideWindow()
627 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
630 * \brief Hide a window.
632 * \sa SDL_ShowWindow()
634 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
637 * \brief Raise a window above other windows and set the input focus.
639 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
642 * \brief Make a window as large as possible.
644 * \sa SDL_RestoreWindow()
646 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
649 * \brief Minimize a window to an iconic representation.
651 * \sa SDL_RestoreWindow()
653 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
656 * \brief Restore the size and position of a minimized or maximized window.
658 * \sa SDL_MaximizeWindow()
659 * \sa SDL_MinimizeWindow()
661 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
664 * \brief Set a window's fullscreen state.
666 * \return 0 on success, or -1 if setting the display mode failed.
668 * \sa SDL_SetWindowDisplayMode()
669 * \sa SDL_GetWindowDisplayMode()
671 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
675 * \brief Get the SDL surface associated with the window.
677 * \return The window's framebuffer surface, or NULL on error.
679 * A new surface will be created with the optimal format for the window,
680 * if necessary. This surface will be freed when the window is destroyed.
682 * \note You may not combine this with 3D or the rendering API on this window.
684 * \sa SDL_UpdateWindowSurface()
685 * \sa SDL_UpdateWindowSurfaceRects()
687 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
690 * \brief Copy the window surface to the screen.
692 * \return 0 on success, or -1 on error.
694 * \sa SDL_GetWindowSurface()
695 * \sa SDL_UpdateWindowSurfaceRects()
697 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
700 * \brief Copy a number of rectangles on the window surface to the screen.
702 * \return 0 on success, or -1 on error.
704 * \sa SDL_GetWindowSurface()
705 * \sa SDL_UpdateWindowSurfaceRect()
707 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
708 const SDL_Rect * rects,
712 * \brief Set a window's input grab mode.
714 * \param window The window for which the input grab mode should be set.
715 * \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
717 * \sa SDL_GetWindowGrab()
719 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
723 * \brief Get a window's input grab mode.
725 * \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.
727 * \sa SDL_SetWindowGrab()
729 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
732 * \brief Set the brightness (gamma correction) for a window.
734 * \return 0 on success, or -1 if setting the brightness isn't supported.
736 * \sa SDL_GetWindowBrightness()
737 * \sa SDL_SetWindowGammaRamp()
739 extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
742 * \brief Get the brightness (gamma correction) for a window.
744 * \return The last brightness value passed to SDL_SetWindowBrightness()
746 * \sa SDL_SetWindowBrightness()
748 extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
751 * \brief Set the gamma ramp for a window.
753 * \param window The window for which the gamma ramp should be set.
754 * \param red The translation table for the red channel, or NULL.
755 * \param green The translation table for the green channel, or NULL.
756 * \param blue The translation table for the blue channel, or NULL.
758 * \return 0 on success, or -1 if gamma ramps are unsupported.
760 * Set the gamma translation table for the red, green, and blue channels
761 * of the video hardware. Each table is an array of 256 16-bit quantities,
762 * representing a mapping between the input and output for that channel.
763 * The input is the index into the array, and the output is the 16-bit
764 * gamma value at that index, scaled to the output color precision.
766 * \sa SDL_GetWindowGammaRamp()
768 extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
770 const Uint16 * green,
771 const Uint16 * blue);
774 * \brief Get the gamma ramp for a window.
776 * \param window The window from which the gamma ramp should be queried.
777 * \param red A pointer to a 256 element array of 16-bit quantities to hold
778 * the translation table for the red channel, or NULL.
779 * \param green A pointer to a 256 element array of 16-bit quantities to hold
780 * the translation table for the green channel, or NULL.
781 * \param blue A pointer to a 256 element array of 16-bit quantities to hold
782 * the translation table for the blue channel, or NULL.
784 * \return 0 on success, or -1 if gamma ramps are unsupported.
786 * \sa SDL_SetWindowGammaRamp()
788 extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
794 * \brief Destroy a window.
796 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
800 * \brief Returns whether the screensaver is currently enabled (default on).
802 * \sa SDL_EnableScreenSaver()
803 * \sa SDL_DisableScreenSaver()
805 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
808 * \brief Allow the screen to be blanked by a screensaver
810 * \sa SDL_IsScreenSaverEnabled()
811 * \sa SDL_DisableScreenSaver()
813 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
816 * \brief Prevent the screen from being blanked by a screensaver
818 * \sa SDL_IsScreenSaverEnabled()
819 * \sa SDL_EnableScreenSaver()
821 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
825 * \name OpenGL support functions
830 * \brief Dynamically load an OpenGL library.
832 * \param path The platform dependent OpenGL library name, or NULL to open the
833 * default OpenGL library.
835 * \return 0 on success, or -1 if the library couldn't be loaded.
837 * This should be done after initializing the video driver, but before
838 * creating any OpenGL windows. If no OpenGL library is loaded, the default
839 * library will be loaded upon creation of the first OpenGL window.
841 * \note If you do this, you need to retrieve all of the GL functions used in
842 * your program from the dynamic library using SDL_GL_GetProcAddress().
844 * \sa SDL_GL_GetProcAddress()
845 * \sa SDL_GL_UnloadLibrary()
847 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
850 * \brief Get the address of an OpenGL function.
852 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
855 * \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
857 * \sa SDL_GL_LoadLibrary()
859 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
862 * \brief Return true if an OpenGL extension is supported for the current
865 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
869 * \brief Reset all previously set OpenGL context attributes to their default values
871 extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
874 * \brief Set an OpenGL window attribute before window creation.
876 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
879 * \brief Get the actual value for an attribute from the current context.
881 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
884 * \brief Create an OpenGL context for use with an OpenGL window, and make it
887 * \sa SDL_GL_DeleteContext()
889 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
893 * \brief Set up an OpenGL context for rendering into an OpenGL window.
895 * \note The context must have been created with a compatible window.
897 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
898 SDL_GLContext context);
901 * \brief Get the currently active OpenGL window.
903 extern DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow(void);
906 * \brief Get the currently active OpenGL context.
908 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
911 * \brief Get the size of a window's underlying drawable (for use with glViewport).
913 * \param window Window from which the drawable size should be queried
914 * \param w Pointer to variable for storing the width, may be NULL
915 * \param h Pointer to variable for storing the height, may be NULL
917 * This may differ from SDL_GetWindowSize if we're rendering to a high-DPI
918 * drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a
919 * platform with high-DPI support (Apple calls this "Retina"), and not disabled
920 * by the SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.
922 * \sa SDL_GetWindowSize()
923 * \sa SDL_CreateWindow()
925 extern DECLSPEC void SDLCALL SDL_GL_GetDrawableSize(SDL_Window * window, int *w,
929 * \brief Set the swap interval for the current OpenGL context.
931 * \param interval 0 for immediate updates, 1 for updates synchronized with the
932 * vertical retrace. If the system supports it, you may
933 * specify -1 to allow late swaps to happen immediately
934 * instead of waiting for the next retrace.
936 * \return 0 on success, or -1 if setting the swap interval is not supported.
938 * \sa SDL_GL_GetSwapInterval()
940 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
943 * \brief Get the swap interval for the current OpenGL context.
945 * \return 0 if there is no vertical retrace synchronization, 1 if the buffer
946 * swap is synchronized with the vertical retrace, and -1 if late
947 * swaps happen immediately instead of waiting for the next retrace.
948 * If the system can't determine the swap interval, or there isn't a
949 * valid current context, this will return 0 as a safe default.
951 * \sa SDL_GL_SetSwapInterval()
953 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
956 * \brief Swap the OpenGL buffers for a window, if double-buffering is
959 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
962 * \brief Delete an OpenGL context.
964 * \sa SDL_GL_CreateContext()
966 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
968 /* @} *//* OpenGL support functions */
971 /* Ends C function definitions when using C++ */
975 #include "close_code.h"
977 #endif /* _SDL_video_h */
979 /* vi: set ts=4 sw=4 expandtab: */