SDL_video.h File Reference

An opaque handle to an OpenGL context.

Definition at line 161 of file SDL_video.h.

The type used to identify a window.

See also:

SDL_CreateWindow()

SDL_CreateWindowFrom()

SDL_DestroyWindow()

SDL_GetWindowData()

SDL_GetWindowFlags()

SDL_GetWindowGrab()

SDL_GetWindowPosition()

SDL_GetWindowSize()

SDL_GetWindowTitle()

SDL_HideWindow()

SDL_MaximizeWindow()

SDL_MinimizeWindow()

SDL_RaiseWindow()

SDL_RestoreWindow()

SDL_SetWindowData()

SDL_SetWindowFullscreen()

SDL_SetWindowGrab()

SDL_SetWindowIcon()

SDL_SetWindowPosition()

SDL_SetWindowSize()

SDL_SetWindowBordered()

SDL_SetWindowTitle()

SDL_ShowWindow()

Definition at line 89 of file SDL_video.h.

OpenGL configuration attributes.

Definition at line 166 of file SDL_video.h.

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.

Definition at line 135 of file SDL_video.h.

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_INPUT_GRABBED	window has grabbed input focus
SDL_WINDOW_INPUT_FOCUS	window has input focus
SDL_WINDOW_MOUSE_FOCUS	window has mouse focus
SDL_WINDOW_FOREIGN	window not created by SDL
SDL_WINDOW_ALLOW_HIGHDPI	window should be created in high-DPI mode if supported

Definition at line 96 of file SDL_video.h.

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

Parameters:

title	The title of the window, in UTF-8 encoding.
x	The x position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.
y	The y position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.
w	The width of the window.
h	The height of the window.
flags	The flags for the window, a mask of any of the following: SDL_WINDOW_FULLSCREEN, SDL_WINDOW_OPENGL, SDL_WINDOW_HIDDEN, SDL_WINDOW_BORDERLESS, SDL_WINDOW_RESIZABLE, SDL_WINDOW_MAXIMIZED, SDL_WINDOW_MINIMIZED, SDL_WINDOW_INPUT_GRABBED, SDL_WINDOW_ALLOW_HIGHDPI.

Returns:

The id of the window created, or zero if window creation failed.

See also:

SDL_DestroyWindow()

Create an SDL window from an existing native window.

Parameters:

data	A pointer to driver-dependent window creation data

Returns:

The id of the window created, or zero if window creation failed.

See also:

SDL_DestroyWindow()

Destroy a window.

Prevent the screen from being blanked by a screensaver.

See also:

SDL_IsScreenSaverEnabled()

SDL_EnableScreenSaver()

Allow the screen to be blanked by a screensaver.

See also:

SDL_IsScreenSaverEnabled()

SDL_DisableScreenSaver()

Get the closest match to the requested display mode.

Parameters:

displayIndex	The index of display from which mode should be queried.
mode	The desired display mode
closest	A pointer to a display mode to be 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.

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

See also:

SDL_GetNumDisplayModes()

SDL_GetDisplayMode()

Fill in information about the current display mode.

Returns the name of the currently initialized video driver.

Returns:

The name of the current video driver or NULL if no driver has been initialized

See also:

SDL_GetNumVideoDrivers()

SDL_GetVideoDriver()

Fill in information about the desktop display mode.

Get the desktop area represented by a display, with the primary display located at 0,0.

Returns:

0 on success, or -1 if the index is out of range.

See also:

SDL_GetNumVideoDisplays()

Fill in information about a specific display mode.

Note:

The display modes are sorted in this priority:

• bits per pixel -> more colors to fewer colors
• width -> largest to smallest
• height -> largest to smallest
• refresh rate -> highest to lowest

See also:

SDL_GetNumDisplayModes()

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

Returns:

The name of a display, or NULL for an invalid display index.

See also:

SDL_GetNumVideoDisplays()

Returns the number of available display modes.

See also:

SDL_GetDisplayMode()

Returns the number of available video displays.

See also:

SDL_GetDisplayBounds()

Get the number of video drivers compiled into SDL.

See also:

SDL_GetVideoDriver()

Get the name of a built in video driver.

Note:

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

See also:

SDL_GetNumVideoDrivers()

Get the brightness (gamma correction) for a window.

Returns:

