SDL 2.0
SDL_video.h File Reference
#include "SDL_stdinc.h"
#include "SDL_pixels.h"
#include "SDL_rect.h"
#include "SDL_surface.h"
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_video.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SDL_DisplayMode
 The structure that defines a display mode. More...
 

Macros

#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u
 Used to indicate that you don't care what the window position is.
 
#define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)   (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
 
#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
 
#define SDL_WINDOWPOS_ISUNDEFINED(X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
 
#define SDL_WINDOWPOS_CENTERED_MASK   0x2FFF0000u
 Used to indicate that the window position should be centered.
 
#define SDL_WINDOWPOS_CENTERED_DISPLAY(X)   (SDL_WINDOWPOS_CENTERED_MASK|(X))
 
#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)
 
#define SDL_WINDOWPOS_ISCENTERED(X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
 

Typedefs

typedef struct SDL_Window SDL_Window
 The type used to identify a window.
 
typedef void * SDL_GLContext
 An opaque handle to an OpenGL context.
 
typedef SDL_HitTestResult(* SDL_HitTest) (SDL_Window *win, const SDL_Point *area, void *data)
 

Enumerations

enum  SDL_WindowFlags {
  SDL_WINDOW_FULLSCREEN = 0x00000001 ,
  SDL_WINDOW_OPENGL = 0x00000002 ,
  SDL_WINDOW_SHOWN = 0x00000004 ,
  SDL_WINDOW_HIDDEN = 0x00000008 ,
  SDL_WINDOW_BORDERLESS = 0x00000010 ,
  SDL_WINDOW_RESIZABLE = 0x00000020 ,
  SDL_WINDOW_MINIMIZED = 0x00000040 ,
  SDL_WINDOW_MAXIMIZED = 0x00000080 ,
  SDL_WINDOW_MOUSE_GRABBED = 0x00000100 ,
  SDL_WINDOW_INPUT_FOCUS = 0x00000200 ,
  SDL_WINDOW_MOUSE_FOCUS = 0x00000400 ,
  SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ) ,
  SDL_WINDOW_FOREIGN = 0x00000800 ,
  SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000 ,
  SDL_WINDOW_MOUSE_CAPTURE = 0x00004000 ,
  SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000 ,
  SDL_WINDOW_SKIP_TASKBAR = 0x00010000 ,
  SDL_WINDOW_UTILITY = 0x00020000 ,
  SDL_WINDOW_TOOLTIP = 0x00040000 ,
  SDL_WINDOW_POPUP_MENU = 0x00080000 ,
  SDL_WINDOW_KEYBOARD_GRABBED = 0x00100000 ,
  SDL_WINDOW_VULKAN = 0x10000000 ,
  SDL_WINDOW_METAL = 0x20000000 ,
  SDL_WINDOW_INPUT_GRABBED = SDL_WINDOW_MOUSE_GRABBED
}
 The flags on a window. More...
 
enum  SDL_WindowEventID {
  SDL_WINDOWEVENT_NONE ,
  SDL_WINDOWEVENT_SHOWN ,
  SDL_WINDOWEVENT_HIDDEN ,
  SDL_WINDOWEVENT_EXPOSED ,
  SDL_WINDOWEVENT_MOVED ,
  SDL_WINDOWEVENT_RESIZED ,
  SDL_WINDOWEVENT_SIZE_CHANGED ,
  SDL_WINDOWEVENT_MINIMIZED ,
  SDL_WINDOWEVENT_MAXIMIZED ,
  SDL_WINDOWEVENT_RESTORED ,
  SDL_WINDOWEVENT_ENTER ,
  SDL_WINDOWEVENT_LEAVE ,
  SDL_WINDOWEVENT_FOCUS_GAINED ,
  SDL_WINDOWEVENT_FOCUS_LOST ,
  SDL_WINDOWEVENT_CLOSE ,
  SDL_WINDOWEVENT_TAKE_FOCUS ,
  SDL_WINDOWEVENT_HIT_TEST ,
  SDL_WINDOWEVENT_ICCPROF_CHANGED ,
  SDL_WINDOWEVENT_DISPLAY_CHANGED
}
 Event subtype for window events. More...
 
enum  SDL_DisplayEventID {
  SDL_DISPLAYEVENT_NONE ,
  SDL_DISPLAYEVENT_ORIENTATION ,
  SDL_DISPLAYEVENT_CONNECTED ,
  SDL_DISPLAYEVENT_DISCONNECTED ,
  SDL_DISPLAYEVENT_MOVED
}
 Event subtype for display events. More...
 
enum  SDL_DisplayOrientation {
  SDL_ORIENTATION_UNKNOWN ,
  SDL_ORIENTATION_LANDSCAPE ,
  SDL_ORIENTATION_LANDSCAPE_FLIPPED ,
  SDL_ORIENTATION_PORTRAIT ,
  SDL_ORIENTATION_PORTRAIT_FLIPPED
}
 Display orientation. More...
 
enum  SDL_FlashOperation {
  SDL_FLASH_CANCEL ,
  SDL_FLASH_BRIEFLY ,
  SDL_FLASH_UNTIL_FOCUSED
}
 Window flash operation. More...
 
enum  SDL_GLattr {
  SDL_GL_RED_SIZE ,
  SDL_GL_GREEN_SIZE ,
  SDL_GL_BLUE_SIZE ,
  SDL_GL_ALPHA_SIZE ,
  SDL_GL_BUFFER_SIZE ,
  SDL_GL_DOUBLEBUFFER ,
  SDL_GL_DEPTH_SIZE ,
  SDL_GL_STENCIL_SIZE ,
  SDL_GL_ACCUM_RED_SIZE ,
  SDL_GL_ACCUM_GREEN_SIZE ,
  SDL_GL_ACCUM_BLUE_SIZE ,
  SDL_GL_ACCUM_ALPHA_SIZE ,
  SDL_GL_STEREO ,
  SDL_GL_MULTISAMPLEBUFFERS ,
  SDL_GL_MULTISAMPLESAMPLES ,
  SDL_GL_ACCELERATED_VISUAL ,
  SDL_GL_RETAINED_BACKING ,
  SDL_GL_CONTEXT_MAJOR_VERSION ,
  SDL_GL_CONTEXT_MINOR_VERSION ,
  SDL_GL_CONTEXT_EGL ,
  SDL_GL_CONTEXT_FLAGS ,
  SDL_GL_CONTEXT_PROFILE_MASK ,
  SDL_GL_SHARE_WITH_CURRENT_CONTEXT ,
  SDL_GL_FRAMEBUFFER_SRGB_CAPABLE ,
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR ,
  SDL_GL_CONTEXT_RESET_NOTIFICATION ,
  SDL_GL_CONTEXT_NO_ERROR ,
  SDL_GL_FLOATBUFFERS
}
 OpenGL configuration attributes. More...
 
enum  SDL_GLprofile {
  SDL_GL_CONTEXT_PROFILE_CORE = 0x0001 ,
  SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002 ,
  SDL_GL_CONTEXT_PROFILE_ES = 0x0004
}
 
enum  SDL_GLcontextFlag {
  SDL_GL_CONTEXT_DEBUG_FLAG = 0x0001 ,
  SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002 ,
  SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG = 0x0004 ,
  SDL_GL_CONTEXT_RESET_ISOLATION_FLAG = 0x0008
}
 
enum  SDL_GLcontextReleaseFlag {
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE = 0x0000 ,
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH = 0x0001
}
 
enum  SDL_GLContextResetNotification {
  SDL_GL_CONTEXT_RESET_NO_NOTIFICATION = 0x0000 ,
  SDL_GL_CONTEXT_RESET_LOSE_CONTEXT = 0x0001
}
 
enum  SDL_HitTestResult {
  SDL_HITTEST_NORMAL ,
  SDL_HITTEST_DRAGGABLE ,
  SDL_HITTEST_RESIZE_TOPLEFT ,
  SDL_HITTEST_RESIZE_TOP ,
  SDL_HITTEST_RESIZE_TOPRIGHT ,
  SDL_HITTEST_RESIZE_RIGHT ,
  SDL_HITTEST_RESIZE_BOTTOMRIGHT ,
  SDL_HITTEST_RESIZE_BOTTOM ,
  SDL_HITTEST_RESIZE_BOTTOMLEFT ,
  SDL_HITTEST_RESIZE_LEFT
}
 

Functions

int SDL_GetNumVideoDrivers (void)
 
const char * SDL_GetVideoDriver (int index)
 
int SDL_VideoInit (const char *driver_name)
 
void SDL_VideoQuit (void)
 
const char * SDL_GetCurrentVideoDriver (void)
 
int SDL_GetNumVideoDisplays (void)
 
const char * SDL_GetDisplayName (int displayIndex)
 
int SDL_GetDisplayBounds (int displayIndex, SDL_Rect *rect)
 
int SDL_GetDisplayUsableBounds (int displayIndex, SDL_Rect *rect)
 
int SDL_GetDisplayDPI (int displayIndex, float *ddpi, float *hdpi, float *vdpi)
 
SDL_DisplayOrientation SDL_GetDisplayOrientation (int displayIndex)
 
int SDL_GetNumDisplayModes (int displayIndex)
 
int SDL_GetDisplayMode (int displayIndex, int modeIndex, SDL_DisplayMode *mode)
 
int SDL_GetDesktopDisplayMode (int displayIndex, SDL_DisplayMode *mode)
 
int SDL_GetCurrentDisplayMode (int displayIndex, SDL_DisplayMode *mode)
 
