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
 

Macros

#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u
 
#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
 
#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
 
typedef void * SDL_GLContext
 
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
}
 
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
}
 
enum  SDL_DisplayEventID {
  SDL_DISPLAYEVENT_NONE ,
  SDL_DISPLAYEVENT_ORIENTATION ,
  SDL_DISPLAYEVENT_CONNECTED ,
  SDL_DISPLAYEVENT_DISCONNECTED ,
  SDL_DISPLAYEVENT_MOVED
}
 
enum  SDL_DisplayOrientation {
  SDL_ORIENTATION_UNKNOWN ,
  SDL_ORIENTATION_LANDSCAPE ,
  SDL_ORIENTATION_LANDSCAPE_FLIPPED ,
  SDL_ORIENTATION_PORTRAIT ,
  SDL_ORIENTATION_PORTRAIT_FLIPPED
}
 
enum  SDL_FlashOperation {
  SDL_FLASH_CANCEL ,
  SDL_FLASH_BRIEFLY ,
  SDL_FLASH_UNTIL_FOCUSED
}
 
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
}
 
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)
 

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

◆ 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.

See also
SDL_GL_CreateContext

Definition at line 221 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 1779 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.

While you can set most OpenGL attributes normally, the attributes listed above must be known before SDL creates the window that will be used with the OpenGL context. These attributes are set and read with SDL_GL_SetAttribute and SDL_GL_GetAttribute.

In some cases, these attributes are minimum requests; the GL does not promise to give you exactly what you asked for. It's possible to ask for a 16-bit depth buffer and get a 24-bit one instead, for example, or to ask for no stencil buffer and still have one available. Context creation should fail if the GL can't provide your requested attributes at a minimum, but you should check to see exactly what you got.

Multisample anti-aliasing is a type of full screen anti-aliasing. Multipsampling defaults to off but can be turned on by setting SDL_GL_MULTISAMPLEBUFFERS to 1 and SDL_GL_MULTISAMPLESAMPLES to a value greater than 0. Typical values are 2 and 4.

SDL_GL_CONTEXT_PROFILE_MASK determines the type of context created, while both SDL_GL_CONTEXT_MAJOR_VERSION and SDL_GL_CONTEXT_MINOR_VERSION determine which version. All three attributes must be set prior to creating the first window, and in general you can't change the value of SDL_GL_CONTEXT_PROFILE_MASK without first destroying all windows created with the previous setting.

SDL_GL_CONTEXT_RELEASE_BEHAVIOR can be set to SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE or SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH.

Enumerator
SDL_GL_RED_SIZE 

the minimum number of bits for the red channel of the color buffer; defaults to 3.

SDL_GL_GREEN_SIZE 

the minimum number of bits for the green channel of the color buffer; defaults to 3.

SDL_GL_BLUE_SIZE 

the minimum number of bits for the blue channel of the color buffer; defaults to 2.

SDL_GL_ALPHA_SIZE 

the minimum number of bits for the alpha channel of the color buffer; defaults to 0.

SDL_GL_BUFFER_SIZE 

the minimum number of bits for frame buffer size; defaults to 0.

SDL_GL_DOUBLEBUFFER 

whether the output is single or double buffered; defaults to double buffering on.

SDL_GL_DEPTH_SIZE 

the minimum number of bits in the depth buffer; defaults to 16.

SDL_GL_STENCIL_SIZE 

the minimum number of bits in the stencil buffer; defaults to 0.

SDL_GL_ACCUM_RED_SIZE 

the minimum number of bits for the red channel of the accumulation buffer; defaults to 0.

SDL_GL_ACCUM_GREEN_SIZE 

the minimum number of bits for the green channel of the accumulation buffer; defaults to 0.

SDL_GL_ACCUM_BLUE_SIZE 

the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0.

SDL_GL_ACCUM_ALPHA_SIZE 

the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0.

SDL_GL_STEREO 

whether the output is stereo 3D; defaults to off.

SDL_GL_MULTISAMPLEBUFFERS 

the number of buffers used for multisample anti-aliasing; defaults to 0.

SDL_GL_MULTISAMPLESAMPLES 

the number of samples used around the current pixel used for multisample anti-aliasing.

SDL_GL_ACCELERATED_VISUAL 

set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either.

SDL_GL_RETAINED_BACKING 

not used (deprecated).

SDL_GL_CONTEXT_MAJOR_VERSION 

OpenGL context major version.

SDL_GL_CONTEXT_MINOR_VERSION 

OpenGL context minor version.

SDL_GL_CONTEXT_EGL 

deprecated: set SDL_GL_CONTEXT_PROFILE_MASK to SDL_GL_CONTEXT_PROFILE_ES to enable instead.

