SDL  2.0
SDL_video.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 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
39 extern "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  */
53 typedef 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_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_SetWindowResizable()
87  * \sa SDL_SetWindowTitle()
88  * \sa SDL_ShowWindow()
89  */
90 typedef struct SDL_Window SDL_Window;
91 
92 /**
93  * \brief The flags on a window
94  *
95  * \sa SDL_GetWindowFlags()
96  */
97 typedef enum
98 {
99  /* !!! FIXME: change this to name = (1<<x). */
100  SDL_WINDOW_FULLSCREEN = 0x00000001, /**< fullscreen window */
101  SDL_WINDOW_OPENGL = 0x00000002, /**< window usable with OpenGL context */
102  SDL_WINDOW_SHOWN = 0x00000004, /**< window is visible */
103  SDL_WINDOW_HIDDEN = 0x00000008, /**< window is not visible */
104  SDL_WINDOW_BORDERLESS = 0x00000010, /**< no window decoration */
105  SDL_WINDOW_RESIZABLE = 0x00000020, /**< window can be resized */
106  SDL_WINDOW_MINIMIZED = 0x00000040, /**< window is minimized */
107  SDL_WINDOW_MAXIMIZED = 0x00000080, /**< window is maximized */
108  SDL_WINDOW_INPUT_GRABBED = 0x00000100, /**< window has grabbed input focus */
109  SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */
110  SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
112  SDL_WINDOW_FOREIGN = 0x00000800, /**< window not created by SDL */
113  SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000, /**< window should be created in high-DPI mode if supported.
114  On macOS NSHighResolutionCapable must be set true in the
115  application's Info.plist for this to have any effect. */
116  SDL_WINDOW_MOUSE_CAPTURE = 0x00004000, /**< window has mouse captured (unrelated to INPUT_GRABBED) */
117  SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000, /**< window should always be above others */
118  SDL_WINDOW_SKIP_TASKBAR = 0x00010000, /**< window should not be added to the taskbar */
119  SDL_WINDOW_UTILITY = 0x00020000, /**< window should be treated as a utility window */
120  SDL_WINDOW_TOOLTIP = 0x00040000, /**< window should be treated as a tooltip */
121  SDL_WINDOW_POPUP_MENU = 0x00080000, /**< window should be treated as a popup menu */
122  SDL_WINDOW_VULKAN = 0x10000000 /**< window usable for Vulkan surface */
124 
125 /**
126  * \brief Used to indicate that you don't care what the window position is.
127  */
128 #define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000u
129 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
130 #define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
131 #define SDL_WINDOWPOS_ISUNDEFINED(X) \
132  (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
133 
134 /**
135  * \brief Used to indicate that the window position should be centered.
136  */
137 #define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000u
138 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK|(X))
139 #define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0)
140 #define SDL_WINDOWPOS_ISCENTERED(X) \
141  (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
142 
143 /**
144  * \brief Event subtype for window events
145  */
146 typedef enum
147 {
148  SDL_WINDOWEVENT_NONE, /**< Never used */
149  SDL_WINDOWEVENT_SHOWN, /**< Window has been shown */
150  SDL_WINDOWEVENT_HIDDEN, /**< Window has been hidden */
151  SDL_WINDOWEVENT_EXPOSED, /**< Window has been exposed and should be
152  redrawn */
153  SDL_WINDOWEVENT_MOVED, /**< Window has been moved to data1, data2
154  */
155  SDL_WINDOWEVENT_RESIZED, /**< Window has been resized to data1xdata2 */
156  SDL_WINDOWEVENT_SIZE_CHANGED, /**< The window size has changed, either as
157  a result of an API call or through the
158  system or user changing the window size. */
159  SDL_WINDOWEVENT_MINIMIZED, /**< Window has been minimized */
160  SDL_WINDOWEVENT_MAXIMIZED, /**< Window has been maximized */
161  SDL_WINDOWEVENT_RESTORED, /**< Window has been restored to normal size
162  and position */
163  SDL_WINDOWEVENT_ENTER, /**< Window has gained mouse focus */
164  SDL_WINDOWEVENT_LEAVE, /**< Window has lost mouse focus */
165  SDL_WINDOWEVENT_FOCUS_GAINED, /**< Window has gained keyboard focus */
166  SDL_WINDOWEVENT_FOCUS_LOST, /**< Window has lost keyboard focus */
167  SDL_WINDOWEVENT_CLOSE, /**< The window manager requests that the window be closed */
168  SDL_WINDOWEVENT_TAKE_FOCUS, /**< Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore) */
169  SDL_WINDOWEVENT_HIT_TEST /**< Window had a hit test that wasn't SDL_HITTEST_NORMAL. */
171 
172 /**
173  * \brief Event subtype for display events
174  */
175 typedef enum
176 {
177  SDL_DISPLAYEVENT_NONE, /**< Never used */
178  SDL_DISPLAYEVENT_ORIENTATION /**< Display orientation has changed to data1 */
180 
181 typedef enum
182 {
183  SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
184  SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
185  SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
186  SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
187  SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
189 
190 /**
191  * \brief An opaque handle to an OpenGL context.
192  */
193 typedef void *SDL_GLContext;
194 
195 /**
196  * \brief OpenGL configuration attributes
197  */
198 typedef enum
199 {
227 } SDL_GLattr;
228 
229 typedef enum
230 {
233  SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
234 } SDL_GLprofile;
235 
236 typedef enum
237 {
243 
244 typedef enum
245 {
249 
250 typedef enum
251 {
255 
256 /* Function prototypes */
257 
258 /**
259  * \brief Get the number of video drivers compiled into SDL
260  *
261  * \sa SDL_GetVideoDriver()
262  */
263 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
264 
265 /**
266  * \brief Get the name of a built in video driver.
267  *
268  * \note The video drivers are presented in the order in which they are
269  * normally checked during initialization.
270  *
271  * \sa SDL_GetNumVideoDrivers()
272  */
273 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
274 
275 /**
276  * \brief Initialize the video subsystem, optionally specifying a video driver.
277  *
278  * \param driver_name Initialize a specific driver by name, or NULL for the
279  * default video driver.
280  *
281  * \return 0 on success, -1 on error
282  *
283  * This function initializes the video subsystem; setting up a connection
284  * to the window manager, etc, and determines the available display modes
285  * and pixel formats, but does not initialize a window or graphics mode.
286  *
287  * \sa SDL_VideoQuit()
288  */
289 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
290 
291 /**
292  * \brief Shuts down the video subsystem.
293  *
294  * This function closes all windows, and restores the original video mode.
295  *
296  * \sa SDL_VideoInit()
297  */
298 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
299 
300 /**
301  * \brief Returns the name of the currently initialized video driver.
302  *
303  * \return The name of the current video driver or NULL if no driver
304  * has been initialized
305  *
306  * \sa SDL_GetNumVideoDrivers()
307  * \sa SDL_GetVideoDriver()
308  */
309 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
310 
311 /**
312  * \brief Returns the number of available video displays.
313  *
314  * \sa SDL_GetDisplayBounds()
315  */
316 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
317 
318 /**
319  * \brief Get the name of a display in UTF-8 encoding
320  *
321  * \return The name of a display, or NULL for an invalid display index.
322  *
323  * \sa SDL_GetNumVideoDisplays()
324  */
325 extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
326 
327 /**
328  * \brief Get the desktop area represented by a display, with the primary
329  * display located at 0,0
330  *
331  * \return 0 on success, or -1 if the index is out of range.
332  *
333  * \sa SDL_GetNumVideoDisplays()
334  */
335 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
336 
337 /**
338  * \brief Get the usable desktop area represented by a display, with the
339  * primary display located at 0,0
340  *
341  * This is the same area as SDL_GetDisplayBounds() reports, but with portions
342  * reserved by the system removed. For example, on Mac OS X, this subtracts
343  * the area occupied by the menu bar and dock.
344  *
345  * Setting a window to be fullscreen generally bypasses these unusable areas,
346  * so these are good guidelines for the maximum space available to a
347  * non-fullscreen window.
348  *
349  * \return 0 on success, or -1 if the index is out of range.
350  *
351  * \sa SDL_GetDisplayBounds()
352  * \sa SDL_GetNumVideoDisplays()
353  */
354 extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect * rect);
355 
356 /**
357  * \brief Get the dots/pixels-per-inch for a display
358  *
359  * \note Diagonal, horizontal and vertical DPI can all be optionally
360  * returned if the parameter is non-NULL.
361  *
362  * \return 0 on success, or -1 if no DPI information is available or the index is out of range.
363  *
364  * \sa SDL_GetNumVideoDisplays()
365  */
366 extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, float * hdpi, float * vdpi);
367 
368 /**
369  * \brief Get the orientation of a display
370  *
371  * \return The orientation of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.
372  *
373  * \sa SDL_GetNumVideoDisplays()
374  */
376 
377 /**
378  * \brief Returns the number of available display modes.
379  *
380  * \sa SDL_GetDisplayMode()
381  */
382 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
383 
384 /**
385  * \brief Fill in information about a specific display mode.
386  *
387  * \note The display modes are sorted in this priority:
388  * \li bits per pixel -> more colors to fewer colors
389  * \li width -> largest to smallest
390  * \li height -> largest to smallest
391  * \li refresh rate -> highest to lowest
392  *
393  * \sa SDL_GetNumDisplayModes()
394  */
395 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
397 
398 /**
399  * \brief Fill in information about the desktop display mode.
400  */
401 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
402 
403 /**
404  * \brief Fill in information about the current display mode.
405  */
406 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
407 
408 
409 /**
410  * \brief Get the closest match to the requested display mode.
411  *
412  * \param displayIndex The index of display from which mode should be queried.
413  * \param mode The desired display mode
414  * \param closest A pointer to a display mode to be filled in with the closest
415  * match of the available display modes.
416  *
417  * \return The passed in value \c closest, or NULL if no matching video mode
418  * was available.
419  *
420  * The available display modes are scanned, and \c closest is filled in with the
421  * closest mode matching the requested mode and returned. The mode format and
422  * refresh_rate default to the desktop mode if they are 0. The modes are
423  * scanned with size being first priority, format being second priority, and
424  * finally checking the refresh_rate. If all the available modes are too
425  * small, then NULL is returned.
426  *
427  * \sa SDL_GetNumDisplayModes()
428  * \sa SDL_GetDisplayMode()
429  */
430 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
431 
432 /**
433  * \brief Get the display index associated with a window.
434  *
435  * \return the display index of the display containing the center of the
436  * window, or -1 on error.
437  */
439 
440 /**
441  * \brief Set the display mode used when a fullscreen window is visible.
442  *
443  * By default the window's dimensions and the desktop format and refresh rate
444  * are used.
445  *
446  * \param window The window for which the display mode should be set.
447  * \param mode The mode to use, or NULL for the default mode.
448  *
449  * \return 0 on success, or -1 if setting the display mode failed.
450  *
451  * \sa SDL_GetWindowDisplayMode()
452  * \sa SDL_SetWindowFullscreen()
453  */
455  const SDL_DisplayMode
456  * mode);
457 
458 /**
459  * \brief Fill in information about the display mode used when a fullscreen
460  * window is visible.
461  *
462  * \sa SDL_SetWindowDisplayMode()
463  * \sa SDL_SetWindowFullscreen()
464  */
467 
468 /**
469  * \brief Get the pixel format associated with the window.
470  */
472 
473 /**
474  * \brief Create a window with the specified position, dimensions, and flags.
475  *
476  * \param title The title of the window, in UTF-8 encoding.
477  * \param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
478  * ::SDL_WINDOWPOS_UNDEFINED.
479  * \param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
480  * ::SDL_WINDOWPOS_UNDEFINED.
481  * \param w The width of the window, in screen coordinates.
482  * \param h The height of the window, in screen coordinates.
483  * \param flags The flags for the window, a mask of any of the following:
484  * ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL,
485  * ::SDL_WINDOW_HIDDEN, ::SDL_WINDOW_BORDERLESS,
486  * ::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED,
487  * ::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_INPUT_GRABBED,
488  * ::SDL_WINDOW_ALLOW_HIGHDPI, ::SDL_WINDOW_VULKAN.
489  *
490  * \return The created window, or NULL if window creation failed.
491  *
492  * If the window is created with the SDL_WINDOW_ALLOW_HIGHDPI flag, its size
493  * in pixels may differ from its size in screen coordinates on platforms with
494  * high-DPI support (e.g. iOS and Mac OS X). Use SDL_GetWindowSize() to query
495  * the client area's size in screen coordinates, and SDL_GL_GetDrawableSize(),
496  * SDL_Vulkan_GetDrawableSize(), or SDL_GetRendererOutputSize() to query the
497  * drawable size in pixels.
498  *
499  * If the window is created with any of the SDL_WINDOW_OPENGL or
500  * SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function
501  * (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the
502  * corresponding UnloadLibrary function is called by SDL_DestroyWindow().
503  *
504  * If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver,
505  * SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail.
506  *
507  * \note On non-Apple devices, SDL requires you to either not link to the
508  * Vulkan loader or link to a dynamic library version. This limitation
509  * may be removed in a future version of SDL.
510  *
511  * \sa SDL_DestroyWindow()
512  * \sa SDL_GL_LoadLibrary()
513  * \sa SDL_Vulkan_LoadLibrary()
514  */
515 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
516  int x, int y, int w,
517  int h, Uint32 flags);
518 
519 /**
520  * \brief Create an SDL window from an existing native window.
521  *
522  * \param data A pointer to driver-dependent window creation data
523  *
524  * \return The created window, or NULL if window creation failed.
525  *
526  * \sa SDL_DestroyWindow()
527  */
528 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
529 
530 /**
531  * \brief Get the numeric ID of a window, for logging purposes.
532  */
534 
535 /**
536  * \brief Get a window from a stored ID, or NULL if it doesn't exist.
537  */
539 
540 /**
541  * \brief Get the window flags.
542  */
544 
545 /**
546  * \brief Set the title of a window, in UTF-8 format.
547  *
548  * \sa SDL_GetWindowTitle()
549  */
551  const char *title);
552 
553 /**
554  * \brief Get the title of a window, in UTF-8 format.
555  *
556  * \sa SDL_SetWindowTitle()
557  */
558 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
559 
560 /**
561  * \brief Set the icon for a window.
562  *
563  * \param window The window for which the icon should be set.
564  * \param icon The icon for the window.
565  */
567  SDL_Surface * icon);
568 
569 /**
570  * \brief Associate an arbitrary named pointer with a window.
571  *
572  * \param window The window to associate with the pointer.
573  * \param name The name of the pointer.
574  * \param userdata The associated pointer.
575  *
576  * \return The previous value associated with 'name'
577  *
578  * \note The name is case-sensitive.
579  *
580  * \sa SDL_GetWindowData()
581  */
583  const char *name,
584  void *userdata);
585 
586 /**
587  * \brief Retrieve the data pointer associated with a window.
588  *
589  * \param window The window to query.
590  * \param name The name of the pointer.
591  *
592  * \return The value associated with 'name'
593  *
594  * \sa SDL_SetWindowData()
595  */
597  const char *name);
598 
599 /**
600  * \brief Set the position of a window.
601  *
602  * \param window The window to reposition.
603  * \param x The x coordinate of the window in screen coordinates, or
604  * ::SDL_WINDOWPOS_CENTERED or ::SDL_WINDOWPOS_UNDEFINED.
605  * \param y The y coordinate of the window in screen coordinates, or
606  * ::SDL_WINDOWPOS_CENTERED or ::SDL_WINDOWPOS_UNDEFINED.
607  *
608  * \note The window coordinate origin is the upper left of the display.
609  *
610  * \sa SDL_GetWindowPosition()
611  */
613  int x, int y);
614 
615 /**
616  * \brief Get the position of a window.
617  *
618  * \param window The window to query.
619  * \param x Pointer to variable for storing the x position, in screen
620  * coordinates. May be NULL.
621  * \param y Pointer to variable for storing the y position, in screen
622  * coordinates. May be NULL.
623  *
624  * \sa SDL_SetWindowPosition()
625  */
627  int *x, int *y);
628 
629 /**
630  * \brief Set the size of a window's client area.
631  *
632  * \param window The window to resize.
633  * \param w The width of the window, in screen coordinates. Must be >0.
634  * \param h The height of the window, in screen coordinates. Must be >0.
635  *
636  * \note Fullscreen windows automatically match the size of the display mode,
637  * and you should use SDL_SetWindowDisplayMode() to change their size.
638  *
639  * The window size in screen coordinates may differ from the size in pixels, if
640  * the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with
641  * high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or
642  * SDL_GetRendererOutputSize() to get the real client area size in pixels.
643  *
644  * \sa SDL_GetWindowSize()
645  * \sa SDL_SetWindowDisplayMode()
646  */
648  int h);
649 
650 /**
651  * \brief Get the size of a window's client area.
652  *
653  * \param window The window to query.
654  * \param w Pointer to variable for storing the width, in screen
655  * coordinates. May be NULL.
656  * \param h Pointer to variable for storing the height, in screen
657  * coordinates. May be NULL.
658  *
659  * The window size in screen coordinates may differ from the size in pixels, if
660  * the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with
661  * high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or
662  * SDL_GetRendererOutputSize() to get the real client area size in pixels.
663  *
664  * \sa SDL_SetWindowSize()
665  */
667  int *h);
668 
669 /**
670  * \brief Get the size of a window's borders (decorations) around the client area.
671  *
672  * \param window The window to query.
673  * \param top Pointer to variable for storing the size of the top border. NULL is permitted.
674  * \param left Pointer to variable for storing the size of the left border. NULL is permitted.
675  * \param bottom Pointer to variable for storing the size of the bottom border. NULL is permitted.
676  * \param right Pointer to variable for storing the size of the right border. NULL is permitted.
677  *
678  * \return 0 on success, or -1 if getting this information is not supported.
679  *
680  * \note if this function fails (returns -1), the size values will be
681  * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as
682  * if the window in question was borderless.
683  */
685  int *top, int *left,
686  int *bottom, int *right);
687 
688 /**
689  * \brief Set the minimum size of a window's client area.
690  *
691  * \param window The window to set a new minimum size.
692  * \param min_w The minimum width of the window, must be >0
693  * \param min_h The minimum height of the window, must be >0
694  *
695  * \note You can't change the minimum size of a fullscreen window, it
696  * automatically matches the size of the display mode.
697  *
698  * \sa SDL_GetWindowMinimumSize()
699  * \sa SDL_SetWindowMaximumSize()
700  */
702  int min_w, int min_h);
703 
704 /**
705  * \brief Get the minimum size of a window's client area.
706  *
707  * \param window The window to query.
708  * \param w Pointer to variable for storing the minimum width, may be NULL
709  * \param h Pointer to variable for storing the minimum height, may be NULL
710  *
711  * \sa SDL_GetWindowMaximumSize()
712  * \sa SDL_SetWindowMinimumSize()
713  */
715  int *w, int *h);
716 
717 /**
718  * \brief Set the maximum size of a window's client area.
719  *
720  * \param window The window to set a new maximum size.
721  * \param max_w The maximum width of the window, must be >0
722  * \param max_h The maximum height of the window, must be >0
723  *
724  * \note You can't change the maximum size of a fullscreen window, it
725  * automatically matches the size of the display mode.
726  *
727  * \sa SDL_GetWindowMaximumSize()
728  * \sa SDL_SetWindowMinimumSize()
729  */
731  int max_w, int max_h);
732 
733 /**
734  * \brief Get the maximum size of a window's client area.
735  *
736  * \param window The window to query.
737  * \param w Pointer to variable for storing the maximum width, may be NULL
738  * \param h Pointer to variable for storing the maximum height, may be NULL
739  *
740  * \sa SDL_GetWindowMinimumSize()
741  * \sa SDL_SetWindowMaximumSize()
742  */
744  int *w, int *h);
745 
746 /**
747  * \brief Set the border state of a window.
748  *
749  * This will add or remove the window's SDL_WINDOW_BORDERLESS flag and
750  * add or remove the border from the actual window. This is a no-op if the
751  * window's border already matches the requested state.
752  *
753  * \param window The window of which to change the border state.
754  * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border.
755  *
756  * \note You can't change the border state of a fullscreen window.
757  *
758  * \sa SDL_GetWindowFlags()
759  */
761  SDL_bool bordered);
762 
763 /**
764  * \brief Set the user-resizable state of a window.
765  *
766  * This will add or remove the window's SDL_WINDOW_RESIZABLE flag and
767  * allow/disallow user resizing of the window. This is a no-op if the
768  * window's resizable state already matches the requested state.
769  *
770  * \param window The window of which to change the resizable state.
771  * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow.
772  *
773  * \note You can't change the resizable state of a fullscreen window.
774  *
775  * \sa SDL_GetWindowFlags()
776  */
778  SDL_bool resizable);
779 
780 /**
781  * \brief Show a window.
782  *
783  * \sa SDL_HideWindow()
784  */
786 
787 /**
788  * \brief Hide a window.
789  *
790  * \sa SDL_ShowWindow()
791  */
793 
794 /**
795  * \brief Raise a window above other windows and set the input focus.
796  */
798 
799 /**
800  * \brief Make a window as large as possible.
801  *
802  * \sa SDL_RestoreWindow()
803  */
805 
806 /**
807  * \brief Minimize a window to an iconic representation.
808  *
809  * \sa SDL_RestoreWindow()
810  */
812 
813 /**
814  * \brief Restore the size and position of a minimized or maximized window.
815  *
816  * \sa SDL_MaximizeWindow()
817  * \sa SDL_MinimizeWindow()
818  */
820 
821 /**
822  * \brief Set a window's fullscreen state.
823  *
824  * \return 0 on success, or -1 if setting the display mode failed.
825  *
826  * \sa SDL_SetWindowDisplayMode()
827  * \sa SDL_GetWindowDisplayMode()
828  */
830  Uint32 flags);
831 
832 /**
833  * \brief Get the SDL surface associated with the window.
834  *
835  * \return The window's framebuffer surface, or NULL on error.
836  *
837  * A new surface will be created with the optimal format for the window,
838  * if necessary. This surface will be freed when the window is destroyed.
839  *
840  * \note You may not combine this with 3D or the rendering API on this window.
841  *
842  * \sa SDL_UpdateWindowSurface()
843  * \sa SDL_UpdateWindowSurfaceRects()
844  */
846 
847 /**
848  * \brief Copy the window surface to the screen.
849  *
850  * \return 0 on success, or -1 on error.
851  *
852  * \sa SDL_GetWindowSurface()
853  * \sa SDL_UpdateWindowSurfaceRects()
854  */
856 
857 /**
858  * \brief Copy a number of rectangles on the window surface to the screen.
859  *
860  * \return 0 on success, or -1 on error.
861  *
862  * \sa SDL_GetWindowSurface()
863  * \sa SDL_UpdateWindowSurface()
864  */
866  const SDL_Rect * rects,
867  int numrects);
868 
869 /**
870  * \brief Set a window's input grab mode.
871  *
872  * \param window The window for which the input grab mode should be set.
873  * \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
874  *
875  * If the caller enables a grab while another window is currently grabbed,
876  * the other window loses its grab in favor of the caller's window.
877  *
878  * \sa SDL_GetWindowGrab()
879  */
881  SDL_bool grabbed);
882 
883 /**
884  * \brief Get a window's input grab mode.
885  *
886  * \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.
887  *
888  * \sa SDL_SetWindowGrab()
889  */
891 
892 /**
893  * \brief Get the window that currently has an input grab enabled.
894  *
895  * \return This returns the window if input is grabbed, and NULL otherwise.
896  *
897  * \sa SDL_SetWindowGrab()
898  */
900 
901 /**
902  * \brief Set the brightness (gamma correction) for a window.
903  *
904  * \return 0 on success, or -1 if setting the brightness isn't supported.
905  *
906  * \sa SDL_GetWindowBrightness()
907  * \sa SDL_SetWindowGammaRamp()
908  */
910 
911 /**
912  * \brief Get the brightness (gamma correction) for a window.
913  *
914  * \return The last brightness value passed to SDL_SetWindowBrightness()
915  *
916  * \sa SDL_SetWindowBrightness()
917  */
919 
920 /**
921  * \brief Set the opacity for a window
922  *
923  * \param window The window which will be made transparent or opaque
924  * \param opacity Opacity (0.0f - transparent, 1.0f - opaque) This will be
925  * clamped internally between 0.0f and 1.0f.
926  *
927  * \return 0 on success, or -1 if setting the opacity isn't supported.
928  *
929  * \sa SDL_GetWindowOpacity()
930  */
932 
933 /**
934  * \brief Get the opacity of a window.
935  *
936  * If transparency isn't supported on this platform, opacity will be reported
937  * as 1.0f without error.
938  *
939  * \param window The window in question.
940  * \param out_opacity Opacity (0.0f - transparent, 1.0f - opaque)
941  *
942  * \return 0 on success, or -1 on error (invalid window, etc).
943  *
944  * \sa SDL_SetWindowOpacity()
945  */
946 extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window * window, float * out_opacity);
947 
948 /**
949  * \brief Sets the window as a modal for another window (TODO: reconsider this function and/or its name)
950  *
951  * \param modal_window The window that should be modal
952  * \param parent_window The parent window
953  *
954  * \return 0 on success, or -1 otherwise.
955  */
956 extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window * modal_window, SDL_Window * parent_window);
957 
958 /**
959  * \brief Explicitly sets input focus to the window.
960  *
961  * You almost certainly want SDL_RaiseWindow() instead of this function. Use
962  * this with caution, as you might give focus to a window that's completely
963  * obscured by other windows.
964  *
965  * \param window The window that should get the input focus
966  *
967  * \return 0 on success, or -1 otherwise.
968  * \sa SDL_RaiseWindow()
969  */
971 
972 /**
973  * \brief Set the gamma ramp for a window.
974  *
975  * \param window The window for which the gamma ramp should be set.
976  * \param red The translation table for the red channel, or NULL.
977  * \param green The translation table for the green channel, or NULL.
978  * \param blue The translation table for the blue channel, or NULL.
979  *
980  * \return 0 on success, or -1 if gamma ramps are unsupported.
981  *
982  * Set the gamma translation table for the red, green, and blue channels
983  * of the video hardware. Each table is an array of 256 16-bit quantities,
984  * representing a mapping between the input and output for that channel.
985  * The input is the index into the array, and the output is the 16-bit
986  * gamma value at that index, scaled to the output color precision.
987  *
988  * \sa SDL_GetWindowGammaRamp()
989  */
991  const Uint16 * red,
992  const Uint16 * green,
993  const Uint16 * blue);
994 
995 /**
996  * \brief Get the gamma ramp for a window.
997  *
998  * \param window The window from which the gamma ramp should be queried.
999  * \param red A pointer to a 256 element array of 16-bit quantities to hold
1000  * the translation table for the red channel, or NULL.
1001  * \param green A pointer to a 256 element array of 16-bit quantities to hold
1002  * the translation table for the green channel, or NULL.
1003  * \param blue A pointer to a 256 element array of 16-bit quantities to hold
1004  * the translation table for the blue channel, or NULL.
1005  *
1006  * \return 0 on success, or -1 if gamma ramps are unsupported.
1007  *
1008  * \sa SDL_SetWindowGammaRamp()
1009  */
1011  Uint16 * red,
1012  Uint16 * green,
1013  Uint16 * blue);
1014 
1015 /**
1016  * \brief Possible return values from the SDL_HitTest callback.
1017  *
1018  * \sa SDL_HitTest
1019  */
1020 typedef enum
1021 {
1022  SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
1023  SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
1033 
1034 /**
1035  * \brief Callback used for hit-testing.
1036  *
1037  * \sa SDL_SetWindowHitTest
1038  */
1040  const SDL_Point *area,
1041  void *data);
1042 
1043 /**
1044  * \brief Provide a callback that decides if a window region has special properties.
1045  *
1046  * Normally windows are dragged and resized by decorations provided by the
1047  * system window manager (a title bar, borders, etc), but for some apps, it
1048  * makes sense to drag them from somewhere else inside the window itself; for
1049  * example, one might have a borderless window that wants to be draggable
1050  * from any part, or simulate its own title bar, etc.
1051  *
1052  * This function lets the app provide a callback that designates pieces of
1053  * a given window as special. This callback is run during event processing
1054  * if we need to tell the OS to treat a region of the window specially; the
1055  * use of this callback is known as "hit testing."
1056  *
1057  * Mouse input may not be delivered to your application if it is within
1058  * a special area; the OS will often apply that input to moving the window or
1059  * resizing the window and not deliver it to the application.
1060  *
1061  * Specifying NULL for a callback disables hit-testing. Hit-testing is
1062  * disabled by default.
1063  *
1064  * Platforms that don't support this functionality will return -1
1065  * unconditionally, even if you're attempting to disable hit-testing.
1066  *
1067  * Your callback may fire at any time, and its firing does not indicate any
1068  * specific behavior (for example, on Windows, this certainly might fire
1069  * when the OS is deciding whether to drag your window, but it fires for lots
1070  * of other reasons, too, some unrelated to anything you probably care about
1071  * _and when the mouse isn't actually at the location it is testing_).
1072  * Since this can fire at any time, you should try to keep your callback
1073  * efficient, devoid of allocations, etc.
1074  *
1075  * \param window The window to set hit-testing on.
1076  * \param callback The callback to call when doing a hit-test.
1077  * \param callback_data An app-defined void pointer passed to the callback.
1078  * \return 0 on success, -1 on error (including unsupported).
1079  */
1082  void *callback_data);
1083 
1084 /**
1085  * \brief Destroy a window.
1086  */
1088 
1089 
1090 /**
1091  * \brief Returns whether the screensaver is currently enabled (default off).
1092  *
1093  * \sa SDL_EnableScreenSaver()
1094  * \sa SDL_DisableScreenSaver()
1095  */
1097 
1098 /**
1099  * \brief Allow the screen to be blanked by a screensaver
1100  *
1101  * \sa SDL_IsScreenSaverEnabled()
1102  * \sa SDL_DisableScreenSaver()
1103  */
1104 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
1105 
1106 /**
1107  * \brief Prevent the screen from being blanked by a screensaver
1108  *
1109  * \sa SDL_IsScreenSaverEnabled()
1110  * \sa SDL_EnableScreenSaver()
1111  */
1112 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
1113 
1114 
1115 /**
1116  * \name OpenGL support functions
1117  */
1118 /* @{ */
1119 
1120 /**
1121  * \brief Dynamically load an OpenGL library.
1122  *
1123  * \param path The platform dependent OpenGL library name, or NULL to open the
1124  * default OpenGL library.
1125  *
1126  * \return 0 on success, or -1 if the library couldn't be loaded.
1127  *
1128  * This should be done after initializing the video driver, but before
1129  * creating any OpenGL windows. If no OpenGL library is loaded, the default
1130  * library will be loaded upon creation of the first OpenGL window.
1131  *
1132  * \note If you do this, you need to retrieve all of the GL functions used in
1133  * your program from the dynamic library using SDL_GL_GetProcAddress().
1134  *
1135  * \sa SDL_GL_GetProcAddress()
1136  * \sa SDL_GL_UnloadLibrary()
1137  */
1138 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
1139 
1140 /**
1141  * \brief Get the address of an OpenGL function.
1142  */
1143 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
1144 
1145 /**
1146  * \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
1147  *
1148  * \sa SDL_GL_LoadLibrary()
1149  */
1150 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
1151 
1152 /**
1153  * \brief Return true if an OpenGL extension is supported for the current
1154  * context.
1155  */
1157  *extension);
1158 
1159 /**
1160  * \brief Reset all previously set OpenGL context attributes to their default values
1161  */
1162 extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
1163 
1164 /**
1165  * \brief Set an OpenGL window attribute before window creation.
1166  *
1167  * \return 0 on success, or -1 if the attribute could not be set.
1168  */
1169 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
1170 
1171 /**
1172  * \brief Get the actual value for an attribute from the current context.
1173  *
1174  * \return 0 on success, or -1 if the attribute could not be retrieved.
1175  * The integer at \c value will be modified in either case.
1176  */
1177 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
1178 
1179 /**
1180  * \brief Create an OpenGL context for use with an OpenGL window, and make it
1181  * current.
1182  *
1183  * \sa SDL_GL_DeleteContext()
1184  */
1185 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
1186  window);
1187 
1188 /**
1189  * \brief Set up an OpenGL context for rendering into an OpenGL window.
1190  *
1191  * \note The context must have been created with a compatible window.
1192  */
1194  SDL_GLContext context);
1195 
1196 /**
1197  * \brief Get the currently active OpenGL window.
1198  */
1200 
1201 /**
1202  * \brief Get the currently active OpenGL context.
1203  */
1204 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
1205 
1206 /**
1207  * \brief Get the size of a window's underlying drawable in pixels (for use
1208  * with glViewport).
1209  *
1210  * \param window Window from which the drawable size should be queried
1211  * \param w Pointer to variable for storing the width in pixels, may be NULL
1212  * \param h Pointer to variable for storing the height in pixels, may be NULL
1213  *
1214  * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI
1215  * drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a
1216  * platform with high-DPI support (Apple calls this "Retina"), and not disabled
1217  * by the SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.
1218  *
1219  * \sa SDL_GetWindowSize()
1220  * \sa SDL_CreateWindow()
1221  */
1223  int *h);
1224 
1225 /**
1226  * \brief Set the swap interval for the current OpenGL context.
1227  *
1228  * \param interval 0 for immediate updates, 1 for updates synchronized with the
1229  * vertical retrace. If the system supports it, you may
1230  * specify -1 to allow late swaps to happen immediately
1231  * instead of waiting for the next retrace.
1232  *
1233  * \return 0 on success, or -1 if setting the swap interval is not supported.
1234  *
1235  * \sa SDL_GL_GetSwapInterval()
1236  */
1237 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
1238 
1239 /**
1240  * \brief Get the swap interval for the current OpenGL context.
1241  *
1242  * \return 0 if there is no vertical retrace synchronization, 1 if the buffer
1243  * swap is synchronized with the vertical retrace, and -1 if late
1244  * swaps happen immediately instead of waiting for the next retrace.
1245  * If the system can't determine the swap interval, or there isn't a
1246  * valid current context, this will return 0 as a safe default.
1247  *
1248  * \sa SDL_GL_SetSwapInterval()
1249  */
1250 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
1251 
1252 /**
1253  * \brief Swap the OpenGL buffers for a window, if double-buffering is
1254  * supported.
1255  */
1257 
1258 /**
1259  * \brief Delete an OpenGL context.
1260  *
1261  * \sa SDL_GL_CreateContext()
1262  */
1263 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
1264 
1265 /* @} *//* OpenGL support functions */
1266 
1267 
1268 /* Ends C function definitions when using C++ */
1269 #ifdef __cplusplus
1270 }
1271 #endif
1272 #include "close_code.h"
1273 
1274 #endif /* SDL_video_h_ */
1275 
1276 /* vi: set ts=4 sw=4 expandtab: */
const char * SDL_GetVideoDriver(int index)
Get the name of a built in video driver.
Definition: SDL_video.c:452
SDL_GLcontextReleaseFlag
Definition: SDL_video.h:244
const char * SDL_GetCurrentVideoDriver(void)
Returns the name of the currently initialized video driver.
Definition: SDL_video.c:576
int SDL_SetWindowBrightness(SDL_Window *window, float brightness)
Set the brightness (gamma correction) for a window.
Definition: SDL_video.c:2339
SDL_WindowFlags
The flags on a window.
Definition: SDL_video.h:97
int SDL_SetWindowDisplayMode(SDL_Window *window, const SDL_DisplayMode *mode)
Set the display mode used when a fullscreen window is visible.
Definition: SDL_video.c:1103
GLdouble GLdouble right
SDL_DisplayMode * SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
Get the closest match to the requested display mode.
Definition: SDL_video.c:962
int SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode *mode)
Fill in information about the desktop display mode.
Definition: SDL_video.c:827
void SDL_SetWindowBordered(SDL_Window *window, SDL_bool bordered)
Set the border state of a window.
Definition: SDL_video.c:1947
int SDL_GetWindowDisplayIndex(SDL_Window *window)
Get the display index associated with a window.
Definition: SDL_video.c:1032
SDL_GLcontextFlag
Definition: SDL_video.h:236
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
const char * SDL_GetWindowTitle(SDL_Window *window)
Get the title of a window, in UTF-8 format.
Definition: SDL_video.c:1762
SDL_Window * SDL_GL_GetCurrentWindow(void)
Get the currently active OpenGL window.
Definition: SDL_video.c:3522
void SDL_HideWindow(SDL_Window *window)
Hide a window.
Definition: SDL_video.c:2165
void * SDL_GetWindowData(SDL_Window *window, const char *name)
Retrieve the data pointer associated with a window.
Definition: SDL_video.c:1839
void SDL_DisableScreenSaver(void)
Prevent the screen from being blanked by a screensaver.
Definition: SDL_video.c:2788
SDL_Rect rect
Definition: testrelative.c:27
void SDL_SetWindowTitle(SDL_Window *window, const char *title)
Set the title of a window, in UTF-8 format.
Definition: SDL_video.c:1745
int SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode *mode)
Fill in information about the current display mode.
Definition: SDL_video.c:841
GLfloat GLfloat GLfloat GLfloat h
void SDL_SetWindowPosition(SDL_Window *window, int x, int y)
Set the position of a window.
Definition: SDL_video.c:1860
The structure that defines a point.
Definition: SDL_rect.h:48
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
void SDL_GetWindowMinimumSize(SDL_Window *window, int *w, int *h)
Get the minimum size of a window's client area.
Definition: SDL_video.c:2096
static screen_context_t context
Definition: video.c:25
The structure that defines a display mode.
Definition: SDL_video.h:53
void * SDL_GL_GetProcAddress(const char *proc)
Get the address of an OpenGL function.
Definition: SDL_video.c:2882
void * SDL_SetWindowData(SDL_Window *window, const char *name, void *userdata)
Associate an arbitrary named pointer with a window.
Definition: SDL_video.c:1792
int SDL_GL_SetSwapInterval(int interval)
Set the swap interval for the current OpenGL context.
Definition: SDL_video.c:3553
uint16_t Uint16
Definition: SDL_stdinc.h:191
GLbyte green
GLint GLint bottom
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
int SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect *rect)
Get the usable desktop area represented by a display, with the primary display located at 0...
Definition: SDL_video.c:703
int SDL_GetWindowDisplayMode(SDL_Window *window, SDL_DisplayMode *mode)
Fill in information about the display mode used when a fullscreen window is visible.
Definition: SDL_video.c:1123
void SDL_ShowWindow(SDL_Window *window)
Show a window.
Definition: SDL_video.c:2150
int SDL_SetWindowModalFor(SDL_Window *modal_window, SDL_Window *parent_window)
Sets the window as a modal for another window (TODO: reconsider this function and/or its name) ...
Definition: SDL_video.c:2399
GLdouble GLdouble GLdouble GLdouble top
void SDL_RaiseWindow(SDL_Window *window)
Raise a window above other windows and set the input focus.
Definition: SDL_video.c:2184
Uint32 SDL_GetWindowPixelFormat(SDL_Window *window)
Get the pixel format associated with the window.
Definition: SDL_video.c:1160
int SDL_SetWindowOpacity(SDL_Window *window, float opacity)
Set the opacity for a window.
Definition: SDL_video.c:2363
GLuint const GLchar * name
const GLubyte GLuint red
Definition: SDL_glfuncs.h:79
SDL_Window * SDL_GetWindowFromID(Uint32 id)
Get a window from a stored ID, or NULL if it doesn't exist.
Definition: SDL_video.c:1721
SDL_HitTestResult
Possible return values from the SDL_HitTest callback.
Definition: SDL_video.h:1020
SDL_HitTestResult(* SDL_HitTest)(SDL_Window *win, const SDL_Point *area, void *data)
Callback used for hit-testing.
Definition: SDL_video.h:1039
SDL_GLattr
OpenGL configuration attributes.
Definition: SDL_video.h:198
void SDL_GL_UnloadLibrary(void)
Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
Definition: SDL_video.c:2904
SDL_DisplayOrientation
Definition: SDL_video.h:181
float SDL_GetWindowBrightness(SDL_Window *window)
Get the brightness (gamma correction) for a window.
Definition: SDL_video.c:2355
int SDL_GL_LoadLibrary(const char *path)
Dynamically load an OpenGL library.
Definition: SDL_video.c:2853
int SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext context)
Set up an OpenGL context for rendering into an OpenGL window.
Definition: SDL_video.c:3491
float opacity
Definition: SDL_sysvideo.h:91
#define DECLSPEC
Definition: SDL_internal.h:44
void SDL_GL_SwapWindow(SDL_Window *window)
Swap the OpenGL buffers for a window, if double-buffering is supported.
Definition: SDL_video.c:3581
void * SDL_GLContext
An opaque handle to an OpenGL context.
Definition: SDL_video.h:193
void SDL_SetWindowGrab(SDL_Window *window, SDL_bool grabbed)
Set a window's input grab mode.
Definition: SDL_video.c:2535
void SDL_EnableScreenSaver(void)
Allow the screen to be blanked by a screensaver.
Definition: SDL_video.c:2773
int SDL_GetDisplayBounds(int displayIndex, SDL_Rect *rect)
Get the desktop area represented by a display, with the primary display located at 0...
Definition: SDL_video.c:676
void SDL_GetWindowMaximumSize(SDL_Window *window, int *w, int *h)
Get the maximum size of a window's client area.
Definition: SDL_video.c:2138
void SDL_RestoreWindow(SDL_Window *window)
Restore the size and position of a minimized or maximized window.
Definition: SDL_video.c:2229
void * driverdata
Definition: SDL_video.h:59
int SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data)
Provide a callback that decides if a window region has special properties.
Definition: SDL_video.c:3973
SDL_WindowEventID
Event subtype for window events.
Definition: SDL_video.h:146
int SDL_VideoInit(const char *driver_name)
Initialize the video subsystem, optionally specifying a video driver.
Definition: SDL_video.c:464
SDL_GLContextResetNotification
Definition: SDL_video.h:250
SDL_DisplayOrientation SDL_GetDisplayOrientation(int displayIndex)
Get the orientation of a display.
Definition: SDL_video.c:743
GLenum mode
GLubyte GLubyte GLubyte GLubyte w
GLsizei const GLfloat * value
void SDL_GL_ResetAttributes(void)
Reset all previously set OpenGL context attributes to their default values.
Definition: SDL_video.c:3044
SDL_Window * SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)
Create a window with the specified position, dimensions, and flags.
Definition: SDL_video.c:1408
SDL_GLContext SDL_GL_GetCurrentContext(void)
Get the currently active OpenGL context.
Definition: SDL_video.c:3532
int SDL_SetWindowFullscreen(SDL_Window *window, Uint32 flags)
Set a window's fullscreen state.
Definition: SDL_video.c:2243
SDL_GLprofile
Definition: SDL_video.h:229
SDL_bool SDL_GL_ExtensionSupported(const char *extension)
Return true if an OpenGL extension is supported for the current context.
Definition: SDL_video.c:2929
static Uint32 callback(Uint32 interval, void *param)
Definition: testtimer.c:34
int SDL_GL_GetSwapInterval(void)
Get the swap interval for the current OpenGL context.
Definition: SDL_video.c:3567
char * title
Definition: SDL_sysvideo.h:77
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
int SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects)
Copy a number of rectangles on the window surface to the screen.
Definition: SDL_video.c:2326
int SDL_GetDisplayDPI(int displayIndex, float *ddpi, float *hdpi, float *vdpi)
Get the dots/pixels-per-inch for a display.
Definition: SDL_video.c:723
void SDL_GetWindowPosition(SDL_Window *window, int *x, int *y)
Get the position of a window.
Definition: SDL_video.c:1905
void SDL_GL_DeleteContext(SDL_GLContext context)
Delete an OpenGL context.
Definition: SDL_video.c:3599
void SDL_GetWindowSize(SDL_Window *window, int *w, int *h)
Get the size of a window's client area.
Definition: SDL_video.c:2031
void SDL_SetWindowMaximumSize(SDL_Window *window, int max_w, int max_h)
Set the maximum size of a window's client area.
Definition: SDL_video.c:2108
int SDL_GetNumVideoDrivers(void)
Get the number of video drivers compiled into SDL.
Definition: SDL_video.c:446
GLuint index
float brightness
Definition: SDL_sysvideo.h:93
void SDL_SetWindowResizable(SDL_Window *window, SDL_bool resizable)
Set the user-resizable state of a window.
Definition: SDL_video.c:1965
const char * SDL_GetDisplayName(int displayIndex)
Get the name of a display in UTF-8 encoding.
Definition: SDL_video.c:668
void SDL_SetWindowSize(SDL_Window *window, int w, int h)
Set the size of a window's client area.
Definition: SDL_video.c:1983
SDL_bool SDL_GetWindowGrab(SDL_Window *window)
Get a window's input grab mode.
Definition: SDL_video.c:2551
SDL_bool
Definition: SDL_stdinc.h:161
int SDL_GetWindowOpacity(SDL_Window *window, float *out_opacity)
Get the opacity of a window.
Definition: SDL_video.c:2387
int SDL_GetNumVideoDisplays(void)
Returns the number of available video displays.
Definition: SDL_video.c:635
GLbitfield flags
SDL_Window * SDL_CreateWindowFrom(const void *data)
Create an SDL window from an existing native window.
Definition: SDL_video.c:1576
void SDL_MinimizeWindow(SDL_Window *window)
Minimize a window to an iconic representation.
Definition: SDL_video.c:2213
SDL_GLContext SDL_GL_CreateContext(SDL_Window *window)
Create an OpenGL context for use with an OpenGL window, and make it current.
Definition: SDL_video.c:3468
SDL_Surface * icon
Definition: SDL_sysvideo.h:78
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
void SDL_DestroyWindow(SDL_Window *window)
Destroy a window.
Definition: SDL_video.c:2687
int SDL_GetNumDisplayModes(int displayIndex)
Returns the number of available display modes.
Definition: SDL_video.c:801
void SDL_MaximizeWindow(SDL_Window *window)
Make a window as large as possible.
Definition: SDL_video.c:2197
The type used to identify a window.
Definition: SDL_sysvideo.h:73
GLbyte GLbyte blue
uint32_t Uint32
Definition: SDL_stdinc.h:203
SDL_bool SDL_IsScreenSaverEnabled(void)
Returns whether the screensaver is currently enabled (default off).
Definition: SDL_video.c:2764
int SDL_UpdateWindowSurface(SDL_Window *window)
Copy the window surface to the screen.
Definition: SDL_video.c:2312
SDL_Window * SDL_GetGrabbedWindow(void)
Get the window that currently has an input grab enabled.
Definition: SDL_video.c:2559
Uint32 SDL_GetWindowFlags(SDL_Window *window)
Get the window flags.
Definition: SDL_video.c:1737
int SDL_SetWindowGammaRamp(SDL_Window *window, const Uint16 *red, const Uint16 *green, const Uint16 *blue)
Set the gamma ramp for a window.
Definition: SDL_video.c:2425
SDL_DisplayEventID
Event subtype for display events.
Definition: SDL_video.h:175
GLsizei const GLchar *const * path
void SDL_SetWindowMinimumSize(SDL_Window *window, int min_w, int min_h)
Set the minimum size of a window's client area.
Definition: SDL_video.c:2065
int SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right)
Get the size of a window's borders (decorations) around the client area.
Definition: SDL_video.c:2043
Uint32 format
Definition: SDL_video.h:55
EGLSurface EGLint * rects
Definition: eglext.h:282
Uint32 SDL_GetWindowID(SDL_Window *window)
Get the numeric ID of a window, for logging purposes.
Definition: SDL_video.c:1713
int SDL_GL_GetAttribute(SDL_GLattr attr, int *value)
Get the actual value for an attribute from the current context.
Definition: SDL_video.c:3219
int SDL_GetWindowGammaRamp(SDL_Window *window, Uint16 *red, Uint16 *green, Uint16 *blue)
Get the gamma ramp for a window.
Definition: SDL_video.c:2459
SDL_Surface * SDL_GetWindowSurface(SDL_Window *window)
Get the SDL surface associated with the window.
Definition: SDL_video.c:2293
int SDL_GetDisplayMode(int displayIndex, int modeIndex, SDL_DisplayMode *mode)
Fill in information about a specific display mode.
Definition: SDL_video.c:809
int SDL_GL_SetAttribute(SDL_GLattr attr, int value)
Set an OpenGL window attribute before window creation.
Definition: SDL_video.c:3098
#define SDLCALL
Definition: SDL_internal.h:45
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64
void SDL_GL_GetDrawableSize(SDL_Window *window, int *w, int *h)
Get the size of a window's underlying drawable in pixels (for use with glViewport).
Definition: SDL_video.c:3541
void SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon)
Set the icon for a window.
Definition: SDL_video.c:1770
GLint left
int SDL_SetWindowInputFocus(SDL_Window *window)
Explicitly sets input focus to the window.
Definition: SDL_video.c:2412
void SDL_VideoQuit(void)
Shuts down the video subsystem.
Definition: SDL_video.c:2803