SDL_DisplayModeSDL_GetClosestDisplayMode (int displayIndex, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
 
int SDL_GetPointDisplayIndex (const SDL_Point *point)
 
int SDL_GetRectDisplayIndex (const SDL_Rect *rect)
 
int SDL_GetWindowDisplayIndex (SDL_Window *window)
 
int SDL_SetWindowDisplayMode (SDL_Window *window, const SDL_DisplayMode *mode)
 
int SDL_GetWindowDisplayMode (SDL_Window *window, SDL_DisplayMode *mode)
 
void * SDL_GetWindowICCProfile (SDL_Window *window, size_t *size)
 
Uint32 SDL_GetWindowPixelFormat (SDL_Window *window)
 
SDL_WindowSDL_CreateWindow (const char *title, int x, int y, int w, int h, Uint32 flags)
 
SDL_WindowSDL_CreateWindowFrom (const void *data)
 
Uint32 SDL_GetWindowID (SDL_Window *window)
 
SDL_WindowSDL_GetWindowFromID (Uint32 id)
 
Uint32 SDL_GetWindowFlags (SDL_Window *window)
 
void SDL_SetWindowTitle (SDL_Window *window, const char *title)
 
const char * SDL_GetWindowTitle (SDL_Window *window)
 
void SDL_SetWindowIcon (SDL_Window *window, SDL_Surface *icon)
 
void * SDL_SetWindowData (SDL_Window *window, const char *name, void *userdata)
 
void * SDL_GetWindowData (SDL_Window *window, const char *name)
 
void SDL_SetWindowPosition (SDL_Window *window, int x, int y)
 
void SDL_GetWindowPosition (SDL_Window *window, int *x, int *y)
 
void SDL_SetWindowSize (SDL_Window *window, int w, int h)
 
void SDL_GetWindowSize (SDL_Window *window, int *w, int *h)
 
int SDL_GetWindowBordersSize (SDL_Window *window, int *top, int *left, int *bottom, int *right)
 
void SDL_GetWindowSizeInPixels (SDL_Window *window, int *w, int *h)
 
void SDL_SetWindowMinimumSize (SDL_Window *window, int min_w, int min_h)
 
void SDL_GetWindowMinimumSize (SDL_Window *window, int *w, int *h)
 
void SDL_SetWindowMaximumSize (SDL_Window *window, int max_w, int max_h)
 
void SDL_GetWindowMaximumSize (SDL_Window *window, int *w, int *h)
 
void SDL_SetWindowBordered (SDL_Window *window, SDL_bool bordered)
 
void SDL_SetWindowResizable (SDL_Window *window, SDL_bool resizable)
 
void SDL_SetWindowAlwaysOnTop (SDL_Window *window, SDL_bool on_top)
 
void SDL_ShowWindow (SDL_Window *window)
 
void SDL_HideWindow (SDL_Window *window)
 
void SDL_RaiseWindow (SDL_Window *window)
 
void SDL_MaximizeWindow (SDL_Window *window)
 
void SDL_MinimizeWindow (SDL_Window *window)
 
void SDL_RestoreWindow (SDL_Window *window)
 
int SDL_SetWindowFullscreen (SDL_Window *window, Uint32 flags)
 
SDL_bool SDL_HasWindowSurface (SDL_Window *window)
 
SDL_SurfaceSDL_GetWindowSurface (SDL_Window *window)
 
int SDL_UpdateWindowSurface (SDL_Window *window)
 
int SDL_UpdateWindowSurfaceRects (SDL_Window *window, const SDL_Rect *rects, int numrects)
 
int SDL_DestroyWindowSurface (SDL_Window *window)
 
void SDL_SetWindowGrab (SDL_Window *window, SDL_bool grabbed)
 
void SDL_SetWindowKeyboardGrab (SDL_Window *window, SDL_bool grabbed)
 
void SDL_SetWindowMouseGrab (SDL_Window *window, SDL_bool grabbed)
 
SDL_bool SDL_GetWindowGrab (SDL_Window *window)
 
SDL_bool SDL_GetWindowKeyboardGrab (SDL_Window *window)
 
SDL_bool SDL_GetWindowMouseGrab (SDL_Window *window)
 
SDL_WindowSDL_GetGrabbedWindow (void)
 
int SDL_SetWindowMouseRect (SDL_Window *window, const SDL_Rect *rect)
 
const SDL_RectSDL_GetWindowMouseRect (SDL_Window *window)
 
int SDL_SetWindowBrightness (SDL_Window *window, float brightness)
 
float SDL_GetWindowBrightness (SDL_Window *window)
 
int SDL_SetWindowOpacity (SDL_Window *window, float opacity)
 
int SDL_GetWindowOpacity (SDL_Window *window, float *out_opacity)
 
int SDL_SetWindowModalFor (SDL_Window *modal_window, SDL_Window *parent_window)
 
int SDL_SetWindowInputFocus (SDL_Window *window)
 
int SDL_SetWindowGammaRamp (SDL_Window *window, const Uint16 *red, const Uint16 *green, const Uint16 *blue)
 
int SDL_GetWindowGammaRamp (SDL_Window *window, Uint16 *red, Uint16 *green, Uint16 *blue)
 
int SDL_SetWindowHitTest (SDL_Window *window, SDL_HitTest callback, void *callback_data)
 
int SDL_FlashWindow (SDL_Window *window, SDL_FlashOperation operation)
 
void SDL_DestroyWindow (SDL_Window *window)
 
SDL_bool SDL_IsScreenSaverEnabled (void)
 
void SDL_EnableScreenSaver (void)
 
void SDL_DisableScreenSaver (void)
 
OpenGL support functions
int SDL_GL_LoadLibrary (const char *path)
 
void * SDL_GL_GetProcAddress (const char *proc)
 
void SDL_GL_UnloadLibrary (void)
 
SDL_bool SDL_GL_ExtensionSupported (const char *extension)
 
void SDL_GL_ResetAttributes (void)
 
int SDL_GL_SetAttribute (SDL_GLattr attr, int value)
 
int SDL_GL_GetAttribute (SDL_GLattr attr, int *value)
 
SDL_GLContext SDL_GL_CreateContext (SDL_Window *window)
 
int SDL_GL_MakeCurrent (SDL_Window *window, SDL_GLContext context)
 
SDL_WindowSDL_GL_GetCurrentWindow (void)
 
SDL_GLContext SDL_GL_GetCurrentContext (void)
 
void SDL_GL_GetDrawableSize (SDL_Window *window, int *w, int *h)
 
int SDL_GL_SetSwapInterval (int interval)
 
int SDL_GL_GetSwapInterval (void)
 
void SDL_GL_SwapWindow (SDL_Window *window)
 
void SDL_GL_DeleteContext (SDL_GLContext context)
 

Detailed Description

Header file for SDL video functions.

Definition in file SDL_video.h.

Macro Definition Documentation

◆ SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 147 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

#define SDL_WINDOWPOS_CENTERED_DISPLAY (   X)    (SDL_WINDOWPOS_CENTERED_MASK|(X))

Definition at line 146 of file SDL_video.h.

◆ SDL_WINDOWPOS_CENTERED_MASK

#define SDL_WINDOWPOS_CENTERED_MASK   0x2FFF0000u

Used to indicate that the window position should be centered.

Definition at line 145 of file SDL_video.h.

◆ SDL_WINDOWPOS_ISCENTERED

#define SDL_WINDOWPOS_ISCENTERED (   X)     (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)

Definition at line 148 of file SDL_video.h.

154{
155 SDL_WINDOWEVENT_NONE, /**< Never used */
156 SDL_WINDOWEVENT_SHOWN, /**< Window has been shown */
157 SDL_WINDOWEVENT_HIDDEN, /**< Window has been hidden */
158 SDL_WINDOWEVENT_EXPOSED, /**< Window has been exposed and should be
159 redrawn */
160 SDL_WINDOWEVENT_MOVED, /**< Window has been moved to data1, data2
161 */
162 SDL_WINDOWEVENT_RESIZED, /**< Window has been resized to data1xdata2 */
163 SDL_WINDOWEVENT_SIZE_CHANGED, /**< The window size has changed, either as
164 a result of an API call or through the
165 system or user changing the window size. */
166 SDL_WINDOWEVENT_MINIMIZED, /**< Window has been minimized */
167 SDL_WINDOWEVENT_MAXIMIZED, /**< Window has been maximized */
168 SDL_WINDOWEVENT_RESTORED, /**< Window has been restored to normal size
169 and position */
170 SDL_WINDOWEVENT_ENTER, /**< Window has gained mouse focus */
171 SDL_WINDOWEVENT_LEAVE, /**< Window has lost mouse focus */
172 SDL_WINDOWEVENT_FOCUS_GAINED, /**< Window has gained keyboard focus */
173 SDL_WINDOWEVENT_FOCUS_LOST, /**< Window has lost keyboard focus */
174 SDL_WINDOWEVENT_CLOSE, /**< The window manager requests that the window be closed */
175 SDL_WINDOWEVENT_TAKE_FOCUS, /**< Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore) */
176 SDL_WINDOWEVENT_HIT_TEST, /**< Window had a hit test that wasn't SDL_HITTEST_NORMAL. */
177 SDL_WINDOWEVENT_ICCPROF_CHANGED,/**< The ICC profile of the window's display has changed. */
178 SDL_WINDOWEVENT_DISPLAY_CHANGED /**< Window has been moved to display data1. */
180
181/**
182 * \brief Event subtype for display events
183 */
184typedef enum
185{
186 SDL_DISPLAYEVENT_NONE, /**< Never used */
187 SDL_DISPLAYEVENT_ORIENTATION, /**< Display orientation has changed to data1 */
188 SDL_DISPLAYEVENT_CONNECTED, /**< Display has been added to the system */
189 SDL_DISPLAYEVENT_DISCONNECTED, /**< Display has been removed from the system */
190 SDL_DISPLAYEVENT_MOVED /**< Display has changed position */
192
193/**
194 * \brief Display orientation
195 */
196typedef enum
197{
198 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
199 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
200 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
201 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
202 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
204
205/**
206 * \brief Window flash operation
207 */
208typedef enum
209{
210 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
211 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
212 SDL_FLASH_UNTIL_FOCUSED /**< Flash the window until it gets focus */
214
215/**
216 * \brief An opaque handle to an OpenGL context.
217 */
218typedef void *SDL_GLContext;
219
220/**
221 * \brief OpenGL configuration attributes
222 */
223typedef enum
224{
253} SDL_GLattr;
254
255typedef enum
256{
259 SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
261
262typedef enum
263{
269
270typedef enum
271{
275
276typedef enum
277{
281
282/* Function prototypes */
283
284/**
285 * Get the number of video drivers compiled into SDL.
286 *
287 * \returns a number >= 1 on success or a negative error code on failure; call
288 * SDL_GetError() for more information.
289 *
290 * \since This function is available since SDL 2.0.0.
291 *
292 * \sa SDL_GetVideoDriver
293 */
294extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
295
296/**
297 * Get the name of a built in video driver.
298 *
299 * The video drivers are presented in the order in which they are normally
300 * checked during initialization.
301 *
302 * \param index the index of a video driver
303 * \returns the name of the video driver with the given **index**.
304 *
305 * \since This function is available since SDL 2.0.0.
306 *
307 * \sa SDL_GetNumVideoDrivers
308 */
309extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
310
311/**
312 * Initialize the video subsystem, optionally specifying a video driver.
313 *
314 * This function initializes the video subsystem, setting up a connection to
315 * the window manager, etc, and determines the available display modes and
316 * pixel formats, but does not initialize a window or graphics mode.
317 *
318 * If you use this function and you haven't used the SDL_INIT_VIDEO flag with
319 * either SDL_Init() or SDL_InitSubSystem(), you should call SDL_VideoQuit()
320 * before calling SDL_Quit().
321 *
322 * It is safe to call this function multiple times. SDL_VideoInit() will call
323 * SDL_VideoQuit() itself if the video subsystem has already been initialized.
324 *
325 * You can use SDL_GetNumVideoDrivers() and SDL_GetVideoDriver() to find a
326 * specific `driver_name`.
327 *
328 * \param driver_name the name of a video driver to initialize, or NULL for
329 * the default driver
330 * \returns 0 on success or a negative error code on failure; call
331 * SDL_GetError() for more information.
332 *
333 * \since This function is available since SDL 2.0.0.
334 *
335 * \sa SDL_GetNumVideoDrivers
336 * \sa SDL_GetVideoDriver
337 * \sa SDL_InitSubSystem
338 * \sa SDL_VideoQuit
339 */
340extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
341
342/**
343 * Shut down the video subsystem, if initialized with SDL_VideoInit().
344 *
345 * This function closes all windows, and restores the original video mode.
346 *
347 * \since This function is available since SDL 2.0.0.
348 *
349 * \sa SDL_VideoInit
350 */
351extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
352
353/**
354 * Get the name of the currently initialized video driver.
355 *
356 * \returns the name of the current video driver or NULL if no driver has been
357 * initialized.
358 *
359 * \since This function is available since SDL 2.0.0.
360 *
361 * \sa SDL_GetNumVideoDrivers
362 * \sa SDL_GetVideoDriver
363 */
364extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
365
366/**
367 * Get the number of available video displays.
368 *
369 * \returns a number >= 1 or a negative error code on failure; call
370 * SDL_GetError() for more information.
371 *
372 * \since This function is available since SDL 2.0.0.
373 *
374 * \sa SDL_GetDisplayBounds
375 */
376extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
377
378/**
379 * Get the name of a display in UTF-8 encoding.
380 *
381 * \param displayIndex the index of display from which the name should be
382 * queried
383 * \returns the name of a display or NULL for an invalid display index or
384 * failure; call SDL_GetError() for more information.
385 *
386 * \since This function is available since SDL 2.0.0.
387 *
388 * \sa SDL_GetNumVideoDisplays
389 */
390extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
391
392/**
393 * Get the desktop area represented by a display.
394 *
395 * The primary display (`displayIndex` zero) is always located at 0,0.
396 *
397 * \param displayIndex the index of the display to query
398 * \param rect the SDL_Rect structure filled in with the display bounds
399 * \returns 0 on success or a negative error code on failure; call
400 * SDL_GetError() for more information.
401 *
402 * \since This function is available since SDL 2.0.0.
403 *
404 * \sa SDL_GetNumVideoDisplays
405 */
406extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
407
408/**
409 * Get the usable desktop area represented by a display.
410 *
411 * The primary display (`displayIndex` zero) is always located at 0,0.
412 *
413 * This is the same area as SDL_GetDisplayBounds() reports, but with portions
414 * reserved by the system removed. For example, on Apple's macOS, this
415 * subtracts the area occupied by the menu bar and dock.
416 *
417 * Setting a window to be fullscreen generally bypasses these unusable areas,
418 * so these are good guidelines for the maximum space available to a
419 * non-fullscreen window.
420 *
421 * The parameter `rect` is ignored if it is NULL.
422 *
423 * This function also returns -1 if the parameter `displayIndex` is out of
424 * range.
425 *
426 * \param displayIndex the index of the display to query the usable bounds
427 * from
428 * \param rect the SDL_Rect structure filled in with the display bounds
429 * \returns 0 on success or a negative error code on failure; call
430 * SDL_GetError() for more information.
431 *
432 * \since This function is available since SDL 2.0.5.
433 *
434 * \sa SDL_GetDisplayBounds
435 * \sa SDL_GetNumVideoDisplays
436 */
437extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect * rect);
438
439/**
440 * Get the dots/pixels-per-inch for a display.
441 *
442 * Diagonal, horizontal and vertical DPI can all be optionally returned if the
443 * appropriate parameter is non-NULL.
444 *
445 * A failure of this function usually means that either no DPI information is
446 * available or the `displayIndex` is out of range.
447 *
448 * **WARNING**: This reports the DPI that the hardware reports, and it is not
449 * always reliable! It is almost always better to use SDL_GetWindowSize() to
450 * find the window size, which might be in logical points instead of pixels,
451 * and then SDL_GL_GetDrawableSize(), SDL_Vulkan_GetDrawableSize(),
452 * SDL_Metal_GetDrawableSize(), or SDL_GetRendererOutputSize(), and compare
453 * the two values to get an actual scaling value between the two. We will be
454 * rethinking how high-dpi details should be managed in SDL3 to make things
455 * more consistent, reliable, and clear.
456 *
457 * \param displayIndex the index of the display from which DPI information
458 * should be queried
459 * \param ddpi a pointer filled in with the diagonal DPI of the display; may
460 * be NULL
461 * \param hdpi a pointer filled in with the horizontal DPI of the display; may
462 * be NULL
463 * \param vdpi a pointer filled in with the vertical DPI of the display; may
464 * be NULL
465 * \returns 0 on success or a negative error code on failure; call
466 * SDL_GetError() for more information.
467 *
468 * \since This function is available since SDL 2.0.4.
469 *
470 * \sa SDL_GetNumVideoDisplays
471 */
472extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, float * hdpi, float * vdpi);
473
474/**
475 * Get the orientation of a display.
476 *
477 * \param displayIndex the index of the display to query
478 * \returns The SDL_DisplayOrientation enum value of the display, or
479 * `SDL_ORIENTATION_UNKNOWN` if it isn't available.
480 *
481 * \since This function is available since SDL 2.0.9.
482 *
483 * \sa SDL_GetNumVideoDisplays
484 */
485extern DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetDisplayOrientation(int displayIndex);
486
487/**
488 * Get the number of available display modes.
489 *
490 * The `displayIndex` needs to be in the range from 0 to
491 * SDL_GetNumVideoDisplays() - 1.
492 *
493 * \param displayIndex the index of the display to query
494 * \returns a number >= 1 on success or a negative error code on failure; call
495 * SDL_GetError() for more information.
496 *
497 * \since This function is available since SDL 2.0.0.
498 *
499 * \sa SDL_GetDisplayMode
500 * \sa SDL_GetNumVideoDisplays
501 */
502extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
503
504/**
505 * Get information about a specific display mode.
506 *
507 * The display modes are sorted in this priority:
508 *
509 * - width -> largest to smallest
510 * - height -> largest to smallest
511 * - bits per pixel -> more colors to fewer colors
512 * - packed pixel layout -> largest to smallest
513 * - refresh rate -> highest to lowest
514 *
515 * \param displayIndex the index of the display to query
516 * \param modeIndex the index of the display mode to query
517 * \param mode an SDL_DisplayMode structure filled in with the mode at
518 * `modeIndex`
519 * \returns 0 on success or a negative error code on failure; call
520 * SDL_GetError() for more information.
521 *
522 * \since This function is available since SDL 2.0.0.
523 *
524 * \sa SDL_GetNumDisplayModes
525 */
526extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
527 SDL_DisplayMode * mode);
528
529/**
530 * Get information about the desktop's display mode.
531 *
532 * There's a difference between this function and SDL_GetCurrentDisplayMode()
533 * when SDL runs fullscreen and has changed the resolution. In that case this
534 * function will return the previous native display mode, and not the current
535 * display mode.
536 *
537 * \param displayIndex the index of the display to query
538 * \param mode an SDL_DisplayMode structure filled in with the current display
539 * mode
540 * \returns 0 on success or a negative error code on failure; call
541 * SDL_GetError() for more information.
542 *
543 * \since This function is available since SDL 2.0.0.
544 *
545 * \sa SDL_GetCurrentDisplayMode
546 * \sa SDL_GetDisplayMode
547 * \sa SDL_SetWindowDisplayMode
548 */
549extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
550
551/**
552 * Get information about the current display mode.
553 *
554 * There's a difference between this function and SDL_GetDesktopDisplayMode()
555 * when SDL runs fullscreen and has changed the resolution. In that case this
556 * function will return the current display mode, and not the previous native
557 * display mode.
558 *
559 * \param displayIndex the index of the display to query
560 * \param mode an SDL_DisplayMode structure filled in with the current display
561 * mode
562 * \returns 0 on success or a negative error code on failure; call
563 * SDL_GetError() for more information.
564 *
565 * \since This function is available since SDL 2.0.0.
566 *
567 * \sa SDL_GetDesktopDisplayMode
568 * \sa SDL_GetDisplayMode
569 * \sa SDL_GetNumVideoDisplays
570 * \sa SDL_SetWindowDisplayMode
571 */
572extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
573
574
575/**
576 * Get the closest match to the requested display mode.
577 *
578 * The available display modes are scanned and `closest` is filled in with the
579 * closest mode matching the requested mode and returned. The mode format and
580 * refresh rate default to the desktop mode if they are set to 0. The modes
581 * are scanned with size being first priority, format being second priority,
582 * and finally checking the refresh rate. If all the available modes are too
583 * small, then NULL is returned.
584 *
585 * \param displayIndex the index of the display to query
586 * \param mode an SDL_DisplayMode structure containing the desired display
587 * mode
588 * \param closest an SDL_DisplayMode structure filled in with the closest
589 * match of the available display modes
590 * \returns the passed in value `closest` or NULL if no matching video mode
591 * was available; call SDL_GetError() for more information.
592 *
593 * \since This function is available since SDL 2.0.0.
594 *
595 * \sa SDL_GetDisplayMode
596 * \sa SDL_GetNumDisplayModes
597 */
598extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
599
600/**
601 * Get the index of the display containing a point
602 *
603 * \param point the point to query
604 * \returns the index of the display containing the point or a negative error
605 * code on failure; call SDL_GetError() for more information.
606 *
607 * \since This function is available since SDL 2.24.0.
608 *
609 * \sa SDL_GetDisplayBounds
610 * \sa SDL_GetNumVideoDisplays
611 */
612extern DECLSPEC int SDLCALL SDL_GetPointDisplayIndex(const SDL_Point * point);
613
614/**
615 * Get the index of the display primarily containing a rect
616 *
617 * \param rect the rect to query
618 * \returns the index of the display entirely containing the rect or closest
619 * to the center of the rect on success or a negative error code on
620 * failure; call SDL_GetError() for more information.
621 *
622 * \since This function is available since SDL 2.24.0.
623 *
624 * \sa SDL_GetDisplayBounds
625 * \sa SDL_GetNumVideoDisplays
626 */
627extern DECLSPEC int SDLCALL SDL_GetRectDisplayIndex(const SDL_Rect * rect);
628
629/**
630 * Get the index of the display associated with a window.
631 *
632 * \param window the window to query
633 * \returns the index of the display containing the center of the window on
634 * success or a negative error code on failure; call SDL_GetError()
635 * for more information.
636 *
637 * \since This function is available since SDL 2.0.0.
638 *
639 * \sa SDL_GetDisplayBounds
640 * \sa SDL_GetNumVideoDisplays
641 */
642extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window);
643
644/**
645 * Set the display mode to use when a window is visible at fullscreen.
646 *
647 * This only affects the display mode used when the window is fullscreen. To
648 * change the window size when the window is not fullscreen, use
649 * SDL_SetWindowSize().
650 *
651 * \param window the window to affect
652 * \param mode the SDL_DisplayMode structure representing the mode to use, or
653 * NULL to use the window's dimensions and the desktop's format
654 * and refresh rate
655 * \returns 0 on success or a negative error code on failure; call
656 * SDL_GetError() for more information.
657 *
658 * \since This function is available since SDL 2.0.0.
659 *
660 * \sa SDL_GetWindowDisplayMode
661 * \sa SDL_SetWindowFullscreen
662 */
663extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
664 const SDL_DisplayMode * mode);
665
666/**
667 * Query the display mode to use when a window is visible at fullscreen.
668 *
669 * \param window the window to query
670 * \param mode an SDL_DisplayMode structure filled in with the fullscreen
671 * display mode
672 * \returns 0 on success or a negative error code on failure; call
673 * SDL_GetError() for more information.
674 *
675 * \since This function is available since SDL 2.0.0.
676 *
677 * \sa SDL_SetWindowDisplayMode
678 * \sa SDL_SetWindowFullscreen
679 */
680extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
681 SDL_DisplayMode * mode);
682
683/**
684 * Get the raw ICC profile data for the screen the window is currently on.
685 *
686 * Data returned should be freed with SDL_free.
687 *
688 * \param window the window to query
689 * \param size the size of the ICC profile
690 * \returns the raw ICC profile data on success or NULL on failure; call
691 * SDL_GetError() for more information.
692 *
693 * \since This function is available since SDL 2.0.18.
694 */
695extern DECLSPEC void* SDLCALL SDL_GetWindowICCProfile(SDL_Window * window, size_t* size);
696
697/**
698 * Get the pixel format associated with the window.
699 *
700 * \param window the window to query
701 * \returns the pixel format of the window on success or
702 * SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more
703 * information.
704 *
705 * \since This function is available since SDL 2.0.0.
706 */
707extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
708
709/**
710 * Create a window with the specified position, dimensions, and flags.
711 *
712 * `flags` may be any of the following OR'd together:
713 *
714 * - `SDL_WINDOW_FULLSCREEN`: fullscreen window
715 * - `SDL_WINDOW_FULLSCREEN_DESKTOP`: fullscreen window at desktop resolution
716 * - `SDL_WINDOW_OPENGL`: window usable with an OpenGL context
717 * - `SDL_WINDOW_VULKAN`: window usable with a Vulkan instance
718 * - `SDL_WINDOW_METAL`: window usable with a Metal instance
719 * - `SDL_WINDOW_HIDDEN`: window is not visible
720 * - `SDL_WINDOW_BORDERLESS`: no window decoration
721 * - `SDL_WINDOW_RESIZABLE`: window can be resized
722 * - `SDL_WINDOW_MINIMIZED`: window is minimized
723 * - `SDL_WINDOW_MAXIMIZED`: window is maximized
724 * - `SDL_WINDOW_INPUT_GRABBED`: window has grabbed input focus
725 * - `SDL_WINDOW_ALLOW_HIGHDPI`: window should be created in high-DPI mode if
726 * supported (>= SDL 2.0.1)
727 *
728 * `SDL_WINDOW_SHOWN` is ignored by SDL_CreateWindow(). The SDL_Window is
729 * implicitly shown if SDL_WINDOW_HIDDEN is not set. `SDL_WINDOW_SHOWN` may be
730 * queried later using SDL_GetWindowFlags().
731 *
732 * On Apple's macOS, you **must** set the NSHighResolutionCapable Info.plist
733 * property to YES, otherwise you will not receive a High-DPI OpenGL canvas.
734 *
735 * If the window is created with the `SDL_WINDOW_ALLOW_HIGHDPI` flag, its size
736 * in pixels may differ from its size in screen coordinates on platforms with
737 * high-DPI support (e.g. iOS and macOS). Use SDL_GetWindowSize() to query the
738 * client area's size in screen coordinates, and SDL_GL_GetDrawableSize() or
739 * SDL_GetRendererOutputSize() to query the drawable size in pixels. Note that
740 * when this flag is set, the drawable size can vary after the window is
741 * created and should be queried after major window events such as when the
742 * window is resized or moved between displays.
743 *
744 * If the window is set fullscreen, the width and height parameters `w` and
745 * `h` will not be used. However, invalid size parameters (e.g. too large) may
746 * still fail. Window size is actually limited to 16384 x 16384 for all
747 * platforms at window creation.
748 *
749 * If the window is created with any of the SDL_WINDOW_OPENGL or
750 * SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function
751 * (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the
752 * corresponding UnloadLibrary function is called by SDL_DestroyWindow().
753 *
754 * If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver,
755 * SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail.
756 *
757 * If SDL_WINDOW_METAL is specified on an OS that does not support Metal,
758 * SDL_CreateWindow() will fail.
759 *
760 * On non-Apple devices, SDL requires you to either not link to the Vulkan
761 * loader or link to a dynamic library version. This limitation may be removed
762 * in a future version of SDL.
763 *
764 * \param title the title of the window, in UTF-8 encoding
765 * \param x the x position of the window, `SDL_WINDOWPOS_CENTERED`, or
766 * `SDL_WINDOWPOS_UNDEFINED`
767 * \param y the y position of the window, `SDL_WINDOWPOS_CENTERED`, or
768 * `SDL_WINDOWPOS_UNDEFINED`
769 * \param w the width of the window, in screen coordinates
770 * \param h the height of the window, in screen coordinates
771 * \param flags 0, or one or more SDL_WindowFlags OR'd together
772 * \returns the window that was created or NULL on failure; call
773 * SDL_GetError() for more information.
774 *
775 * \since This function is available since SDL 2.0.0.
776 *
777 * \sa SDL_CreateWindowFrom
778 * \sa SDL_DestroyWindow
779 */
780extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
781 int x, int y, int w,
782 int h, Uint32 flags);
783
784/**
785 * Create an SDL window from an existing native window.
786 *
787 * In some cases (e.g. OpenGL) and on some platforms (e.g. Microsoft Windows)
788 * the hint `SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT` needs to be configured
789 * before using SDL_CreateWindowFrom().
790 *
791 * \param data a pointer to driver-dependent window creation data, typically
792 * your native window cast to a void*
793 * \returns the window that was created or NULL on failure; call
794 * SDL_GetError() for more information.
795 *
796 * \since This function is available since SDL 2.0.0.
797 *
798 * \sa SDL_CreateWindow
799 * \sa SDL_DestroyWindow
800 */
801extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
802
803/**
804 * Get the numeric ID of a window.
805 *
806 * The numeric ID is what SDL_WindowEvent references, and is necessary to map
807 * these events to specific SDL_Window objects.
808 *
809 * \param window the window to query
810 * \returns the ID of the window on success or 0 on failure; call
811 * SDL_GetError() for more information.
812 *
813 * \since This function is available since SDL 2.0.0.
814 *
815 * \sa SDL_GetWindowFromID
816 */
817extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
818
819/**
820 * Get a window from a stored ID.
821 *
822 * The numeric ID is what SDL_WindowEvent references, and is necessary to map
823 * these events to specific SDL_Window objects.
824 *
825 * \param id the ID of the window
826 * \returns the window associated with `id` or NULL if it doesn't exist; call
827 * SDL_GetError() for more information.
828 *
829 * \since This function is available since SDL 2.0.0.
830 *
831 * \sa SDL_GetWindowID
832 */
833extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
834
835/**
836 * Get the window flags.
837 *
838 * \param window the window to query
839 * \returns a mask of the SDL_WindowFlags associated with `window`
840 *
841 * \since This function is available since SDL 2.0.0.
842 *
843 * \sa SDL_CreateWindow
844 * \sa SDL_HideWindow
845 * \sa SDL_MaximizeWindow
846 * \sa SDL_MinimizeWindow
847 * \sa SDL_SetWindowFullscreen
848 * \sa SDL_SetWindowGrab
849 * \sa SDL_ShowWindow
850 */
851extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
852
853/**
854 * Set the title of a window.
855 *
856 * This string is expected to be in UTF-8 encoding.
857 *
858 * \param window the window to change
859 * \param title the desired window title in UTF-8 format
860 *
861 * \since This function is available since SDL 2.0.0.
862 *
863 * \sa SDL_GetWindowTitle
864 */
865extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
866 const char *title);
867
868/**
869 * Get the title of a window.
870 *
871 * \param window the window to query
872 * \returns the title of the window in UTF-8 format or "" if there is no
873 * title.
874 *
875 * \since This function is available since SDL 2.0.0.
876 *
877 * \sa SDL_SetWindowTitle
878 */
879extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
880
881/**
882 * Set the icon for a window.
883 *
884 * \param window the window to change
885 * \param icon an SDL_Surface structure containing the icon for the window
886 *
887 * \since This function is available since SDL 2.0.0.
888 */
889extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
890 SDL_Surface * icon);
891
892/**
893 * Associate an arbitrary named pointer with a window.
894 *
895 * `name` is case-sensitive.
896 *
897 * \param window the window to associate with the pointer
898 * \param name the name of the pointer
899 * \param userdata the associated pointer
900 * \returns the previous value associated with `name`.
901 *
902 * \since This function is available since SDL 2.0.0.
903 *
904 * \sa SDL_GetWindowData
905 */
906extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
907 const char *name,
908 void *userdata);
909
910/**
911 * Retrieve the data pointer associated with a window.
912 *
913 * \param window the window to query
914 * \param name the name of the pointer
915 * \returns the value associated with `name`.
916 *
917 * \since This function is available since SDL 2.0.0.
918 *
919 * \sa SDL_SetWindowData
920 */
921extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
922 const char *name);
923
924/**
925 * Set the position of a window.
926 *
927 * The window coordinate origin is the upper left of the display.
928 *
929 * \param window the window to reposition
930 * \param x the x coordinate of the window in screen coordinates, or
931 * `SDL_WINDOWPOS_CENTERED` or `SDL_WINDOWPOS_UNDEFINED`
932 * \param y the y coordinate of the window in screen coordinates, or
933 * `SDL_WINDOWPOS_CENTERED` or `SDL_WINDOWPOS_UNDEFINED`
934 *
935 * \since This function is available since SDL 2.0.0.
936 *
937 * \sa SDL_GetWindowPosition
938 */
939extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
940 int x, int y);
941
942/**
943 * Get the position of a window.
944 *
945 * If you do not need the value for one of the positions a NULL may be passed
946 * in the `x` or `y` parameter.
947 *
948 * \param window the window to query
949 * \param x a pointer filled in with the x position of the window, in screen
950 * coordinates, may be NULL
951 * \param y a pointer filled in with the y position of the window, in screen
952 * coordinates, may be NULL
953 *
954 * \since This function is available since SDL 2.0.0.
955 *
956 * \sa SDL_SetWindowPosition
957 */
958extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
959 int *x, int *y);
960
961/**
962 * Set the size of a window's client area.
963 *
964 * The window size in screen coordinates may differ from the size in pixels,
965 * if the window was created with `SDL_WINDOW_ALLOW_HIGHDPI` on a platform
966 * with high-dpi support (e.g. iOS or macOS). Use SDL_GL_GetDrawableSize() or
967 * SDL_GetRendererOutputSize() to get the real client area size in pixels.
968 *
969 * Fullscreen windows automatically match the size of the display mode, and
970 * you should use SDL_SetWindowDisplayMode() to change their size.
971 *
972 * \param window the window to change
973 * \param w the width of the window in pixels, in screen coordinates, must be
974 * > 0
975 * \param h the height of the window in pixels, in screen coordinates, must be
976 * > 0
977 *
978 * \since This function is available since SDL 2.0.0.
979 *
980 * \sa SDL_GetWindowSize
981 * \sa SDL_SetWindowDisplayMode
982 */
983extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
984 int h);
985
986/**
987 * Get the size of a window's client area.
988 *
989 * NULL can safely be passed as the `w` or `h` parameter if the width or
990 * height value is not desired.
991 *
992 * The window size in screen coordinates may differ from the size in pixels,
993 * if the window was created with `SDL_WINDOW_ALLOW_HIGHDPI` on a platform
994 * with high-dpi support (e.g. iOS or macOS). Use SDL_GL_GetDrawableSize(),
995 * SDL_Vulkan_GetDrawableSize(), or SDL_GetRendererOutputSize() to get the
996 * real client area size in pixels.
997 *
998 * \param window the window to query the width and height from
999 * \param w a pointer filled in with the width of the window, in screen
1000 * coordinates, may be NULL
1001 * \param h a pointer filled in with the height of the window, in screen
1002 * coordinates, may be NULL
1003 *
1004 * \since This function is available since SDL 2.0.0.
1005 *
1006 * \sa SDL_GL_GetDrawableSize
1007 * \sa SDL_Vulkan_GetDrawableSize
1008 * \sa SDL_SetWindowSize
1009 */
1010extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
1011 int *h);
1012
1013/**
1014 * Get the size of a window's borders (decorations) around the client area.
1015 *
1016 * Note: If this function fails (returns -1), the size values will be
1017 * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the
1018 * window in question was borderless.
1019 *
1020 * Note: This function may fail on systems where the window has not yet been
1021 * decorated by the display server (for example, immediately after calling
1022 * SDL_CreateWindow). It is recommended that you wait at least until the
1023 * window has been presented and composited, so that the window system has a
1024 * chance to decorate the window and provide the border dimensions to SDL.
1025 *
1026 * This function also returns -1 if getting the information is not supported.
1027 *
1028 * \param window the window to query the size values of the border
1029 * (decorations) from
1030 * \param top pointer to variable for storing the size of the top border; NULL
1031 * is permitted
1032 * \param left pointer to variable for storing the size of the left border;
1033 * NULL is permitted
1034 * \param bottom pointer to variable for storing the size of the bottom
1035 * border; NULL is permitted
1036 * \param right pointer to variable for storing the size of the right border;
1037 * NULL is permitted
1038 * \returns 0 on success or a negative error code on failure; call
1039 * SDL_GetError() for more information.
1040 *
1041 * \since This function is available since SDL 2.0.5.
1042 *
1043 * \sa SDL_GetWindowSize
1044 */
1045extern DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window * window,
1046 int *top, int *left,
1047 int *bottom, int *right);
1048
1049/**
1050 * Get the size of a window in pixels.
1051 *
1052 * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI
1053 * drawable, i.e. the window was created with `SDL_WINDOW_ALLOW_HIGHDPI` on a
1054 * platform with high-DPI support (Apple calls this "Retina"), and not
1055 * disabled by the `SDL_HINT_VIDEO_HIGHDPI_DISABLED` hint.
1056 *
1057 * \param window the window from which the drawable size should be queried
1058 * \param w a pointer to variable for storing the width in pixels, may be NULL
1059 * \param h a pointer to variable for storing the height in pixels, may be
1060 * NULL
1061 *
1062 * \since This function is available since SDL 2.26.0.
1063 *
1064 * \sa SDL_CreateWindow
1065 * \sa SDL_GetWindowSize
1066 */
1067extern DECLSPEC void SDLCALL SDL_GetWindowSizeInPixels(SDL_Window * window,
1068 int *w, int *h);
1069
1070/**
1071 * Set the minimum size of a window's client area.
1072 *
1073 * \param window the window to change
1074 * \param min_w the minimum width of the window in pixels
1075 * \param min_h the minimum height of the window in pixels
1076 *
1077 * \since This function is available since SDL 2.0.0.
1078 *
1079 * \sa SDL_GetWindowMinimumSize
1080 * \sa SDL_SetWindowMaximumSize
1081 */
1082extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window,
1083 int min_w, int min_h);
1084
1085/**
1086 * Get the minimum size of a window's client area.
1087 *
1088 * \param window the window to query
1089 * \param w a pointer filled in with the minimum width of the window, may be
1090 * NULL
1091 * \param h a pointer filled in with the minimum height of the window, may be
1092 * NULL
1093 *
1094 * \since This function is available since SDL 2.0.0.
1095 *
1096 * \sa SDL_GetWindowMaximumSize
1097 * \sa SDL_SetWindowMinimumSize
1098 */
1099extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window,
1100 int *w, int *h);
1101
1102/**
1103 * Set the maximum size of a window's client area.
1104 *
1105 * \param window the window to change
1106 * \param max_w the maximum width of the window in pixels
1107 * \param max_h the maximum height of the window in pixels
1108 *
1109 * \since This function is available since SDL 2.0.0.
1110 *
1111 * \sa SDL_GetWindowMaximumSize
1112 * \sa SDL_SetWindowMinimumSize
1113 */
1114extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window,
1115 int max_w, int max_h);
1116
1117/**
1118 * Get the maximum size of a window's client area.
1119 *
1120 * \param window the window to query
1121 * \param w a pointer filled in with the maximum width of the window, may be
1122 * NULL
1123 * \param h a pointer filled in with the maximum height of the window, may be
1124 * NULL
1125 *
1126 * \since This function is available since SDL 2.0.0.
1127 *
1128 * \sa SDL_GetWindowMinimumSize
1129 * \sa SDL_SetWindowMaximumSize
1130 */
1131extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window,
1132 int *w, int *h);
1133
1134/**
1135 * Set the border state of a window.
1136 *
1137 * This will add or remove the window's `SDL_WINDOW_BORDERLESS` flag and add
1138 * or remove the border from the actual window. This is a no-op if the
1139 * window's border already matches the requested state.
1140 *
1141 * You can't change the border state of a fullscreen window.
1142 *
1143 * \param window the window of which to change the border state
1144 * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border
1145 *
1146 * \since This function is available since SDL 2.0.0.
1147 *
1148 * \sa SDL_GetWindowFlags
1149 */
1150extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window,
1151 SDL_bool bordered);
1152
1153/**
1154 * Set the user-resizable state of a window.
1155 *
1156 * This will add or remove the window's `SDL_WINDOW_RESIZABLE` flag and
1157 * allow/disallow user resizing of the window. This is a no-op if the window's
1158 * resizable state already matches the requested state.
1159 *
1160 * You can't change the resizable state of a fullscreen window.
1161 *
1162 * \param window the window of which to change the resizable state
1163 * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow
1164 *
1165 * \since This function is available since SDL 2.0.5.
1166 *
1167 * \sa SDL_GetWindowFlags
1168 */
1169extern DECLSPEC void SDLCALL SDL_SetWindowResizable(SDL_Window * window,
1170 SDL_bool resizable);
1171
1172/**
1173 * Set the window to always be above the others.
1174 *
1175 * This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP` flag. This
1176 * will bring the window to the front and keep the window above the rest.
1177 *
1178 * \param window The window of which to change the always on top state
1179 * \param on_top SDL_TRUE to set the window always on top, SDL_FALSE to
1180 * disable
1181 *
1182 * \since This function is available since SDL 2.0.16.
1183 *
1184 * \sa SDL_GetWindowFlags
1185 */
1186extern DECLSPEC void SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window * window,
1187 SDL_bool on_top);
1188
1189/**
1190 * Show a window.
1191 *
1192 * \param window the window to show
1193 *
1194 * \since This function is available since SDL 2.0.0.
1195 *
1196 * \sa SDL_HideWindow
1197 * \sa SDL_RaiseWindow
1198 */
1199extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
1200
1201/**
1202 * Hide a window.
1203 *
1204 * \param window the window to hide
1205 *
1206 * \since This function is available since SDL 2.0.0.
1207 *
1208 * \sa SDL_ShowWindow
1209 */
1210extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
1211
1212/**
1213 * Raise a window above other windows and set the input focus.
1214 *
1215 * \param window the window to raise
1216 *
1217 * \since This function is available since SDL 2.0.0.
1218 */
1219extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
1220
1221/**
1222 * Make a window as large as possible.
1223 *
1224 * \param window the window to maximize
1225 *
1226 * \since This function is available since SDL 2.0.0.
1227 *
1228 * \sa SDL_MinimizeWindow
1229 * \sa SDL_RestoreWindow
1230 */
1231extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
1232
1233/**
1234 * Minimize a window to an iconic representation.
1235 *
1236 * \param window the window to minimize
1237 *
1238 * \since This function is available since SDL 2.0.0.
1239 *
1240 * \sa SDL_MaximizeWindow
1241 * \sa SDL_RestoreWindow
1242 */
1243extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
1244
1245/**
1246 * Restore the size and position of a minimized or maximized window.
1247 *
1248 * \param window the window to restore
1249 *
1250 * \since This function is available since SDL 2.0.0.
1251 *
1252 * \sa SDL_MaximizeWindow
1253 * \sa SDL_MinimizeWindow
1254 */
1255extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
1256
1257/**
1258 * Set a window's fullscreen state.
1259 *
1260 * `flags` may be `SDL_WINDOW_FULLSCREEN`, for "real" fullscreen with a
1261 * videomode change; `SDL_WINDOW_FULLSCREEN_DESKTOP` for "fake" fullscreen
1262 * that takes the size of the desktop; and 0 for windowed mode.
1263 *
1264 * \param window the window to change
1265 * \param flags `SDL_WINDOW_FULLSCREEN`, `SDL_WINDOW_FULLSCREEN_DESKTOP` or 0
1266 * \returns 0 on success or a negative error code on failure; call
1267 * SDL_GetError() for more information.
1268 *
1269 * \since This function is available since SDL 2.0.0.
1270 *
1271 * \sa SDL_GetWindowDisplayMode
1272 * \sa SDL_SetWindowDisplayMode
1273 */
1274extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
1275 Uint32 flags);
1276
1277/**
1278 * Return whether the window has a surface associated with it.
1279 *
1280 * \returns SDL_TRUE if there is a surface associated with the window, or
1281 * SDL_FALSE otherwise.
1282 *
1283 * \since This function is available since SDL 2.28.0.
1284 *
1285 * \sa SDL_GetWindowSurface
1286 */
1287extern DECLSPEC SDL_bool SDLCALL SDL_HasWindowSurface(SDL_Window *window);
1288
1289/**
1290 * Get the SDL surface associated with the window.
1291 *
1292 * A new surface will be created with the optimal format for the window, if
1293 * necessary. This surface will be freed when the window is destroyed. Do not
1294 * free this surface.
1295 *
1296 * This surface will be invalidated if the window is resized. After resizing a
1297 * window this function must be called again to return a valid surface.
1298 *
1299 * You may not combine this with 3D or the rendering API on this window.
1300 *
1301 * This function is affected by `SDL_HINT_FRAMEBUFFER_ACCELERATION`.
1302 *
1303 * \param window the window to query
1304 * \returns the surface associated with the window, or NULL on failure; call
1305 * SDL_GetError() for more information.
1306 *
1307 * \since This function is available since SDL 2.0.0.
1308 *
1309 * \sa SDL_DestroyWindowSurface
1310 * \sa SDL_HasWindowSurface
1311 * \sa SDL_UpdateWindowSurface
1312 * \sa SDL_UpdateWindowSurfaceRects
1313 */
1314extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
1315
1316/**
1317 * Copy the window surface to the screen.
1318 *
1319 * This is the function you use to reflect any changes to the surface on the
1320 * screen.
1321 *
1322 * This function is equivalent to the SDL 1.2 API SDL_Flip().
1323 *
1324 * \param window the window to update
1325 * \returns 0 on success or a negative error code on failure; call
1326 * SDL_GetError() for more information.
1327 *
1328 * \since This function is available since SDL 2.0.0.
1329 *
1330 * \sa SDL_GetWindowSurface
1331 * \sa SDL_UpdateWindowSurfaceRects
1332 */
1333extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
1334
1335/**
1336 * Copy areas of the window surface to the screen.
1337 *
1338 * This is the function you use to reflect changes to portions of the surface
1339 * on the screen.
1340 *
1341 * This function is equivalent to the SDL 1.2 API SDL_UpdateRects().
1342 *
1343 * Note that this function will update _at least_ the rectangles specified,
1344 * but this is only intended as an optimization; in practice, this might
1345 * update more of the screen (or all of the screen!), depending on what
1346 * method SDL uses to send pixels to the system.
1347 *
1348 * \param window the window to update
1349 * \param rects an array of SDL_Rect structures representing areas of the
1350 * surface to copy, in pixels
1351 * \param numrects the number of rectangles
1352 * \returns 0 on success or a negative error code on failure; call
1353 * SDL_GetError() for more information.
1354 *
1355 * \since This function is available since SDL 2.0.0.
1356 *
1357 * \sa SDL_GetWindowSurface
1358 * \sa SDL_UpdateWindowSurface
1359 */
1360extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
1361 const SDL_Rect * rects,
1362 int numrects);
1363
1364/**
1365 * Destroy the surface associated with the window.
1366 *
1367 * \param window the window to update
1368 * \returns 0 on success or a negative error code on failure; call
1369 * SDL_GetError() for more information.
1370 *
1371 * \since This function is available since SDL 2.28.0.
1372 *
1373 * \sa SDL_GetWindowSurface
1374 * \sa SDL_HasWindowSurface
1375 */
1376extern DECLSPEC int SDLCALL SDL_DestroyWindowSurface(SDL_Window *window);
1377
1378/**
1379 * Set a window's input grab mode.
1380 *
1381 * When input is grabbed, the mouse is confined to the window. This function
1382 * will also grab the keyboard if `SDL_HINT_GRAB_KEYBOARD` is set. To grab the
1383 * keyboard without also grabbing the mouse, use SDL_SetWindowKeyboardGrab().
1384 *
1385 * If the caller enables a grab while another window is currently grabbed, the
1386 * other window loses its grab in favor of the caller's window.
1387 *
1388 * \param window the window for which the input grab mode should be set
1389 * \param grabbed SDL_TRUE to grab input or SDL_FALSE to release input
1390 *
1391 * \since This function is available since SDL 2.0.0.
1392 *
1393 * \sa SDL_GetGrabbedWindow
1394 * \sa SDL_GetWindowGrab
1395 */
1396extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
1397 SDL_bool grabbed);
1398
1399/**
1400 * Set a window's keyboard grab mode.
1401 *
1402 * Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or
1403 * the Meta/Super key. Note that not all system keyboard shortcuts can be
1404 * captured by applications (one example is Ctrl+Alt+Del on Windows).
1405 *
1406 * This is primarily intended for specialized applications such as VNC clients
1407 * or VM frontends. Normal games should not use keyboard grab.
1408 *
1409 * When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the
1410 * window is full-screen to ensure the user is not trapped in your
1411 * application. If you have a custom keyboard shortcut to exit fullscreen
1412 * mode, you may suppress this behavior with
1413 * `SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED`.
1414 *
1415 * If the caller enables a grab while another window is currently grabbed, the
1416 * other window loses its grab in favor of the caller's window.
1417 *
1418 * \param window The window for which the keyboard grab mode should be set.
1419 * \param grabbed This is SDL_TRUE to grab keyboard, and SDL_FALSE to release.
1420 *
1421 * \since This function is available since SDL 2.0.16.
1422 *
1423 * \sa SDL_GetWindowKeyboardGrab
1424 * \sa SDL_SetWindowMouseGrab
1425 * \sa SDL_SetWindowGrab
1426 */
1427extern DECLSPEC void SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window * window,
1428 SDL_bool grabbed);
1429
1430/**
1431 * Set a window's mouse grab mode.
1432 *
1433 * Mouse grab confines the mouse cursor to the window.
1434 *
1435 * \param window The window for which the mouse grab mode should be set.
1436 * \param grabbed This is SDL_TRUE to grab mouse, and SDL_FALSE to release.
1437 *
1438 * \since This function is available since SDL 2.0.16.
1439 *
1440 * \sa SDL_GetWindowMouseGrab
1441 * \sa SDL_SetWindowKeyboardGrab
1442 * \sa SDL_SetWindowGrab
1443 */
1444extern DECLSPEC void SDLCALL SDL_SetWindowMouseGrab(SDL_Window * window,
1445 SDL_bool grabbed);
1446
1447/**
1448 * Get a window's input grab mode.
1449 *
1450 * \param window the window to query
1451 * \returns SDL_TRUE if input is grabbed, SDL_FALSE otherwise.
1452 *
1453 * \since This function is available since SDL 2.0.0.
1454 *
1455 * \sa SDL_SetWindowGrab
1456 */
1457extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
1458
1459/**
1460 * Get a window's keyboard grab mode.
1461 *
1462 * \param window the window to query
1463 * \returns SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise.
1464 *
1465 * \since This function is available since SDL 2.0.16.
1466 *
1467 * \sa SDL_SetWindowKeyboardGrab
1468 * \sa SDL_GetWindowGrab
1469 */
1470extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window * window);
1471
1472/**
1473 * Get a window's mouse grab mode.
1474 *
1475 * \param window the window to query
1476 * \returns SDL_TRUE if mouse is grabbed, and SDL_FALSE otherwise.
1477 *
1478 * \since This function is available since SDL 2.0.16.
1479 *
1480 * \sa SDL_SetWindowKeyboardGrab
1481 * \sa SDL_GetWindowGrab
1482 */
1483extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowMouseGrab(SDL_Window * window);
1484
1485/**
1486 * Get the window that currently has an input grab enabled.
1487 *
1488 * \returns the window if input is grabbed or NULL otherwise.
1489 *
1490 * \since This function is available since SDL 2.0.4.
1491 *
1492 * \sa SDL_GetWindowGrab
1493 * \sa SDL_SetWindowGrab
1494 */
1495extern DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void);
1496
1497/**
1498 * Confines the cursor to the specified area of a window.
1499 *
1500 * Note that this does NOT grab the cursor, it only defines the area a cursor
1501 * is restricted to when the window has mouse focus.
1502 *
1503 * \param window The window that will be associated with the barrier.
1504 * \param rect A rectangle area in window-relative coordinates. If NULL the
1505 * barrier for the specified window will be destroyed.
1506 * \returns 0 on success or a negative error code on failure; call
1507 * SDL_GetError() for more information.
1508 *
1509 * \since This function is available since SDL 2.0.18.
1510 *
1511 * \sa SDL_GetWindowMouseRect
1512 * \sa SDL_SetWindowMouseGrab
1513 */
1514extern DECLSPEC int SDLCALL SDL_SetWindowMouseRect(SDL_Window * window, const SDL_Rect * rect);
1515
1516/**
1517 * Get the mouse confinement rectangle of a window.
1518 *
1519 * \param window The window to query
1520 * \returns A pointer to the mouse confinement rectangle of a window, or NULL
1521 * if there isn't one.
1522 *
1523 * \since This function is available since SDL 2.0.18.
1524 *
1525 * \sa SDL_SetWindowMouseRect
1526 */
1527extern DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window * window);
1528
1529/**
1530 * Set the brightness (gamma multiplier) for a given window's display.
1531 *
1532 * Despite the name and signature, this method sets the brightness of the
1533 * entire display, not an individual window. A window is considered to be
1534 * owned by the display that contains the window's center pixel. (The index of
1535 * this display can be retrieved using SDL_GetWindowDisplayIndex().) The
1536 * brightness set will not follow the window if it is moved to another
1537 * display.
1538 *
1539 * Many platforms will refuse to set the display brightness in modern times.
1540 * You are better off using a shader to adjust gamma during rendering, or
1541 * something similar.
1542 *
1543 * \param window the window used to select the display whose brightness will
1544 * be changed
1545 * \param brightness the brightness (gamma multiplier) value to set where 0.0
1546 * is completely dark and 1.0 is normal brightness
1547 * \returns 0 on success or a negative error code on failure; call
1548 * SDL_GetError() for more information.
1549 *
1550 * \since This function is available since SDL 2.0.0.
1551 *
1552 * \sa SDL_GetWindowBrightness
1553 * \sa SDL_SetWindowGammaRamp
1554 */
1555extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
1556
1557/**
1558 * Get the brightness (gamma multiplier) for a given window's display.
1559 *
1560 * Despite the name and signature, this method retrieves the brightness of the
1561 * entire display, not an individual window. A window is considered to be
1562 * owned by the display that contains the window's center pixel. (The index of
1563 * this display can be retrieved using SDL_GetWindowDisplayIndex().)
1564 *
1565 * \param window the window used to select the display whose brightness will
1566 * be queried
1567 * \returns the brightness for the display where 0.0 is completely dark and
1568 * 1.0 is normal brightness.
1569 *
1570 * \since This function is available since SDL 2.0.0.
1571 *
1572 * \sa SDL_SetWindowBrightness
1573 */
1574extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
1575
1576/**
1577 * Set the opacity for a window.
1578 *
1579 * The parameter `opacity` will be clamped internally between 0.0f
1580 * (transparent) and 1.0f (opaque).
1581 *
1582 * This function also returns -1 if setting the opacity isn't supported.
1583 *
1584 * \param window the window which will be made transparent or opaque
1585 * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque)
1586 * \returns 0 on success or a negative error code on failure; call
1587 * SDL_GetError() for more information.
1588 *
1589 * \since This function is available since SDL 2.0.5.
1590 *
1591 * \sa SDL_GetWindowOpacity
1592 */
1593extern DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window * window, float opacity);
1594
1595/**
1596 * Get the opacity of a window.
1597 *
1598 * If transparency isn't supported on this platform, opacity will be reported
1599 * as 1.0f without error.
1600 *
1601 * The parameter `opacity` is ignored if it is NULL.
1602 *
1603 * This function also returns -1 if an invalid window was provided.
1604 *
1605 * \param window the window to get the current opacity value from
1606 * \param out_opacity the float filled in (0.0f - transparent, 1.0f - opaque)
1607 * \returns 0 on success or a negative error code on failure; call
1608 * SDL_GetError() for more information.
1609 *
1610 * \since This function is available since SDL 2.0.5.
1611 *
1612 * \sa SDL_SetWindowOpacity
1613 */
1614extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window * window, float * out_opacity);
1615
1616/**
1617 * Set the window as a modal for another window.
1618 *
1619 * \param modal_window the window that should be set modal
1620 * \param parent_window the parent window for the modal window
1621 * \returns 0 on success or a negative error code on failure; call
1622 * SDL_GetError() for more information.
1623 *
1624 * \since This function is available since SDL 2.0.5.
1625 */
1626extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window * modal_window, SDL_Window * parent_window);
1627
1628/**
1629 * Explicitly set input focus to the window.
1630 *
1631 * You almost certainly want SDL_RaiseWindow() instead of this function. Use
1632 * this with caution, as you might give focus to a window that is completely
1633 * obscured by other windows.
1634 *
1635 * \param window the window that should get the input focus
1636 * \returns 0 on success or a negative error code on failure; call
1637 * SDL_GetError() for more information.
1638 *
1639 * \since This function is available since SDL 2.0.5.
1640 *
1641 * \sa SDL_RaiseWindow
1642 */
1643extern DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window * window);
1644
1645/**
1646 * Set the gamma ramp for the display that owns a given window.
1647 *
1648 * Set the gamma translation table for the red, green, and blue channels of
1649 * the video hardware. Each table is an array of 256 16-bit quantities,
1650 * representing a mapping between the input and output for that channel. The
1651 * input is the index into the array, and the output is the 16-bit gamma value
1652 * at that index, scaled to the output color precision.
1653 *
1654 * Despite the name and signature, this method sets the gamma ramp of the
1655 * entire display, not an individual window. A window is considered to be
1656 * owned by the display that contains the window's center pixel. (The index of
1657 * this display can be retrieved using SDL_GetWindowDisplayIndex().) The gamma
1658 * ramp set will not follow the window if it is moved to another display.
1659 *
1660 * \param window the window used to select the display whose gamma ramp will
1661 * be changed
1662 * \param red a 256 element array of 16-bit quantities representing the
1663 * translation table for the red channel, or NULL
1664 * \param green a 256 element array of 16-bit quantities representing the
1665 * translation table for the green channel, or NULL
1666 * \param blue a 256 element array of 16-bit quantities representing the
1667 * translation table for the blue channel, or NULL
1668 * \returns 0 on success or a negative error code on failure; call
1669 * SDL_GetError() for more information.
1670 *
1671 * \since This function is available since SDL 2.0.0.
1672 *
1673 * \sa SDL_GetWindowGammaRamp
1674 */
1675extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
1676 const Uint16 * red,
1677 const Uint16 * green,
1678 const Uint16 * blue);
1679
1680/**
1681 * Get the gamma ramp for a given window's display.
1682 *
1683 * Despite the name and signature, this method retrieves the gamma ramp of the
1684 * entire display, not an individual window. A window is considered to be
1685 * owned by the display that contains the window's center pixel. (The index of
1686 * this display can be retrieved using SDL_GetWindowDisplayIndex().)
1687 *
1688 * \param window the window used to select the display whose gamma ramp will
1689 * be queried
1690 * \param red a 256 element array of 16-bit quantities filled in with the
1691 * translation table for the red channel, or NULL
1692 * \param green a 256 element array of 16-bit quantities filled in with the
1693 * translation table for the green channel, or NULL
1694 * \param blue a 256 element array of 16-bit quantities filled in with the
1695 * translation table for the blue channel, or NULL
1696 * \returns 0 on success or a negative error code on failure; call
1697 * SDL_GetError() for more information.
1698 *
1699 * \since This function is available since SDL 2.0.0.
1700 *
1701 * \sa SDL_SetWindowGammaRamp
1702 */
1703extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
1704 Uint16 * red,
1705 Uint16 * green,
1706 Uint16 * blue);
1707
1708/**
1709 * Possible return values from the SDL_HitTest callback.
1710 *
1711 * \sa SDL_HitTest
1712 */
1713typedef enum
1714{
1715 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
1716 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
1726
1727/**
1728 * Callback used for hit-testing.
1729 *
1730 * \param win the SDL_Window where hit-testing was set on
1731 * \param area an SDL_Point which should be hit-tested
1732 * \param data what was passed as `callback_data` to SDL_SetWindowHitTest()
1733 * \return an SDL_HitTestResult value.
1734 *
1735 * \sa SDL_SetWindowHitTest
1736 */
1737typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
1738 const SDL_Point *area,
1739 void *data);
1740
1741/**
1742 * Provide a callback that decides if a window region has special properties.
1743 *
1744 * Normally windows are dragged and resized by decorations provided by the
1745 * system window manager (a title bar, borders, etc), but for some apps, it
1746 * makes sense to drag them from somewhere else inside the window itself; for
1747 * example, one might have a borderless window that wants to be draggable from
1748 * any part, or simulate its own title bar, etc.
1749 *
1750 * This function lets the app provide a callback that designates pieces of a
1751 * given window as special. This callback is run during event processing if we
1752 * need to tell the OS to treat a region of the window specially; the use of
1753 * this callback is known as "hit testing."
1754 *
1755 * Mouse input may not be delivered to your application if it is within a
1756 * special area; the OS will often apply that input to moving the window or
1757 * resizing the window and not deliver it to the application.
1758 *
1759 * Specifying NULL for a callback disables hit-testing. Hit-testing is
1760 * disabled by default.
1761 *
1762 * Platforms that don't support this functionality will return -1
1763 * unconditionally, even if you're attempting to disable hit-testing.
1764 *
1765 * Your callback may fire at any time, and its firing does not indicate any
1766 * specific behavior (for example, on Windows, this certainly might fire when
1767 * the OS is deciding whether to drag your window, but it fires for lots of
1768 * other reasons, too, some unrelated to anything you probably care about _and
1769 * when the mouse isn't actually at the location it is testing_). Since this
1770 * can fire at any time, you should try to keep your callback efficient,
1771 * devoid of allocations, etc.
1772 *
1773 * \param window the window to set hit-testing on
1774 * \param callback the function to call when doing a hit-test
1775 * \param callback_data an app-defined void pointer passed to **callback**
1776 * \returns 0 on success or -1 on error (including unsupported); call
1777 * SDL_GetError() for more information.
1778 *
1779 * \since This function is available since SDL 2.0.4.
1780 */
1781extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window * window,
1782 SDL_HitTest callback,
1783 void *callback_data);
1784
1785/**
1786 * Request a window to demand attention from the user.
1787 *
1788 * \param window the window to be flashed
1789 * \param operation the flash operation
1790 * \returns 0 on success or a negative error code on failure; call
1791 * SDL_GetError() for more information.
1792 *
1793 * \since This function is available since SDL 2.0.16.
1794 */
1795extern DECLSPEC int SDLCALL SDL_FlashWindow(SDL_Window * window, SDL_FlashOperation operation);
1796
1797/**
1798 * Destroy a window.
1799 *
1800 * If `window` is NULL, this function will return immediately after setting
1801 * the SDL error message to "Invalid window". See SDL_GetError().
1802 *
1803 * \param window the window to destroy
1804 *
1805 * \since This function is available since SDL 2.0.0.
1806 *
1807 * \sa SDL_CreateWindow
1808 * \sa SDL_CreateWindowFrom
1809 */
1810extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
1811
1812
1813/**
1814 * Check whether the screensaver is currently enabled.
1815 *
1816 * The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2
1817 * the screensaver was enabled by default.
1818 *
1819 * The default can also be changed using `SDL_HINT_VIDEO_ALLOW_SCREENSAVER`.
1820 *
1821 * \returns SDL_TRUE if the screensaver is enabled, SDL_FALSE if it is
1822 * disabled.
1823 *
1824 * \since This function is available since SDL 2.0.0.
1825 *
1826 * \sa SDL_DisableScreenSaver
1827 * \sa SDL_EnableScreenSaver
1828 */
1829extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
1830
1831/**
1832 * Allow the screen to be blanked by a screen saver.
1833 *
1834 * \since This function is available since SDL 2.0.0.
1835 *
1836 * \sa SDL_DisableScreenSaver
1837 * \sa SDL_IsScreenSaverEnabled
1838 */
1839extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
1840
1841/**
1842 * Prevent the screen from being blanked by a screen saver.
1843 *
1844 * If you disable the screensaver, it is automatically re-enabled when SDL
1845 * quits.
1846 *
1847 * The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2
1848 * the screensaver was enabled by default.
1849 *
1850 * \since This function is available since SDL 2.0.0.
1851 *
1852 * \sa SDL_EnableScreenSaver
1853 * \sa SDL_IsScreenSaverEnabled
1854 */
1855extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
1856
1857
1858/**
1859 * \name OpenGL support functions
1860 */
1861/* @{ */
1862
1863/**
1864 * Dynamically load an OpenGL library.
1865 *
1866 * This should be done after initializing the video driver, but before
1867 * creating any OpenGL windows. If no OpenGL library is loaded, the default
1868 * library will be loaded upon creation of the first OpenGL window.
1869 *
1870 * If you do this, you need to retrieve all of the GL functions used in your
1871 * program from the dynamic library using SDL_GL_GetProcAddress().
1872 *
1873 * \param path the platform dependent OpenGL library name, or NULL to open the
1874 * default OpenGL library
1875 * \returns 0 on success or a negative error code on failure; call
1876 * SDL_GetError() for more information.
1877 *
1878 * \since This function is available since SDL 2.0.0.
1879 *
1880 * \sa SDL_GL_GetProcAddress
1881 * \sa SDL_GL_UnloadLibrary
1882 */
1883extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
1884
1885/**
1886 * Get an OpenGL function by name.
1887 *
1888 * If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all
1889 * GL functions must be retrieved this way. Usually this is used to retrieve
1890 * function pointers to OpenGL extensions.
1891 *
1892 * There are some quirks to looking up OpenGL functions that require some
1893 * extra care from the application. If you code carefully, you can handle
1894 * these quirks without any platform-specific code, though:
1895 *
1896 * - On Windows, function pointers are specific to the current GL context;
1897 * this means you need to have created a GL context and made it current
1898 * before calling SDL_GL_GetProcAddress(). If you recreate your context or
1899 * create a second context, you should assume that any existing function
1900 * pointers aren't valid to use with it. This is (currently) a
1901 * Windows-specific limitation, and in practice lots of drivers don't suffer
1902 * this limitation, but it is still the way the wgl API is documented to
1903 * work and you should expect crashes if you don't respect it. Store a copy
1904 * of the function pointers that comes and goes with context lifespan.
1905 * - On X11, function pointers returned by this function are valid for any
1906 * context, and can even be looked up before a context is created at all.
1907 * This means that, for at least some common OpenGL implementations, if you
1908 * look up a function that doesn't exist, you'll get a non-NULL result that
1909 * is _NOT_ safe to call. You must always make sure the function is actually
1910 * available for a given GL context before calling it, by checking for the
1911 * existence of the appropriate extension with SDL_GL_ExtensionSupported(),
1912 * or verifying that the version of OpenGL you're using offers the function
1913 * as core functionality.
1914 * - Some OpenGL drivers, on all platforms, *will* return NULL if a function
1915 * isn't supported, but you can't count on this behavior. Check for
1916 * extensions you use, and if you get a NULL anyway, act as if that
1917 * extension wasn't available. This is probably a bug in the driver, but you
1918 * can code defensively for this scenario anyhow.
1919 * - Just because you're on Linux/Unix, don't assume you'll be using X11.
1920 * Next-gen display servers are waiting to replace it, and may or may not
1921 * make the same promises about function pointers.
1922 * - OpenGL function pointers must be declared `APIENTRY` as in the example
1923 * code. This will ensure the proper calling convention is followed on
1924 * platforms where this matters (Win32) thereby avoiding stack corruption.
1925 *
1926 * \param proc the name of an OpenGL function
1927 * \returns a pointer to the named OpenGL function. The returned pointer
1928 * should be cast to the appropriate function signature.
1929 *
1930 * \since This function is available since SDL 2.0.0.
1931 *
1932 * \sa SDL_GL_ExtensionSupported
1933 * \sa SDL_GL_LoadLibrary
1934 * \sa SDL_GL_UnloadLibrary
1935 */
1936extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
1937
1938/**
1939 * Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
1940 *
1941 * \since This function is available since SDL 2.0.0.
1942 *
1943 * \sa SDL_GL_LoadLibrary
1944 */
1945extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
1946
1947/**
1948 * Check if an OpenGL extension is supported for the current context.
1949 *
1950 * This function operates on the current GL context; you must have created a
1951 * context and it must be current before calling this function. Do not assume
1952 * that all contexts you create will have the same set of extensions
1953 * available, or that recreating an existing context will offer the same
1954 * extensions again.
1955 *
1956 * While it's probably not a massive overhead, this function is not an O(1)
1957 * operation. Check the extensions you care about after creating the GL
1958 * context and save that information somewhere instead of calling the function
1959 * every time you need to know.
1960 *
1961 * \param extension the name of the extension to check
1962 * \returns SDL_TRUE if the extension is supported, SDL_FALSE otherwise.
1963 *
1964 * \since This function is available since SDL 2.0.0.
1965 */
1966extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
1967 *extension);
1968
1969/**
1970 * Reset all previously set OpenGL context attributes to their default values.
1971 *
1972 * \since This function is available since SDL 2.0.2.
1973 *
1974 * \sa SDL_GL_GetAttribute
1975 * \sa SDL_GL_SetAttribute
1976 */
1977extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
1978
1979/**
1980 * Set an OpenGL window attribute before window creation.
1981 *
1982 * This function sets the OpenGL attribute `attr` to `value`. The requested
1983 * attributes should be set before creating an OpenGL window. You should use
1984 * SDL_GL_GetAttribute() to check the values after creating the OpenGL
1985 * context, since the values obtained can differ from the requested ones.
1986 *
1987 * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to set
1988 * \param value the desired value for the attribute
1989 * \returns 0 on success or a negative error code on failure; call
1990 * SDL_GetError() for more information.
1991 *
1992 * \since This function is available since SDL 2.0.0.
1993 *
1994 * \sa SDL_GL_GetAttribute
1995 * \sa SDL_GL_ResetAttributes
1996 */
1997extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
1998
1999/**
2000 * Get the actual value for an attribute from the current context.
2001 *
2002 * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to get
2003 * \param value a pointer filled in with the current value of `attr`
2004 * \returns 0 on success or a negative error code on failure; call
2005 * SDL_GetError() for more information.
2006 *
2007 * \since This function is available since SDL 2.0.0.
2008 *
2009 * \sa SDL_GL_ResetAttributes
2010 * \sa SDL_GL_SetAttribute
2011 */
2012extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
2013
2014/**
2015 * Create an OpenGL context for an OpenGL window, and make it current.
2016 *
2017 * Windows users new to OpenGL should note that, for historical reasons, GL
2018 * functions added after OpenGL version 1.1 are not available by default.
2019 * Those functions must be loaded at run-time, either with an OpenGL
2020 * extension-handling library or with SDL_GL_GetProcAddress() and its related
2021 * functions.
2022 *
2023 * SDL_GLContext is an alias for `void *`. It's opaque to the application.
2024 *
2025 * \param window the window to associate with the context
2026 * \returns the OpenGL context associated with `window` or NULL on error; call
2027 * SDL_GetError() for more details.
2028 *
2029 * \since This function is available since SDL 2.0.0.
2030 *
2031 * \sa SDL_GL_DeleteContext
2032 * \sa SDL_GL_MakeCurrent
2033 */
2034extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
2035 window);
2036
2037/**
2038 * Set up an OpenGL context for rendering into an OpenGL window.
2039 *
2040 * The context must have been created with a compatible window.
2041 *
2042 * \param window the window to associate with the context
2043 * \param context the OpenGL context to associate with the window
2044 * \returns 0 on success or a negative error code on failure; call
2045 * SDL_GetError() for more information.
2046 *
2047 * \since This function is available since SDL 2.0.0.
2048 *
2049 * \sa SDL_GL_CreateContext
2050 */
2051extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
2052 SDL_GLContext context);
2053
2054/**
2055 * Get the currently active OpenGL window.
2056 *
2057 * \returns the currently active OpenGL window on success or NULL on failure;
2058 * call SDL_GetError() for more information.
2059 *
2060 * \since This function is available since SDL 2.0.0.
2061 */
2062extern DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow(void);
2063
2064/**
2065 * Get the currently active OpenGL context.
2066 *
2067 * \returns the currently active OpenGL context or NULL on failure; call
2068 * SDL_GetError() for more information.
2069 *
2070 * \since This function is available since SDL 2.0.0.
2071 *
2072 * \sa SDL_GL_MakeCurrent
2073 */
2074extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
2075
2076/**
2077 * Get the size of a window's underlying drawable in pixels.
2078 *
2079 * This returns info useful for calling glViewport().
2080 *
2081 * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI
2082 * drawable, i.e. the window was created with `SDL_WINDOW_ALLOW_HIGHDPI` on a
2083 * platform with high-DPI support (Apple calls this "Retina"), and not
2084 * disabled by the `SDL_HINT_VIDEO_HIGHDPI_DISABLED` hint.
2085 *
2086 * \param window the window from which the drawable size should be queried
2087 * \param w a pointer to variable for storing the width in pixels, may be NULL
2088 * \param h a pointer to variable for storing the height in pixels, may be
2089 * NULL
2090 *
2091 * \since This function is available since SDL 2.0.1.
2092 *
2093 * \sa SDL_CreateWindow
2094 * \sa SDL_GetWindowSize
2095 */
2096extern DECLSPEC void SDLCALL SDL_GL_GetDrawableSize(SDL_Window * window, int *w,
2097 int *h);
2098
2099/**
2100 * Set the swap interval for the current OpenGL context.
2101 *
2102 * Some systems allow specifying -1 for the interval, to enable adaptive
2103 * vsync. Adaptive vsync works the same as vsync, but if you've already missed
2104 * the vertical retrace for a given frame, it swaps buffers immediately, which
2105 * might be less jarring for the user during occasional framerate drops. If an
2106 * application requests adaptive vsync and the system does not support it,
2107 * this function will fail and return -1. In such a case, you should probably
2108 * retry the call with 1 for the interval.
2109 *
2110 * Adaptive vsync is implemented for some glX drivers with
2111 * GLX_EXT_swap_control_tear, and for some Windows drivers with
2112 * WGL_EXT_swap_control_tear.
2113 *
2114 * Read more on the Khronos wiki:
2115 * https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync
2116 *
2117 * \param interval 0 for immediate updates, 1 for updates synchronized with
2118 * the vertical retrace, -1 for adaptive vsync
2119 * \returns 0 on success or -1 if setting the swap interval is not supported;
2120 * call SDL_GetError() for more information.
2121 *
2122 * \since This function is available since SDL 2.0.0.
2123 *
2124 * \sa SDL_GL_GetSwapInterval
2125 */
2126extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
2127
2128/**
2129 * Get the swap interval for the current OpenGL context.
2130 *
2131 * If the system can't determine the swap interval, or there isn't a valid
2132 * current context, this function will return 0 as a safe default.
2133 *
2134 * \returns 0 if there is no vertical retrace synchronization, 1 if the buffer
2135 * swap is synchronized with the vertical retrace, and -1 if late
2136 * swaps happen immediately instead of waiting for the next retrace;
2137 * call SDL_GetError() for more information.
2138 *
2139 * \since This function is available since SDL 2.0.0.
2140 *
2141 * \sa SDL_GL_SetSwapInterval
2142 */
2143extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
2144
2145/**
2146 * Update a window with OpenGL rendering.
2147 *
2148 * This is used with double-buffered OpenGL contexts, which are the default.
2149 *
2150 * On macOS, make sure you bind 0 to the draw framebuffer before swapping the
2151 * window, otherwise nothing will happen. If you aren't using
2152 * glBindFramebuffer(), this is the default and you won't have to do anything
2153 * extra.
2154 *
2155 * \param window the window to change
2156 *
2157 * \since This function is available since SDL 2.0.0.
2158 */
2159extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
2160
2161/**
2162 * Delete an OpenGL context.
2163 *
2164 * \param context the OpenGL context to be deleted
2165 *
2166 * \since This function is available since SDL 2.0.0.
2167 *
2168 * \sa SDL_GL_CreateContext
2169 */
2170extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
2171
2172/* @} *//* OpenGL support functions */
2173
2174
2175/* Ends C function definitions when using C++ */
2176#ifdef __cplusplus
2177}
2178#endif
2179#include "close_code.h"
2180
2181#endif /* SDL_video_h_ */
2182
2183/* vi: set ts=4 sw=4 expandtab: */
uint16_t Uint16
Definition SDL_stdinc.h:210
SDL_bool
Definition SDL_stdinc.h:181
uint32_t Uint32
Definition SDL_stdinc.h:222
void SDL_HideWindow(SDL_Window *window)
void SDL_DisableScreenSaver(void)
SDL_HitTestResult
Definition SDL_video.h:1715
@ SDL_HITTEST_DRAGGABLE
Definition SDL_video.h:1717
@ SDL_HITTEST_RESIZE_LEFT
Definition SDL_video.h:1725
@ SDL_HITTEST_RESIZE_TOP
Definition SDL_video.h:1719
@ SDL_HITTEST_RESIZE_TOPRIGHT
Definition SDL_video.h:1720
@ SDL_HITTEST_NORMAL
Definition SDL_video.h:1716
@ SDL_HITTEST_RESIZE_BOTTOM
Definition SDL_video.h:1723
@ SDL_HITTEST_RESIZE_BOTTOMRIGHT
Definition SDL_video.h:1722
@ SDL_HITTEST_RESIZE_BOTTOMLEFT
Definition SDL_video.h:1724
@ SDL_HITTEST_RESIZE_RIGHT
Definition SDL_video.h:1721
@ SDL_HITTEST_RESIZE_TOPLEFT
Definition SDL_video.h:1718
int SDL_SetWindowModalFor(SDL_Window *modal_window, SDL_Window *parent_window)
int SDL_UpdateWindowSurface(SDL_Window *window)
void SDL_GL_GetDrawableSize(SDL_Window *window, int *w, int *h)
void SDL_SetWindowAlwaysOnTop(SDL_Window *window, SDL_bool on_top)
void * SDL_GLContext
An opaque handle to an OpenGL context.
Definition SDL_video.h:219
void SDL_SetWindowPosition(SDL_Window *window, int x, int y)
SDL_Surface * SDL_GetWindowSurface(SDL_Window *window)
Uint32 SDL_GetWindowFlags(SDL_Window *window)
int SDL_GetWindowDisplayIndex(SDL_Window *window)
void SDL_SetWindowKeyboardGrab(SDL_Window *window, SDL_bool grabbed)
SDL_bool SDL_GL_ExtensionSupported(const char *extension)
int SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode *mode)
int SDL_GL_SetSwapInterval(int interval)
void * SDL_GetWindowData(SDL_Window *window, const char *name)
const char * SDL_GetWindowTitle(SDL_Window *window)
void SDL_GL_SwapWindow(SDL_Window *window)
SDL_HitTestResult(* SDL_HitTest)(SDL_Window *win, const SDL_Point *area, void *data)
Definition SDL_video.h:1738
SDL_GLattr
OpenGL configuration attributes.
Definition SDL_video.h:225
@ SDL_GL_FRAMEBUFFER_SRGB_CAPABLE
Definition SDL_video.h:249
@ SDL_GL_CONTEXT_RELEASE_BEHAVIOR
Definition SDL_video.h:250
@ SDL_GL_DOUBLEBUFFER
Definition SDL_video.h:231
@ SDL_GL_STENCIL_SIZE
Definition SDL_video.h:233
@ SDL_GL_CONTEXT_MAJOR_VERSION
Definition SDL_video.h:243
@ SDL_GL_CONTEXT_RESET_NOTIFICATION
Definition SDL_video.h:251
@ SDL_GL_CONTEXT_EGL
Definition SDL_video.h:245
@ SDL_GL_ACCUM_ALPHA_SIZE
Definition SDL_video.h:237
@ SDL_GL_MULTISAMPLESAMPLES
Definition SDL_video.h:240
@ SDL_GL_CONTEXT_MINOR_VERSION
Definition SDL_video.h:244
@ SDL_GL_FLOATBUFFERS
Definition SDL_video.h:253
@ SDL_GL_STEREO
Definition SDL_video.h:238
@ SDL_GL_MULTISAMPLEBUFFERS
Definition SDL_video.h:239
@ SDL_GL_ACCUM_GREEN_SIZE
Definition SDL_video.h:235
@ SDL_GL_BLUE_SIZE
Definition SDL_video.h:228
@ SDL_GL_SHARE_WITH_CURRENT_CONTEXT
Definition SDL_video.h:248
@ SDL_GL_RETAINED_BACKING
Definition SDL_video.h:242
@ SDL_GL_RED_SIZE
Definition SDL_video.h:226
@ SDL_GL_ALPHA_SIZE
Definition SDL_video.h:229
@ SDL_GL_BUFFER_SIZE
Definition SDL_video.h:230
@ SDL_GL_ACCELERATED_VISUAL
Definition SDL_video.h:241
@ SDL_GL_ACCUM_BLUE_SIZE
Definition SDL_video.h:236
@ SDL_GL_DEPTH_SIZE
Definition SDL_video.h:232
@ SDL_GL_ACCUM_RED_SIZE
Definition SDL_video.h:234
@ SDL_GL_CONTEXT_FLAGS
Definition SDL_video.h:246
@ SDL_GL_CONTEXT_PROFILE_MASK
Definition SDL_video.h:247
@ SDL_GL_CONTEXT_NO_ERROR
Definition SDL_video.h:252
@ SDL_GL_GREEN_SIZE
Definition SDL_video.h:227
Uint32 SDL_GetWindowPixelFormat(SDL_Window *window)
int SDL_VideoInit(const char *driver_name)
void SDL_GL_ResetAttributes(void)
SDL_FlashOperation
Window flash operation.
Definition SDL_video.h:210
@ SDL_FLASH_UNTIL_FOCUSED
Definition SDL_video.h:213
@ SDL_FLASH_BRIEFLY
Definition SDL_video.h:212
@ SDL_FLASH_CANCEL
Definition SDL_video.h:211
SDL_DisplayOrientation SDL_GetDisplayOrientation(int displayIndex)
void SDL_SetWindowGrab(SDL_Window *window, SDL_bool grabbed)
void * SDL_GetWindowICCProfile(SDL_Window *window, size_t *size)
int SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation)
void * SDL_GL_GetProcAddress(const char *proc)
int SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right)
int SDL_GL_GetSwapInterval(void)
const SDL_Rect * SDL_GetWindowMouseRect(SDL_Window *window)
SDL_bool SDL_GetWindowKeyboardGrab(SDL_Window *window)
int SDL_GetWindowDisplayMode(SDL_Window *window, SDL_DisplayMode *mode)
int SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects)
struct SDL_Window SDL_Window
The type used to identify a window.
Definition SDL_video.h:95
int SDL_GetDisplayDPI(int displayIndex, float *ddpi, float *hdpi, float *vdpi)
void SDL_SetWindowMouseGrab(SDL_Window *window, SDL_bool grabbed)
SDL_DisplayMode * SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
void SDL_SetWindowTitle(SDL_Window *window, const char *title)
void SDL_RestoreWindow(SDL_Window *window)
SDL_GLContext SDL_GL_CreateContext(SDL_Window *window)
const char * SDL_GetCurrentVideoDriver(void)
int SDL_SetWindowFullscreen(SDL_Window *window, Uint32 flags)
void SDL_SetWindowMaximumSize(SDL_Window *window, int max_w, int max_h)
SDL_bool SDL_HasWindowSurface(SDL_Window *window)
void SDL_SetWindowBordered(SDL_Window *window, SDL_bool bordered)
int SDL_GetDisplayBounds(int displayIndex, SDL_Rect *rect)
void SDL_EnableScreenSaver(void)
SDL_bool SDL_GetWindowGrab(SDL_Window *window)
int SDL_GetNumVideoDisplays(void)
int SDL_SetWindowInputFocus(SDL_Window *window)
void SDL_GetWindowPosition(SDL_Window *window, int *x, int *y)
void SDL_GetWindowMinimumSize(SDL_Window *window, int *w, int *h)
SDL_Window * SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)
int SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect *rect)
SDL_GLContext SDL_GL_GetCurrentContext(void)
void SDL_ShowWindow(SDL_Window *window)
SDL_Window * SDL_GetGrabbedWindow(void)
const char * SDL_GetDisplayName(int displayIndex)
void SDL_GL_UnloadLibrary(void)
float SDL_GetWindowBrightness(SDL_Window *window)
void SDL_GetWindowMaximumSize(SDL_Window *window, int *w, int *h)
int SDL_GL_SetAttribute(SDL_GLattr attr, int value)
int SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect)
int SDL_SetWindowOpacity(SDL_Window *window, float opacity)
int SDL_SetWindowBrightness(SDL_Window *window, float brightness)
SDL_GLcontextReleaseFlag
Definition SDL_video.h:272
@ SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE
Definition SDL_video.h:273
@ SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH
Definition SDL_video.h:274
int SDL_GetNumVideoDrivers(void)
SDL_Window * SDL_GL_GetCurrentWindow(void)
void * SDL_SetWindowData(SDL_Window *window, const char *name, void *userdata)
int SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode *mode)
void SDL_SetWindowMinimumSize(SDL_Window *window, int min_w, int min_h)
int SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext context)
SDL_Window * SDL_GetWindowFromID(Uint32 id)
const char * SDL_GetVideoDriver(int index)
void SDL_GL_DeleteContext(SDL_GLContext context)
void SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon)
SDL_bool SDL_GetWindowMouseGrab(SDL_Window *window)
SDL_GLcontextFlag
Definition SDL_video.h:264
@ SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG
Definition SDL_video.h:266
@ SDL_GL_CONTEXT_RESET_ISOLATION_FLAG
Definition SDL_video.h:268
@ SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG
Definition SDL_video.h:267
@ SDL_GL_CONTEXT_DEBUG_FLAG
Definition SDL_video.h:265
void SDL_GetWindowSize(SDL_Window *window, int *w, int *h)
int SDL_GetPointDisplayIndex(const SDL_Point *point)
int SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data)
void SDL_DestroyWindow(SDL_Window *window)
void SDL_MaximizeWindow(SDL_Window *window)
SDL_WindowEventID
Event subtype for window events.
Definition SDL_video.h:155
@ SDL_WINDOWEVENT_HIDDEN
Definition SDL_video.h:158
@ SDL_WINDOWEVENT_FOCUS_LOST
Definition SDL_video.h:174
@ SDL_WINDOWEVENT_CLOSE
Definition SDL_video.h:175
@ SDL_WINDOWEVENT_RESIZED
Definition SDL_video.h:163
@ SDL_WINDOWEVENT_HIT_TEST
Definition SDL_video.h:177
@ SDL_WINDOWEVENT_FOCUS_GAINED
Definition SDL_video.h:173
@ SDL_WINDOWEVENT_SHOWN
Definition SDL_video.h:157
@ SDL_WINDOWEVENT_MOVED
Definition SDL_video.h:161
@ SDL_WINDOWEVENT_TAKE_FOCUS
Definition SDL_video.h:176
@ SDL_WINDOWEVENT_MINIMIZED
Definition SDL_video.h:167
@ SDL_WINDOWEVENT_DISPLAY_CHANGED
Definition SDL_video.h:179
@ SDL_WINDOWEVENT_LEAVE
Definition SDL_video.h:172
@ SDL_WINDOWEVENT_MAXIMIZED
Definition SDL_video.h:168
@ SDL_WINDOWEVENT_SIZE_CHANGED
Definition SDL_video.h:164
@ SDL_WINDOWEVENT_RESTORED
Definition SDL_video.h:169
@ SDL_WINDOWEVENT_ICCPROF_CHANGED
Definition SDL_video.h:178
@ SDL_WINDOWEVENT_EXPOSED
Definition SDL_video.h:159
@ SDL_WINDOWEVENT_ENTER
Definition SDL_video.h:171
@ SDL_WINDOWEVENT_NONE
Definition SDL_video.h:156
int SDL_DestroyWindowSurface(SDL_Window *window)
void SDL_MinimizeWindow(SDL_Window *window)
Uint32 SDL_GetWindowID(SDL_Window *window)
SDL_Window * SDL_CreateWindowFrom(const void *data)
void SDL_SetWindowSize(SDL_Window *window, int w, int h)
int SDL_GetDisplayMode(int displayIndex, int modeIndex, SDL_DisplayMode *mode)
int SDL_GL_GetAttribute(SDL_GLattr attr, int *value)
SDL_bool SDL_IsScreenSaverEnabled(void)
SDL_GLprofile
Definition SDL_video.h:257
@ SDL_GL_CONTEXT_PROFILE_COMPATIBILITY
Definition SDL_video.h:259
@ SDL_GL_CONTEXT_PROFILE_ES
Definition SDL_video.h:260
@ SDL_GL_CONTEXT_PROFILE_CORE
Definition SDL_video.h:258
SDL_DisplayEventID
Event subtype for display events.
Definition SDL_video.h:186
@ SDL_DISPLAYEVENT_NONE
Definition SDL_video.h:187
@ SDL_DISPLAYEVENT_MOVED
Definition SDL_video.h:191
@ SDL_DISPLAYEVENT_ORIENTATION
Definition SDL_video.h:188
@ SDL_DISPLAYEVENT_DISCONNECTED
Definition SDL_video.h:190
@ SDL_DISPLAYEVENT_CONNECTED
Definition SDL_video.h:189
int SDL_GL_LoadLibrary(const char *path)
void SDL_GetWindowSizeInPixels(SDL_Window *window, int *w, int *h)
int SDL_GetWindowGammaRamp(SDL_Window *window, Uint16 *red, Uint16 *green, Uint16 *blue)
void SDL_SetWindowResizable(SDL_Window *window, SDL_bool resizable)
int SDL_SetWindowGammaRamp(SDL_Window *window, const Uint16 *red, const Uint16 *green, const Uint16 *blue)
void SDL_VideoQuit(void)
int SDL_SetWindowDisplayMode(SDL_Window *window, const SDL_DisplayMode *mode)
int SDL_GetNumDisplayModes(int displayIndex)
SDL_DisplayOrientation
Display orientation.
Definition SDL_video.h:198
@ SDL_ORIENTATION_LANDSCAPE
Definition SDL_video.h:200
@ SDL_ORIENTATION_PORTRAIT
Definition SDL_video.h:202
@ SDL_ORIENTATION_PORTRAIT_FLIPPED
Definition SDL_video.h:203
@ SDL_ORIENTATION_LANDSCAPE_FLIPPED
Definition SDL_video.h:201
@ SDL_ORIENTATION_UNKNOWN
Definition SDL_video.h:199
void SDL_RaiseWindow(SDL_Window *window)
SDL_GLContextResetNotification
Definition SDL_video.h:278
@ SDL_GL_CONTEXT_RESET_NO_NOTIFICATION
Definition SDL_video.h:279
@ SDL_GL_CONTEXT_RESET_LOSE_CONTEXT
Definition SDL_video.h:280
int SDL_GetRectDisplayIndex(const SDL_Rect *rect)
int SDL_GetWindowOpacity(SDL_Window *window, float *out_opacity)
The structure that defines a display mode.
Definition SDL_video.h:54
A collection of pixels used in software blitting.
Definition SDL_surface.h:73