The last brightness value passed to SDL_SetWindowBrightness()

See also:

SDL_SetWindowBrightness()

Retrieve the data pointer associated with a window.

Parameters:

window	The window to query.
name	The name of the pointer.

Returns:

The value associated with 'name'

See also:

SDL_SetWindowData()

Get the display index associated with a window.

Returns:

the display index of the display containing the center of the window, or -1 on error.

Fill in information about the display mode used when a fullscreen window is visible.

See also:

SDL_SetWindowDisplayMode()

SDL_SetWindowFullscreen()

Get the window flags.

Get a window from a stored ID, or NULL if it doesn't exist.

Get the gamma ramp for a window.

Parameters:

window	The window from which the gamma ramp should be queried.
red	A pointer to a 256 element array of 16-bit quantities to hold the translation table for the red channel, or NULL.
green	A pointer to a 256 element array of 16-bit quantities to hold the translation table for the green channel, or NULL.
blue	A pointer to a 256 element array of 16-bit quantities to hold the translation table for the blue channel, or NULL.

Returns:

0 on success, or -1 if gamma ramps are unsupported.

See also:

SDL_SetWindowGammaRamp()

Get a window's input grab mode.

Returns:

This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.

See also:

SDL_SetWindowGrab()

Get the numeric ID of a window, for logging purposes.

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

Parameters:

window	The window to query.
w	Pointer to variable for storing the maximum width, may be NULL
h	Pointer to variable for storing the maximum height, may be NULL

See also:

SDL_GetWindowMinimumSize()

SDL_SetWindowMaximumSize()

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

Parameters:

window	The window to query.
w	Pointer to variable for storing the minimum width, may be NULL
h	Pointer to variable for storing the minimum height, may be NULL

See also:

SDL_GetWindowMaximumSize()

SDL_SetWindowMinimumSize()

Get the pixel format associated with the window.

Get the position of a window.

Parameters:

window	The window to query.
x	Pointer to variable for storing the x position, may be NULL
y	Pointer to variable for storing the y position, may be NULL

See also:

SDL_SetWindowPosition()

Get the size of a window's client area.

Parameters:

window	The window to query.
w	Pointer to variable for storing the width, may be NULL
h	Pointer to variable for storing the height, may be NULL

See also:

SDL_SetWindowSize()

Get the SDL surface associated with the window.

Returns:

The window's framebuffer surface, or NULL on error.

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.

Note:

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

See also:

SDL_UpdateWindowSurface()

SDL_UpdateWindowSurfaceRects()

Get the title of a window, in UTF-8 format.

See also:

SDL_SetWindowTitle()

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

See also:

SDL_GL_DeleteContext()

Delete an OpenGL context.

See also:

SDL_GL_CreateContext()

Return true if an OpenGL extension is supported for the current context.

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

Get the currently active OpenGL context.

Get the currently active OpenGL window.

Get the size of a window's underlying drawable (for use with glViewport).

Parameters:

window	Window from which the drawable size should be queried
w	Pointer to variable for storing the width, may be NULL
h	Pointer to variable for storing the height, may be NULL

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.

See also:

SDL_GetWindowSize()

SDL_CreateWindow()

Get the address of an OpenGL function.

Get the swap interval for the current OpenGL context.

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. If the system can't determine the swap interval, or there isn't a valid current context, this will return 0 as a safe default.

See also:

SDL_GL_SetSwapInterval()

Dynamically load an OpenGL library.

Parameters:

path	The platform dependent OpenGL library name, or NULL to open the default OpenGL library.

Returns:

0 on success, or -1 if the library couldn't be loaded.

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.

Note:

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().

See also:

SDL_GL_GetProcAddress()

SDL_GL_UnloadLibrary()

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

Note:

The context must have been created with a compatible window.

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

Set an OpenGL window attribute before window creation.

Set the swap interval for the current OpenGL context.

Parameters:

interval

0 for immediate updates, 1 for updates synchronized with the vertical retrace. If the system supports it, you may specify -1 to allow late swaps to happen immediately instead of waiting for the next retrace.

Returns:

0 on success, or -1 if setting the swap interval is not supported.

See also:

SDL_GL_GetSwapInterval()

Swap the OpenGL buffers for a window, if double-buffering is supported.

Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().

See also:

SDL_GL_LoadLibrary()