SDL_GL_CONTEXT_FLAGS 

some combination of 0 or more of elements of the SDL_GLcontextFlag enumeration; defaults to 0.

SDL_GL_CONTEXT_PROFILE_MASK 

type of GL context (Core, Compatibility, ES). See SDL_GLprofile; default value depends on platform.

SDL_GL_SHARE_WITH_CURRENT_CONTEXT 

OpenGL context sharing; defaults to 0.

SDL_GL_FRAMEBUFFER_SRGB_CAPABLE 

requests sRGB capable visual; defaults to 0. (>= SDL 2.0.1)

SDL_GL_CONTEXT_RELEASE_BEHAVIOR 

sets context the release behavior; defaults to 1. (>= SDL 2.0.4)

SDL_GL_CONTEXT_RESET_NOTIFICATION 
SDL_GL_CONTEXT_NO_ERROR 
SDL_GL_FLOATBUFFERS 

Definition at line 256 of file SDL_video.h.

257{
258 SDL_GL_RED_SIZE, /**< the minimum number of bits for the red channel of the color buffer; defaults to 3. */
259 SDL_GL_GREEN_SIZE, /**< the minimum number of bits for the green channel of the color buffer; defaults to 3. */
260 SDL_GL_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the color buffer; defaults to 2. */
261 SDL_GL_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the color buffer; defaults to 0. */
262 SDL_GL_BUFFER_SIZE, /**< the minimum number of bits for frame buffer size; defaults to 0. */
263 SDL_GL_DOUBLEBUFFER, /**< whether the output is single or double buffered; defaults to double buffering on. */
264 SDL_GL_DEPTH_SIZE, /**< the minimum number of bits in the depth buffer; defaults to 16. */
265 SDL_GL_STENCIL_SIZE, /**< the minimum number of bits in the stencil buffer; defaults to 0. */
266 SDL_GL_ACCUM_RED_SIZE, /**< the minimum number of bits for the red channel of the accumulation buffer; defaults to 0. */
267 SDL_GL_ACCUM_GREEN_SIZE, /**< the minimum number of bits for the green channel of the accumulation buffer; defaults to 0. */
268 SDL_GL_ACCUM_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0. */
269 SDL_GL_ACCUM_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0. */
270 SDL_GL_STEREO, /**< whether the output is stereo 3D; defaults to off. */
271 SDL_GL_MULTISAMPLEBUFFERS, /**< the number of buffers used for multisample anti-aliasing; defaults to 0. */
272 SDL_GL_MULTISAMPLESAMPLES, /**< the number of samples used around the current pixel used for multisample anti-aliasing. */
273 SDL_GL_ACCELERATED_VISUAL, /**< set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either. */
274 SDL_GL_RETAINED_BACKING, /**< not used (deprecated). */
275 SDL_GL_CONTEXT_MAJOR_VERSION, /**< OpenGL context major version. */
276 SDL_GL_CONTEXT_MINOR_VERSION, /**< OpenGL context minor version. */
277 SDL_GL_CONTEXT_EGL, /**< deprecated: set SDL_GL_CONTEXT_PROFILE_MASK to SDL_GL_CONTEXT_PROFILE_ES to enable instead. */
278 SDL_GL_CONTEXT_FLAGS, /**< some combination of 0 or more of elements of the SDL_GLcontextFlag enumeration; defaults to 0. */
279 SDL_GL_CONTEXT_PROFILE_MASK, /**< type of GL context (Core, Compatibility, ES). See SDL_GLprofile; default value depends on platform. */
280 SDL_GL_SHARE_WITH_CURRENT_CONTEXT, /**< OpenGL context sharing; defaults to 0. */
281 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, /**< requests sRGB capable visual; defaults to 0. (>= SDL 2.0.1) */
282 SDL_GL_CONTEXT_RELEASE_BEHAVIOR, /**< sets context the release behavior; defaults to 1. (>= SDL 2.0.4) */
286} SDL_GLattr;

◆ 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 295 of file SDL_video.h.

◆ SDL_GLcontextReleaseFlag

Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 

Definition at line 303 of file SDL_video.h.

◆ SDL_GLContextResetNotification

Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 

Definition at line 309 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 288 of file SDL_video.h.

289{
292 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 1755 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
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 SDL_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.

Note that on some platforms the pixels pointer of the surface may be modified after each call to SDL_UpdateWindowSurface(), so that the platform code can implement efficient double or triple buffering.

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.

Note that for some renderers, this function may trigger an SDL_RENDER_TARGETS_RESET event. Your application should be prepared to handle this event by reuploading textures!

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