Merge "[SDL_Tizen] fix Skip event" into tizen
[platform/upstream/SDL.git] / include / SDL_video.h
1 /*
2   Simple DirectMedia Layer
3   Copyright (C) 1997-2016 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 */
60 } SDL_DisplayMode;
61
62 /**
63  *  \brief The type used to identify a window
64  *
65  *  \sa SDL_CreateWindow()
66  *  \sa SDL_CreateWindowFrom()
67  *  \sa SDL_DestroyWindow()
68  *  \sa SDL_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()
88  */
89 typedef struct SDL_Window SDL_Window;
90
91 /**
92  *  \brief The flags on a window
93  *
94  *  \sa SDL_GetWindowFlags()
95  */
96 typedef enum
97 {
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 */
112     SDL_WINDOW_MOUSE_CAPTURE = 0x00004000,      /**< window has mouse captured (unrelated to INPUT_GRABBED) */
113     SDL_WINDOW_VULKAN = 0x10000000,             /**< window usable with Vulkan */
114     SDL_WINDOW_INPUT_UNFOCUS = 0x20000000,      /**< window loses input focus */
115     SDL_WINDOW_MOUSE_UNFOCUS = 0x40000000       /**< window loses mouse focus */
116 } SDL_WindowFlags;
117
118 /**
119  *  \brief Used to indicate that you don't care what the window position is.
120  */
121 #define SDL_WINDOWPOS_UNDEFINED_MASK    0x1FFF0000
122 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)  (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
123 #define SDL_WINDOWPOS_UNDEFINED         SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
124 #define SDL_WINDOWPOS_ISUNDEFINED(X)    \
125             (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
126
127 /**
128  *  \brief Used to indicate that the window position should be centered.
129  */
130 #define SDL_WINDOWPOS_CENTERED_MASK    0x2FFF0000
131 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X)  (SDL_WINDOWPOS_CENTERED_MASK|(X))
132 #define SDL_WINDOWPOS_CENTERED         SDL_WINDOWPOS_CENTERED_DISPLAY(0)
133 #define SDL_WINDOWPOS_ISCENTERED(X)    \
134             (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
135
136 /**
137  *  \brief Event subtype for window events
138  */
139 typedef enum
140 {
141     SDL_WINDOWEVENT_NONE,           /**< Never used */
142     SDL_WINDOWEVENT_SHOWN,          /**< Window has been shown */
143     SDL_WINDOWEVENT_HIDDEN,         /**< Window has been hidden */
144     SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be
145                                          redrawn */
146     SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2
147                                      */
148     SDL_WINDOWEVENT_RESIZED,        /**< Window has been resized to data1xdata2 */
149     SDL_WINDOWEVENT_SIZE_CHANGED,   /**< The window size has changed, either as
150                                          a result of an API call or through the
151                                          system or user changing the window size. */
152     SDL_WINDOWEVENT_MINIMIZED,      /**< Window has been minimized */
153     SDL_WINDOWEVENT_MAXIMIZED,      /**< Window has been maximized */
154     SDL_WINDOWEVENT_RESTORED,       /**< Window has been restored to normal size
155                                          and position */
156     SDL_WINDOWEVENT_ENTER,          /**< Window has gained mouse focus */
157     SDL_WINDOWEVENT_LEAVE,          /**< Window has lost mouse focus */
158     SDL_WINDOWEVENT_FOCUS_GAINED,   /**< Window has gained keyboard focus */
159     SDL_WINDOWEVENT_FOCUS_LOST,     /**< Window has lost keyboard focus */
160     SDL_WINDOWEVENT_CLOSE           /**< The window manager requests that the
161                                          window be closed */
162 } SDL_WindowEventID;
163
164 /**
165  *  \brief An opaque handle to an OpenGL context.
166  */
167 typedef void *SDL_GLContext;
168
169 /**
170  *  \brief OpenGL configuration attributes
171  */
172 typedef enum
173 {
174     SDL_GL_RED_SIZE,
175     SDL_GL_GREEN_SIZE,
176     SDL_GL_BLUE_SIZE,
177     SDL_GL_ALPHA_SIZE,
178     SDL_GL_BUFFER_SIZE,
179     SDL_GL_DOUBLEBUFFER,
180     SDL_GL_DEPTH_SIZE,
181     SDL_GL_STENCIL_SIZE,
182     SDL_GL_ACCUM_RED_SIZE,
183     SDL_GL_ACCUM_GREEN_SIZE,
184     SDL_GL_ACCUM_BLUE_SIZE,
185     SDL_GL_ACCUM_ALPHA_SIZE,
186     SDL_GL_STEREO,
187     SDL_GL_MULTISAMPLEBUFFERS,
188     SDL_GL_MULTISAMPLESAMPLES,
189     SDL_GL_ACCELERATED_VISUAL,
190     SDL_GL_RETAINED_BACKING,
191     SDL_GL_CONTEXT_MAJOR_VERSION,
192     SDL_GL_CONTEXT_MINOR_VERSION,
193     SDL_GL_CONTEXT_EGL,
194     SDL_GL_CONTEXT_FLAGS,
195     SDL_GL_CONTEXT_PROFILE_MASK,
196     SDL_GL_SHARE_WITH_CURRENT_CONTEXT,
197     SDL_GL_FRAMEBUFFER_SRGB_CAPABLE,
198     SDL_GL_CONTEXT_RELEASE_BEHAVIOR
199 #ifdef __TIZEN__
200     ,SDL_GL_CONTEXT_PRIORITY
201 #endif
202 } SDL_GLattr;
203
204 typedef enum
205 {
206     SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
207     SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
208     SDL_GL_CONTEXT_PROFILE_ES             = 0x0004 /* GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
209 } SDL_GLprofile;
210
211 typedef enum
212 {
213     SDL_GL_CONTEXT_DEBUG_FLAG              = 0x0001,
214     SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
215     SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG      = 0x0004,
216     SDL_GL_CONTEXT_RESET_ISOLATION_FLAG    = 0x0008
217 } SDL_GLcontextFlag;
218
219 typedef enum
220 {
221     SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE   = 0x0000,
222     SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH  = 0x0001
223 } SDL_GLcontextReleaseFlag;
224
225
226 #ifdef __TIZEN__
227 typedef enum
228 {
229     SDL_GL_CONTEXT_PRIORITY_NONE    = 0x0000,
230     SDL_GL_CONTEXT_PRIORITY_HIGH    = 0x0001,
231     SDL_GL_CONTEXT_PRIORITY_MEDIUM  = 0x0002,
232     SDL_GL_CONTEXT_PRIORITY_LOW     = 0x0003
233 } SDL_GLcontextPriorityLevel;
234 #endif
235
236 /**
237  *  \brief An opaque handle to an Vulkan instance.
238  */
239 typedef void *SDL_vulkanInstance;
240
241 /**
242  *  \brief An opaque handle to an Vulkan instance.
243  */
244 typedef void *SDL_vulkanSurface;
245
246 /* Function prototypes */
247
248 /**
249  *  \brief Get the number of video drivers compiled into SDL
250  *
251  *  \sa SDL_GetVideoDriver()
252  */
253 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
254
255 /**
256  *  \brief Get the name of a built in video driver.
257  *
258  *  \note The video drivers are presented in the order in which they are
259  *        normally checked during initialization.
260  *
261  *  \sa SDL_GetNumVideoDrivers()
262  */
263 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
264
265 /**
266  *  \brief Initialize the video subsystem, optionally specifying a video driver.
267  *
268  *  \param driver_name Initialize a specific driver by name, or NULL for the
269  *                     default video driver.
270  *
271  *  \return 0 on success, -1 on error
272  *
273  *  This function initializes the video subsystem; setting up a connection
274  *  to the window manager, etc, and determines the available display modes
275  *  and pixel formats, but does not initialize a window or graphics mode.
276  *
277  *  \sa SDL_VideoQuit()
278  */
279 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
280
281 /**
282  *  \brief Shuts down the video subsystem.
283  *
284  *  This function closes all windows, and restores the original video mode.
285  *
286  *  \sa SDL_VideoInit()
287  */
288 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
289
290 /**
291  *  \brief Returns the name of the currently initialized video driver.
292  *
293  *  \return The name of the current video driver or NULL if no driver
294  *          has been initialized
295  *
296  *  \sa SDL_GetNumVideoDrivers()
297  *  \sa SDL_GetVideoDriver()
298  */
299 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
300
301 /**
302  *  \brief Returns the number of available video displays.
303  *
304  *  \sa SDL_GetDisplayBounds()
305  */
306 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
307
308 /**
309  *  \brief Get the name of a display in UTF-8 encoding
310  *
311  *  \return The name of a display, or NULL for an invalid display index.
312  *
313  *  \sa SDL_GetNumVideoDisplays()
314  */
315 extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
316
317 /**
318  *  \brief Get the desktop area represented by a display, with the primary
319  *         display located at 0,0
320  *
321  *  \return 0 on success, or -1 if the index is out of range.
322  *
323  *  \sa SDL_GetNumVideoDisplays()
324  */
325 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
326
327 /**
328  *  \brief Get the dots/pixels-per-inch for a display
329  *
330  *  \note Diagonal, horizontal and vertical DPI can all be optionally
331  *        returned if the parameter is non-NULL.
332  *
333  *  \return 0 on success, or -1 if no DPI information is available or the index is out of range.
334  *
335  *  \sa SDL_GetNumVideoDisplays()
336  */
337 extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, float * hdpi, float * vdpi);
338
339 /**
340  *  \brief Returns the number of available display modes.
341  *
342  *  \sa SDL_GetDisplayMode()
343  */
344 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
345
346 /**
347  *  \brief Fill in information about a specific display mode.
348  *
349  *  \note The display modes are sorted in this priority:
350  *        \li bits per pixel -> more colors to fewer colors
351  *        \li width -> largest to smallest
352  *        \li height -> largest to smallest
353  *        \li refresh rate -> highest to lowest
354  *
355  *  \sa SDL_GetNumDisplayModes()
356  */
357 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
358                                                SDL_DisplayMode * mode);
359
360 /**
361  *  \brief Fill in information about the desktop display mode.
362  */
363 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
364
365 /**
366  *  \brief Fill in information about the current display mode.
367  */
368 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
369
370
371 /**
372  *  \brief Get the closest match to the requested display mode.
373  *
374  *  \param displayIndex The index of display from which mode should be queried.
375  *  \param mode The desired display mode
376  *  \param closest A pointer to a display mode to be filled in with the closest
377  *                 match of the available display modes.
378  *
379  *  \return The passed in value \c closest, or NULL if no matching video mode
380  *          was available.
381  *
382  *  The available display modes are scanned, and \c closest is filled in with the
383  *  closest mode matching the requested mode and returned.  The mode format and
384  *  refresh_rate default to the desktop mode if they are 0.  The modes are
385  *  scanned with size being first priority, format being second priority, and
386  *  finally checking the refresh_rate.  If all the available modes are too
387  *  small, then NULL is returned.
388  *
389  *  \sa SDL_GetNumDisplayModes()
390  *  \sa SDL_GetDisplayMode()
391  */
392 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
393
394 /**
395  *  \brief Get the display index associated with a window.
396  *
397  *  \return the display index of the display containing the center of the
398  *          window, or -1 on error.
399  */
400 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window);
401
402 /**
403  *  \brief Set the display mode used when a fullscreen window is visible.
404  *
405  *  By default the window's dimensions and the desktop format and refresh rate
406  *  are used.
407  *
408  *  \param window The window for which the display mode should be set.
409  *  \param mode The mode to use, or NULL for the default mode.
410  *
411  *  \return 0 on success, or -1 if setting the display mode failed.
412  *
413  *  \sa SDL_GetWindowDisplayMode()
414  *  \sa SDL_SetWindowFullscreen()
415  */
416 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
417                                                      const SDL_DisplayMode
418                                                          * mode);
419
420 /**
421  *  \brief Fill in information about the display mode used when a fullscreen
422  *         window is visible.
423  *
424  *  \sa SDL_SetWindowDisplayMode()
425  *  \sa SDL_SetWindowFullscreen()
426  */
427 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
428                                                      SDL_DisplayMode * mode);
429
430 /**
431  *  \brief Get the pixel format associated with the window.
432  */
433 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
434
435 /**
436  *  \brief Create a window with the specified position, dimensions, and flags.
437  *
438  *  \param title The title of the window, in UTF-8 encoding.
439  *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
440  *               ::SDL_WINDOWPOS_UNDEFINED.
441  *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
442  *               ::SDL_WINDOWPOS_UNDEFINED.
443  *  \param w     The width of the window, in screen coordinates.
444  *  \param h     The height of the window, in screen coordinates.
445  *  \param flags The flags for the window, a mask of any of the following:
446  *               ::SDL_WINDOW_FULLSCREEN,    ::SDL_WINDOW_OPENGL,
447  *               ::SDL_WINDOW_HIDDEN,        ::SDL_WINDOW_BORDERLESS,
448  *               ::SDL_WINDOW_RESIZABLE,     ::SDL_WINDOW_MAXIMIZED,
449  *               ::SDL_WINDOW_MINIMIZED,     ::SDL_WINDOW_INPUT_GRABBED,
450  *               ::SDL_WINDOW_ALLOW_HIGHDPI.
451  *
452  *  \return The id of the window created, or zero if window creation failed.
453  *
454  *  If the window is created with the SDL_WINDOW_ALLOW_HIGHDPI flag, its size
455  *  in pixels may differ from its size in screen coordinates on platforms with
456  *  high-DPI support (e.g. iOS and Mac OS X). Use SDL_GetWindowSize() to query
457  *  the client area's size in screen coordinates, and SDL_GL_GetDrawableSize()
458  *  or SDL_GetRendererOutputSize() to query the drawable size in pixels.
459  *
460  *  \sa SDL_DestroyWindow()
461  */
462 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
463                                                       int x, int y, int w,
464                                                       int h, Uint32 flags);
465
466 /**
467  *  \brief Create an SDL window from an existing native window.
468  *
469  *  \param data A pointer to driver-dependent window creation data
470  *
471  *  \return The id of the window created, or zero if window creation failed.
472  *
473  *  \sa SDL_DestroyWindow()
474  */
475 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
476
477 /**
478  *  \brief Get the numeric ID of a window, for logging purposes.
479  */
480 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
481
482 /**
483  *  \brief Get a window from a stored ID, or NULL if it doesn't exist.
484  */
485 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
486
487 /**
488  *  \brief Get the window flags.
489  */
490 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
491
492 /**
493  *  \brief Set the title of a window, in UTF-8 format.
494  *
495  *  \sa SDL_GetWindowTitle()
496  */
497 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
498                                                 const char *title);
499
500 /**
501  *  \brief Get the title of a window, in UTF-8 format.
502  *
503  *  \sa SDL_SetWindowTitle()
504  */
505 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
506
507 /**
508  *  \brief Set the icon for a window.
509  *
510  *  \param window The window for which the icon should be set.
511  *  \param icon The icon for the window.
512  */
513 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
514                                                SDL_Surface * icon);
515
516 /**
517  *  \brief Associate an arbitrary named pointer with a window.
518  *
519  *  \param window   The window to associate with the pointer.
520  *  \param name     The name of the pointer.
521  *  \param userdata The associated pointer.
522  *
523  *  \return The previous value associated with 'name'
524  *
525  *  \note The name is case-sensitive.
526  *
527  *  \sa SDL_GetWindowData()
528  */
529 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
530                                                 const char *name,
531                                                 void *userdata);
532
533 /**
534  *  \brief Retrieve the data pointer associated with a window.
535  *
536  *  \param window   The window to query.
537  *  \param name     The name of the pointer.
538  *
539  *  \return The value associated with 'name'
540  *
541  *  \sa SDL_SetWindowData()
542  */
543 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
544                                                 const char *name);
545
546 /**
547  *  \brief Set the position of a window.
548  *
549  *  \param window   The window to reposition.
550  *  \param x        The x coordinate of the window in screen coordinates, or
551  *                  ::SDL_WINDOWPOS_CENTERED or ::SDL_WINDOWPOS_UNDEFINED.
552  *  \param y        The y coordinate of the window in screen coordinates, or
553  *                  ::SDL_WINDOWPOS_CENTERED or ::SDL_WINDOWPOS_UNDEFINED.
554  *
555  *  \note The window coordinate origin is the upper left of the display.
556  *
557  *  \sa SDL_GetWindowPosition()
558  */
559 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
560                                                    int x, int y);
561
562 /**
563  *  \brief Get the position of a window.
564  *
565  *  \param window   The window to query.
566  *  \param x        Pointer to variable for storing the x position, in screen
567  *                  coordinates. May be NULL.
568  *  \param y        Pointer to variable for storing the y position, in screen
569  *                  coordinates. May be NULL.
570  *
571  *  \sa SDL_SetWindowPosition()
572  */
573 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
574                                                    int *x, int *y);
575
576 /**
577  *  \brief Set the size of a window's client area.
578  *
579  *  \param window   The window to resize.
580  *  \param w        The width of the window, in screen coordinates. Must be >0.
581  *  \param h        The height of the window, in screen coordinates. Must be >0.
582  *
583  *  \note You can't change the size of a fullscreen window, it automatically
584  *        matches the size of the display mode.
585  *
586  *  The window size in screen coordinates may differ from the size in pixels, if
587  *  the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with
588  *  high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or
589  *  SDL_GetRendererOutputSize() to get the real client area size in pixels.
590  *
591  *  \sa SDL_GetWindowSize()
592  */
593 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
594                                                int h);
595
596 /**
597  *  \brief Get the size of a window's client area.
598  *
599  *  \param window   The window to query.
600  *  \param w        Pointer to variable for storing the width, in screen
601  *                  coordinates. May be NULL.
602  *  \param h        Pointer to variable for storing the height, in screen
603  *                  coordinates. May be NULL.
604  *
605  *  The window size in screen coordinates may differ from the size in pixels, if
606  *  the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with
607  *  high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or
608  *  SDL_GetRendererOutputSize() to get the real client area size in pixels.
609  *
610  *  \sa SDL_SetWindowSize()
611  */
612 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
613                                                int *h);
614
615 /**
616  *  \brief Set the minimum size of a window's client area.
617  *
618  *  \param window    The window to set a new minimum size.
619  *  \param min_w     The minimum width of the window, must be >0
620  *  \param min_h     The minimum height of the window, must be >0
621  *
622  *  \note You can't change the minimum size of a fullscreen window, it
623  *        automatically matches the size of the display mode.
624  *
625  *  \sa SDL_GetWindowMinimumSize()
626  *  \sa SDL_SetWindowMaximumSize()
627  */
628 extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window,
629                                                       int min_w, int min_h);
630
631 /**
632  *  \brief Get the minimum size of a window's client area.
633  *
634  *  \param window   The window to query.
635  *  \param w        Pointer to variable for storing the minimum width, may be NULL
636  *  \param h        Pointer to variable for storing the minimum height, may be NULL
637  *
638  *  \sa SDL_GetWindowMaximumSize()
639  *  \sa SDL_SetWindowMinimumSize()
640  */
641 extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window,
642                                                       int *w, int *h);
643
644 /**
645  *  \brief Set the maximum size of a window's client area.
646  *
647  *  \param window    The window to set a new maximum size.
648  *  \param max_w     The maximum width of the window, must be >0
649  *  \param max_h     The maximum height of the window, must be >0
650  *
651  *  \note You can't change the maximum size of a fullscreen window, it
652  *        automatically matches the size of the display mode.
653  *
654  *  \sa SDL_GetWindowMaximumSize()
655  *  \sa SDL_SetWindowMinimumSize()
656  */
657 extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window,
658                                                       int max_w, int max_h);
659
660 /**
661  *  \brief Get the maximum size of a window's client area.
662  *
663  *  \param window   The window to query.
664  *  \param w        Pointer to variable for storing the maximum width, may be NULL
665  *  \param h        Pointer to variable for storing the maximum height, may be NULL
666  *
667  *  \sa SDL_GetWindowMinimumSize()
668  *  \sa SDL_SetWindowMaximumSize()
669  */
670 extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window,
671                                                       int *w, int *h);
672
673 /**
674  *  \brief Set the border state of a window.
675  *
676  *  This will add or remove the window's SDL_WINDOW_BORDERLESS flag and
677  *  add or remove the border from the actual window. This is a no-op if the
678  *  window's border already matches the requested state.
679  *
680  *  \param window The window of which to change the border state.
681  *  \param bordered SDL_FALSE to remove border, SDL_TRUE to add border.
682  *
683  *  \note You can't change the border state of a fullscreen window.
684  *
685  *  \sa SDL_GetWindowFlags()
686  */
687 extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window,
688                                                    SDL_bool bordered);
689
690 /**
691  *  \brief Show a window.
692  *
693  *  \sa SDL_HideWindow()
694  */
695 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
696
697 /**
698  *  \brief Hide a window.
699  *
700  *  \sa SDL_ShowWindow()
701  */
702 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
703
704 /**
705  *  \brief Raise a window above other windows and set the input focus.
706  */
707 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
708
709 /**
710  *  \brief Make a window as large as possible.
711  *
712  *  \sa SDL_RestoreWindow()
713  */
714 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
715
716 /**
717  *  \brief Minimize a window to an iconic representation.
718  *
719  *  \sa SDL_RestoreWindow()
720  */
721 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
722
723 /**
724  *  \brief Restore the size and position of a minimized or maximized window.
725  *
726  *  \sa SDL_MaximizeWindow()
727  *  \sa SDL_MinimizeWindow()
728  */
729 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
730
731 /**
732  *  \brief Set a window's fullscreen state.
733  *
734  *  \return 0 on success, or -1 if setting the display mode failed.
735  *
736  *  \sa SDL_SetWindowDisplayMode()
737  *  \sa SDL_GetWindowDisplayMode()
738  */
739 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
740                                                     Uint32 flags);
741
742 /**
743  *  \brief Get the SDL surface associated with the window.
744  *
745  *  \return The window's framebuffer surface, or NULL on error.
746  *
747  *  A new surface will be created with the optimal format for the window,
748  *  if necessary. This surface will be freed when the window is destroyed.
749  *
750  *  \note You may not combine this with 3D or the rendering API on this window.
751  *
752  *  \sa SDL_UpdateWindowSurface()
753  *  \sa SDL_UpdateWindowSurfaceRects()
754  */
755 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
756
757 /**
758  *  \brief Copy the window surface to the screen.
759  *
760  *  \return 0 on success, or -1 on error.
761  *
762  *  \sa SDL_GetWindowSurface()
763  *  \sa SDL_UpdateWindowSurfaceRects()
764  */
765 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
766
767 /**
768  *  \brief Copy a number of rectangles on the window surface to the screen.
769  *
770  *  \return 0 on success, or -1 on error.
771  *
772  *  \sa SDL_GetWindowSurface()
773  *  \sa SDL_UpdateWindowSurfaceRect()
774  */
775 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
776                                                          const SDL_Rect * rects,
777                                                          int numrects);
778
779 /**
780  *  \brief Set a window's input grab mode.
781  *
782  *  \param window The window for which the input grab mode should be set.
783  *  \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
784  *
785  *  If the caller enables a grab while another window is currently grabbed,
786  *  the other window loses its grab in favor of the caller's window.
787  *
788  *  \sa SDL_GetWindowGrab()
789  */
790 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
791                                                SDL_bool grabbed);
792
793 /**
794  *  \brief Get a window's input grab mode.
795  *
796  *  \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.
797  *
798  *  \sa SDL_SetWindowGrab()
799  */
800 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
801
802 /**
803  *  \brief Get the window that currently has an input grab enabled.
804  *
805  *  \return This returns the window if input is grabbed, and NULL otherwise.
806  *
807  *  \sa SDL_SetWindowGrab()
808  */
809 extern DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void);
810
811 /**
812  *  \brief Set the brightness (gamma correction) for a window.
813  *
814  *  \return 0 on success, or -1 if setting the brightness isn't supported.
815  *
816  *  \sa SDL_GetWindowBrightness()
817  *  \sa SDL_SetWindowGammaRamp()
818  */
819 extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
820
821 /**
822  *  \brief Get the brightness (gamma correction) for a window.
823  *
824  *  \return The last brightness value passed to SDL_SetWindowBrightness()
825  *
826  *  \sa SDL_SetWindowBrightness()
827  */
828 extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
829
830 /**
831  *  \brief Set the gamma ramp for a window.
832  *
833  *  \param window The window for which the gamma ramp should be set.
834  *  \param red The translation table for the red channel, or NULL.
835  *  \param green The translation table for the green channel, or NULL.
836  *  \param blue The translation table for the blue channel, or NULL.
837  *
838  *  \return 0 on success, or -1 if gamma ramps are unsupported.
839  *
840  *  Set the gamma translation table for the red, green, and blue channels
841  *  of the video hardware.  Each table is an array of 256 16-bit quantities,
842  *  representing a mapping between the input and output for that channel.
843  *  The input is the index into the array, and the output is the 16-bit
844  *  gamma value at that index, scaled to the output color precision.
845  *
846  *  \sa SDL_GetWindowGammaRamp()
847  */
848 extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
849                                                    const Uint16 * red,
850                                                    const Uint16 * green,
851                                                    const Uint16 * blue);
852
853 /**
854  *  \brief Get the gamma ramp for a window.
855  *
856  *  \param window The window from which the gamma ramp should be queried.
857  *  \param red   A pointer to a 256 element array of 16-bit quantities to hold
858  *               the translation table for the red channel, or NULL.
859  *  \param green A pointer to a 256 element array of 16-bit quantities to hold
860  *               the translation table for the green channel, or NULL.
861  *  \param blue  A pointer to a 256 element array of 16-bit quantities to hold
862  *               the translation table for the blue channel, or NULL.
863  *
864  *  \return 0 on success, or -1 if gamma ramps are unsupported.
865  *
866  *  \sa SDL_SetWindowGammaRamp()
867  */
868 extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
869                                                    Uint16 * red,
870                                                    Uint16 * green,
871                                                    Uint16 * blue);
872
873 /**
874  *  \brief Possible return values from the SDL_HitTest callback.
875  *
876  *  \sa SDL_HitTest
877  */
878 typedef enum
879 {
880     SDL_HITTEST_NORMAL,  /**< Region is normal. No special properties. */
881     SDL_HITTEST_DRAGGABLE,  /**< Region can drag entire window. */
882     SDL_HITTEST_RESIZE_TOPLEFT,
883     SDL_HITTEST_RESIZE_TOP,
884     SDL_HITTEST_RESIZE_TOPRIGHT,
885     SDL_HITTEST_RESIZE_RIGHT,
886     SDL_HITTEST_RESIZE_BOTTOMRIGHT,
887     SDL_HITTEST_RESIZE_BOTTOM,
888     SDL_HITTEST_RESIZE_BOTTOMLEFT,
889     SDL_HITTEST_RESIZE_LEFT
890 } SDL_HitTestResult;
891
892 /**
893  *  \brief Callback used for hit-testing.
894  *
895  *  \sa SDL_SetWindowHitTest
896  */
897 typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
898                                                  const SDL_Point *area,
899                                                  void *data);
900
901 /**
902  *  \brief Provide a callback that decides if a window region has special properties.
903  *
904  *  Normally windows are dragged and resized by decorations provided by the
905  *  system window manager (a title bar, borders, etc), but for some apps, it
906  *  makes sense to drag them from somewhere else inside the window itself; for
907  *  example, one might have a borderless window that wants to be draggable
908  *  from any part, or simulate its own title bar, etc.
909  *
910  *  This function lets the app provide a callback that designates pieces of
911  *  a given window as special. This callback is run during event processing
912  *  if we need to tell the OS to treat a region of the window specially; the
913  *  use of this callback is known as "hit testing."
914  *
915  *  Mouse input may not be delivered to your application if it is within
916  *  a special area; the OS will often apply that input to moving the window or
917  *  resizing the window and not deliver it to the application.
918  *
919  *  Specifying NULL for a callback disables hit-testing. Hit-testing is
920  *  disabled by default.
921  *
922  *  Platforms that don't support this functionality will return -1
923  *  unconditionally, even if you're attempting to disable hit-testing.
924  *
925  *  Your callback may fire at any time, and its firing does not indicate any
926  *  specific behavior (for example, on Windows, this certainly might fire
927  *  when the OS is deciding whether to drag your window, but it fires for lots
928  *  of other reasons, too, some unrelated to anything you probably care about
929  *  _and when the mouse isn't actually at the location it is testing_).
930  *  Since this can fire at any time, you should try to keep your callback
931  *  efficient, devoid of allocations, etc.
932  *
933  *  \param window The window to set hit-testing on.
934  *  \param callback The callback to call when doing a hit-test.
935  *  \param callback_data An app-defined void pointer passed to the callback.
936  *  \return 0 on success, -1 on error (including unsupported).
937  */
938 extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window * window,
939                                                  SDL_HitTest callback,
940                                                  void *callback_data);
941
942 /**
943  *  \brief Destroy a window.
944  */
945 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
946
947
948 /**
949  *  \brief Returns whether the screensaver is currently enabled (default on).
950  *
951  *  \sa SDL_EnableScreenSaver()
952  *  \sa SDL_DisableScreenSaver()
953  */
954 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
955
956 /**
957  *  \brief Allow the screen to be blanked by a screensaver
958  *
959  *  \sa SDL_IsScreenSaverEnabled()
960  *  \sa SDL_DisableScreenSaver()
961  */
962 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
963
964 /**
965  *  \brief Prevent the screen from being blanked by a screensaver
966  *
967  *  \sa SDL_IsScreenSaverEnabled()
968  *  \sa SDL_EnableScreenSaver()
969  */
970 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
971
972
973 /**
974  *  \name OpenGL support functions
975  */
976 /* @{ */
977
978 /**
979  *  \brief Dynamically load an OpenGL library.
980  *
981  *  \param path The platform dependent OpenGL library name, or NULL to open the
982  *              default OpenGL library.
983  *
984  *  \return 0 on success, or -1 if the library couldn't be loaded.
985  *
986  *  This should be done after initializing the video driver, but before
987  *  creating any OpenGL windows.  If no OpenGL library is loaded, the default
988  *  library will be loaded upon creation of the first OpenGL window.
989  *
990  *  \note If you do this, you need to retrieve all of the GL functions used in
991  *        your program from the dynamic library using SDL_GL_GetProcAddress().
992  *
993  *  \sa SDL_GL_GetProcAddress()
994  *  \sa SDL_GL_UnloadLibrary()
995  */
996 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
997
998 /**
999  *  \brief Get the address of an OpenGL function.
1000  */
1001 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
1002
1003 /**
1004  *  \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
1005  *
1006  *  \sa SDL_GL_LoadLibrary()
1007  */
1008 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
1009
1010 /**
1011  *  \brief Return true if an OpenGL extension is supported for the current
1012  *         context.
1013  */
1014 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
1015                                                            *extension);
1016
1017 /**
1018  *  \brief Reset all previously set OpenGL context attributes to their default values
1019  */
1020 extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
1021
1022 /**
1023  *  \brief Set an OpenGL window attribute before window creation.
1024  */
1025 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
1026
1027 /**
1028  *  \brief Get the actual value for an attribute from the current context.
1029  */
1030 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
1031
1032 /**
1033  *  \brief Create an OpenGL context for use with an OpenGL window, and make it
1034  *         current.
1035  *
1036  *  \sa SDL_GL_DeleteContext()
1037  */
1038 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
1039                                                            window);
1040
1041 /**
1042  *  \brief Set up an OpenGL context for rendering into an OpenGL window.
1043  *
1044  *  \note The context must have been created with a compatible window.
1045  */
1046 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
1047                                                SDL_GLContext context);
1048
1049 /**
1050  *  \brief Get the currently active OpenGL window.
1051  */
1052 extern DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow(void);
1053
1054 /**
1055  *  \brief Get the currently active OpenGL context.
1056  */
1057 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
1058
1059 /**
1060  *  \brief Get the size of a window's underlying drawable in pixels (for use
1061  *         with glViewport).
1062  *
1063  *  \param window   Window from which the drawable size should be queried
1064  *  \param w        Pointer to variable for storing the width in pixels, may be NULL
1065  *  \param h        Pointer to variable for storing the height in pixels, may be NULL
1066  *
1067  * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI
1068  * drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a
1069  * platform with high-DPI support (Apple calls this "Retina"), and not disabled
1070  * by the SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.
1071  *
1072  *  \sa SDL_GetWindowSize()
1073  *  \sa SDL_CreateWindow()
1074  */
1075 extern DECLSPEC void SDLCALL SDL_GL_GetDrawableSize(SDL_Window * window, int *w,
1076                                                     int *h);
1077
1078 /**
1079  *  \brief Set the swap interval for the current OpenGL context.
1080  *
1081  *  \param interval 0 for immediate updates, 1 for updates synchronized with the
1082  *                  vertical retrace. If the system supports it, you may
1083  *                  specify -1 to allow late swaps to happen immediately
1084  *                  instead of waiting for the next retrace.
1085  *
1086  *  \return 0 on success, or -1 if setting the swap interval is not supported.
1087  *
1088  *  \sa SDL_GL_GetSwapInterval()
1089  */
1090 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
1091
1092 /**
1093  *  \brief Get the swap interval for the current OpenGL context.
1094  *
1095  *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer
1096  *          swap is synchronized with the vertical retrace, and -1 if late
1097  *          swaps happen immediately instead of waiting for the next retrace.
1098  *          If the system can't determine the swap interval, or there isn't a
1099  *          valid current context, this will return 0 as a safe default.
1100  *
1101  *  \sa SDL_GL_SetSwapInterval()
1102  */
1103 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
1104
1105 /**
1106  * \brief Swap the OpenGL buffers for a window, if double-buffering is
1107  *        supported.
1108  */
1109 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
1110
1111 /**
1112  *  \brief Delete an OpenGL context.
1113  *
1114  *  \sa SDL_GL_CreateContext()
1115  */
1116 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
1117
1118 /* @} *//* OpenGL support functions */
1119
1120 /**
1121  *  \name Vulkan support functions
1122  */
1123 /* @{ */
1124
1125 extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_GetInstanceExtensions(SDL_Window* window, unsigned* count, char** names);
1126 extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_CreateSurface(SDL_Window* window, SDL_vulkanInstance instance, SDL_vulkanSurface* surface);
1127
1128 /* @} *//* Vulkan support functions */
1129
1130 /* Ends C function definitions when using C++ */
1131 #ifdef __cplusplus
1132 }
1133 #endif
1134 #include "close_code.h"
1135
1136 #endif /* _SDL_video_h */
1137
1138 /* vi: set ts=4 sw=4 expandtab: */