◆ SDL_WINDOWPOS_ISUNDEFINED

#define SDL_WINDOWPOS_ISUNDEFINED (   X)     (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)

Definition at line 139 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 138 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

#define SDL_WINDOWPOS_UNDEFINED_DISPLAY (   X)    (SDL_WINDOWPOS_UNDEFINED_MASK|(X))

Definition at line 137 of file SDL_video.h.

◆ SDL_WINDOWPOS_UNDEFINED_MASK

#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u

Used to indicate that you don't care what the window position is.

Definition at line 136 of file SDL_video.h.

Typedef Documentation

◆ SDL_GLContext

typedef void* SDL_GLContext

An opaque handle to an OpenGL context.

Definition at line 219 of file SDL_video.h.

◆ SDL_HitTest

typedef SDL_HitTestResult(* SDL_HitTest) (SDL_Window *win, const SDL_Point *area, void *data)

Callback used for hit-testing.

Parameters
winthe SDL_Window where hit-testing was set on
areaan SDL_Point which should be hit-tested
datawhat was passed as callback_data to SDL_SetWindowHitTest()
Returns
an SDL_HitTestResult value.
See also
SDL_SetWindowHitTest

Definition at line 1738 of file SDL_video.h.

◆ SDL_Window

Enumeration Type Documentation

