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