Hide a window.

See also:

SDL_ShowWindow()

Returns whether the screensaver is currently enabled (default on).

See also:

SDL_EnableScreenSaver()

SDL_DisableScreenSaver()

Make a window as large as possible.

See also:

SDL_RestoreWindow()

Minimize a window to an iconic representation.

See also:

SDL_RestoreWindow()

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

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

See also:

SDL_MaximizeWindow()

SDL_MinimizeWindow()

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.

Parameters:

window	The window of which to change the border state.
bordered	SDL_FALSE to remove border, SDL_TRUE to add border.

Note:

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

See also:

SDL_GetWindowFlags()

Set the brightness (gamma correction) for a window.

Returns:

0 on success, or -1 if setting the brightness isn't supported.

See also:

SDL_GetWindowBrightness()

SDL_SetWindowGammaRamp()

Associate an arbitrary named pointer with a window.

Parameters:

window	The window to associate with the pointer.
name	The name of the pointer.
userdata	The associated pointer.

Returns:

The previous value associated with 'name'

Note:

The name is case-sensitive.

See also:

SDL_GetWindowData()

Set the display mode used when a fullscreen window is visible.

By default the window's dimensions and the desktop format and refresh rate are used.

Parameters:

window	The window for which the display mode should be set.
mode	The mode to use, or NULL for the default mode.

Returns:

0 on success, or -1 if setting the display mode failed.

See also:

SDL_GetWindowDisplayMode()

SDL_SetWindowFullscreen()

Set a window's fullscreen state.

Returns:

0 on success, or -1 if setting the display mode failed.

See also:

SDL_SetWindowDisplayMode()

SDL_GetWindowDisplayMode()

Set the gamma ramp for a window.

Parameters:

window	The window for which the gamma ramp should be set.
red	The translation table for the red channel, or NULL.
green	The translation table for the green channel, or NULL.
blue	The translation table for the blue channel, or NULL.

Returns:

0 on success, or -1 if gamma ramps are unsupported.

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.

See also:

SDL_GetWindowGammaRamp()

Set a window's input grab mode.

Parameters:

window	The window for which the input grab mode should be set.
grabbed	This is SDL_TRUE to grab input, and SDL_FALSE to release input.

See also:

SDL_GetWindowGrab()

Set the icon for a window.

Parameters:

window	The window for which the icon should be set.
icon	The icon for the window.

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

Parameters:

window	The window to set a new maximum size.
max_w	The maximum width of the window, must be >0
max_h	The maximum height of the window, must be >0

Note:

You can't change the maximum size of a fullscreen window, it automatically matches the size of the display mode.

See also:

SDL_GetWindowMaximumSize()

SDL_SetWindowMinimumSize()

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

Parameters:

window	The window to set a new minimum size.
min_w	The minimum width of the window, must be >0
min_h	The minimum height of the window, must be >0

Note:

You can't change the minimum size of a fullscreen window, it automatically matches the size of the display mode.

See also:

SDL_GetWindowMinimumSize()

SDL_SetWindowMaximumSize()

Set the position of a window.

Parameters:

window	The window to reposition.
x	The x coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.
y	The y coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.

Note:

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

See also:

SDL_GetWindowPosition()

Set the size of a window's client area.

Parameters:

window	The window to resize.
w	The width of the window, must be >0
h	The height of the window, must be >0

Note:

You can't change the size of a fullscreen window, it automatically matches the size of the display mode.

See also:

SDL_GetWindowSize()

Set the title of a window, in UTF-8 format.

See also:

SDL_GetWindowTitle()

Show a window.

See also:

SDL_HideWindow()

Copy the window surface to the screen.

Returns:

0 on success, or -1 on error.

See also:

SDL_GetWindowSurface()

SDL_UpdateWindowSurfaceRects()

Copy a number of rectangles on the window surface to the screen.

Returns:

0 on success, or -1 on error.

See also:

SDL_GetWindowSurface()

SDL_UpdateWindowSurfaceRect()

Initialize the video subsystem, optionally specifying a video driver.

Parameters:

driver_name

Initialize a specific driver by name, or NULL for the default video driver.

Returns:

0 on success, -1 on error

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.

See also:

SDL_VideoQuit()

Shuts down the video subsystem.

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

See also:

SDL_VideoInit()