◆ SDL_DisplayEventID

Event subtype for display events.

Enumerator
SDL_DISPLAYEVENT_NONE 

Never used

SDL_DISPLAYEVENT_ORIENTATION 

Display orientation has changed to data1

SDL_DISPLAYEVENT_CONNECTED 

Display has been added to the system

SDL_DISPLAYEVENT_DISCONNECTED 

Display has been removed from the system

SDL_DISPLAYEVENT_MOVED 

Display has changed position

Definition at line 185 of file SDL_video.h.

186{
187 SDL_DISPLAYEVENT_NONE, /**< Never used */
188 SDL_DISPLAYEVENT_ORIENTATION, /**< Display orientation has changed to data1 */
189 SDL_DISPLAYEVENT_CONNECTED, /**< Display has been added to the system */
190 SDL_DISPLAYEVENT_DISCONNECTED, /**< Display has been removed from the system */
191 SDL_DISPLAYEVENT_MOVED /**< Display has changed position */

◆ SDL_DisplayOrientation

Display orientation.

Enumerator
SDL_ORIENTATION_UNKNOWN 

The display orientation can't be determined

SDL_ORIENTATION_LANDSCAPE 

The display is in landscape mode, with the right side up, relative to portrait mode

SDL_ORIENTATION_LANDSCAPE_FLIPPED 

The display is in landscape mode, with the left side up, relative to portrait mode

SDL_ORIENTATION_PORTRAIT 

The display is in portrait mode

SDL_ORIENTATION_PORTRAIT_FLIPPED 

The display is in portrait mode, upside down

Definition at line 197 of file SDL_video.h.

198{
199 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
200 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
201 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
202 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
203 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */

◆ SDL_FlashOperation

Window flash operation.

Enumerator
SDL_FLASH_CANCEL 

Cancel any window flash state

SDL_FLASH_BRIEFLY 

Flash the window briefly to get attention

SDL_FLASH_UNTIL_FOCUSED 

Flash the window until it gets focus

Definition at line 209 of file SDL_video.h.

210{
211 SDL_FLASH_CANCEL, /**< Cancel any window flash state */
212 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
213 SDL_FLASH_UNTIL_FOCUSED /**< Flash the window until it gets focus */

◆ SDL_GLattr

enum SDL_GLattr

OpenGL configuration attributes.

Enumerator
SDL_GL_RED_SIZE 
SDL_GL_GREEN_SIZE 
SDL_GL_BLUE_SIZE 
SDL_GL_ALPHA_SIZE 
SDL_GL_BUFFER_SIZE 
SDL_GL_DOUBLEBUFFER 
SDL_GL_DEPTH_SIZE 
SDL_GL_STENCIL_SIZE 
SDL_GL_ACCUM_RED_SIZE 
SDL_GL_ACCUM_GREEN_SIZE 
SDL_GL_ACCUM_BLUE_SIZE 
SDL_GL_ACCUM_ALPHA_SIZE 
SDL_GL_STEREO 
SDL_GL_MULTISAMPLEBUFFERS 
SDL_GL_MULTISAMPLESAMPLES 
SDL_GL_ACCELERATED_VISUAL 
SDL_GL_RETAINED_BACKING 
SDL_GL_CONTEXT_MAJOR_VERSION 
SDL_GL_CONTEXT_MINOR_VERSION 
SDL_GL_CONTEXT_EGL 
SDL_GL_CONTEXT_FLAGS 
SDL_GL_CONTEXT_PROFILE_MASK 
SDL_GL_SHARE_WITH_CURRENT_CONTEXT 
SDL_GL_FRAMEBUFFER_SRGB_CAPABLE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR 
SDL_GL_CONTEXT_RESET_NOTIFICATION 
SDL_GL_CONTEXT_NO_ERROR 
SDL_GL_FLOATBUFFERS 

Definition at line 224 of file SDL_video.h.

◆ SDL_GLcontextFlag

Enumerator
SDL_GL_CONTEXT_DEBUG_FLAG 
SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG 
SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG 
SDL_GL_CONTEXT_RESET_ISOLATION_FLAG 

Definition at line 263 of file SDL_video.h.

◆ SDL_GLcontextReleaseFlag

Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 

Definition at line 271 of file SDL_video.h.

◆ SDL_GLContextResetNotification

Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 

Definition at line 277 of file SDL_video.h.

◆ SDL_GLprofile

Enumerator
SDL_GL_CONTEXT_PROFILE_CORE 
SDL_GL_CONTEXT_PROFILE_COMPATIBILITY 
SDL_GL_CONTEXT_PROFILE_ES 

GLX_CONTEXT_ES2_PROFILE_BIT_EXT

Definition at line 256 of file SDL_video.h.

257{
260 SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */

◆ SDL_HitTestResult

Possible return values from the SDL_HitTest callback.

See also
SDL_HitTest
Enumerator
SDL_HITTEST_NORMAL 

Region is normal. No special properties.

SDL_HITTEST_DRAGGABLE 

Region can drag entire window.

SDL_HITTEST_RESIZE_TOPLEFT 
SDL_HITTEST_RESIZE_TOP 
SDL_HITTEST_RESIZE_TOPRIGHT 
SDL_HITTEST_RESIZE_RIGHT 
SDL_HITTEST_RESIZE_BOTTOMRIGHT 
SDL_HITTEST_RESIZE_BOTTOM 
SDL_HITTEST_RESIZE_BOTTOMLEFT 
SDL_HITTEST_RESIZE_LEFT 

Definition at line 1714 of file SDL_video.h.

◆ SDL_WindowEventID

Event subtype for window events.

Enumerator
SDL_WINDOWEVENT_NONE 

Never used

SDL_WINDOWEVENT_SHOWN 

Window has been shown

SDL_WINDOWEVENT_HIDDEN 

Window has been hidden

SDL_WINDOWEVENT_EXPOSED 

Window has been exposed and should be redrawn

SDL_WINDOWEVENT_MOVED 

Window has been moved to data1, data2

SDL_WINDOWEVENT_RESIZED 

Window has been resized to data1xdata2

SDL_WINDOWEVENT_SIZE_CHANGED 

The window size has changed, either as a result of an API call or through the system or user changing the window size.

SDL_WINDOWEVENT_MINIMIZED 

Window has been minimized

SDL_WINDOWEVENT_MAXIMIZED 

Window has been maximized

SDL_WINDOWEVENT_RESTORED 

Window has been restored to normal size and position

SDL_WINDOWEVENT_ENTER 

Window has gained mouse focus

SDL_WINDOWEVENT_LEAVE 

Window has lost mouse focus

SDL_WINDOWEVENT_FOCUS_GAINED 

Window has gained keyboard focus

SDL_WINDOWEVENT_FOCUS_LOST 

Window has lost keyboard focus

SDL_WINDOWEVENT_CLOSE 

The window manager requests that the window be closed

SDL_WINDOWEVENT_TAKE_FOCUS 

Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore)

SDL_WINDOWEVENT_HIT_TEST 

Window had a hit test that wasn't SDL_HITTEST_NORMAL.

SDL_WINDOWEVENT_ICCPROF_CHANGED 

The ICC profile of the window's display has changed.

SDL_WINDOWEVENT_DISPLAY_CHANGED 

Window has been moved to display data1.

Definition at line 154 of file SDL_video.h.

155{
156 SDL_WINDOWEVENT_NONE, /**< Never used */
157 SDL_WINDOWEVENT_SHOWN, /**< Window has been shown */
158 SDL_WINDOWEVENT_HIDDEN, /**< Window has been hidden */
159 SDL_WINDOWEVENT_EXPOSED, /**< Window has been exposed and should be
160 redrawn */
161 SDL_WINDOWEVENT_MOVED, /**< Window has been moved to data1, data2
162 */
163 SDL_WINDOWEVENT_RESIZED, /**< Window has been resized to data1xdata2 */
164 SDL_WINDOWEVENT_SIZE_CHANGED, /**< The window size has changed, either as
165 a result of an API call or through the
166 system or user changing the window size. */
167 SDL_WINDOWEVENT_MINIMIZED, /**< Window has been minimized */
168 SDL_WINDOWEVENT_MAXIMIZED, /**< Window has been maximized */
169 SDL_WINDOWEVENT_RESTORED, /**< Window has been restored to normal size
170 and position */
171 SDL_WINDOWEVENT_ENTER, /**< Window has gained mouse focus */
172 SDL_WINDOWEVENT_LEAVE, /**< Window has lost mouse focus */
173 SDL_WINDOWEVENT_FOCUS_GAINED, /**< Window has gained keyboard focus */
174 SDL_WINDOWEVENT_FOCUS_LOST, /**< Window has lost keyboard focus */
175 SDL_WINDOWEVENT_CLOSE, /**< The window manager requests that the window be closed */
176 SDL_WINDOWEVENT_TAKE_FOCUS, /**< Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore) */
177 SDL_WINDOWEVENT_HIT_TEST, /**< Window had a hit test that wasn't SDL_HITTEST_NORMAL. */
178 SDL_WINDOWEVENT_ICCPROF_CHANGED,/**< The ICC profile of the window's display has changed. */
179 SDL_WINDOWEVENT_DISPLAY_CHANGED /**< Window has been moved to display data1. */

◆ SDL_WindowFlags

The flags on a window.

See also
SDL_GetWindowFlags()
Enumerator
SDL_WINDOW_FULLSCREEN 

fullscreen window

SDL_WINDOW_OPENGL 

window usable with OpenGL context

SDL_WINDOW_SHOWN 

window is visible

SDL_WINDOW_HIDDEN 

window is not visible

SDL_WINDOW_BORDERLESS 

no window decoration

SDL_WINDOW_RESIZABLE 

window can be resized

SDL_WINDOW_MINIMIZED 

window is minimized

SDL_WINDOW_MAXIMIZED 

window is maximized

SDL_WINDOW_MOUSE_GRABBED 

window has grabbed mouse input

SDL_WINDOW_INPUT_FOCUS 

window has input focus

SDL_WINDOW_MOUSE_FOCUS 

window has mouse focus

SDL_WINDOW_FULLSCREEN_DESKTOP 
SDL_WINDOW_FOREIGN 

window not created by SDL

SDL_WINDOW_ALLOW_HIGHDPI 

window should be created in high-DPI mode if supported. On macOS NSHighResolutionCapable must be set true in the application's Info.plist for this to have any effect.

SDL_WINDOW_MOUSE_CAPTURE 

window has mouse captured (unrelated to MOUSE_GRABBED)

SDL_WINDOW_ALWAYS_ON_TOP 

window should always be above others

SDL_WINDOW_SKIP_TASKBAR 

window should not be added to the taskbar

SDL_WINDOW_UTILITY 

window should be treated as a utility window

SDL_WINDOW_TOOLTIP 

window should be treated as a tooltip

SDL_WINDOW_POPUP_MENU 

window should be treated as a popup menu

SDL_WINDOW_KEYBOARD_GRABBED 

window has grabbed keyboard input

SDL_WINDOW_VULKAN 

window usable for Vulkan surface

SDL_WINDOW_METAL 

window usable for Metal view

SDL_WINDOW_INPUT_GRABBED 

equivalent to SDL_WINDOW_MOUSE_GRABBED for compatibility

Definition at line 102 of file SDL_video.h.

103{
104 SDL_WINDOW_FULLSCREEN = 0x00000001, /**< fullscreen window */
105 SDL_WINDOW_OPENGL = 0x00000002, /**< window usable with OpenGL context */
106 SDL_WINDOW_SHOWN = 0x00000004, /**< window is visible */
107 SDL_WINDOW_HIDDEN = 0x00000008, /**< window is not visible */
108 SDL_WINDOW_BORDERLESS = 0x00000010, /**< no window decoration */
109 SDL_WINDOW_RESIZABLE = 0x00000020, /**< window can be resized */
110 SDL_WINDOW_MINIMIZED = 0x00000040, /**< window is minimized */
111 SDL_WINDOW_MAXIMIZED = 0x00000080, /**< window is maximized */
112 SDL_WINDOW_MOUSE_GRABBED = 0x00000100, /**< window has grabbed mouse input */
113 SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */
114 SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
116 SDL_WINDOW_FOREIGN = 0x00000800, /**< window not created by SDL */
117 SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000, /**< window should be created in high-DPI mode if supported.
118 On macOS NSHighResolutionCapable must be set true in the
119 application's Info.plist for this to have any effect. */
120 SDL_WINDOW_MOUSE_CAPTURE = 0x00004000, /**< window has mouse captured (unrelated to MOUSE_GRABBED) */
121 SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000, /**< window should always be above others */
122 SDL_WINDOW_SKIP_TASKBAR = 0x00010000, /**< window should not be added to the taskbar */
123 SDL_WINDOW_UTILITY = 0x00020000, /**< window should be treated as a utility window */
124 SDL_WINDOW_TOOLTIP = 0x00040000, /**< window should be treated as a tooltip */
125 SDL_WINDOW_POPUP_MENU = 0x00080000, /**< window should be treated as a popup menu */
126 SDL_WINDOW_KEYBOARD_GRABBED = 0x00100000, /**< window has grabbed keyboard input */
127 SDL_WINDOW_VULKAN = 0x10000000, /**< window usable for Vulkan surface */
128 SDL_WINDOW_METAL = 0x20000000, /**< window usable for Metal view */
129
130 SDL_WINDOW_INPUT_GRABBED = SDL_WINDOW_MOUSE_GRABBED /**< equivalent to SDL_WINDOW_MOUSE_GRABBED for compatibility */
SDL_WindowFlags
The flags on a window.
Definition SDL_video.h:103
@ SDL_WINDOW_ALLOW_HIGHDPI
Definition SDL_video.h:117
@ SDL_WINDOW_FOREIGN
Definition SDL_video.h:116
@ SDL_WINDOW_TOOLTIP
Definition SDL_video.h:124
@ SDL_WINDOW_ALWAYS_ON_TOP
Definition SDL_video.h:121
@ SDL_WINDOW_SHOWN
Definition SDL_video.h:106
@ SDL_WINDOW_SKIP_TASKBAR
Definition SDL_video.h:122
@ SDL_WINDOW_MOUSE_CAPTURE
Definition SDL_video.h:120
@ SDL_WINDOW_VULKAN
Definition SDL_video.h:127
@ SDL_WINDOW_OPENGL
Definition SDL_video.h:105
@ SDL_WINDOW_MINIMIZED
Definition SDL_video.h:110
@ SDL_WINDOW_UTILITY
Definition SDL_video.h:123
@ SDL_WINDOW_MOUSE_FOCUS
Definition SDL_video.h:114
@ SDL_WINDOW_INPUT_GRABBED
Definition SDL_video.h:130
@ SDL_WINDOW_RESIZABLE
Definition SDL_video.h:109
@ SDL_WINDOW_KEYBOARD_GRABBED
Definition SDL_video.h:126
@ SDL_WINDOW_FULLSCREEN_DESKTOP
Definition SDL_video.h:115
@ SDL_WINDOW_FULLSCREEN
Definition SDL_video.h:104
@ SDL_WINDOW_MAXIMIZED
Definition SDL_video.h:111
@ SDL_WINDOW_METAL
Definition SDL_video.h:128
@ SDL_WINDOW_HIDDEN
Definition SDL_video.h:107
@ SDL_WINDOW_MOUSE_GRABBED
Definition SDL_video.h:112
@ SDL_WINDOW_POPUP_MENU
Definition SDL_video.h:125
@ SDL_WINDOW_BORDERLESS
Definition SDL_video.h:108
@ SDL_WINDOW_INPUT_FOCUS
Definition SDL_video.h:113

Function Documentation

◆ SDL_CreateWindow()

SDL_Window * SDL_CreateWindow ( const char *  title,
int  x,
int  y,
int  w,
int  h,
Uint32  flags 
)
extern

Create a window with the specified position, dimensions, and flags.

flags may be any of the following OR'd together:

  • SDL_WINDOW_FULLSCREEN: fullscreen window
  • SDL_WINDOW_FULLSCREEN_DESKTOP: fullscreen window at desktop resolution
  • SDL_WINDOW_OPENGL: window usable with an OpenGL context
  • SDL_WINDOW_VULKAN: window usable with a Vulkan instance
  • SDL_WINDOW_METAL: window usable with a Metal instance
  • SDL_WINDOW_HIDDEN: window is not visible
  • SDL_WINDOW_BORDERLESS: no window decoration
  • SDL_WINDOW_RESIZABLE: window can be resized
  • SDL_WINDOW_MINIMIZED: window is minimized
  • SDL_WINDOW_MAXIMIZED: window is maximized
  • SDL_WINDOW_INPUT_GRABBED: window has grabbed input focus
  • SDL_WINDOW_ALLOW_HIGHDPI: window should be created in high-DPI mode if supported (>= SDL 2.0.1)

SDL_WINDOW_SHOWN is ignored by SDL_CreateWindow(). The SDL_Window is implicitly shown if SDL_WINDOW_HIDDEN is not set. SDL_WINDOW_SHOWN may be queried later using SDL_GetWindowFlags().

On Apple's macOS, you must set the NSHighResolutionCapable Info.plist property to YES, otherwise you will not receive a High-DPI OpenGL canvas.

If the window is created with the SDL_WINDOW_ALLOW_HIGHDPI flag, its size in pixels may differ from its size in screen coordinates on platforms with high-DPI support (e.g. iOS and macOS). Use SDL_GetWindowSize() to query the client area's size in screen coordinates, and SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() to query the drawable size in pixels. Note that when this flag is set, the drawable size can vary after the window is created and should be queried after major window events such as when the window is resized or moved between displays.

If the window is set fullscreen, the width and height parameters w and h will not be used. However, invalid size parameters (e.g. too large) may still fail. Window size is actually limited to 16384 x 16384 for all platforms at window creation.

If the window is created with any of the SDL_WINDOW_OPENGL or SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the corresponding UnloadLibrary function is called by SDL_DestroyWindow().

If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver, SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail.

If SDL_WINDOW_METAL is specified on an OS that does not support Metal, SDL_CreateWindow() will fail.

On non-Apple devices, SDL requires you to either not link to the Vulkan loader or link to a dynamic library version. This limitation may be removed in a future version of SDL.

Parameters
titlethe title of the window, in UTF-8 encoding
xthe x position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
ythe y position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
wthe width of the window, in screen coordinates
hthe height of the window, in screen coordinates
flags0, or one or more SDL_WindowFlags OR'd together
Returns
the window that was created or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_CreateWindowFrom
SDL_DestroyWindow

◆ SDL_CreateWindowFrom()

SDL_Window * SDL_CreateWindowFrom ( const void *  data)
extern

Create an SDL window from an existing native window.

In some cases (e.g. OpenGL) and on some platforms (e.g. Microsoft Windows) the hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT needs to be configured before using SDL_CreateWindowFrom().

Parameters
dataa pointer to driver-dependent window creation data, typically your native window cast to a void*
Returns
the window that was created or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_CreateWindow
SDL_DestroyWindow

◆ SDL_DestroyWindow()

void SDL_DestroyWindow ( SDL_Window window)
extern

Destroy a window.

If window is NULL, this function will return immediately after setting the SDL error message to "Invalid window". See SDL_GetError().

Parameters
windowthe window to destroy
Since
This function is available since SDL 2.0.0.
See also
SDL_CreateWindow
SDL_CreateWindowFrom

◆ SDL_DestroyWindowSurface()

int SDL_DestroyWindowSurface ( SDL_Window window)
extern

Destroy the surface associated with the window.

Parameters
windowthe window to update
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.28.0.
See also
SDL_GetWindowSurface
SDL_HasWindowSurface

◆ SDL_DisableScreenSaver()

void SDL_DisableScreenSaver ( void  )
extern

Prevent the screen from being blanked by a screen saver.

If you disable the screensaver, it is automatically re-enabled when SDL quits.

The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2 the screensaver was enabled by default.

Since
This function is available since SDL 2.0.0.
See also
SDL_EnableScreenSaver
SDL_IsScreenSaverEnabled

◆ SDL_EnableScreenSaver()

void SDL_EnableScreenSaver ( void  )
extern

Allow the screen to be blanked by a screen saver.

Since
This function is available since SDL 2.0.0.
See also
SDL_DisableScreenSaver
SDL_IsScreenSaverEnabled

◆ SDL_FlashWindow()

int SDL_FlashWindow ( SDL_Window window,
SDL_FlashOperation  operation 
)
extern

Request a window to demand attention from the user.

Parameters
windowthe window to be flashed
operationthe flash operation
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.16.

◆ SDL_GetClosestDisplayMode()

SDL_DisplayMode * SDL_GetClosestDisplayMode ( int  displayIndex,
const SDL_DisplayMode mode,
SDL_DisplayMode closest 
)
extern

Get the closest match to the requested display mode.

The available display modes are scanned and closest is filled in with the closest mode matching the requested mode and returned. The mode format and refresh rate default to the desktop mode if they are set to 0. The modes are scanned with size being first priority, format being second priority, and finally checking the refresh rate. If all the available modes are too small, then NULL is returned.

Parameters
displayIndexthe index of the display to query
modean SDL_DisplayMode structure containing the desired display mode
closestan SDL_DisplayMode structure filled in with the closest match of the available display modes
Returns
the passed in value closest or NULL if no matching video mode was available; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetDisplayMode
SDL_GetNumDisplayModes

◆ SDL_GetCurrentDisplayMode()

int SDL_GetCurrentDisplayMode ( int  displayIndex,
SDL_DisplayMode mode 
)
extern

Get information about the current display mode.

There's a difference between this function and SDL_GetDesktopDisplayMode() when SDL runs fullscreen and has changed the resolution. In that case this function will return the current display mode, and not the previous native display mode.

Parameters
displayIndexthe index of the display to query
modean SDL_DisplayMode structure filled in with the current display mode
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetDesktopDisplayMode
SDL_GetDisplayMode
SDL_GetNumVideoDisplays
SDL_SetWindowDisplayMode

◆ SDL_GetCurrentVideoDriver()

const char * SDL_GetCurrentVideoDriver ( void  )
extern

Get the name of the currently initialized video driver.

Returns
the name of the current video driver or NULL if no driver has been initialized.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetNumVideoDrivers
SDL_GetVideoDriver

◆ SDL_GetDesktopDisplayMode()

int SDL_GetDesktopDisplayMode ( int  displayIndex,
SDL_DisplayMode mode 
)
extern

Get information about the desktop's display mode.

There's a difference between this function and SDL_GetCurrentDisplayMode() when SDL runs fullscreen and has changed the resolution. In that case this function will return the previous native display mode, and not the current display mode.

Parameters
displayIndexthe index of the display to query
modean SDL_DisplayMode structure filled in with the current display mode
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetCurrentDisplayMode
SDL_GetDisplayMode
SDL_SetWindowDisplayMode

◆ SDL_GetDisplayBounds()

int SDL_GetDisplayBounds ( int  displayIndex,
SDL_Rect rect 
)
extern

Get the desktop area represented by a display.

The primary display (displayIndex zero) is always located at 0,0.

Parameters
displayIndexthe index of the display to query
rectthe SDL_Rect structure filled in with the display bounds
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetNumVideoDisplays

◆ SDL_GetDisplayDPI()

int SDL_GetDisplayDPI ( int  displayIndex,
float *  ddpi,
float *  hdpi,
float *  vdpi 
)
extern

Get the dots/pixels-per-inch for a display.

Diagonal, horizontal and vertical DPI can all be optionally returned if the appropriate parameter is non-NULL.

A failure of this function usually means that either no DPI information is available or the displayIndex is out of range.

WARNING: This reports the DPI that the hardware reports, and it is not always reliable! It is almost always better to use SDL_GetWindowSize() to find the window size, which might be in logical points instead of pixels, and then SDL_GL_GetDrawableSize(), SDL_Vulkan_GetDrawableSize(), SDL_Metal_GetDrawableSize(), or SDL_GetRendererOutputSize(), and compare the two values to get an actual scaling value between the two. We will be rethinking how high-dpi details should be managed in SDL3 to make things more consistent, reliable, and clear.

Parameters
displayIndexthe index of the display from which DPI information should be queried
ddpia pointer filled in with the diagonal DPI of the display; may be NULL
hdpia pointer filled in with the horizontal DPI of the display; may be NULL
vdpia pointer filled in with the vertical DPI of the display; may be NULL
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.4.
See also
SDL_GetNumVideoDisplays

◆ SDL_GetDisplayMode()

int SDL_GetDisplayMode ( int  displayIndex,
int  modeIndex,
SDL_DisplayMode mode 
)
extern

Get information about a specific display mode.

The display modes are sorted in this priority:

  • width -> largest to smallest
  • height -> largest to smallest
  • bits per pixel -> more colors to fewer colors
  • packed pixel layout -> largest to smallest
  • refresh rate -> highest to lowest
Parameters
displayIndexthe index of the display to query
modeIndexthe index of the display mode to query
modean SDL_DisplayMode structure filled in with the mode at modeIndex
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetNumDisplayModes

◆ SDL_GetDisplayName()

const char * SDL_GetDisplayName ( int  displayIndex)
extern

Get the name of a display in UTF-8 encoding.

Parameters
displayIndexthe index of display from which the name should be queried
Returns
the name of a display or NULL for an invalid display index or failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetNumVideoDisplays

◆ SDL_GetDisplayOrientation()

SDL_DisplayOrientation SDL_GetDisplayOrientation ( int  displayIndex)
extern

Get the orientation of a display.

Parameters
displayIndexthe index of the display to query
Returns
The SDL_DisplayOrientation enum value of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.
Since
This function is available since SDL 2.0.9.
See also
SDL_GetNumVideoDisplays

◆ SDL_GetDisplayUsableBounds()

int SDL_GetDisplayUsableBounds ( int  displayIndex,
SDL_Rect rect 
)
extern

Get the usable desktop area represented by a display.

The primary display (displayIndex zero) is always located at 0,0.

This is the same area as SDL_GetDisplayBounds() reports, but with portions reserved by the system removed. For example, on Apple's macOS, this subtracts the area occupied by the menu bar and dock.

Setting a window to be fullscreen generally bypasses these unusable areas, so these are good guidelines for the maximum space available to a non-fullscreen window.

The parameter rect is ignored if it is NULL.

This function also returns -1 if the parameter displayIndex is out of range.

Parameters
displayIndexthe index of the display to query the usable bounds from
rectthe SDL_Rect structure filled in with the display bounds
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.5.
See also
SDL_GetDisplayBounds
SDL_GetNumVideoDisplays

◆ SDL_GetGrabbedWindow()

SDL_Window * SDL_GetGrabbedWindow ( void  )
extern

Get the window that currently has an input grab enabled.

Returns
the window if input is grabbed or NULL otherwise.
Since
This function is available since SDL 2.0.4.
See also
SDL_GetWindowGrab
SDL_SetWindowGrab

◆ SDL_GetNumDisplayModes()

int SDL_GetNumDisplayModes ( int  displayIndex)
extern

Get the number of available display modes.

The displayIndex needs to be in the range from 0 to SDL_GetNumVideoDisplays() - 1.

Parameters
displayIndexthe index of the display to query
Returns
a number >= 1 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetDisplayMode
SDL_GetNumVideoDisplays

◆ SDL_GetNumVideoDisplays()

int SDL_GetNumVideoDisplays ( void  )
extern

Get the number of available video displays.

Returns
a number >= 1 or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetDisplayBounds

◆ SDL_GetNumVideoDrivers()

int SDL_GetNumVideoDrivers ( void  )
extern

Get the number of video drivers compiled into SDL.

Returns
a number >= 1 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetVideoDriver

◆ SDL_GetPointDisplayIndex()

int SDL_GetPointDisplayIndex ( const SDL_Point point)
extern

Get the index of the display containing a point

Parameters
pointthe point to query
Returns
the index of the display containing the point or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.24.0.
See also
SDL_GetDisplayBounds
SDL_GetNumVideoDisplays

◆ SDL_GetRectDisplayIndex()

int SDL_GetRectDisplayIndex ( const SDL_Rect rect)
extern

Get the index of the display primarily containing a rect

Parameters
rectthe rect to query
Returns
the index of the display entirely containing the rect or closest to the center of the rect on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.24.0.
See also
SDL_GetDisplayBounds
SDL_GetNumVideoDisplays

◆ SDL_GetVideoDriver()

const char * SDL_GetVideoDriver ( int  index)
extern

Get the name of a built in video driver.

The video drivers are presented in the order in which they are normally checked during initialization.

Parameters
indexthe index of a video driver
Returns
the name of the video driver with the given index.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetNumVideoDrivers

◆ SDL_GetWindowBordersSize()

int SDL_GetWindowBordersSize ( SDL_Window window,
int *  top,
int *  left,
int *  bottom,
int *  right 
)
extern

Get the size of a window's borders (decorations) around the client area.

Note: If this function fails (returns -1), the size values will be initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the window in question was borderless.

Note: This function may fail on systems where the window has not yet been decorated by the display server (for example, immediately after calling SDL_CreateWindow). It is recommended that you wait at least until the window has been presented and composited, so that the window system has a chance to decorate the window and provide the border dimensions to SDL.

This function also returns -1 if getting the information is not supported.

Parameters
windowthe window to query the size values of the border (decorations) from
toppointer to variable for storing the size of the top border; NULL is permitted
leftpointer to variable for storing the size of the left border; NULL is permitted
bottompointer to variable for storing the size of the bottom border; NULL is permitted
rightpointer to variable for storing the size of the right border; NULL is permitted
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.5.
See also
SDL_GetWindowSize

◆ SDL_GetWindowBrightness()

float SDL_GetWindowBrightness ( SDL_Window window)
extern

Get the brightness (gamma multiplier) for a given window's display.

Despite the name and signature, this method retrieves the brightness of the entire display, not an individual window. A window is considered to be owned by the display that contains the window's center pixel. (The index of this display can be retrieved using SDL_GetWindowDisplayIndex().)

Parameters
windowthe window used to select the display whose brightness will be queried
Returns
the brightness for the display where 0.0 is completely dark and 1.0 is normal brightness.
Since
This function is available since SDL 2.0.0.
See also
SDL_SetWindowBrightness

◆ SDL_GetWindowData()

void * SDL_GetWindowData ( SDL_Window window,
const char *  name 
)
extern

Retrieve the data pointer associated with a window.

Parameters
windowthe window to query
namethe name of the pointer
Returns
the value associated with name.
Since
This function is available since SDL 2.0.0.
See also
SDL_SetWindowData

◆ SDL_GetWindowDisplayIndex()

int SDL_GetWindowDisplayIndex ( SDL_Window window)
extern

Get the index of the display associated with a window.

Parameters
windowthe window to query
Returns
the index of the display containing the center of the window on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetDisplayBounds
SDL_GetNumVideoDisplays

◆ SDL_GetWindowDisplayMode()

int SDL_GetWindowDisplayMode ( SDL_Window window,
SDL_DisplayMode mode 
)
extern

Query the display mode to use when a window is visible at fullscreen.

Parameters
windowthe window to query
modean SDL_DisplayMode structure filled in with the fullscreen display mode
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_SetWindowDisplayMode
SDL_SetWindowFullscreen

◆ SDL_GetWindowFlags()

Uint32 SDL_GetWindowFlags ( SDL_Window window)
extern

Get the window flags.

Parameters
windowthe window to query
Returns
a mask of the SDL_WindowFlags associated with window
Since
This function is available since SDL 2.0.0.
See also
SDL_CreateWindow
SDL_HideWindow
SDL_MaximizeWindow
SDL_MinimizeWindow
SDL_SetWindowFullscreen
SDL_SetWindowGrab
SDL_ShowWindow

◆ SDL_GetWindowFromID()

SDL_Window * SDL_GetWindowFromID ( Uint32  id)
extern

Get a window from a stored ID.

The numeric ID is what SDL_WindowEvent references, and is necessary to map these events to specific SDL_Window objects.

Parameters
idthe ID of the window
Returns
the window associated with id or NULL if it doesn't exist; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowID

◆ SDL_GetWindowGammaRamp()

int SDL_GetWindowGammaRamp ( SDL_Window window,
Uint16 red,
Uint16 green,
Uint16 blue 
)
extern

Get the gamma ramp for a given window's display.

Despite the name and signature, this method retrieves the gamma ramp of the entire display, not an individual window. A window is considered to be owned by the display that contains the window's center pixel. (The index of this display can be retrieved using SDL_GetWindowDisplayIndex().)

Parameters
windowthe window used to select the display whose gamma ramp will be queried
reda 256 element array of 16-bit quantities filled in with the translation table for the red channel, or NULL
greena 256 element array of 16-bit quantities filled in with the translation table for the green channel, or NULL
bluea 256 element array of 16-bit quantities filled in with the translation table for the blue channel, or NULL
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_SetWindowGammaRamp

◆ SDL_GetWindowGrab()

SDL_bool SDL_GetWindowGrab ( SDL_Window window)
extern

Get a window's input grab mode.

Parameters
windowthe window to query
Returns
SDL_TRUE if input is grabbed, SDL_FALSE otherwise.
Since
This function is available since SDL 2.0.0.
See also
SDL_SetWindowGrab

◆ SDL_GetWindowICCProfile()

void * SDL_GetWindowICCProfile ( SDL_Window window,
size_t *  size 
)
extern

Get the raw ICC profile data for the screen the window is currently on.

Data returned should be freed with SDL_free.

Parameters
windowthe window to query
sizethe size of the ICC profile
Returns
the raw ICC profile data on success or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.18.

◆ SDL_GetWindowID()

Uint32 SDL_GetWindowID ( SDL_Window window)
extern

Get the numeric ID of a window.

The numeric ID is what SDL_WindowEvent references, and is necessary to map these events to specific SDL_Window objects.

Parameters
windowthe window to query
Returns
the ID of the window on success or 0 on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowFromID

◆ SDL_GetWindowKeyboardGrab()

SDL_bool SDL_GetWindowKeyboardGrab ( SDL_Window window)
extern

Get a window's keyboard grab mode.

Parameters
windowthe window to query
Returns
SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise.
Since
This function is available since SDL 2.0.16.
See also
SDL_SetWindowKeyboardGrab
SDL_GetWindowGrab

◆ SDL_GetWindowMaximumSize()

void SDL_GetWindowMaximumSize ( SDL_Window window,
int *  w,
int *  h 
)
extern

Get the maximum size of a window's client area.

Parameters
windowthe window to query
wa pointer filled in with the maximum width of the window, may be NULL
ha pointer filled in with the maximum height of the window, may be NULL
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowMinimumSize
SDL_SetWindowMaximumSize

◆ SDL_GetWindowMinimumSize()

void SDL_GetWindowMinimumSize ( SDL_Window window,
int *  w,
int *  h 
)
extern

Get the minimum size of a window's client area.

Parameters
windowthe window to query
wa pointer filled in with the minimum width of the window, may be NULL
ha pointer filled in with the minimum height of the window, may be NULL
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowMaximumSize
SDL_SetWindowMinimumSize

◆ SDL_GetWindowMouseGrab()

SDL_bool SDL_GetWindowMouseGrab ( SDL_Window window)
extern

Get a window's mouse grab mode.

Parameters
windowthe window to query
Returns
SDL_TRUE if mouse is grabbed, and SDL_FALSE otherwise.
Since
This function is available since SDL 2.0.16.
See also
SDL_SetWindowKeyboardGrab
SDL_GetWindowGrab

◆ SDL_GetWindowMouseRect()

const SDL_Rect * SDL_GetWindowMouseRect ( SDL_Window window)
extern

Get the mouse confinement rectangle of a window.

Parameters
windowThe window to query
Returns
A pointer to the mouse confinement rectangle of a window, or NULL if there isn't one.
Since
This function is available since SDL 2.0.18.
See also
SDL_SetWindowMouseRect

◆ SDL_GetWindowOpacity()

int SDL_GetWindowOpacity ( SDL_Window window,
float *  out_opacity 
)
extern

Get the opacity of a window.

If transparency isn't supported on this platform, opacity will be reported as 1.0f without error.

The parameter opacity is ignored if it is NULL.

This function also returns -1 if an invalid window was provided.

Parameters
windowthe window to get the current opacity value from
out_opacitythe float filled in (0.0f - transparent, 1.0f - opaque)
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.5.
See also
SDL_SetWindowOpacity

◆ SDL_GetWindowPixelFormat()

Uint32 SDL_GetWindowPixelFormat ( SDL_Window window)
extern

Get the pixel format associated with the window.

Parameters
windowthe window to query
Returns
the pixel format of the window on success or SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.

◆ SDL_GetWindowPosition()

void SDL_GetWindowPosition ( SDL_Window window,
int *  x,
int *  y 
)
extern

Get the position of a window.

If you do not need the value for one of the positions a NULL may be passed in the x or y parameter.

Parameters
windowthe window to query
xa pointer filled in with the x position of the window, in screen coordinates, may be NULL
ya pointer filled in with the y position of the window, in screen coordinates, may be NULL
Since
This function is available since SDL 2.0.0.
See also
SDL_SetWindowPosition

◆ SDL_GetWindowSize()

void SDL_GetWindowSize ( SDL_Window window,
int *  w,
int *  h 
)
extern

Get the size of a window's client area.

NULL can safely be passed as the w or h parameter if the width or height value is not desired.

The window size in screen coordinates may differ from the size in pixels, if the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with high-dpi support (e.g. iOS or macOS). Use SDL_GL_GetDrawableSize(), SDL_Vulkan_GetDrawableSize(), or SDL_GetRendererOutputSize() to get the real client area size in pixels.

Parameters
windowthe window to query the width and height from
wa pointer filled in with the width of the window, in screen coordinates, may be NULL
ha pointer filled in with the height of the window, in screen coordinates, may be NULL
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_GetDrawableSize
SDL_Vulkan_GetDrawableSize
SDL_SetWindowSize

◆ SDL_GetWindowSizeInPixels()

void SDL_GetWindowSizeInPixels ( SDL_Window window,
int *  w,
int *  h 
)
extern

Get the size of a window in pixels.

This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with high-DPI support (Apple calls this "Retina"), and not disabled by the SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.

Parameters
windowthe window from which the drawable size should be queried
wa pointer to variable for storing the width in pixels, may be NULL
ha pointer to variable for storing the height in pixels, may be NULL
Since
This function is available since SDL 2.26.0.
See also
SDL_CreateWindow
SDL_GetWindowSize

◆ SDL_GetWindowSurface()

SDL_Surface * SDL_GetWindowSurface ( SDL_Window window)
extern

Get the SDL surface associated with the window.

A new surface will be created with the optimal format for the window, if necessary. This surface will be freed when the window is destroyed. Do not free this surface.

This surface will be invalidated if the window is resized. After resizing a window this function must be called again to return a valid surface.

You may not combine this with 3D or the rendering API on this window.

This function is affected by SDL_HINT_FRAMEBUFFER_ACCELERATION.

Parameters
windowthe window to query
Returns
the surface associated with the window, or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_DestroyWindowSurface
SDL_HasWindowSurface
SDL_UpdateWindowSurface
SDL_UpdateWindowSurfaceRects

◆ SDL_GetWindowTitle()

const char * SDL_GetWindowTitle ( SDL_Window window)
extern

Get the title of a window.

Parameters
windowthe window to query
Returns
the title of the window in UTF-8 format or "" if there is no title.
Since
This function is available since SDL 2.0.0.
See also
SDL_SetWindowTitle

◆ SDL_GL_CreateContext()

SDL_GLContext SDL_GL_CreateContext ( SDL_Window window)
extern

Create an OpenGL context for an OpenGL window, and make it current.

Windows users new to OpenGL should note that, for historical reasons, GL functions added after OpenGL version 1.1 are not available by default. Those functions must be loaded at run-time, either with an OpenGL extension-handling library or with SDL_GL_GetProcAddress() and its related functions.

SDL_GLContext is an alias for void *. It's opaque to the application.

Parameters
windowthe window to associate with the context
Returns
the OpenGL context associated with window or NULL on error; call SDL_GetError() for more details.
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_DeleteContext
SDL_GL_MakeCurrent

◆ SDL_GL_DeleteContext()

void SDL_GL_DeleteContext ( SDL_GLContext  context)
extern

Delete an OpenGL context.

Parameters
contextthe OpenGL context to be deleted
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_CreateContext

◆ SDL_GL_ExtensionSupported()

SDL_bool SDL_GL_ExtensionSupported ( const char *  extension)
extern

Check if an OpenGL extension is supported for the current context.

This function operates on the current GL context; you must have created a context and it must be current before calling this function. Do not assume that all contexts you create will have the same set of extensions available, or that recreating an existing context will offer the same extensions again.

While it's probably not a massive overhead, this function is not an O(1) operation. Check the extensions you care about after creating the GL context and save that information somewhere instead of calling the function every time you need to know.

Parameters
extensionthe name of the extension to check
Returns
SDL_TRUE if the extension is supported, SDL_FALSE otherwise.
Since
This function is available since SDL 2.0.0.

◆ SDL_GL_GetAttribute()

int SDL_GL_GetAttribute ( SDL_GLattr  attr,
int *  value 
)
extern

Get the actual value for an attribute from the current context.

Parameters
attran SDL_GLattr enum value specifying the OpenGL attribute to get
valuea pointer filled in with the current value of attr
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_ResetAttributes
SDL_GL_SetAttribute

◆ SDL_GL_GetCurrentContext()

SDL_GLContext SDL_GL_GetCurrentContext ( void  )
extern

Get the currently active OpenGL context.

Returns
the currently active OpenGL context or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_MakeCurrent

◆ SDL_GL_GetCurrentWindow()

SDL_Window * SDL_GL_GetCurrentWindow ( void  )
extern

Get the currently active OpenGL window.

Returns
the currently active OpenGL window on success or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.

◆ SDL_GL_GetDrawableSize()

void SDL_GL_GetDrawableSize ( SDL_Window window,
int *  w,
int *  h 
)
extern

Get the size of a window's underlying drawable in pixels.

This returns info useful for calling glViewport().

This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with high-DPI support (Apple calls this "Retina"), and not disabled by the SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.

Parameters
windowthe window from which the drawable size should be queried
wa pointer to variable for storing the width in pixels, may be NULL
ha pointer to variable for storing the height in pixels, may be NULL
Since
This function is available since SDL 2.0.1.
See also
SDL_CreateWindow
SDL_GetWindowSize

◆ SDL_GL_GetProcAddress()

void * SDL_GL_GetProcAddress ( const char *  proc)
extern

Get an OpenGL function by name.

If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all GL functions must be retrieved this way. Usually this is used to retrieve function pointers to OpenGL extensions.

There are some quirks to looking up OpenGL functions that require some extra care from the application. If you code carefully, you can handle these quirks without any platform-specific code, though:

  • On Windows, function pointers are specific to the current GL context; this means you need to have created a GL context and made it current before calling SDL_GL_GetProcAddress(). If you recreate your context or create a second context, you should assume that any existing function pointers aren't valid to use with it. This is (currently) a Windows-specific limitation, and in practice lots of drivers don't suffer this limitation, but it is still the way the wgl API is documented to work and you should expect crashes if you don't respect it. Store a copy of the function pointers that comes and goes with context lifespan.
  • On X11, function pointers returned by this function are valid for any context, and can even be looked up before a context is created at all. This means that, for at least some common OpenGL implementations, if you look up a function that doesn't exist, you'll get a non-NULL result that is NOT safe to call. You must always make sure the function is actually available for a given GL context before calling it, by checking for the existence of the appropriate extension with SDL_GL_ExtensionSupported(), or verifying that the version of OpenGL you're using offers the function as core functionality.
  • Some OpenGL drivers, on all platforms, will return NULL if a function isn't supported, but you can't count on this behavior. Check for extensions you use, and if you get a NULL anyway, act as if that extension wasn't available. This is probably a bug in the driver, but you can code defensively for this scenario anyhow.
  • Just because you're on Linux/Unix, don't assume you'll be using X11. Next-gen display servers are waiting to replace it, and may or may not make the same promises about function pointers.
  • OpenGL function pointers must be declared APIENTRY as in the example code. This will ensure the proper calling convention is followed on platforms where this matters (Win32) thereby avoiding stack corruption.
Parameters
procthe name of an OpenGL function
Returns
a pointer to the named OpenGL function. The returned pointer should be cast to the appropriate function signature.
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_ExtensionSupported
SDL_GL_LoadLibrary
SDL_GL_UnloadLibrary

◆ SDL_GL_GetSwapInterval()

int SDL_GL_GetSwapInterval ( void  )
extern

Get the swap interval for the current OpenGL context.

If the system can't determine the swap interval, or there isn't a valid current context, this function will return 0 as a safe default.

Returns
0 if there is no vertical retrace synchronization, 1 if the buffer swap is synchronized with the vertical retrace, and -1 if late swaps happen immediately instead of waiting for the next retrace; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_SetSwapInterval

◆ SDL_GL_LoadLibrary()

int SDL_GL_LoadLibrary ( const char *  path)
extern

Dynamically load an OpenGL library.

This should be done after initializing the video driver, but before creating any OpenGL windows. If no OpenGL library is loaded, the default library will be loaded upon creation of the first OpenGL window.

If you do this, you need to retrieve all of the GL functions used in your program from the dynamic library using SDL_GL_GetProcAddress().

Parameters
paththe platform dependent OpenGL library name, or NULL to open the default OpenGL library
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_GetProcAddress
SDL_GL_UnloadLibrary

◆ SDL_GL_MakeCurrent()

int SDL_GL_MakeCurrent ( SDL_Window window,
SDL_GLContext  context 
)
extern

Set up an OpenGL context for rendering into an OpenGL window.

The context must have been created with a compatible window.

Parameters
windowthe window to associate with the context
contextthe OpenGL context to associate with the window
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_CreateContext

◆ SDL_GL_ResetAttributes()

void SDL_GL_ResetAttributes ( void  )
extern

Reset all previously set OpenGL context attributes to their default values.

Since
This function is available since SDL 2.0.2.
See also
SDL_GL_GetAttribute
SDL_GL_SetAttribute

◆ SDL_GL_SetAttribute()

int SDL_GL_SetAttribute ( SDL_GLattr  attr,
int  value 
)
extern

Set an OpenGL window attribute before window creation.

This function sets the OpenGL attribute attr to value. The requested attributes should be set before creating an OpenGL window. You should use SDL_GL_GetAttribute() to check the values after creating the OpenGL context, since the values obtained can differ from the requested ones.

Parameters
attran SDL_GLattr enum value specifying the OpenGL attribute to set
valuethe desired value for the attribute
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_GetAttribute
SDL_GL_ResetAttributes

◆ SDL_GL_SetSwapInterval()

int SDL_GL_SetSwapInterval ( int  interval)
extern

Set the swap interval for the current OpenGL context.

Some systems allow specifying -1 for the interval, to enable adaptive vsync. Adaptive vsync works the same as vsync, but if you've already missed the vertical retrace for a given frame, it swaps buffers immediately, which might be less jarring for the user during occasional framerate drops. If an application requests adaptive vsync and the system does not support it, this function will fail and return -1. In such a case, you should probably retry the call with 1 for the interval.

Adaptive vsync is implemented for some glX drivers with GLX_EXT_swap_control_tear, and for some Windows drivers with WGL_EXT_swap_control_tear.

Read more on the Khronos wiki: https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync

Parameters
interval0 for immediate updates, 1 for updates synchronized with the vertical retrace, -1 for adaptive vsync
Returns
0 on success or -1 if setting the swap interval is not supported; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GL_GetSwapInterval

◆ SDL_GL_SwapWindow()

void SDL_GL_SwapWindow ( SDL_Window window)
extern

Update a window with OpenGL rendering.

This is used with double-buffered OpenGL contexts, which are the default.

On macOS, make sure you bind 0 to the draw framebuffer before swapping the window, otherwise nothing will happen. If you aren't using glBindFramebuffer(), this is the default and you won't have to do anything extra.

Parameters
windowthe window to change
Since
This function is available since SDL 2.0.0.

◆ SDL_GL_UnloadLibrary()

void SDL_GL_UnloadLibrary ( void  )
extern

Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().

Since
This function is available since SDL 2.0.0.
See also
SDL_GL_LoadLibrary

◆ SDL_HasWindowSurface()

SDL_bool SDL_HasWindowSurface ( SDL_Window window)
extern

Return whether the window has a surface associated with it.

Returns
SDL_TRUE if there is a surface associated with the window, or SDL_FALSE otherwise.
Since
This function is available since SDL 2.28.0.
See also
SDL_GetWindowSurface

◆ SDL_HideWindow()

void SDL_HideWindow ( SDL_Window window)
extern

Hide a window.

Parameters
windowthe window to hide
Since
This function is available since SDL 2.0.0.
See also
SDL_ShowWindow

◆ SDL_IsScreenSaverEnabled()

SDL_bool SDL_IsScreenSaverEnabled ( void  )
extern

Check whether the screensaver is currently enabled.

The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2 the screensaver was enabled by default.

The default can also be changed using SDL_HINT_VIDEO_ALLOW_SCREENSAVER.

Returns
SDL_TRUE if the screensaver is enabled, SDL_FALSE if it is disabled.
Since
This function is available since SDL 2.0.0.
See also
SDL_DisableScreenSaver
SDL_EnableScreenSaver

◆ SDL_MaximizeWindow()

void SDL_MaximizeWindow ( SDL_Window window)
extern

Make a window as large as possible.

Parameters
windowthe window to maximize
Since
This function is available since SDL 2.0.0.
See also
SDL_MinimizeWindow
SDL_RestoreWindow

◆ SDL_MinimizeWindow()

void SDL_MinimizeWindow ( SDL_Window window)
extern

Minimize a window to an iconic representation.

Parameters
windowthe window to minimize
Since
This function is available since SDL 2.0.0.
See also
SDL_MaximizeWindow
SDL_RestoreWindow

◆ SDL_RaiseWindow()

void SDL_RaiseWindow ( SDL_Window window)
extern

Raise a window above other windows and set the input focus.

Parameters
windowthe window to raise
Since
This function is available since SDL 2.0.0.

◆ SDL_RestoreWindow()

void SDL_RestoreWindow ( SDL_Window window)
extern

Restore the size and position of a minimized or maximized window.

Parameters
windowthe window to restore
Since
This function is available since SDL 2.0.0.
See also
SDL_MaximizeWindow
SDL_MinimizeWindow

◆ SDL_SetWindowAlwaysOnTop()

void SDL_SetWindowAlwaysOnTop ( SDL_Window window,
SDL_bool  on_top 
)
extern

Set the window to always be above the others.

This will add or remove the window's SDL_WINDOW_ALWAYS_ON_TOP flag. This will bring the window to the front and keep the window above the rest.

Parameters
windowThe window of which to change the always on top state
on_topSDL_TRUE to set the window always on top, SDL_FALSE to disable
Since
This function is available since SDL 2.0.16.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowBordered()

void SDL_SetWindowBordered ( SDL_Window window,
SDL_bool  bordered 
)
extern

Set the border state of a window.

This will add or remove the window's SDL_WINDOW_BORDERLESS flag and add or remove the border from the actual window. This is a no-op if the window's border already matches the requested state.

You can't change the border state of a fullscreen window.

Parameters
windowthe window of which to change the border state
borderedSDL_FALSE to remove border, SDL_TRUE to add border
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowBrightness()

int SDL_SetWindowBrightness ( SDL_Window window,
float  brightness 
)
extern

Set the brightness (gamma multiplier) for a given window's display.

Despite the name and signature, this method sets the brightness of the entire display, not an individual window. A window is considered to be owned by the display that contains the window's center pixel. (The index of this display can be retrieved using SDL_GetWindowDisplayIndex().) The brightness set will not follow the window if it is moved to another display.

Many platforms will refuse to set the display brightness in modern times. You are better off using a shader to adjust gamma during rendering, or something similar.

Parameters
windowthe window used to select the display whose brightness will be changed
brightnessthe brightness (gamma multiplier) value to set where 0.0 is completely dark and 1.0 is normal brightness
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowBrightness
SDL_SetWindowGammaRamp

◆ SDL_SetWindowData()

void * SDL_SetWindowData ( SDL_Window window,
const char *  name,
void *  userdata 
)
extern

Associate an arbitrary named pointer with a window.

name is case-sensitive.

Parameters
windowthe window to associate with the pointer
namethe name of the pointer
userdatathe associated pointer
Returns
the previous value associated with name.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowData

◆ SDL_SetWindowDisplayMode()

int SDL_SetWindowDisplayMode ( SDL_Window window,
const SDL_DisplayMode mode 
)
extern

Set the display mode to use when a window is visible at fullscreen.

This only affects the display mode used when the window is fullscreen. To change the window size when the window is not fullscreen, use SDL_SetWindowSize().

Parameters
windowthe window to affect
modethe SDL_DisplayMode structure representing the mode to use, or NULL to use the window's dimensions and the desktop's format and refresh rate
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowDisplayMode
SDL_SetWindowFullscreen

◆ SDL_SetWindowFullscreen()

int SDL_SetWindowFullscreen ( SDL_Window window,
Uint32  flags 
)
extern

Set a window's fullscreen state.

flags may be SDL_WINDOW_FULLSCREEN, for "real" fullscreen with a videomode change; SDL_WINDOW_FULLSCREEN_DESKTOP for "fake" fullscreen that takes the size of the desktop; and 0 for windowed mode.

Parameters
windowthe window to change
flagsSDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP or 0
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowDisplayMode
SDL_SetWindowDisplayMode

◆ SDL_SetWindowGammaRamp()

int SDL_SetWindowGammaRamp ( SDL_Window window,
const Uint16 red,
const Uint16 green,
const Uint16 blue 
)
extern

Set the gamma ramp for the display that owns a given window.

Set the gamma translation table for the red, green, and blue channels of the video hardware. Each table is an array of 256 16-bit quantities, representing a mapping between the input and output for that channel. The input is the index into the array, and the output is the 16-bit gamma value at that index, scaled to the output color precision.

Despite the name and signature, this method sets the gamma ramp of the entire display, not an individual window. A window is considered to be owned by the display that contains the window's center pixel. (The index of this display can be retrieved using SDL_GetWindowDisplayIndex().) The gamma ramp set will not follow the window if it is moved to another display.

Parameters
windowthe window used to select the display whose gamma ramp will be changed
reda 256 element array of 16-bit quantities representing the translation table for the red channel, or NULL
greena 256 element array of 16-bit quantities representing the translation table for the green channel, or NULL
bluea 256 element array of 16-bit quantities representing the translation table for the blue channel, or NULL
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowGammaRamp

◆ SDL_SetWindowGrab()

void SDL_SetWindowGrab ( SDL_Window window,
SDL_bool  grabbed 
)
extern

Set a window's input grab mode.

When input is grabbed, the mouse is confined to the window. This function will also grab the keyboard if SDL_HINT_GRAB_KEYBOARD is set. To grab the keyboard without also grabbing the mouse, use SDL_SetWindowKeyboardGrab().

If the caller enables a grab while another window is currently grabbed, the other window loses its grab in favor of the caller's window.

Parameters
windowthe window for which the input grab mode should be set
grabbedSDL_TRUE to grab input or SDL_FALSE to release input
Since
This function is available since SDL 2.0.0.
See also
SDL_GetGrabbedWindow
SDL_GetWindowGrab

◆ SDL_SetWindowHitTest()

int SDL_SetWindowHitTest ( SDL_Window window,
SDL_HitTest  callback,
void *  callback_data 
)
extern

Provide a callback that decides if a window region has special properties.

Normally windows are dragged and resized by decorations provided by the system window manager (a title bar, borders, etc), but for some apps, it makes sense to drag them from somewhere else inside the window itself; for example, one might have a borderless window that wants to be draggable from any part, or simulate its own title bar, etc.

This function lets the app provide a callback that designates pieces of a given window as special. This callback is run during event processing if we need to tell the OS to treat a region of the window specially; the use of this callback is known as "hit testing."

Mouse input may not be delivered to your application if it is within a special area; the OS will often apply that input to moving the window or resizing the window and not deliver it to the application.

Specifying NULL for a callback disables hit-testing. Hit-testing is disabled by default.

Platforms that don't support this functionality will return -1 unconditionally, even if you're attempting to disable hit-testing.

Your callback may fire at any time, and its firing does not indicate any specific behavior (for example, on Windows, this certainly might fire when the OS is deciding whether to drag your window, but it fires for lots of other reasons, too, some unrelated to anything you probably care about and when the mouse isn't actually at the location it is testing). Since this can fire at any time, you should try to keep your callback efficient, devoid of allocations, etc.

Parameters
windowthe window to set hit-testing on
callbackthe function to call when doing a hit-test
callback_dataan app-defined void pointer passed to callback
Returns
0 on success or -1 on error (including unsupported); call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.4.

◆ SDL_SetWindowIcon()

void SDL_SetWindowIcon ( SDL_Window window,
SDL_Surface icon 
)
extern

Set the icon for a window.

Parameters
windowthe window to change
iconan SDL_Surface structure containing the icon for the window
Since
This function is available since SDL 2.0.0.

◆ SDL_SetWindowInputFocus()

int SDL_SetWindowInputFocus ( SDL_Window window)
extern

Explicitly set input focus to the window.

You almost certainly want SDL_RaiseWindow() instead of this function. Use this with caution, as you might give focus to a window that is completely obscured by other windows.

Parameters
windowthe window that should get the input focus
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.5.
See also
SDL_RaiseWindow

◆ SDL_SetWindowKeyboardGrab()

void SDL_SetWindowKeyboardGrab ( SDL_Window window,
SDL_bool  grabbed 
)
extern

Set a window's keyboard grab mode.

Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or the Meta/Super key. Note that not all system keyboard shortcuts can be captured by applications (one example is Ctrl+Alt+Del on Windows).

This is primarily intended for specialized applications such as VNC clients or VM frontends. Normal games should not use keyboard grab.

When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the window is full-screen to ensure the user is not trapped in your application. If you have a custom keyboard shortcut to exit fullscreen mode, you may suppress this behavior with SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED.

If the caller enables a grab while another window is currently grabbed, the other window loses its grab in favor of the caller's window.

Parameters
windowThe window for which the keyboard grab mode should be set.
grabbedThis is SDL_TRUE to grab keyboard, and SDL_FALSE to release.
Since
This function is available since SDL 2.0.16.
See also
SDL_GetWindowKeyboardGrab
SDL_SetWindowMouseGrab
SDL_SetWindowGrab

◆ SDL_SetWindowMaximumSize()

void SDL_SetWindowMaximumSize ( SDL_Window window,
int  max_w,
int  max_h 
)
extern

Set the maximum size of a window's client area.

Parameters
windowthe window to change
max_wthe maximum width of the window in pixels
max_hthe maximum height of the window in pixels
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowMaximumSize
SDL_SetWindowMinimumSize

◆ SDL_SetWindowMinimumSize()

void SDL_SetWindowMinimumSize ( SDL_Window window,
int  min_w,
int  min_h 
)
extern

Set the minimum size of a window's client area.

Parameters
windowthe window to change
min_wthe minimum width of the window in pixels
min_hthe minimum height of the window in pixels
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowMinimumSize
SDL_SetWindowMaximumSize

◆ SDL_SetWindowModalFor()

int SDL_SetWindowModalFor ( SDL_Window modal_window,
SDL_Window parent_window 
)
extern

Set the window as a modal for another window.

Parameters
modal_windowthe window that should be set modal
parent_windowthe parent window for the modal window
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.5.

◆ SDL_SetWindowMouseGrab()

void SDL_SetWindowMouseGrab ( SDL_Window window,
SDL_bool  grabbed 
)
extern

Set a window's mouse grab mode.

Mouse grab confines the mouse cursor to the window.

Parameters
windowThe window for which the mouse grab mode should be set.
grabbedThis is SDL_TRUE to grab mouse, and SDL_FALSE to release.
Since
This function is available since SDL 2.0.16.
See also
SDL_GetWindowMouseGrab
SDL_SetWindowKeyboardGrab
SDL_SetWindowGrab

◆ SDL_SetWindowMouseRect()

int SDL_SetWindowMouseRect ( SDL_Window window,
const SDL_Rect rect 
)
extern

Confines the cursor to the specified area of a window.

Note that this does NOT grab the cursor, it only defines the area a cursor is restricted to when the window has mouse focus.

Parameters
windowThe window that will be associated with the barrier.
rectA rectangle area in window-relative coordinates. If NULL the barrier for the specified window will be destroyed.
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.18.
See also
SDL_GetWindowMouseRect
SDL_SetWindowMouseGrab

◆ SDL_SetWindowOpacity()

int SDL_SetWindowOpacity ( SDL_Window window,
float  opacity 
)
extern

Set the opacity for a window.

The parameter opacity will be clamped internally between 0.0f (transparent) and 1.0f (opaque).

This function also returns -1 if setting the opacity isn't supported.

Parameters
windowthe window which will be made transparent or opaque
opacitythe opacity value (0.0f - transparent, 1.0f - opaque)
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.5.
See also
SDL_GetWindowOpacity

◆ SDL_SetWindowPosition()

void SDL_SetWindowPosition ( SDL_Window window,
int  x,
int  y 
)
extern

Set the position of a window.

The window coordinate origin is the upper left of the display.

Parameters
windowthe window to reposition
xthe x coordinate of the window in screen coordinates, or SDL_WINDOWPOS_CENTERED or SDL_WINDOWPOS_UNDEFINED
ythe y coordinate of the window in screen coordinates, or SDL_WINDOWPOS_CENTERED or SDL_WINDOWPOS_UNDEFINED
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowPosition

◆ SDL_SetWindowResizable()

void SDL_SetWindowResizable ( SDL_Window window,
SDL_bool  resizable 
)
extern

Set the user-resizable state of a window.

This will add or remove the window's SDL_WINDOW_RESIZABLE flag and allow/disallow user resizing of the window. This is a no-op if the window's resizable state already matches the requested state.

You can't change the resizable state of a fullscreen window.

Parameters
windowthe window of which to change the resizable state
resizableSDL_TRUE to allow resizing, SDL_FALSE to disallow
Since
This function is available since SDL 2.0.5.
See also
SDL_GetWindowFlags

◆ SDL_SetWindowSize()

void SDL_SetWindowSize ( SDL_Window window,
int  w,
int  h 
)
extern

Set the size of a window's client area.

The window size in screen coordinates may differ from the size in pixels, if the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with high-dpi support (e.g. iOS or macOS). Use SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() to get the real client area size in pixels.

Fullscreen windows automatically match the size of the display mode, and you should use SDL_SetWindowDisplayMode() to change their size.

Parameters
windowthe window to change
wthe width of the window in pixels, in screen coordinates, must be > 0
hthe height of the window in pixels, in screen coordinates, must be > 0
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowSize
SDL_SetWindowDisplayMode

◆ SDL_SetWindowTitle()

void SDL_SetWindowTitle ( SDL_Window window,
const char *  title 
)
extern

Set the title of a window.

This string is expected to be in UTF-8 encoding.

Parameters
windowthe window to change
titlethe desired window title in UTF-8 format
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowTitle

◆ SDL_ShowWindow()

void SDL_ShowWindow ( SDL_Window window)
extern

Show a window.

Parameters
windowthe window to show
Since
This function is available since SDL 2.0.0.
See also
SDL_HideWindow
SDL_RaiseWindow

◆ SDL_UpdateWindowSurface()

int SDL_UpdateWindowSurface ( SDL_Window window)
extern

Copy the window surface to the screen.

This is the function you use to reflect any changes to the surface on the screen.

This function is equivalent to the SDL 1.2 API SDL_Flip().

Parameters
windowthe window to update
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowSurface
SDL_UpdateWindowSurfaceRects

◆ SDL_UpdateWindowSurfaceRects()

int SDL_UpdateWindowSurfaceRects ( SDL_Window window,
const SDL_Rect rects,
int  numrects 
)
extern

Copy areas of the window surface to the screen.

This is the function you use to reflect changes to portions of the surface on the screen.

This function is equivalent to the SDL 1.2 API SDL_UpdateRects().

Note that this function will update at least the rectangles specified, but this is only intended as an optimization; in practice, this might update more of the screen (or all of the screen!), depending on what method SDL uses to send pixels to the system.

Parameters
windowthe window to update
rectsan array of SDL_Rect structures representing areas of the surface to copy, in pixels
numrectsthe number of rectangles
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetWindowSurface
SDL_UpdateWindowSurface

◆ SDL_VideoInit()

int SDL_VideoInit ( const char *  driver_name)
extern

Initialize the video subsystem, optionally specifying a video driver.

This function initializes the video subsystem, setting up a connection to the window manager, etc, and determines the available display modes and pixel formats, but does not initialize a window or graphics mode.

If you use this function and you haven't used the SDL_INIT_VIDEO flag with either SDL_Init() or SDL_InitSubSystem(), you should call SDL_VideoQuit() before calling SDL_Quit().

It is safe to call this function multiple times. SDL_VideoInit() will call SDL_VideoQuit() itself if the video subsystem has already been initialized.

You can use SDL_GetNumVideoDrivers() and SDL_GetVideoDriver() to find a specific driver_name.

Parameters
driver_namethe name of a video driver to initialize, or NULL for the default driver
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.
See also
SDL_GetNumVideoDrivers
SDL_GetVideoDriver
SDL_InitSubSystem
SDL_VideoQuit

◆ SDL_VideoQuit()

void SDL_VideoQuit ( void  )
extern

Shut down the video subsystem, if initialized with SDL_VideoInit().

This function closes all windows, and restores the original video mode.

Since
This function is available since SDL 2.0.0.
See also
SDL_VideoInit