My Project
SDL_video.h
Go to the documentation of this file.
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 
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 
53 typedef struct
54 {
56  int w;
57  int h;
59  void *driverdata;
61 
90 typedef struct SDL_Window SDL_Window;
91 
97 typedef enum
98 {
99  /* !!! FIXME: change this to name = (1<<x). */
100  SDL_WINDOW_FULLSCREEN = 0x00000001,
101  SDL_WINDOW_OPENGL = 0x00000002,
102  SDL_WINDOW_SHOWN = 0x00000004,
103  SDL_WINDOW_HIDDEN = 0x00000008,
104  SDL_WINDOW_BORDERLESS = 0x00000010,
105  SDL_WINDOW_RESIZABLE = 0x00000020,
106  SDL_WINDOW_MINIMIZED = 0x00000040,
107  SDL_WINDOW_MAXIMIZED = 0x00000080,
109  SDL_WINDOW_INPUT_FOCUS = 0x00000200,
110  SDL_WINDOW_MOUSE_FOCUS = 0x00000400,
111  SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
112  SDL_WINDOW_FOREIGN = 0x00000800,
116  SDL_WINDOW_SKIP_TASKBAR = 0x00010000,
117  SDL_WINDOW_UTILITY = 0x00020000,
118  SDL_WINDOW_TOOLTIP = 0x00040000,
119  SDL_WINDOW_POPUP_MENU = 0x00080000
121 
125 #define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000u
126 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
127 #define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
128 #define SDL_WINDOWPOS_ISUNDEFINED(X) \
129  (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
130 
134 #define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000u
135 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK|(X))
136 #define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0)
137 #define SDL_WINDOWPOS_ISCENTERED(X) \
138  (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
139 
143 typedef enum
144 {
168 
172 typedef void *SDL_GLContext;
173 
177 typedef enum
178 {
179  SDL_GL_RED_SIZE,
180  SDL_GL_GREEN_SIZE,
181  SDL_GL_BLUE_SIZE,
182  SDL_GL_ALPHA_SIZE,
183  SDL_GL_BUFFER_SIZE,
184  SDL_GL_DOUBLEBUFFER,
185  SDL_GL_DEPTH_SIZE,
186  SDL_GL_STENCIL_SIZE,
187  SDL_GL_ACCUM_RED_SIZE,
188  SDL_GL_ACCUM_GREEN_SIZE,
189  SDL_GL_ACCUM_BLUE_SIZE,
190  SDL_GL_ACCUM_ALPHA_SIZE,
191  SDL_GL_STEREO,
192  SDL_GL_MULTISAMPLEBUFFERS,
193  SDL_GL_MULTISAMPLESAMPLES,
194  SDL_GL_ACCELERATED_VISUAL,
195  SDL_GL_RETAINED_BACKING,
196  SDL_GL_CONTEXT_MAJOR_VERSION,
197  SDL_GL_CONTEXT_MINOR_VERSION,
198  SDL_GL_CONTEXT_EGL,
199  SDL_GL_CONTEXT_FLAGS,
200  SDL_GL_CONTEXT_PROFILE_MASK,
201  SDL_GL_SHARE_WITH_CURRENT_CONTEXT,
202  SDL_GL_FRAMEBUFFER_SRGB_CAPABLE,
203  SDL_GL_CONTEXT_RELEASE_BEHAVIOR
204 } SDL_GLattr;
205 
206 typedef enum
207 {
208  SDL_GL_CONTEXT_PROFILE_CORE = 0x0001,
209  SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002,
210  SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /* GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
211 } SDL_GLprofile;
212 
213 typedef enum
214 {
215  SDL_GL_CONTEXT_DEBUG_FLAG = 0x0001,
216  SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
217  SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG = 0x0004,
218  SDL_GL_CONTEXT_RESET_ISOLATION_FLAG = 0x0008
219 } SDL_GLcontextFlag;
220 
221 typedef enum
222 {
223  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE = 0x0000,
224  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH = 0x0001
225 } SDL_GLcontextReleaseFlag;
226 
227 
228 /* Function prototypes */
229 
235 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
236 
245 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
246 
261 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
262 
270 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
271 
281 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
282 
288 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
289 
297 extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
298 
307 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
308 
319 extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, float * hdpi, float * vdpi);
320 
338 extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect * rect);
339 
345 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
346 
358 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
359  SDL_DisplayMode * mode);
360 
364 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
365 
369 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
370 
371 
393 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
394 
401 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window);
402 
417 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
418  const SDL_DisplayMode
419  * mode);
420 
428 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
429  SDL_DisplayMode * mode);
430 
434 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
435 
463 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
464  int x, int y, int w,
465  int h, Uint32 flags);
466 
476 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
477 
481 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
482 
486 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
487 
491 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
492 
498 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
499  const char *title);
500 
506 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
507 
514 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
515  SDL_Surface * icon);
516 
530 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
531  const char *name,
532  void *userdata);
533 
544 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
545  const char *name);
546 
560 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
561  int x, int y);
562 
574 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
575  int *x, int *y);
576 
594 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
595  int h);
596 
613 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
614  int *h);
615 
631 extern DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window * window,
632  int *top, int *left,
633  int *bottom, int *right);
634 
648 extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window,
649  int min_w, int min_h);
650 
661 extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window,
662  int *w, int *h);
663 
677 extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window,
678  int max_w, int max_h);
679 
690 extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window,
691  int *w, int *h);
692 
707 extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window,
708  SDL_bool bordered);
709 
724 extern DECLSPEC void SDLCALL SDL_SetWindowResizable(SDL_Window * window,
725  SDL_bool resizable);
726 
732 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
733 
739 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
740 
744 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
745 
751 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
752 
758 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
759 
766 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
767 
776 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
777  Uint32 flags);
778 
792 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
793 
802 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
803 
812 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
813  const SDL_Rect * rects,
814  int numrects);
815 
827 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
828  SDL_bool grabbed);
829 
837 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
838 
846 extern DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void);
847 
856 extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
857 
865 extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
866 
878 extern DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window * window, float opacity);
879 
893 extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window * window, float * out_opacity);
894 
903 extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window * modal_window, SDL_Window * parent_window);
904 
917 extern DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window * window);
918 
937 extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
938  const Uint16 * red,
939  const Uint16 * green,
940  const Uint16 * blue);
941 
957 extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
958  Uint16 * red,
959  Uint16 * green,
960  Uint16 * blue);
961 
967 typedef enum
968 {
971  SDL_HITTEST_RESIZE_TOPLEFT,
972  SDL_HITTEST_RESIZE_TOP,
973  SDL_HITTEST_RESIZE_TOPRIGHT,
974  SDL_HITTEST_RESIZE_RIGHT,
975  SDL_HITTEST_RESIZE_BOTTOMRIGHT,
976  SDL_HITTEST_RESIZE_BOTTOM,
977  SDL_HITTEST_RESIZE_BOTTOMLEFT,
978  SDL_HITTEST_RESIZE_LEFT
980 
986 typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
987  const SDL_Point *area,
988  void *data);
989 
1027 extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window * window,
1028  SDL_HitTest callback,
1029  void *callback_data);
1030 
1034 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
1035 
1036 
1043 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
1044 
1051 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
1052 
1059 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
1060 
1061 
1065 /* @{ */
1066 
1085 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
1086 
1090 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
1091 
1097 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
1098 
1103 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
1104  *extension);
1105 
1109 extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
1110 
1114 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
1115 
1119 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
1120 
1127 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
1128  window);
1129 
1135 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
1136  SDL_GLContext context);
1137 
1141 extern DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow(void);
1142 
1146 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
1147 
1164 extern DECLSPEC void SDLCALL SDL_GL_GetDrawableSize(SDL_Window * window, int *w,
1165  int *h);
1166 
1179 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
1180 
1192 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
1193 
1198 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
1199 
1205 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
1206 
1207 /* @} *//* OpenGL support functions */
1208 
1209 
1210 /* Ends C function definitions when using C++ */
1211 #ifdef __cplusplus
1212 }
1213 #endif
1214 #include "close_code.h"
1215 
1216 #endif /* _SDL_video_h */
1217 
1218 /* vi: set ts=4 sw=4 expandtab: */
DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window, int *w, int *h)
Get the minimum size of a window&#39;s client area.
Definition: SDL_video.h:157
Definition: SDL_video.h:104
struct SDL_Window SDL_Window
The type used to identify a window.
Definition: SDL_video.h:90
DECLSPEC void SDLCALL SDL_GL_GetDrawableSize(SDL_Window *window, int *w, int *h)
Get the size of a window&#39;s underlying drawable in pixels (for use with glViewport).
DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window *window)
Get the brightness (gamma correction) for a window.
DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect *rect)
Get the desktop area represented by a display, with the primary display located at 0...
DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window *window)
Destroy a window.
DECLSPEC SDL_Window *SDLCALL SDL_GetGrabbedWindow(void)
Get the window that currently has an input grab enabled.
DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect *rect)
Get the usable desktop area represented by a display, with the primary display located at 0...
DECLSPEC void SDLCALL SDL_SetWindowResizable(SDL_Window *window, SDL_bool resizable)
Set the user-resizable state of a window.
Definition: SDL_video.h:156
DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context)
Delete an OpenGL context.
DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name)
Initialize the video subsystem, optionally specifying a video driver.
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:159
Definition: SDL_video.h:119
DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window *window, SDL_DisplayMode *mode)
Fill in information about the display mode used when a fullscreen window is visible.
DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window *window)
Restore the size and position of a minimized or maximized window.
SDL_HitTestResult(SDLCALL * SDL_HitTest)(SDL_Window *win, const SDL_Point *area, void *data)
Callback used for hit-testing.
Definition: SDL_video.h:986
DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
Get the closest match to the requested display mode.
DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window *window)
Get the display index associated with a window.
uint16_t Uint16
An unsigned 16-bit integer type.
Definition: SDL_stdinc.h:151
DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window *window)
Make a window as large as possible.
DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window *window, const Uint16 *red, const Uint16 *green, const Uint16 *blue)
Set the gamma ramp for a window.
int w
Definition: SDL_video.h:56
DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *window)
Create an OpenGL context for use with an OpenGL window, and make it current.
Definition: SDL_video.h:116
DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value)
Set an OpenGL window attribute before window creation.
DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data)
Provide a callback that decides if a window region has special properties.
DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window *window, int *x, int *y)
Get the position of a window.
DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void)
Get the currently active OpenGL context.
DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window *window, float *out_opacity)
Get the opacity of a window.
Definition: SDL_video.h:152
DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void)
Reset all previously set OpenGL context attributes to their default values.
Definition: SDL_video.h:145
DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext context)
Set up an OpenGL context for rendering into an OpenGL window.
DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window *window)
Show a window.
DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window *window, const char *title)
Set the title of a window, in UTF-8 format.
Definition: SDL_video.h:969
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64
DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window *window, int x, int y)
Set the position of a window.
DECLSPEC void SDLCALL SDL_DisableScreenSaver(void)
Prevent the screen from being blanked by a screensaver.
DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window *window)
Explicitly sets input focus to the window.
Definition: SDL_video.h:150
DECLSPEC void *SDLCALL SDL_SetWindowData(SDL_Window *window, const char *name, void *userdata)
Associate an arbitrary named pointer with a window.
Definition: SDL_video.h:108
DECLSPEC SDL_Window *SDLCALL SDL_GL_GetCurrentWindow(void)
Get the currently active OpenGL window.
Definition: SDL_video.h:164
DECLSPEC SDL_Surface *SDLCALL SDL_GetWindowSurface(SDL_Window *window)
Get the SDL surface associated with the window.
DECLSPEC SDL_Window *SDLCALL SDL_GetWindowFromID(Uint32 id)
Get a window from a stored ID, or NULL if it doesn&#39;t exist.
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window *window)
Swap the OpenGL buffers for a window, if double-buffering is supported.
Definition: SDL_video.h:100
DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, Uint32 flags)
Set a window&#39;s fullscreen state.
DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc)
Get the address of an OpenGL function.
Definition: SDL_video.h:162
DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void)
Returns the number of available video displays.
Definition: SDL_video.h:106
Definition: SDL_video.h:105
void * driverdata
Definition: SDL_video.h:59
SDL_WindowEventID
Event subtype for window events.
Definition: SDL_video.h:143
Definition: SDL_video.h:147
int h
Definition: SDL_video.h:57
DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void)
Get the number of video drivers compiled into SDL.
DECLSPEC int SDLCALL 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) ...
DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window *window)
Copy the window surface to the screen.
DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window, int min_w, int min_h)
Set the minimum size of a window&#39;s client area.
Definition: SDL_video.h:115
DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window *window, int *w, int *h)
Get the size of a window&#39;s client area.
DECLSPEC const char *SDLCALL SDL_GetDisplayName(int displayIndex)
Get the name of a display in UTF-8 encoding.
DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window *window)
Get a window&#39;s input grab mode.
Definition: SDL_video.h:117
DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value)
Get the actual value for an attribute from the current context.
DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon)
Set the icon for a window.
DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window *window, const SDL_DisplayMode *mode)
Set the display mode used when a fullscreen window is visible.
DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right)
Get the size of a window&#39;s borders (decorations) around the client area.
DECLSPEC SDL_Window *SDLCALL SDL_CreateWindowFrom(const void *data)
Create an SDL window from an existing native window.
Definition: SDL_video.h:158
Definition: SDL_video.h:970
DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path)
Dynamically load an OpenGL library.
DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void)
Returns whether the screensaver is currently enabled (default off).
DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window *window)
Get the window flags.
Definition: SDL_video.h:107
DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window, int *w, int *h)
Get the maximum size of a window&#39;s client area.
Definition: SDL_video.h:146
DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex, SDL_DisplayMode *mode)
Fill in information about a specific display mode.
Definition: SDL_video.h:161
DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window *window)
Get the pixel format associated with the window.
Definition: SDL_video.h:148
The structure that defines a point.
Definition: SDL_rect.h:48
Definition: SDL_video.h:166
DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float *ddpi, float *hdpi, float *vdpi)
Get the dots/pixels-per-inch for a display.
Definition: SDL_video.h:113
DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window *window, Uint16 *red, Uint16 *green, Uint16 *blue)
Get the gamma ramp for a window.
Definition: SDL_video.h:110
SDL_WindowFlags
The flags on a window.
Definition: SDL_video.h:97
SDL_GLattr
OpenGL configuration attributes.
Definition: SDL_video.h:177
The structure that defines a display mode.
Definition: SDL_video.h:53
DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window, int max_w, int max_h)
Set the maximum size of a window&#39;s client area.
DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window *window, int w, int h)
Set the size of a window&#39;s client area.
Definition: SDL_video.h:112
DECLSPEC void SDLCALL SDL_EnableScreenSaver(void)
Allow the screen to be blanked by a screensaver.
Uint32 format
Definition: SDL_video.h:55
Definition: SDL_video.h:165
DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window *window, SDL_bool grabbed)
Set a window&#39;s input grab mode.
DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode *mode)
Fill in information about the desktop display mode.
Definition: SDL_video.h:109
DECLSPEC void SDLCALL SDL_VideoQuit(void)
Shuts down the video subsystem.
SDL_HitTestResult
Possible return values from the SDL_HitTest callback.
Definition: SDL_video.h:967
DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window *window)
Minimize a window to an iconic representation.
int refresh_rate
Definition: SDL_video.h:58
DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window *window, SDL_bool bordered)
Set the border state of a window.
DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void)
Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window *window, float opacity)
Set the opacity for a window.
DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char *extension)
Return true if an OpenGL extension is supported for the current context.
DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window *window)
Get the numeric ID of a window, for logging purposes.
Definition: SDL_video.h:160
Definition: SDL_video.h:103
Definition: SDL_video.h:153
DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window *window, float brightness)
Set the brightness (gamma correction) for a window.
DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void)
Returns the name of the currently initialized video driver.
DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window *window)
Hide a window.
DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex)
Returns the number of available display modes.
DECLSPEC SDL_Window *SDLCALL 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.
DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window *window)
Get the title of a window, in UTF-8 format.
DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window *window, const char *name)
Retrieve the data pointer associated with a window.
DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode *mode)
Fill in information about the current display mode.
Definition: SDL_video.h:101
Definition: SDL_video.h:163
void * SDL_GLContext
An opaque handle to an OpenGL context.
Definition: SDL_video.h:172
Definition: SDL_video.h:118
DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval)
Set the swap interval for the current OpenGL context.
Definition: SDL_video.h:114
DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects)
Copy a number of rectangles on the window surface to the screen.
DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window *window)
Raise a window above other windows and set the input focus.
Definition: SDL_video.h:102
DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index)
Get the name of a built in video driver.
DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void)
Get the swap interval for the current OpenGL context.