SDL_video.h File Reference

#include "SDL_stdinc.h"
#include "SDL_pixels.h"
#include "SDL_rect.h"
#include "SDL_surface.h"
#include "begin_code.h"
#include "close_code.h"

Include dependency graph for SDL_video.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

Macros
#define	SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u
	Used to indicate that you don't care what the window position is. More...
#define	SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)   (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
#define	SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
#define	SDL_WINDOWPOS_ISUNDEFINED(X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
#define	SDL_WINDOWPOS_CENTERED_MASK   0x2FFF0000u
	Used to indicate that the window position should be centered. More...
#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 void *	SDL_GLContext
	An opaque handle to an OpenGL context. More...
typedef SDL_HitTestResult(*	SDL_HitTest) (SDL_Window *win, const SDL_Point *area, void *data)
	Callback used for hit-testing. More...

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_INPUT_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_VULKAN = 0x10000000 ,   SDL_WINDOW_METAL = 0x20000000 }
	The flags on a window. More...
enum	SDL_WindowEventID {   SDL_WINDOWEVENT_NONE ,   SDL_WINDOWEVENT_SHOWN ,   SDL_WINDOWEVENT_HIDDEN ,   SDL_WINDOWEVENT_EXPOSED ,   SDL_WINDOWEVENT_MOVED ,   SDL_WINDOWEVENT_RESIZED ,   SDL_WINDOWEVENT_SIZE_CHANGED ,   SDL_WINDOWEVENT_MINIMIZED ,   SDL_WINDOWEVENT_MAXIMIZED ,   SDL_WINDOWEVENT_RESTORED ,   SDL_WINDOWEVENT_ENTER ,   SDL_WINDOWEVENT_LEAVE ,   SDL_WINDOWEVENT_FOCUS_GAINED ,   SDL_WINDOWEVENT_FOCUS_LOST ,   SDL_WINDOWEVENT_CLOSE ,   SDL_WINDOWEVENT_TAKE_FOCUS ,   SDL_WINDOWEVENT_HIT_TEST }
	Event subtype for window events. More...
enum	SDL_DisplayEventID {   SDL_DISPLAYEVENT_NONE ,   SDL_DISPLAYEVENT_ORIENTATION ,   SDL_DISPLAYEVENT_CONNECTED ,   SDL_DISPLAYEVENT_DISCONNECTED }
	Event subtype for display events. More...
enum	SDL_DisplayOrientation {   SDL_ORIENTATION_UNKNOWN ,   SDL_ORIENTATION_LANDSCAPE ,   SDL_ORIENTATION_LANDSCAPE_FLIPPED ,   SDL_ORIENTATION_PORTRAIT ,   SDL_ORIENTATION_PORTRAIT_FLIPPED }
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 }
	OpenGL configuration attributes. More...
enum	SDL_GLprofile {   SDL_GL_CONTEXT_PROFILE_CORE = 0x0001 ,   SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002 ,   SDL_GL_CONTEXT_PROFILE_ES = 0x0004 }
enum	SDL_GLcontextFlag {   SDL_GL_CONTEXT_DEBUG_FLAG = 0x0001 ,   SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002 ,   SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG = 0x0004 ,   SDL_GL_CONTEXT_RESET_ISOLATION_FLAG = 0x0008 }
enum	SDL_GLcontextReleaseFlag {   SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE = 0x0000 ,   SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH = 0x0001 }
enum	SDL_GLContextResetNotification {   SDL_GL_CONTEXT_RESET_NO_NOTIFICATION = 0x0000 ,   SDL_GL_CONTEXT_RESET_LOSE_CONTEXT = 0x0001 }
enum	SDL_HitTestResult {   SDL_HITTEST_NORMAL ,   SDL_HITTEST_DRAGGABLE ,   SDL_HITTEST_RESIZE_TOPLEFT ,   SDL_HITTEST_RESIZE_TOP ,   SDL_HITTEST_RESIZE_TOPRIGHT ,   SDL_HITTEST_RESIZE_RIGHT ,   SDL_HITTEST_RESIZE_BOTTOMRIGHT ,   SDL_HITTEST_RESIZE_BOTTOM ,   SDL_HITTEST_RESIZE_BOTTOMLEFT ,   SDL_HITTEST_RESIZE_LEFT }
	Possible return values from the SDL_HitTest callback. More...

Functions
int	SDL_GetNumVideoDrivers (void)
	Get the number of video drivers compiled into SDL. More...
const char *	SDL_GetVideoDriver (int index)
	Get the name of a built in video driver. More...
int	SDL_VideoInit (const char *driver_name)
	Initialize the video subsystem, optionally specifying a video driver. More...
void	SDL_VideoQuit (void)
	Shuts down the video subsystem. More...
const char *	SDL_GetCurrentVideoDriver (void)
	Returns the name of the currently initialized video driver. More...
int	SDL_GetNumVideoDisplays (void)
	Returns the number of available video displays. More...
const char *	SDL_GetDisplayName (int displayIndex)
	Get the name of a display in UTF-8 encoding. More...
int	SDL_GetDisplayBounds (int displayIndex, SDL_Rect *rect)
	Get the desktop area represented by a display, with the primary display located at 0,0. More...
int	SDL_GetDisplayUsableBounds (int displayIndex, SDL_Rect *rect)
	Get the usable desktop area represented by a display, with the primary display located at 0,0. More...
int	SDL_GetDisplayDPI (int displayIndex, float *ddpi, float *hdpi, float *vdpi)
	Get the dots/pixels-per-inch for a display. More...
SDL_DisplayOrientation	SDL_GetDisplayOrientation (int displayIndex)
	Get the orientation of a display. More...
int	SDL_GetNumDisplayModes (int displayIndex)
	Returns the number of available display modes. More...
int	SDL_GetDisplayMode (int displayIndex, int modeIndex, SDL_DisplayMode *mode)
	Fill in information about a specific display mode. More...
int	SDL_GetDesktopDisplayMode (int displayIndex, SDL_DisplayMode *mode)
	Fill in information about the desktop display mode. More...
int	SDL_GetCurrentDisplayMode (int displayIndex, SDL_DisplayMode *mode)
	Fill in information about the current display mode. More...
SDL_DisplayMode *	SDL_GetClosestDisplayMode (int displayIndex, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
	Get the closest match to the requested display mode. More...
int	SDL_GetWindowDisplayIndex (SDL_Window *window)
	Get the display index associated with a window. More...
int	SDL_SetWindowDisplayMode (SDL_Window *window, const SDL_DisplayMode *mode)
	Set the display mode used when a fullscreen window is visible. More...
int	SDL_GetWindowDisplayMode (SDL_Window *window, SDL_DisplayMode *mode)
	Fill in information about the display mode used when a fullscreen window is visible. More...
Uint32	SDL_GetWindowPixelFormat (SDL_Window *window)
	Get the pixel format associated with the window. More...
SDL_Window *	SDL_CreateWindow (const char *title, int x, int y, int w, int h, Uint32 flags)
	Create a window with the specified position, dimensions, and flags. More...
SDL_Window *	SDL_CreateWindowFrom (const void *data)
	Create an SDL window from an existing native window. More...
Uint32	SDL_GetWindowID (SDL_Window *window)
	Get the numeric ID of a window, for logging purposes. More...
SDL_Window *	SDL_GetWindowFromID (Uint32 id)
	Get a window from a stored ID, or NULL if it doesn't exist. More...
Uint32	SDL_GetWindowFlags (SDL_Window *window)
	Get the window flags. More...
void	SDL_SetWindowTitle (SDL_Window *window, const char *title)
	Set the title of a window, in UTF-8 format. More...
const char *	SDL_GetWindowTitle (SDL_Window *window)
	Get the title of a window, in UTF-8 format. More...
void	SDL_SetWindowIcon (SDL_Window *window, SDL_Surface *icon)
	Set the icon for a window. More...
void *	SDL_SetWindowData (SDL_Window *window, const char *name, void *userdata)
	Associate an arbitrary named pointer with a window. More...
void *	SDL_GetWindowData (SDL_Window *window, const char *name)
	Retrieve the data pointer associated with a window. More...
void	SDL_SetWindowPosition (SDL_Window *window, int x, int y)
	Set the position of a window. More...
void	SDL_GetWindowPosition (SDL_Window *window, int *x, int *y)
	Get the position of a window. More...
void	SDL_SetWindowSize (SDL_Window *window, int w, int h)
	Set the size of a window's client area. More...
void	SDL_GetWindowSize (SDL_Window *window, int *w, int *h)
	Get the size of a window's client area. More...
int	SDL_GetWindowBordersSize (SDL_Window *window, int *top, int *left, int *bottom, int *right)
	Get the size of a window's borders (decorations) around the client area. More...
void	SDL_SetWindowMinimumSize (SDL_Window *window, int min_w, int min_h)
	Set the minimum size of a window's client area. More...
void	SDL_GetWindowMinimumSize (SDL_Window *window, int *w, int *h)
	Get the minimum size of a window's client area. More...
void	SDL_SetWindowMaximumSize (SDL_Window *window, int max_w, int max_h)
	Set the maximum size of a window's client area. More...
void	SDL_GetWindowMaximumSize (SDL_Window *window, int *w, int *h)
	Get the maximum size of a window's client area. More...
void	SDL_SetWindowBordered (SDL_Window *window, SDL_bool bordered)
	Set the border state of a window. More...
void	SDL_SetWindowResizable (SDL_Window *window, SDL_bool resizable)
	Set the user-resizable state of a window. More...
void	SDL_ShowWindow (SDL_Window *window)
	Show a window. More...
void	SDL_HideWindow (SDL_Window *window)
	Hide a window. More...
void	SDL_RaiseWindow (SDL_Window *window)
	Raise a window above other windows and set the input focus. More...
void	SDL_MaximizeWindow (SDL_Window *window)
	Make a window as large as possible. More...
void	SDL_MinimizeWindow (SDL_Window *window)
	Minimize a window to an iconic representation. More...
void	SDL_RestoreWindow (SDL_Window *window)
	Restore the size and position of a minimized or maximized window. More...
int	SDL_SetWindowFullscreen (SDL_Window *window, Uint32 flags)
	Set a window's fullscreen state. More...
SDL_Surface *	SDL_GetWindowSurface (SDL_Window *window)
	Get the SDL surface associated with the window. More...
int	SDL_UpdateWindowSurface (SDL_Window *window)
	Copy the window surface to the screen. More...
int	SDL_UpdateWindowSurfaceRects (SDL_Window *window, const SDL_Rect *rects, int numrects)
	Copy a number of rectangles on the window surface to the screen. More...
void	SDL_SetWindowGrab (SDL_Window *window, SDL_bool grabbed)
	Set a window's input grab mode. More...
SDL_bool	SDL_GetWindowGrab (SDL_Window *window)
	Get a window's input grab mode. More...
SDL_Window *	SDL_GetGrabbedWindow (void)
	Get the window that currently has an input grab enabled. More...
int	SDL_SetWindowBrightness (SDL_Window *window, float brightness)
	Set the brightness (gamma correction) for a window. More...
float	SDL_GetWindowBrightness (SDL_Window *window)
	Get the brightness (gamma correction) for a window. More...
int	SDL_SetWindowOpacity (SDL_Window *window, float opacity)
	Set the opacity for a window. More...
int	SDL_GetWindowOpacity (SDL_Window *window, float *out_opacity)
	Get the opacity of a window. More...
int	SDL_SetWindowModalFor (SDL_Window *modal_window, SDL_Window *parent_window)
	Sets the window as a modal for another window (TODO: reconsider this function and/or its name) More...
int	SDL_SetWindowInputFocus (SDL_Window *window)
	Explicitly sets input focus to the window. More...
int	SDL_SetWindowGammaRamp (SDL_Window *window, const Uint16 *red, const Uint16 *green, const Uint16 *blue)
	Set the gamma ramp for a window. More...
int	SDL_GetWindowGammaRamp (SDL_Window *window, Uint16 *red, Uint16 *green, Uint16 *blue)
	Get the gamma ramp for a window. More...
int	SDL_SetWindowHitTest (SDL_Window *window, SDL_HitTest callback, void *callback_data)
	Provide a callback that decides if a window region has special properties. More...
void	SDL_DestroyWindow (SDL_Window *window)
	Destroy a window. More...
SDL_bool	SDL_IsScreenSaverEnabled (void)
	Returns whether the screensaver is currently enabled (default off). More...
void	SDL_EnableScreenSaver (void)
	Allow the screen to be blanked by a screensaver. More...
void	SDL_DisableScreenSaver (void)
	Prevent the screen from being blanked by a screensaver. More...
OpenGL support functions
int	SDL_GL_LoadLibrary (const char *path)
	Dynamically load an OpenGL library. More...
void *	SDL_GL_GetProcAddress (const char *proc)
	Get the address of an OpenGL function. More...
void	SDL_GL_UnloadLibrary (void)
	Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary(). More...
SDL_bool	SDL_GL_ExtensionSupported (const char *extension)
	Return true if an OpenGL extension is supported for the current context. More...
void	SDL_GL_ResetAttributes (void)
	Reset all previously set OpenGL context attributes to their default values. More...
int	SDL_GL_SetAttribute (SDL_GLattr attr, int value)
	Set an OpenGL window attribute before window creation. More...
int	SDL_GL_GetAttribute (SDL_GLattr attr, int *value)
	Get the actual value for an attribute from the current context. More...
SDL_GLContext	SDL_GL_CreateContext (SDL_Window *window)
	Create an OpenGL context for use with an OpenGL window, and make it current. More...
int	SDL_GL_MakeCurrent (SDL_Window *window, SDL_GLContext context)
	Set up an OpenGL context for rendering into an OpenGL window. More...
SDL_Window *	SDL_GL_GetCurrentWindow (void)
	Get the currently active OpenGL window. More...
SDL_GLContext	SDL_GL_GetCurrentContext (void)
	Get the currently active OpenGL context. More...
void	SDL_GL_GetDrawableSize (SDL_Window *window, int *w, int *h)
	Get the size of a window's underlying drawable in pixels (for use with glViewport). More...
int	SDL_GL_SetSwapInterval (int interval)
	Set the swap interval for the current OpenGL context. More...
int	SDL_GL_GetSwapInterval (void)
	Get the swap interval for the current OpenGL context. More...
void	SDL_GL_SwapWindow (SDL_Window *window)
	Swap the OpenGL buffers for a window, if double-buffering is supported. More...
void	SDL_GL_DeleteContext (SDL_GLContext context)
	Delete an OpenGL context. More...

Detailed Description

Header file for SDL video functions.

Definition in file SDL_video.h.

Macro Definition Documentation

SDL_WINDOWPOS_CENTERED

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 139 of file SDL_video.h.

SDL_WINDOWPOS_CENTERED_DISPLAY

#define SDL_WINDOWPOS_CENTERED_DISPLAY

(

X

)

(SDL_WINDOWPOS_CENTERED_MASK|(X))

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

SDL_WINDOWPOS_ISCENTERED

#define SDL_WINDOWPOS_ISCENTERED

(

X

)

(((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)

Definition at line 140 of file SDL_video.h.

SDL_WINDOWPOS_ISUNDEFINED

#define SDL_WINDOWPOS_ISUNDEFINED

(

X

)

(((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)

Definition at line 131 of file SDL_video.h.

SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 130 of file SDL_video.h.

SDL_WINDOWPOS_UNDEFINED_DISPLAY

#define SDL_WINDOWPOS_UNDEFINED_DISPLAY

(

X

)

(SDL_WINDOWPOS_UNDEFINED_MASK|(X))

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

Typedef Documentation

SDL_GLContext

SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const char return SDL_ThreadFunction const char void return Uint32 return Uint32 SDL_AssertionHandler void SDL_SpinLock SDL_atomic_t int int return SDL_atomic_t return void void void return void return int return SDL_AudioSpec SDL_AudioSpec return int int return return int SDL_RWops int SDL_AudioSpec Uint8 Uint32 return SDL_AudioCVT SDL_AudioFormat Uint8 int SDL_AudioFormat Uint8 int return Uint8 const Uint8 Uint32 int const char return return return return return return return return Uint32 return Uint32 SDL_Event return SDL_Event int return SDL_EventFilter void SDL_EventFilter void SDL_EventFilter void int return const char const char return SDL_JoystickGUID return int return int return SDL_GameController return int return const char return SDL_GameController SDL_GameControllerAxis return const char return SDL_GameController SDL_GameControllerButton return SDL_GameController SDL_RWops return SDL_TouchID SDL_RWops return int return int return return SDL_Joystick return SDL_Haptic SDL_Haptic return SDL_Haptic return SDL_Haptic SDL_HapticEffect return SDL_Haptic int Uint32 return SDL_Haptic int SDL_Haptic int return SDL_Haptic return SDL_Haptic return SDL_Haptic return SDL_Haptic return const char const char return const char SDL_HintCallback void int return SDL_Joystick return SDL_Joystick return const char return SDL_Joystick return SDL_Joystick return SDL_Joystick return int return SDL_Joystick int return SDL_Joystick int return return return SDL_Scancode return SDL_Scancode return SDL_Keycode return return const char return void int SDL_LogPriority SDL_LogOutputFunction void Uint32 const char const char SDL_Window return int int return SDL_Window int int return SDL_Surface int int return SDL_Cursor return int return SDL_mutex return SDL_mutex return Uint32 return SDL_sem return SDL_sem Uint32 return SDL_sem return SDL_cond SDL_cond return SDL_cond SDL_mutex Uint32 return Uint32 int Uint32 Uint32 Uint32 Uint32 return Uint32 return int return SDL_Palette const SDL_Color int int return const SDL_PixelFormat Uint8 Uint8 Uint8 return Uint32 const SDL_PixelFormat Uint8 Uint8 Uint8 float Uint16 int int return const SDL_Rect const SDL_Rect SDL_Rect return const SDL_Point int const SDL_Rect SDL_Rect return return int int Uint32 SDL_Window SDL_Renderer return SDL_Surface return SDL_Renderer SDL_RendererInfo return SDL_Renderer Uint32 int int int return SDL_Texture Uint32 int int int return SDL_Texture Uint8 Uint8 Uint8 return SDL_Texture Uint8 return SDL_Texture SDL_BlendMode return SDL_Texture const SDL_Rect const Uint8 int const Uint8 int const Uint8 int return SDL_Texture SDL_Renderer SDL_Texture return SDL_Renderer int int return SDL_Renderer const SDL_Rect return SDL_Renderer const SDL_Rect return SDL_Renderer float float return SDL_Renderer Uint8 Uint8 Uint8 Uint8 return SDL_Renderer SDL_BlendMode return SDL_Renderer return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Rect int return SDL_Renderer const SDL_Rect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_Rect const double const SDL_Point const SDL_RendererFlip return SDL_Renderer SDL_Renderer SDL_Texture return void int return return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops Uint16 return SDL_RWops Uint32 return SDL_RWops Uint64 return const char unsigned int unsigned int unsigned int unsigned int Uint32 return SDL_Window SDL_Surface SDL_WindowShapeMode return size_t return void size_t return const char return void size_t size_t int(*) SDL_DYNAPI_PROC int return int return int size_t return size_t return const wchar_t return const wchar_t size_t return const char size_t return const char size_t return char return char return const char int return int char int return long char int return Sint64 char int return const char return const char char int return const char char int return const char char return const char const char size_t return const char const char size_t return double return double return double return double return double return double return double int return float return const char const char return SDL_iconv_t const char size_t char size_t return Uint32 int int int Uint32 Uint32 Uint32 Uint32 return SDL_Surface SDL_Surface return SDL_RWops int return SDL_Surface int return SDL_Surface Uint32 return SDL_Surface Uint8 Uint8 Uint8 return SDL_Surface Uint8 return SDL_Surface SDL_BlendMode return SDL_Surface SDL_Rect SDL_Surface Uint32 Uint32 return SDL_Surface const SDL_Rect Uint32 return SDL_Surface const SDL_Rect SDL_Surface SDL_Rect return SDL_Surface const SDL_Rect SDL_Surface const SDL_Rect return SDL_Surface SDL_Rect SDL_Surface SDL_Rect return SDL_Thread return SDL_Thread return SDL_Thread int return SDL_TLSID const void void(*) return return Uint32 SDL_TimerID return int return SDL_TouchID int return return return const char return return int return int return int SDL_DisplayMode return int const SDL_DisplayMode SDL_DisplayMode return SDL_Window const SDL_DisplayMode return SDL_Window return const void return Uint32 return SDL_Window const char SDL_Window SDL_Surface SDL_Window const char return SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window SDL_Window SDL_Window SDL_Window Uint32 return SDL_Window return SDL_Window SDL_bool SDL_Window float return SDL_Window const Uint16 const Uint16 const Uint16 return SDL_Window const char return SDL_GLattr int return SDL_Window return return SDL_Window int int return SDL_GLContext(int, SDL_vsscanf,(const char *a, const char *b, va_list c),(a, b, c), return) SDL_DYNAPI_PROC(int

An opaque handle to an OpenGL context.

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

See also

SDL_SetWindowHitTest

Definition at line 1045 of file SDL_video.h.

Enumeration Type Documentation

SDL_DisplayEventID

enum 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

Definition at line 175 of file SDL_video.h.

{
    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_DisplayEventID;

SDL_DisplayOrientation

enum SDL_DisplayOrientation

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

{
    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 */
} SDL_DisplayOrientation;

SDL_GLattr

enum SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const char return SDL_ThreadFunction const char void return Uint32 return Uint32 SDL_AssertionHandler void SDL_SpinLock SDL_atomic_t int int return SDL_atomic_t return void void void return void return int return SDL_AudioSpec SDL_AudioSpec return int int return return int SDL_RWops int SDL_AudioSpec Uint8 Uint32 return SDL_AudioCVT SDL_AudioFormat Uint8 int SDL_AudioFormat Uint8 int return Uint8 const Uint8 Uint32 int const char return return return return return return return return Uint32 return Uint32 SDL_Event return SDL_Event int return SDL_EventFilter void SDL_EventFilter void SDL_EventFilter void int return const char const char return SDL_JoystickGUID return int return int return SDL_GameController return int return const char return SDL_GameController SDL_GameControllerAxis return const char return SDL_GameController SDL_GameControllerButton return SDL_GameController SDL_RWops return SDL_TouchID SDL_RWops return int return int return return SDL_Joystick return SDL_Haptic SDL_Haptic return SDL_Haptic return SDL_Haptic SDL_HapticEffect return SDL_Haptic int Uint32 return SDL_Haptic int SDL_Haptic int return SDL_Haptic return SDL_Haptic return SDL_Haptic return SDL_Haptic return const char const char return const char SDL_HintCallback void int return SDL_Joystick return SDL_Joystick return const char return SDL_Joystick return SDL_Joystick return SDL_Joystick return int return SDL_Joystick int return SDL_Joystick int return return return SDL_Scancode return SDL_Scancode return SDL_Keycode return return const char return void int SDL_LogPriority SDL_LogOutputFunction void Uint32 const char const char SDL_Window return int int return SDL_Window int int return SDL_Surface int int return SDL_Cursor return int return SDL_mutex return SDL_mutex return Uint32 return SDL_sem return SDL_sem Uint32 return SDL_sem return SDL_cond SDL_cond return SDL_cond SDL_mutex Uint32 return Uint32 int Uint32 Uint32 Uint32 Uint32 return Uint32 return int return SDL_Palette const SDL_Color int int return const SDL_PixelFormat Uint8 Uint8 Uint8 return Uint32 const SDL_PixelFormat Uint8 Uint8 Uint8 float Uint16 int int return const SDL_Rect const SDL_Rect SDL_Rect return const SDL_Point int const SDL_Rect SDL_Rect return return int int Uint32 SDL_Window SDL_Renderer return SDL_Surface return SDL_Renderer SDL_RendererInfo return SDL_Renderer Uint32 int int int return SDL_Texture Uint32 int int int return SDL_Texture Uint8 Uint8 Uint8 return SDL_Texture Uint8 return SDL_Texture SDL_BlendMode return SDL_Texture const SDL_Rect const Uint8 int const Uint8 int const Uint8 int return SDL_Texture SDL_Renderer SDL_Texture return SDL_Renderer int int return SDL_Renderer const SDL_Rect return SDL_Renderer const SDL_Rect return SDL_Renderer float float return SDL_Renderer Uint8 Uint8 Uint8 Uint8 return SDL_Renderer SDL_BlendMode return SDL_Renderer return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Rect int return SDL_Renderer const SDL_Rect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_Rect const double const SDL_Point const SDL_RendererFlip return SDL_Renderer SDL_Renderer SDL_Texture return void int return return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops Uint16 return SDL_RWops Uint32 return SDL_RWops Uint64 return const char unsigned int unsigned int unsigned int unsigned int Uint32 return SDL_Window SDL_Surface SDL_WindowShapeMode return size_t return void size_t return const char return void size_t size_t int(*) a int return int return int size_t return size_t return const wchar_t return const wchar_t size_t return const char size_t return const char size_t return char return char return const char int return int char int return long char int return Sint64 char int return const char return const char char int return const char char int return const char char return const char const char size_t return const char const char size_t return double return double return double return double return double return double return double int return float return const char const char return SDL_iconv_t const char size_t char size_t return Uint32 int int int Uint32 Uint32 Uint32 Uint32 return SDL_Surface SDL_Surface return SDL_RWops int return SDL_Surface int return SDL_Surface Uint32 return SDL_Surface Uint8 Uint8 Uint8 return SDL_Surface Uint8 return SDL_Surface SDL_BlendMode return SDL_Surface SDL_Rect SDL_Surface Uint32 Uint32 return SDL_Surface const SDL_Rect Uint32 return SDL_Surface const SDL_Rect SDL_Surface SDL_Rect return SDL_Surface const SDL_Rect SDL_Surface const SDL_Rect return SDL_Surface SDL_Rect SDL_Surface SDL_Rect return SDL_Thread return SDL_Thread return SDL_Thread int return SDL_TLSID const void void(*) return return Uint32 SDL_TimerID return int return SDL_TouchID int return return return const char return return int return int return int SDL_DisplayMode return int const SDL_DisplayMode SDL_DisplayMode return SDL_Window const SDL_DisplayMode return SDL_Window return const void return Uint32 return SDL_Window const char SDL_Window SDL_Surface SDL_Window const char return SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window SDL_Window SDL_Window SDL_Window Uint32 return SDL_Window return SDL_Window SDL_bool SDL_Window float return SDL_Window const Uint16 const Uint16 const Uint16 return SDL_Window const char return SDL_GLattr

OpenGL configuration attributes.

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

Definition at line 200 of file SDL_video.h.

{
    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_GLattr;

SDL_GLcontextFlag

enum 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 238 of file SDL_video.h.

{
    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
} SDL_GLcontextFlag;

SDL_GLcontextReleaseFlag

enum SDL_GLcontextReleaseFlag

Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH

Definition at line 246 of file SDL_video.h.

{
    SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE   = 0x0000,
    SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH  = 0x0001
} SDL_GLcontextReleaseFlag;

SDL_GLContextResetNotification

enum SDL_GLContextResetNotification

Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT

Definition at line 252 of file SDL_video.h.

{
    SDL_GL_CONTEXT_RESET_NO_NOTIFICATION = 0x0000,
    SDL_GL_CONTEXT_RESET_LOSE_CONTEXT    = 0x0001
} SDL_GLContextResetNotification;

SDL_GLprofile

enum 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 231 of file SDL_video.h.

{
    SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
    SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
    SDL_GL_CONTEXT_PROFILE_ES             = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
} SDL_GLprofile;

SDL_HitTestResult

enum 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 1026 of file SDL_video.h.

{
    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
} SDL_HitTestResult;

SDL_WindowEventID

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

Definition at line 146 of file SDL_video.h.

{
    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_WindowEventID;

SDL_WindowFlags

enum 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_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_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 INPUT_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_VULKAN	window usable for Vulkan surface
SDL_WINDOW_METAL	window usable for Metal view

Definition at line 97 of file SDL_video.h.

{
    SDL_WINDOW_FULLSCREEN = 0x00000001,         /**< fullscreen window */
    SDL_WINDOW_OPENGL = 0x00000002,             /**< window usable with OpenGL context */
    SDL_WINDOW_SHOWN = 0x00000004,              /**< window is visible */
    SDL_WINDOW_HIDDEN = 0x00000008,             /**< window is not visible */
    SDL_WINDOW_BORDERLESS = 0x00000010,         /**< no window decoration */
    SDL_WINDOW_RESIZABLE = 0x00000020,          /**< window can be resized */
    SDL_WINDOW_MINIMIZED = 0x00000040,          /**< window is minimized */
    SDL_WINDOW_MAXIMIZED = 0x00000080,          /**< window is maximized */
    SDL_WINDOW_INPUT_GRABBED = 0x00000100,      /**< window has grabbed input focus */
    SDL_WINDOW_INPUT_FOCUS = 0x00000200,        /**< window has input focus */
    SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        /**< window has mouse focus */
    SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
    SDL_WINDOW_FOREIGN = 0x00000800,            /**< window not created by SDL */
    SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000,      /**< 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 = 0x00004000,      /**< window has mouse captured (unrelated to INPUT_GRABBED) */
    SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000,      /**< window should always be above others */
    SDL_WINDOW_SKIP_TASKBAR  = 0x00010000,      /**< window should not be added to the taskbar */
    SDL_WINDOW_UTILITY       = 0x00020000,      /**< window should be treated as a utility window */
    SDL_WINDOW_TOOLTIP       = 0x00040000,      /**< window should be treated as a tooltip */
    SDL_WINDOW_POPUP_MENU    = 0x00080000,      /**< window should be treated as a popup menu */
    SDL_WINDOW_VULKAN        = 0x10000000,      /**< window usable for Vulkan surface */
    SDL_WINDOW_METAL         = 0x20000000       /**< window usable for Metal view */
} SDL_WindowFlags;

Function Documentation

SDL_CreateWindow()

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

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

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, in screen coordinates.
h	The height of the window, in screen coordinates.
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, SDL_WINDOW_VULKAN SDL_WINDOW_METAL.

Returns

The created window, or NULL if window creation failed.

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 Mac OS X). Use SDL_GetWindowSize() to query the client area's size in screen coordinates, and SDL_GL_GetDrawableSize(), SDL_Vulkan_GetDrawableSize(), or SDL_GetRendererOutputSize() to query the drawable size in pixels.

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.

Note

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.

See also

SDL_DestroyWindow()

SDL_GL_LoadLibrary()

SDL_Vulkan_LoadLibrary()

Definition at line 1446 of file SDL_video.c.

{
    SDL_Window *window;
 
    if (!_this) {
        /* Initialize the video system if needed */
        if (SDL_Init(SDL_INIT_VIDEO) < 0) {
            return NULL;
        }
    }
 
    if ((((flags & SDL_WINDOW_UTILITY) != 0) + ((flags & SDL_WINDOW_TOOLTIP) != 0) + ((flags & SDL_WINDOW_POPUP_MENU) != 0)) > 1) {
        SDL_SetError("Conflicting window flags specified");
        return NULL;
    }
 
    /* Some platforms can't create zero-sized windows */
    if (w < 1) {
        w = 1;
    }
    if (h < 1) {
        h = 1;
    }
 
    /* Some platforms blow up if the windows are too large. Raise it later? */
    if ((w > 16384) || (h > 16384)) {
        SDL_SetError("Window is too large.");
        return NULL;
    }
 
    /* Some platforms have OpenGL enabled by default */
#if (SDL_VIDEO_OPENGL && __MACOSX__) || __IPHONEOS__ || __ANDROID__ || __NACL__
    if (!_this->is_dummy && !(flags & SDL_WINDOW_VULKAN) && !(flags & SDL_WINDOW_METAL) && !SDL_IsVideoContextExternal()) {
        flags |= SDL_WINDOW_OPENGL;
    }
#endif
    if (flags & SDL_WINDOW_OPENGL) {
        if (!_this->GL_CreateContext) {
            SDL_SetError("OpenGL support is either not configured in SDL "
                         "or not available in current SDL video driver "
                         "(%s) or platform", _this->name);
            return NULL;
        }
        if (SDL_GL_LoadLibrary(NULL) < 0) {
            return NULL;
        }
    }
 
    if (flags & SDL_WINDOW_VULKAN) {
        if (!_this->Vulkan_CreateSurface) {
            SDL_SetError("Vulkan support is either not configured in SDL "
                         "or not available in current SDL video driver "
                         "(%s) or platform", _this->name);
            return NULL;
        }
        if (flags & SDL_WINDOW_OPENGL) {
            SDL_SetError("Vulkan and OpenGL not supported on same window");
            return NULL;
        }
        if (SDL_Vulkan_LoadLibrary(NULL) < 0) {
            return NULL;
        }
    }
 
    if (flags & SDL_WINDOW_METAL) {
        if (!_this->Metal_CreateView) {
            SDL_SetError("Metal support is either not configured in SDL "
                         "or not available in current SDL video driver "
                         "(%s) or platform", _this->name);
            return NULL;
        }
        if (flags & SDL_WINDOW_OPENGL) {
            SDL_SetError("Metal and OpenGL not supported on same window");
            return NULL;
        }
        if (flags & SDL_WINDOW_VULKAN) {
            SDL_SetError("Metal and Vulkan not supported on same window. "
                         "To use MoltenVK, set SDL_WINDOW_VULKAN only.");
            return NULL;
        }
    }
 
    /* Unless the user has specified the high-DPI disabling hint, respect the
     * SDL_WINDOW_ALLOW_HIGHDPI flag.
     */
    if (flags & SDL_WINDOW_ALLOW_HIGHDPI) {
        if (SDL_GetHintBoolean(SDL_HINT_VIDEO_HIGHDPI_DISABLED, SDL_FALSE)) {
            flags &= ~SDL_WINDOW_ALLOW_HIGHDPI;
        }
    }
 
    window = (SDL_Window *)SDL_calloc(1, sizeof(*window));
    if (!window) {
        SDL_OutOfMemory();
        return NULL;
    }
    window->magic = &_this->window_magic;
    window->id = _this->next_object_id++;
    window->x = x;
    window->y = y;
    window->w = w;
    window->h = h;
    if (SDL_WINDOWPOS_ISUNDEFINED(x) || SDL_WINDOWPOS_ISUNDEFINED(y) ||
        SDL_WINDOWPOS_ISCENTERED(x) || SDL_WINDOWPOS_ISCENTERED(y)) {
        SDL_VideoDisplay *display = SDL_GetDisplayForWindow(window);
        int displayIndex;
        SDL_Rect bounds;
 
        displayIndex = SDL_GetIndexOfDisplay(display);
        SDL_GetDisplayBounds(displayIndex, &bounds);
        if (SDL_WINDOWPOS_ISUNDEFINED(x) || SDL_WINDOWPOS_ISCENTERED(x)) {
            window->x = bounds.x + (bounds.w - w) / 2;
        }
        if (SDL_WINDOWPOS_ISUNDEFINED(y) || SDL_WINDOWPOS_ISCENTERED(y)) {
            window->y = bounds.y + (bounds.h - h) / 2;
        }
    }
    window->windowed.x = window->x;
    window->windowed.y = window->y;
    window->windowed.w = window->w;
    window->windowed.h = window->h;
 
    if (flags & SDL_WINDOW_FULLSCREEN) {
        SDL_VideoDisplay *display = SDL_GetDisplayForWindow(window);
        int displayIndex;
        SDL_Rect bounds;
 
        displayIndex = SDL_GetIndexOfDisplay(display);
        SDL_GetDisplayBounds(displayIndex, &bounds);
 
        window->x = bounds.x;
        window->y = bounds.y;
        window->w = bounds.w;
        window->h = bounds.h;
    }
 
    window->flags = ((flags & CREATE_FLAGS) | SDL_WINDOW_HIDDEN);
    window->last_fullscreen_flags = window->flags;
    window->opacity = 1.0f;
    window->brightness = 1.0f;
    window->next = _this->windows;
    window->is_destroying = SDL_FALSE;
 
    if (_this->windows) {
        _this->windows->prev = window;
    }
    _this->windows = window;
 
    if (_this->CreateSDLWindow && _this->CreateSDLWindow(_this, window) < 0) {
        SDL_DestroyWindow(window);
        return NULL;
    }
 
    /* Clear minimized if not on windows, only windows handles it at create rather than FinishWindowCreation,
     * but it's important or window focus will get broken on windows!
     */
#if !defined(__WIN32__)
    if (window->flags & SDL_WINDOW_MINIMIZED) {
        window->flags &= ~SDL_WINDOW_MINIMIZED;
    }
#endif
 
#if __WINRT__ && (NTDDI_VERSION < NTDDI_WIN10)
    /* HACK: WinRT 8.x apps can't choose whether or not they are fullscreen
       or not.  The user can choose this, via OS-provided UI, but this can't
       be set programmatically.
 
       Just look at what SDL's WinRT video backend code detected with regards
       to fullscreen (being active, or not), and figure out a return/error code
       from that.
    */
    flags = window->flags;
#endif
 
    if (title) {
        SDL_SetWindowTitle(window, title);
    }
    SDL_FinishWindowCreation(window, flags);
 
    /* If the window was created fullscreen, make sure the mode code matches */
    SDL_UpdateFullscreenMode(window, FULLSCREEN_VISIBLE(window));
 
    return window;
}

References _this, CREATE_FLAGS, SDL_VideoDevice::CreateSDLWindow, FULLSCREEN_VISIBLE, SDL_VideoDevice::GL_CreateContext, SDL_Rect::h, SDL_Window::is_destroying, SDL_VideoDevice::is_dummy, SDL_VideoDevice::Metal_CreateView, SDL_VideoDevice::name, SDL_VideoDevice::next_object_id, NULL, SDL_Window::prev, SDL_calloc, SDL_DestroyWindow(), SDL_FALSE, SDL_FinishWindowCreation(), SDL_GetDisplayBounds(), SDL_GetDisplayForWindow(), SDL_GetHintBoolean, SDL_GetIndexOfDisplay(), SDL_GL_LoadLibrary(), SDL_HINT_VIDEO_HIGHDPI_DISABLED, SDL_Init, SDL_INIT_VIDEO, SDL_IsVideoContextExternal(), SDL_OutOfMemory, SDL_SetError, SDL_SetWindowTitle(), SDL_UpdateFullscreenMode(), SDL_Vulkan_LoadLibrary(), SDL_WINDOW_ALLOW_HIGHDPI, SDL_WINDOW_FULLSCREEN, SDL_WINDOW_HIDDEN, SDL_WINDOW_METAL, SDL_WINDOW_MINIMIZED, SDL_WINDOW_OPENGL, SDL_WINDOW_POPUP_MENU, SDL_WINDOW_TOOLTIP, SDL_WINDOW_UTILITY, SDL_WINDOW_VULKAN, SDL_WINDOWPOS_ISCENTERED, SDL_WINDOWPOS_ISUNDEFINED, SDL_VideoDevice::Vulkan_CreateSurface, SDL_Rect::w, SDL_VideoDevice::window_magic, SDL_VideoDevice::windows, SDL_Rect::x, and SDL_Rect::y.

Referenced by ShouldUseTextureFramebuffer().

SDL_CreateWindowFrom()

SDL_Window* SDL_CreateWindowFrom

(

const void *

data

)

Create an SDL window from an existing native window.

Parameters

data	A pointer to driver-dependent window creation data

Returns

The created window, or NULL if window creation failed.

See also

SDL_DestroyWindow()

Definition at line 1632 of file SDL_video.c.

{
    SDL_Window *window;
 
    if (!_this) {
        SDL_UninitializedVideo();
        return NULL;
    }
    if (!_this->CreateSDLWindowFrom) {
        SDL_Unsupported();
        return NULL;
    }
    window = (SDL_Window *)SDL_calloc(1, sizeof(*window));
    if (!window) {
        SDL_OutOfMemory();
        return NULL;
    }
    window->magic = &_this->window_magic;
    window->id = _this->next_object_id++;
    window->flags = SDL_WINDOW_FOREIGN;
    window->last_fullscreen_flags = window->flags;
    window->is_destroying = SDL_FALSE;
    window->opacity = 1.0f;
    window->brightness = 1.0f;
    window->next = _this->windows;
    if (_this->windows) {
        _this->windows->prev = window;
    }
    _this->windows = window;
 
    if (_this->CreateSDLWindowFrom(_this, window, data) < 0) {
        SDL_DestroyWindow(window);
        return NULL;
    }
 
    PrepareDragAndDropSupport(window);
 
    return window;
}

References _this, SDL_VideoDevice::CreateSDLWindowFrom, SDL_VideoDevice::next_object_id, NULL, PrepareDragAndDropSupport(), SDL_Window::prev, SDL_calloc, SDL_DestroyWindow(), SDL_FALSE, SDL_OutOfMemory, SDL_UninitializedVideo(), SDL_Unsupported, SDL_WINDOW_FOREIGN, SDL_VideoDevice::window_magic, and SDL_VideoDevice::windows.

SDL_DestroyWindow()

void SDL_DestroyWindow

(

SDL_Window *

window

)

Destroy a window.

Definition at line 2828 of file SDL_video.c.

{
    SDL_VideoDisplay *display;
 
    CHECK_WINDOW_MAGIC(window,);
 
    window->is_destroying = SDL_TRUE;
 
    /* Restore video mode, etc. */
    SDL_HideWindow(window);
 
    /* Make sure this window no longer has focus */
    if (SDL_GetKeyboardFocus() == window) {
        SDL_SetKeyboardFocus(NULL);
    }
    if (SDL_GetMouseFocus() == window) {
        SDL_SetMouseFocus(NULL);
    }
 
    /* make no context current if this is the current context window. */
    if (window->flags & SDL_WINDOW_OPENGL) {
        if (_this->current_glwin == window) {
            SDL_GL_MakeCurrent(window, NULL);
        }
    }
 
    if (window->surface) {
        window->surface->flags &= ~SDL_DONTFREE;
        SDL_FreeSurface(window->surface);
        window->surface = NULL;
        window->surface_valid = SDL_FALSE;
    }
    if (_this->DestroyWindowFramebuffer) {
        _this->DestroyWindowFramebuffer(_this, window);
    }
    if (_this->DestroyWindow) {
        _this->DestroyWindow(_this, window);
    }
    if (window->flags & SDL_WINDOW_OPENGL) {
        SDL_GL_UnloadLibrary();
    }
    if (window->flags & SDL_WINDOW_VULKAN) {
        SDL_Vulkan_UnloadLibrary();
    }
 
    display = SDL_GetDisplayForWindow(window);
    if (display->fullscreen_window == window) {
        display->fullscreen_window = NULL;
    }
 
    /* Now invalidate magic */
    window->magic = NULL;
 
    /* Free memory associated with the window */
    SDL_free(window->title);
    SDL_FreeSurface(window->icon);
    SDL_free(window->gamma);
    while (window->data) {
        SDL_WindowUserData *data = window->data;
 
        window->data = data->next;
        SDL_free(data->name);
        SDL_free(data);
    }
 
    /* Unlink the window from the list */
    if (window->next) {
        window->next->prev = window->prev;
    }
    if (window->prev) {
        window->prev->next = window->next;
    } else {
        _this->windows = window->next;
    }
 
    SDL_free(window);
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::current_glwin, SDL_WindowUserData::data, SDL_VideoDevice::DestroyWindow, SDL_VideoDevice::DestroyWindowFramebuffer, SDL_VideoDisplay::fullscreen_window, SDL_Window::next, NULL, SDL_DONTFREE, SDL_FALSE, SDL_free, SDL_FreeSurface, SDL_GetDisplayForWindow(), SDL_GetKeyboardFocus, SDL_GetMouseFocus, SDL_GL_MakeCurrent(), SDL_GL_UnloadLibrary(), SDL_HideWindow(), SDL_SetKeyboardFocus(), SDL_SetMouseFocus(), SDL_TRUE, SDL_Vulkan_UnloadLibrary(), SDL_WINDOW_OPENGL, SDL_WINDOW_VULKAN, and SDL_VideoDevice::windows.

Referenced by SDL_CreateWindow(), SDL_CreateWindowFrom(), SDL_VideoQuit(), and ShouldUseTextureFramebuffer().

SDL_DisableScreenSaver()

void SDL_DisableScreenSaver

(

void

)

Prevent the screen from being blanked by a screensaver.

See also

SDL_IsScreenSaverEnabled()

SDL_EnableScreenSaver()

Definition at line 2931 of file SDL_video.c.

{
    if (!_this) {
        return;
    }
    if (_this->suspend_screensaver) {
        return;
    }
    _this->suspend_screensaver = SDL_TRUE;
    if (_this->SuspendScreenSaver) {
        _this->SuspendScreenSaver(_this);
    }
}

References _this, SDL_TRUE, SDL_VideoDevice::suspend_screensaver, and SDL_VideoDevice::SuspendScreenSaver.

Referenced by SDL_VideoInit().

SDL_EnableScreenSaver()

void SDL_EnableScreenSaver

(

void

)

Allow the screen to be blanked by a screensaver.

See also

SDL_IsScreenSaverEnabled()

SDL_DisableScreenSaver()

Definition at line 579 of file SDL_dynapi_procs.h.

References _this, SDL_FALSE, SDL_VideoDevice::suspend_screensaver, and SDL_VideoDevice::SuspendScreenSaver.

Referenced by SDL_VideoQuit().

SDL_GetClosestDisplayMode()

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

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

Definition at line 1000 of file SDL_video.c.

{
    SDL_VideoDisplay *display;
 
    CHECK_DISPLAY_INDEX(displayIndex, NULL);
 
    display = &_this->displays[displayIndex];
    return SDL_GetClosestDisplayModeForDisplay(display, mode, closest);
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, NULL, and SDL_GetClosestDisplayModeForDisplay().

SDL_GetCurrentDisplayMode()

int SDL_GetCurrentDisplayMode	(	int	displayIndex,
		SDL_DisplayMode *	mode
	)

Fill in information about the current display mode.

Definition at line 879 of file SDL_video.c.

{
    SDL_VideoDisplay *display;
 
    CHECK_DISPLAY_INDEX(displayIndex, -1);
 
    display = &_this->displays[displayIndex];
    if (mode) {
        *mode = display->current_mode;
    }
    return 0;
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDisplay::current_mode, and SDL_VideoDevice::displays.

SDL_GetCurrentVideoDriver()

const char* SDL_GetCurrentVideoDriver

(

void

)

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

Definition at line 529 of file SDL_dynapi_procs.h.

References _this, SDL_VideoDevice::name, NULL, and SDL_UninitializedVideo().

SDL_GetDesktopDisplayMode()

int SDL_GetDesktopDisplayMode	(	int	displayIndex,
		SDL_DisplayMode *	mode
	)

Fill in information about the desktop display mode.

Definition at line 865 of file SDL_video.c.

{
    SDL_VideoDisplay *display;
 
    CHECK_DISPLAY_INDEX(displayIndex, -1);
 
    display = &_this->displays[displayIndex];
    if (mode) {
        *mode = display->desktop_mode;
    }
    return 0;
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDisplay::desktop_mode, and SDL_VideoDevice::displays.

SDL_GetDisplayBounds()

int SDL_GetDisplayBounds	(	int	displayIndex,
		SDL_Rect *	rect
	)

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

Definition at line 702 of file SDL_video.c.

{
    CHECK_DISPLAY_INDEX(displayIndex, -1);
 
    if (rect) {
        SDL_VideoDisplay *display = &_this->displays[displayIndex];
 
        if (_this->GetDisplayBounds) {
            if (_this->GetDisplayBounds(_this, display, rect) == 0) {
                return 0;
            }
        }
 
        /* Assume that the displays are left to right */
        if (displayIndex == 0) {
            rect->x = 0;
            rect->y = 0;
        } else {
            SDL_GetDisplayBounds(displayIndex-1, rect);
            rect->x += rect->w;
        }
        rect->w = display->current_mode.w;
        rect->h = display->current_mode.h;
    }
    return 0;  /* !!! FIXME: should this be an error if (rect==NULL) ? */
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDisplay::current_mode, SDL_VideoDevice::displays, SDL_VideoDevice::GetDisplayBounds, SDL_Rect::h, SDL_DisplayMode::h, rect, SDL_GetDisplayBounds(), SDL_Rect::w, SDL_DisplayMode::w, SDL_Rect::x, and SDL_Rect::y.

Referenced by SDL_CreateWindow(), SDL_GetDisplayBounds(), SDL_GetDisplayUsableBounds(), SDL_GetWindowDisplayIndex(), SDL_GetWindowPosition(), and SDL_SetWindowPosition().

SDL_GetDisplayDPI()

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

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

Note

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

Returns

0 on success, or -1 if no DPI information is available or the index is out of range.

See also

SDL_GetNumVideoDisplays()

Definition at line 761 of file SDL_video.c.

{
    SDL_VideoDisplay *display;
 
    CHECK_DISPLAY_INDEX(displayIndex, -1);
 
    display = &_this->displays[displayIndex];
 
    if (_this->GetDisplayDPI) {
        if (_this->GetDisplayDPI(_this, display, ddpi, hdpi, vdpi) == 0) {
            return 0;
        }
    } else {
        return SDL_Unsupported();
    }
 
    return -1;
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, SDL_VideoDevice::GetDisplayDPI, and SDL_Unsupported.

SDL_GetDisplayMode()

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

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

Definition at line 847 of file SDL_video.c.

{
    SDL_VideoDisplay *display;
 
    CHECK_DISPLAY_INDEX(displayIndex, -1);
 
    display = &_this->displays[displayIndex];
    if (index < 0 || index >= SDL_GetNumDisplayModesForDisplay(display)) {
        return SDL_SetError("index must be in the range of 0 - %d",
                            SDL_GetNumDisplayModesForDisplay(display) - 1);
    }
    if (mode) {
        *mode = display->display_modes[index];
    }
    return 0;
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDisplay::display_modes, SDL_VideoDevice::displays, SDL_GetNumDisplayModesForDisplay(), and SDL_SetError.

SDL_GetDisplayName()

const char* SDL_GetDisplayName

(

int

displayIndex

)

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

Definition at line 694 of file SDL_video.c.

{
    CHECK_DISPLAY_INDEX(displayIndex, NULL);
 
    return _this->displays[displayIndex].name;
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, SDL_VideoDisplay::name, and NULL.

SDL_GetDisplayOrientation()

SDL_DisplayOrientation SDL_GetDisplayOrientation

(

int

displayIndex

)

Get the orientation of a display.

Returns

The orientation of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.

See also

SDL_GetNumVideoDisplays()

Definition at line 781 of file SDL_video.c.

{
    SDL_VideoDisplay *display;
 
    CHECK_DISPLAY_INDEX(displayIndex, SDL_ORIENTATION_UNKNOWN);
 
    display = &_this->displays[displayIndex];
    return display->orientation;
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, SDL_VideoDisplay::orientation, and SDL_ORIENTATION_UNKNOWN.

SDL_GetDisplayUsableBounds()

int SDL_GetDisplayUsableBounds	(	int	displayIndex,
		SDL_Rect *	rect
	)

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

This is the same area as SDL_GetDisplayBounds() reports, but with portions reserved by the system removed. For example, on Mac OS X, 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.

Returns

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

See also

SDL_GetDisplayBounds()

SDL_GetNumVideoDisplays()

Definition at line 737 of file SDL_video.c.

{
    CHECK_DISPLAY_INDEX(displayIndex, -1);
 
    if (rect) {
        SDL_VideoDisplay *display = &_this->displays[displayIndex];
 
        if ((displayIndex == 0) && ParseDisplayUsableBoundsHint(rect)) {
            return 0;
        }
 
        if (_this->GetDisplayUsableBounds) {
            if (_this->GetDisplayUsableBounds(_this, display, rect) == 0) {
                return 0;
            }
        }
 
        /* Oh well, just give the entire display bounds. */
        return SDL_GetDisplayBounds(displayIndex, rect);
    }
    return 0;  /* !!! FIXME: should this be an error if (rect==NULL) ? */
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, SDL_VideoDevice::GetDisplayUsableBounds, ParseDisplayUsableBoundsHint(), rect, and SDL_GetDisplayBounds().

SDL_GetGrabbedWindow()

SDL_Window* SDL_GetGrabbedWindow

(

void

)

Get the window that currently has an input grab enabled.

Returns

This returns the window if input is grabbed, and NULL otherwise.

See also

SDL_SetWindowGrab()

Definition at line 2691 of file SDL_video.c.

{
    SDL_assert(!_this->grabbed_window || ((_this->grabbed_window->flags & SDL_WINDOW_INPUT_GRABBED) != 0));
    return _this->grabbed_window;
}

References _this, SDL_Window::flags, SDL_VideoDevice::grabbed_window, SDL_assert, and SDL_WINDOW_INPUT_GRABBED.

SDL_GetNumDisplayModes()

int SDL_GetNumDisplayModes

(

int

displayIndex

)

Returns the number of available display modes.

See also

SDL_GetDisplayMode()

Definition at line 839 of file SDL_video.c.

{
    CHECK_DISPLAY_INDEX(displayIndex, -1);
 
    return SDL_GetNumDisplayModesForDisplay(&_this->displays[displayIndex]);
}

References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, and SDL_GetNumDisplayModesForDisplay().

SDL_GetNumVideoDisplays()

int SDL_GetNumVideoDisplays

(

void

)

Returns the number of available video displays.

See also

SDL_GetDisplayBounds()

Definition at line 655 of file SDL_video.c.

{
    if (!_this) {
        SDL_UninitializedVideo();
        return 0;
    }
    return _this->num_displays;
}

References _this, SDL_VideoDevice::num_displays, and SDL_UninitializedVideo().

SDL_GetNumVideoDrivers()

int SDL_GetNumVideoDrivers

(

void

)

Get the number of video drivers compiled into SDL.

See also

SDL_GetVideoDriver()

Definition at line 525 of file SDL_dynapi_procs.h.

References bootstrap, and SDL_arraysize.

Referenced by SDL_GetVideoDriver().

SDL_GetVideoDriver()

const char* SDL_GetVideoDriver

(

int

index

)

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

Definition at line 457 of file SDL_video.c.

{
    if (index >= 0 && index < SDL_GetNumVideoDrivers()) {
        return bootstrap[index]->name;
    }
    return NULL;
}

References bootstrap, VideoBootStrap::name, NULL, and SDL_GetNumVideoDrivers().

SDL_GetWindowBordersSize()

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

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

Parameters

window	The window to query.
top	Pointer to variable for storing the size of the top border. NULL is permitted.
left	Pointer to variable for storing the size of the left border. NULL is permitted.
bottom	Pointer to variable for storing the size of the bottom border. NULL is permitted.
right	Pointer to variable for storing the size of the right border. NULL is permitted.

Returns

0 on success, or -1 if getting this information is not supported.

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.

Definition at line 2157 of file SDL_video.c.

{
    int dummy = 0;
 
    if (!top) { top = &dummy; }
    if (!left) { left = &dummy; }
    if (!right) { right = &dummy; }
    if (!bottom) { bottom = &dummy; }
 
    /* Always initialize, so applications don't have to care */
    *top = *left = *bottom = *right = 0;
 
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (!_this->GetWindowBordersSize) {
        return SDL_Unsupported();
    }
 
    return _this->GetWindowBordersSize(_this, window, top, left, bottom, right);
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GetWindowBordersSize, and SDL_Unsupported.

SDL_GetWindowBrightness()

float SDL_GetWindowBrightness

(

SDL_Window *

window

)

Get the brightness (gamma correction) for a window.

Returns

The last brightness value passed to SDL_SetWindowBrightness()

See also

SDL_SetWindowBrightness()

Definition at line 2487 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, 1.0f);
 
    return window->brightness;
}

References CHECK_WINDOW_MAGIC.

SDL_GetWindowData()

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

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

Definition at line 1954 of file SDL_video.c.

{
    SDL_WindowUserData *data;
 
    CHECK_WINDOW_MAGIC(window, NULL);
 
    /* Input validation */
    if (name == NULL || name[0] == '\0') {
      SDL_InvalidParamError("name");
      return NULL;
    }
 
    for (data = window->data; data; data = data->next) {
        if (data->name && SDL_strcmp(data->name, name) == 0) {
            return data->data;
        }
    }
    return NULL;
}

References CHECK_WINDOW_MAGIC, NULL, SDL_InvalidParamError, and SDL_strcmp.

Referenced by SDL_CreateWindowTexture(), and SDL_UpdateWindowTexture().

SDL_GetWindowDisplayIndex()

int SDL_GetWindowDisplayIndex

(

SDL_Window *

window

)

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.

Definition at line 1070 of file SDL_video.c.

{
    int displayIndex;
    int i, dist;
    int closest = -1;
    int closest_dist = 0x7FFFFFFF;
    SDL_Point center;
    SDL_Point delta;
    SDL_Rect rect;
 
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (SDL_WINDOWPOS_ISUNDEFINED(window->x) ||
        SDL_WINDOWPOS_ISCENTERED(window->x)) {
        displayIndex = (window->x & 0xFFFF);
        if (displayIndex >= _this->num_displays) {
            displayIndex = 0;
        }
        return displayIndex;
    }
    if (SDL_WINDOWPOS_ISUNDEFINED(window->y) ||
        SDL_WINDOWPOS_ISCENTERED(window->y)) {
        displayIndex = (window->y & 0xFFFF);
        if (displayIndex >= _this->num_displays) {
            displayIndex = 0;
        }
        return displayIndex;
    }
 
    /* Find the display containing the window */
    for (i = 0; i < _this->num_displays; ++i) {
        SDL_VideoDisplay *display = &_this->displays[i];
 
        if (display->fullscreen_window == window) {
            return i;
        }
    }
    center.x = window->x + window->w / 2;
    center.y = window->y + window->h / 2;
    for (i = 0; i < _this->num_displays; ++i) {
        SDL_GetDisplayBounds(i, &rect);
        if (SDL_EnclosePoints(&center, 1, &rect, NULL)) {
            return i;
        }
 
        delta.x = center.x - (rect.x + rect.w / 2);
        delta.y = center.y - (rect.y + rect.h / 2);
        dist = (delta.x*delta.x + delta.y*delta.y);
        if (dist < closest_dist) {
            closest = i;
            closest_dist = dist;
        }
    }
    if (closest < 0) {
        SDL_SetError("Couldn't find any displays");
    }
    return closest;
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::displays, SDL_VideoDisplay::fullscreen_window, SDL_Rect::h, i, NULL, SDL_VideoDevice::num_displays, rect, SDL_EnclosePoints, SDL_GetDisplayBounds(), SDL_SetError, SDL_WINDOWPOS_ISCENTERED, SDL_WINDOWPOS_ISUNDEFINED, SDL_Rect::w, SDL_Point::x, SDL_Rect::x, SDL_Point::y, and SDL_Rect::y.

Referenced by SDL_GetDisplayForWindow(), and SDL_GetWindowPosition().

SDL_GetWindowDisplayMode()

int SDL_GetWindowDisplayMode	(	SDL_Window *	window,
		SDL_DisplayMode *	mode
	)

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

See also

SDL_SetWindowDisplayMode()

SDL_SetWindowFullscreen()

Definition at line 1161 of file SDL_video.c.

{
    SDL_DisplayMode fullscreen_mode;
    SDL_VideoDisplay *display;
 
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (!mode) {
        return SDL_InvalidParamError("mode");
    }
 
    fullscreen_mode = window->fullscreen_mode;
    if (!fullscreen_mode.w) {
        fullscreen_mode.w = window->windowed.w;
    }
    if (!fullscreen_mode.h) {
        fullscreen_mode.h = window->windowed.h;
    }
 
    display = SDL_GetDisplayForWindow(window);
 
    /* if in desktop size mode, just return the size of the desktop */
    if ((window->flags & SDL_WINDOW_FULLSCREEN_DESKTOP) == SDL_WINDOW_FULLSCREEN_DESKTOP) {
        fullscreen_mode = display->desktop_mode;
    } else if (!SDL_GetClosestDisplayModeForDisplay(SDL_GetDisplayForWindow(window),
                                             &fullscreen_mode,
                                             &fullscreen_mode)) {
        return SDL_SetError("Couldn't find display mode match");
    }
 
    if (mode) {
        *mode = fullscreen_mode;
    }
    return 0;
}

References CHECK_WINDOW_MAGIC, SDL_VideoDisplay::desktop_mode, SDL_DisplayMode::h, SDL_GetClosestDisplayModeForDisplay(), SDL_GetDisplayForWindow(), SDL_InvalidParamError, SDL_SetError, SDL_WINDOW_FULLSCREEN_DESKTOP, and SDL_DisplayMode::w.

Referenced by SDL_SetWindowDisplayMode(), and SDL_UpdateFullscreenMode().

SDL_GetWindowFlags()

Uint32 SDL_GetWindowFlags

(

SDL_Window *

window

)

Get the window flags.

Definition at line 1852 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, 0);
 
    return window->flags;
}

References CHECK_WINDOW_MAGIC.

Referenced by SDL_ShowMessageBox().

SDL_GetWindowFromID()

SDL_Window* SDL_GetWindowFromID

(

Uint32

id

)

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

Definition at line 1836 of file SDL_video.c.

{
    SDL_Window *window;
 
    if (!_this) {
        return NULL;
    }
    for (window = _this->windows; window; window = window->next) {
        if (window->id == id) {
            return window;
        }
    }
    return NULL;
}

References _this, SDL_Window::next, NULL, and SDL_VideoDevice::windows.

SDL_GetWindowGammaRamp()

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

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

Definition at line 2591 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (!window->gamma) {
        int i;
 
        window->gamma = (Uint16 *)SDL_malloc(256*6*sizeof(Uint16));
        if (!window->gamma) {
            return SDL_OutOfMemory();
        }
        window->saved_gamma = window->gamma + 3*256;
 
        if (_this->GetWindowGammaRamp) {
            if (_this->GetWindowGammaRamp(_this, window, window->gamma) < 0) {
                return -1;
            }
        } else {
            /* Create an identity gamma ramp */
            for (i = 0; i < 256; ++i) {
                Uint16 value = (Uint16)((i << 8) | i);
 
                window->gamma[0*256+i] = value;
                window->gamma[1*256+i] = value;
                window->gamma[2*256+i] = value;
            }
        }
        SDL_memcpy(window->saved_gamma, window->gamma, 3*256*sizeof(Uint16));
    }
 
    if (red) {
        SDL_memcpy(red, &window->gamma[0*256], 256*sizeof(Uint16));
    }
    if (green) {
        SDL_memcpy(green, &window->gamma[1*256], 256*sizeof(Uint16));
    }
    if (blue) {
        SDL_memcpy(blue, &window->gamma[2*256], 256*sizeof(Uint16));
    }
    return 0;
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GetWindowGammaRamp, i, red, SDL_malloc, SDL_memcpy, and SDL_OutOfMemory.

Referenced by SDL_SetWindowGammaRamp().

SDL_GetWindowGrab()

SDL_bool SDL_GetWindowGrab

(

SDL_Window *

window

)

Get a window's input grab mode.

Returns

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

See also

SDL_SetWindowGrab()

Definition at line 2683 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, SDL_FALSE);
    SDL_assert(!_this->grabbed_window || ((_this->grabbed_window->flags & SDL_WINDOW_INPUT_GRABBED) != 0));
    return window == _this->grabbed_window;
}

References _this, CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_VideoDevice::grabbed_window, SDL_assert, SDL_FALSE, and SDL_WINDOW_INPUT_GRABBED.

SDL_GetWindowID()

Uint32 SDL_GetWindowID

(

SDL_Window *

window

)

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

Definition at line 1828 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, 0);
 
    return window->id;
}

References CHECK_WINDOW_MAGIC.

SDL_GetWindowMaximumSize()

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

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

Definition at line 2252 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
    if (max_w) {
        *max_w = window->max_w;
    }
    if (max_h) {
        *max_h = window->max_h;
    }
}

References CHECK_WINDOW_MAGIC.

SDL_GetWindowMinimumSize()

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

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

Definition at line 2210 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
    if (min_w) {
        *min_w = window->min_w;
    }
    if (min_h) {
        *min_h = window->min_h;
    }
}

References CHECK_WINDOW_MAGIC.

SDL_GetWindowOpacity()

int SDL_GetWindowOpacity	(	SDL_Window *	window,
		float *	out_opacity
	)

Get the opacity of a window.

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

Parameters

window	The window in question.
out_opacity	Opacity (0.0f - transparent, 1.0f - opaque)

Returns

0 on success, or -1 on error (invalid window, etc).

See also

SDL_SetWindowOpacity()

Definition at line 2519 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (out_opacity) {
        *out_opacity = window->opacity;
    }
 
    return 0;
}

References CHECK_WINDOW_MAGIC.

SDL_GetWindowPixelFormat()

Uint32 SDL_GetWindowPixelFormat

(

SDL_Window *

window

)

Get the pixel format associated with the window.

Definition at line 1198 of file SDL_video.c.

{
    SDL_VideoDisplay *display;
 
    CHECK_WINDOW_MAGIC(window, SDL_PIXELFORMAT_UNKNOWN);
 
    display = SDL_GetDisplayForWindow(window);
    return display->current_mode.format;
}

References CHECK_WINDOW_MAGIC, SDL_VideoDisplay::current_mode, SDL_DisplayMode::format, SDL_GetDisplayForWindow(), and SDL_PIXELFORMAT_UNKNOWN.

SDL_GetWindowPosition()

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

Get the position of a window.

Parameters

window	The window to query.
x	Pointer to variable for storing the x position, in screen coordinates. May be NULL.
y	Pointer to variable for storing the y position, in screen coordinates. May be NULL.

See also

SDL_SetWindowPosition()

Definition at line 2019 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    /* Fullscreen windows are always at their display's origin */
    if (window->flags & SDL_WINDOW_FULLSCREEN) {
        int displayIndex;
        
        if (x) {
            *x = 0;
        }
        if (y) {
            *y = 0;
        }
 
        /* Find the window's monitor and update to the
           monitor offset. */
        displayIndex = SDL_GetWindowDisplayIndex(window);
        if (displayIndex >= 0) {
            SDL_Rect bounds;
 
            SDL_zero(bounds);
 
            SDL_GetDisplayBounds(displayIndex, &bounds);
            if (x) {
                *x = bounds.x;
            }
            if (y) {
                *y = bounds.y;
            }
        }
    } else {
        if (x) {
            *x = window->x;
        }
        if (y) {
            *y = window->y;
        }
    }
}

References CHECK_WINDOW_MAGIC, SDL_GetDisplayBounds(), SDL_GetWindowDisplayIndex(), SDL_WINDOW_FULLSCREEN, SDL_zero, SDL_Rect::x, and SDL_Rect::y.

SDL_GetWindowSize()

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

Get the size of a window's client area.

Parameters

window	The window to query.
w	Pointer to variable for storing the width, in screen coordinates. May be NULL.
h	Pointer to variable for storing the height, in screen coordinates. May be NULL.

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 OS X). Use SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() to get the real client area size in pixels.

See also

SDL_SetWindowSize()

Definition at line 2145 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
    if (w) {
        *w = window->w;
    }
    if (h) {
        *h = window->h;
    }
}

References CHECK_WINDOW_MAGIC.

Referenced by SDL_GL_GetDrawableSize(), SDL_Metal_GetDrawableSize(), and SDL_Vulkan_GetDrawableSize().

SDL_GetWindowSurface()

SDL_Surface* SDL_GetWindowSurface

(

SDL_Window *

window

)

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

Definition at line 2424 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, NULL);
 
    if (!window->surface_valid) {
        if (window->surface) {
            window->surface->flags &= ~SDL_DONTFREE;
            SDL_FreeSurface(window->surface);
            window->surface = NULL;
        }
        window->surface = SDL_CreateWindowFramebuffer(window);
        if (window->surface) {
            window->surface_valid = SDL_TRUE;
            window->surface->flags |= SDL_DONTFREE;
        }
    }
    return window->surface;
}

References CHECK_WINDOW_MAGIC, NULL, SDL_CreateWindowFramebuffer(), SDL_DONTFREE, SDL_FreeSurface, and SDL_TRUE.

SDL_GetWindowTitle()

const char* SDL_GetWindowTitle

(

SDL_Window *

window

)

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

See also

SDL_SetWindowTitle()

Definition at line 1877 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, "");
 
    return window->title ? window->title : "";
}

References CHECK_WINDOW_MAGIC.

SDL_GL_CreateContext()

SDL_GLContext SDL_GL_CreateContext

(

SDL_Window *

window

)

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

See also

SDL_GL_DeleteContext()

Definition at line 3611 of file SDL_video.c.

{
    SDL_GLContext ctx = NULL;
    CHECK_WINDOW_MAGIC(window, NULL);
 
    if (!(window->flags & SDL_WINDOW_OPENGL)) {
        SDL_SetError("The specified window isn't an OpenGL window");
        return NULL;
    }
 
    ctx = _this->GL_CreateContext(_this, window);
 
    /* Creating a context is assumed to make it current in the SDL driver. */
    if (ctx) {
        _this->current_glwin = window;
        _this->current_glctx = ctx;
        SDL_TLSSet(_this->current_glwin_tls, window, NULL);
        SDL_TLSSet(_this->current_glctx_tls, ctx, NULL);
    }
    return ctx;
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::current_glctx, SDL_VideoDevice::current_glctx_tls, SDL_VideoDevice::current_glwin, SDL_VideoDevice::current_glwin_tls, SDL_VideoDevice::GL_CreateContext, NULL, SDL_SetError, SDL_TLSSet, and SDL_WINDOW_OPENGL.

Referenced by ShouldUseTextureFramebuffer().

SDL_GL_DeleteContext()

void SDL_GL_DeleteContext

(

SDL_GLContext

context

)

Delete an OpenGL context.

See also

SDL_GL_CreateContext()

Definition at line 3744 of file SDL_video.c.

{
    if (!_this || !context) {
        return;
    }
 
    if (SDL_GL_GetCurrentContext() == context) {
        SDL_GL_MakeCurrent(NULL, NULL);
    }
 
    _this->GL_DeleteContext(_this, context);
}

References _this, context, SDL_VideoDevice::GL_DeleteContext, NULL, SDL_GL_GetCurrentContext(), and SDL_GL_MakeCurrent().

Referenced by ShouldUseTextureFramebuffer().

SDL_GL_ExtensionSupported()

SDL_bool SDL_GL_ExtensionSupported

(

const char *

extension

)

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

Definition at line 3072 of file SDL_video.c.

{
#if SDL_VIDEO_OPENGL || SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
    const GLubyte *(APIENTRY * glGetStringFunc) (GLenum);
    const char *extensions;
    const char *start;
    const char *where, *terminator;
 
    /* Extension names should not have spaces. */
    where = SDL_strchr(extension, ' ');
    if (where || *extension == '\0') {
        return SDL_FALSE;
    }
    /* See if there's an environment variable override */
    start = SDL_getenv(extension);
    if (start && *start == '0') {
        return SDL_FALSE;
    }
 
    /* Lookup the available extensions */
 
    glGetStringFunc = SDL_GL_GetProcAddress("glGetString");
    if (!glGetStringFunc) {
        return SDL_FALSE;
    }
 
    if (isAtLeastGL3((const char *) glGetStringFunc(GL_VERSION))) {
        const GLubyte *(APIENTRY * glGetStringiFunc) (GLenum, GLuint);
        void (APIENTRY * glGetIntegervFunc) (GLenum pname, GLint * params);
        GLint num_exts = 0;
        GLint i;
 
        glGetStringiFunc = SDL_GL_GetProcAddress("glGetStringi");
        glGetIntegervFunc = SDL_GL_GetProcAddress("glGetIntegerv");
        if ((!glGetStringiFunc) || (!glGetIntegervFunc)) {
            return SDL_FALSE;
        }
 
        #ifndef GL_NUM_EXTENSIONS
        #define GL_NUM_EXTENSIONS 0x821D
        #endif
        glGetIntegervFunc(GL_NUM_EXTENSIONS, &num_exts);
        for (i = 0; i < num_exts; i++) {
            const char *thisext = (const char *) glGetStringiFunc(GL_EXTENSIONS, i);
            if (SDL_strcmp(thisext, extension) == 0) {
                return SDL_TRUE;
            }
        }
 
        return SDL_FALSE;
    }
 
    /* Try the old way with glGetString(GL_EXTENSIONS) ... */
 
    extensions = (const char *) glGetStringFunc(GL_EXTENSIONS);
    if (!extensions) {
        return SDL_FALSE;
    }
    /*
     * It takes a bit of care to be fool-proof about parsing the OpenGL
     * extensions string. Don't be fooled by sub-strings, etc.
     */
 
    start = extensions;
 
    for (;;) {
        where = SDL_strstr(start, extension);
        if (!where)
            break;
 
        terminator = where + SDL_strlen(extension);
        if (where == extensions || *(where - 1) == ' ')
            if (*terminator == ' ' || *terminator == '\0')
                return SDL_TRUE;
 
        start = terminator;
    }
    return SDL_FALSE;
#else
    return SDL_FALSE;
#endif
}

References APIENTRY, GL_EXTENSIONS, GL_NUM_EXTENSIONS, GL_VERSION, i, isAtLeastGL3(), SDL_FALSE, SDL_getenv, SDL_GL_GetProcAddress(), SDL_strchr, SDL_strcmp, SDL_strlen, SDL_strstr, SDL_TRUE, and void.

Referenced by SDL_GL_DeduceMaxSupportedESProfile().

SDL_GL_GetAttribute()

int SDL_GL_GetAttribute	(	SDL_GLattr	attr,
		int *	value
	)

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

Returns

0 on success, or -1 if the attribute could not be retrieved. The integer at value will be modified in either case.

Definition at line 3362 of file SDL_video.c.

{
#if SDL_VIDEO_OPENGL || SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
    GLenum (APIENTRY *glGetErrorFunc) (void);
    GLenum attrib = 0;
    GLenum error = 0;
 
    /*
     * Some queries in Core Profile desktop OpenGL 3+ contexts require
     * glGetFramebufferAttachmentParameteriv instead of glGetIntegerv. Note that
     * the enums we use for the former function don't exist in OpenGL ES 2, and
     * the function itself doesn't exist prior to OpenGL 3 and OpenGL ES 2.
     */
#if SDL_VIDEO_OPENGL
    const GLubyte *(APIENTRY *glGetStringFunc) (GLenum name);
    void (APIENTRY *glGetFramebufferAttachmentParameterivFunc) (GLenum target, GLenum attachment, GLenum pname, GLint* params);
    GLenum attachment = GL_BACK_LEFT;
    GLenum attachmentattrib = 0;
#endif
 
    if (!value) {
        return SDL_InvalidParamError("value");
    }
 
    /* Clear value in any case */
    *value = 0;
 
    if (!_this) {
        return SDL_UninitializedVideo();
    }
 
    switch (attr) {
    case SDL_GL_RED_SIZE:
#if SDL_VIDEO_OPENGL
        attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_RED_SIZE;
#endif
        attrib = GL_RED_BITS;
        break;
    case SDL_GL_BLUE_SIZE:
#if SDL_VIDEO_OPENGL
        attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_BLUE_SIZE;
#endif
        attrib = GL_BLUE_BITS;
        break;
    case SDL_GL_GREEN_SIZE:
#if SDL_VIDEO_OPENGL
        attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_GREEN_SIZE;
#endif
        attrib = GL_GREEN_BITS;
        break;
    case SDL_GL_ALPHA_SIZE:
#if SDL_VIDEO_OPENGL
        attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE;
#endif
        attrib = GL_ALPHA_BITS;
        break;
    case SDL_GL_DOUBLEBUFFER:
#if SDL_VIDEO_OPENGL
        attrib = GL_DOUBLEBUFFER;
        break;
#else
        /* OpenGL ES 1.0 and above specifications have EGL_SINGLE_BUFFER      */
        /* parameter which switches double buffer to single buffer. OpenGL ES */
        /* SDL driver must set proper value after initialization              */
        *value = _this->gl_config.double_buffer;
        return 0;
#endif
    case SDL_GL_DEPTH_SIZE:
#if SDL_VIDEO_OPENGL
        attachment = GL_DEPTH;
        attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE;
#endif
        attrib = GL_DEPTH_BITS;
        break;
    case SDL_GL_STENCIL_SIZE:
#if SDL_VIDEO_OPENGL
        attachment = GL_STENCIL;
        attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE;
#endif
        attrib = GL_STENCIL_BITS;
        break;
#if SDL_VIDEO_OPENGL
    case SDL_GL_ACCUM_RED_SIZE:
        attrib = GL_ACCUM_RED_BITS;
        break;
    case SDL_GL_ACCUM_GREEN_SIZE:
        attrib = GL_ACCUM_GREEN_BITS;
        break;
    case SDL_GL_ACCUM_BLUE_SIZE:
        attrib = GL_ACCUM_BLUE_BITS;
        break;
    case SDL_GL_ACCUM_ALPHA_SIZE:
        attrib = GL_ACCUM_ALPHA_BITS;
        break;
    case SDL_GL_STEREO:
        attrib = GL_STEREO;
        break;
#else
    case SDL_GL_ACCUM_RED_SIZE:
    case SDL_GL_ACCUM_GREEN_SIZE:
    case SDL_GL_ACCUM_BLUE_SIZE:
    case SDL_GL_ACCUM_ALPHA_SIZE:
    case SDL_GL_STEREO:
        /* none of these are supported in OpenGL ES */
        *value = 0;
        return 0;
#endif
    case SDL_GL_MULTISAMPLEBUFFERS:
        attrib = GL_SAMPLE_BUFFERS;
        break;
    case SDL_GL_MULTISAMPLESAMPLES:
        attrib = GL_SAMPLES;
        break;
    case SDL_GL_CONTEXT_RELEASE_BEHAVIOR:
#if SDL_VIDEO_OPENGL
        attrib = GL_CONTEXT_RELEASE_BEHAVIOR;
#else
        attrib = GL_CONTEXT_RELEASE_BEHAVIOR_KHR;
#endif
        break;
    case SDL_GL_BUFFER_SIZE:
        {
            int rsize = 0, gsize = 0, bsize = 0, asize = 0;
 
            /* There doesn't seem to be a single flag in OpenGL for this! */
            if (SDL_GL_GetAttribute(SDL_GL_RED_SIZE, &rsize) < 0) {
                return -1;
            }
            if (SDL_GL_GetAttribute(SDL_GL_GREEN_SIZE, &gsize) < 0) {
                return -1;
            }
            if (SDL_GL_GetAttribute(SDL_GL_BLUE_SIZE, &bsize) < 0) {
                return -1;
            }
            if (SDL_GL_GetAttribute(SDL_GL_ALPHA_SIZE, &asize) < 0) {
                return -1;
            }
 
            *value = rsize + gsize + bsize + asize;
            return 0;
        }
    case SDL_GL_ACCELERATED_VISUAL:
        {
            /* FIXME: How do we get this information? */
            *value = (_this->gl_config.accelerated != 0);
            return 0;
        }
    case SDL_GL_RETAINED_BACKING:
        {
            *value = _this->gl_config.retained_backing;
            return 0;
        }
    case SDL_GL_CONTEXT_MAJOR_VERSION:
        {
            *value = _this->gl_config.major_version;
            return 0;
        }
    case SDL_GL_CONTEXT_MINOR_VERSION:
        {
            *value = _this->gl_config.minor_version;
            return 0;
        }
    case SDL_GL_CONTEXT_EGL:
        /* FIXME: SDL_GL_CONTEXT_EGL to be deprecated in SDL 2.1 */
        {
            if (_this->gl_config.profile_mask == SDL_GL_CONTEXT_PROFILE_ES) {
                *value = 1;
            }
            else {
                *value = 0;
            }
            return 0;
        }
    case SDL_GL_CONTEXT_FLAGS:
        {
            *value = _this->gl_config.flags;
            return 0;
        }
    case SDL_GL_CONTEXT_PROFILE_MASK:
        {
            *value = _this->gl_config.profile_mask;
            return 0;
        }
    case SDL_GL_SHARE_WITH_CURRENT_CONTEXT:
        {
            *value = _this->gl_config.share_with_current_context;
            return 0;
        }
    case SDL_GL_FRAMEBUFFER_SRGB_CAPABLE:
        {
            *value = _this->gl_config.framebuffer_srgb_capable;
            return 0;
        }
    case SDL_GL_CONTEXT_NO_ERROR:
        {
            *value = _this->gl_config.no_error;
            return 0;
        }
    default:
        return SDL_SetError("Unknown OpenGL attribute");
    }
 
#if SDL_VIDEO_OPENGL
    glGetStringFunc = SDL_GL_GetProcAddress("glGetString");
    if (!glGetStringFunc) {
        return -1;
    }
 
    if (attachmentattrib && isAtLeastGL3((const char *) glGetStringFunc(GL_VERSION))) {
        glGetFramebufferAttachmentParameterivFunc = SDL_GL_GetProcAddress("glGetFramebufferAttachmentParameteriv");
 
        if (glGetFramebufferAttachmentParameterivFunc) {
            glGetFramebufferAttachmentParameterivFunc(GL_FRAMEBUFFER, attachment, attachmentattrib, (GLint *) value);
        } else {
            return -1;
        }
    } else
#endif
    {
        void (APIENTRY *glGetIntegervFunc) (GLenum pname, GLint * params);
        glGetIntegervFunc = SDL_GL_GetProcAddress("glGetIntegerv");
        if (glGetIntegervFunc) {
            glGetIntegervFunc(attrib, (GLint *) value);
        } else {
            return -1;
        }
    }
 
    glGetErrorFunc = SDL_GL_GetProcAddress("glGetError");
    if (!glGetErrorFunc) {
        return -1;
    }
 
    error = glGetErrorFunc();
    if (error != GL_NO_ERROR) {
        if (error == GL_INVALID_ENUM) {
            return SDL_SetError("OpenGL error: GL_INVALID_ENUM");
        } else if (error == GL_INVALID_VALUE) {
            return SDL_SetError("OpenGL error: GL_INVALID_VALUE");
        }
        return SDL_SetError("OpenGL error: %08X", error);
    }
    return 0;
#else
    return SDL_Unsupported();
#endif /* SDL_VIDEO_OPENGL */
}

References _this, SDL_VideoDevice::accelerated, APIENTRY, SDL_VideoDevice::double_buffer, SDL_VideoDevice::flags, SDL_VideoDevice::framebuffer_srgb_capable, GL_ACCUM_ALPHA_BITS, GL_ACCUM_BLUE_BITS, GL_ACCUM_GREEN_BITS, GL_ACCUM_RED_BITS, GL_ALPHA_BITS, GL_BACK_LEFT, GL_BLUE_BITS, SDL_VideoDevice::gl_config, GL_CONTEXT_RELEASE_BEHAVIOR, GL_CONTEXT_RELEASE_BEHAVIOR_KHR, GL_DEPTH, GL_DEPTH_BITS, GL_DOUBLEBUFFER, GL_FRAMEBUFFER, GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE, GL_FRAMEBUFFER_ATTACHMENT_BLUE_SIZE, GL_FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE, GL_FRAMEBUFFER_ATTACHMENT_GREEN_SIZE, GL_FRAMEBUFFER_ATTACHMENT_RED_SIZE, GL_FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE, GL_GREEN_BITS, GL_INVALID_ENUM, GL_INVALID_VALUE, GL_NO_ERROR, GL_RED_BITS, GL_SAMPLE_BUFFERS, GL_SAMPLES, GL_STENCIL, GL_STENCIL_BITS, GL_STEREO, GL_VERSION, isAtLeastGL3(), SDL_VideoDevice::major_version, SDL_VideoDevice::minor_version, SDL_VideoDevice::no_error, SDL_VideoDevice::profile_mask, SDL_VideoDevice::retained_backing, SDL_GL_ACCELERATED_VISUAL, SDL_GL_ACCUM_ALPHA_SIZE, SDL_GL_ACCUM_BLUE_SIZE, SDL_GL_ACCUM_GREEN_SIZE, SDL_GL_ACCUM_RED_SIZE, SDL_GL_ALPHA_SIZE, SDL_GL_BLUE_SIZE, SDL_GL_BUFFER_SIZE, SDL_GL_CONTEXT_EGL, SDL_GL_CONTEXT_FLAGS, SDL_GL_CONTEXT_MAJOR_VERSION, SDL_GL_CONTEXT_MINOR_VERSION, SDL_GL_CONTEXT_NO_ERROR, SDL_GL_CONTEXT_PROFILE_ES, SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_RELEASE_BEHAVIOR, SDL_GL_DEPTH_SIZE, SDL_GL_DOUBLEBUFFER, SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, SDL_GL_GetAttribute(), SDL_GL_GetProcAddress(), SDL_GL_GREEN_SIZE, SDL_GL_MULTISAMPLEBUFFERS, SDL_GL_MULTISAMPLESAMPLES, SDL_GL_RED_SIZE, SDL_GL_RETAINED_BACKING, SDL_GL_SHARE_WITH_CURRENT_CONTEXT, SDL_GL_STENCIL_SIZE, SDL_GL_STEREO, SDL_InvalidParamError, SDL_SetError, SDL_UninitializedVideo(), SDL_Unsupported, SDL_VideoDevice::share_with_current_context, and void.

Referenced by SDL_GL_GetAttribute().

SDL_GL_GetCurrentContext()

SDL_GLContext SDL_GL_GetCurrentContext

(

void

)

Get the currently active OpenGL context.

Definition at line 3677 of file SDL_video.c.

{
    if (!_this) {
        SDL_UninitializedVideo();
        return NULL;
    }
    return (SDL_GLContext)SDL_TLSGet(_this->current_glctx_tls);
}

References _this, SDL_VideoDevice::current_glctx_tls, NULL, SDL_TLSGet, and SDL_UninitializedVideo().

Referenced by SDL_GL_DeleteContext(), SDL_GL_GetSwapInterval(), SDL_GL_MakeCurrent(), and SDL_GL_SetSwapInterval().

SDL_GL_GetCurrentWindow()

SDL_Window* SDL_GL_GetCurrentWindow

(

void

)

Get the currently active OpenGL window.

Definition at line 589 of file SDL_dynapi_procs.h.

References _this, SDL_VideoDevice::current_glwin_tls, NULL, SDL_TLSGet, and SDL_UninitializedVideo().

Referenced by SDL_GL_MakeCurrent(), and SDL_GL_SwapWindow().

SDL_GL_GetDrawableSize()

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

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

Parameters

window	Window from which the drawable size should be queried
w	Pointer to variable for storing the width in pixels, may be NULL
h	Pointer to variable for storing the height in pixels, 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()

Definition at line 3686 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (_this->GL_GetDrawableSize) {
        _this->GL_GetDrawableSize(_this, window, w, h);
    } else {
        SDL_GetWindowSize(window, w, h);
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GL_GetDrawableSize, and SDL_GetWindowSize().

SDL_GL_GetProcAddress()

void* SDL_GL_GetProcAddress

(

const char *

proc

)

Get the address of an OpenGL function.

Definition at line 3025 of file SDL_video.c.

{
    void *func;
 
    if (!_this) {
        SDL_UninitializedVideo();
        return NULL;
    }
    func = NULL;
    if (_this->GL_GetProcAddress) {
        if (_this->gl_config.driver_loaded) {
            func = _this->GL_GetProcAddress(_this, proc);
        } else {
            SDL_SetError("No GL driver has been loaded");
        }
    } else {
        SDL_SetError("No dynamic GL support in current SDL video driver (%s)", _this->name);
    }
    return func;
}

References _this, SDL_VideoDevice::driver_loaded, SDL_VideoDevice::gl_config, SDL_VideoDevice::GL_GetProcAddress, SDL_VideoDevice::name, NULL, SDL_SetError, and SDL_UninitializedVideo().

Referenced by SDL_GL_ExtensionSupported(), SDL_GL_GetAttribute(), and ShouldUseTextureFramebuffer().

SDL_GL_GetSwapInterval()

int SDL_GL_GetSwapInterval

(

void

)

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

Definition at line 593 of file SDL_dynapi_procs.h.

References _this, SDL_VideoDevice::GL_GetSwapInterval, NULL, and SDL_GL_GetCurrentContext().

SDL_GL_LoadLibrary()

int SDL_GL_LoadLibrary

(

const char *

path

)

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

Definition at line 2996 of file SDL_video.c.

{
    int retval;
 
    if (!_this) {
        return SDL_UninitializedVideo();
    }
    if (_this->gl_config.driver_loaded) {
        if (path && SDL_strcmp(path, _this->gl_config.driver_path) != 0) {
            return SDL_SetError("OpenGL library already loaded");
        }
        retval = 0;
    } else {
        if (!_this->GL_LoadLibrary) {
            return SDL_SetError("No dynamic GL support in current SDL video driver (%s)", _this->name);
        }
        retval = _this->GL_LoadLibrary(_this, path);
    }
    if (retval == 0) {
        ++_this->gl_config.driver_loaded;
    } else {
        if (_this->GL_UnloadLibrary) {
            _this->GL_UnloadLibrary(_this);
        }
    }
    return (retval);
}

References _this, SDL_VideoDevice::driver_loaded, SDL_VideoDevice::driver_path, SDL_VideoDevice::gl_config, SDL_VideoDevice::GL_LoadLibrary, SDL_VideoDevice::GL_UnloadLibrary, SDL_VideoDevice::name, retval, SDL_SetError, SDL_strcmp, and SDL_UninitializedVideo().

Referenced by SDL_CreateWindow(), and SDL_RecreateWindow().

SDL_GL_MakeCurrent()

int SDL_GL_MakeCurrent	(	SDL_Window *	window,
		SDL_GLContext	context
	)

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

Note

The context must have been created with a compatible window.

Definition at line 3634 of file SDL_video.c.

{
    int retval;
 
    if (window == SDL_GL_GetCurrentWindow() &&
        ctx == SDL_GL_GetCurrentContext()) {
        /* We're already current. */
        return 0;
    }
 
    if (!ctx) {
        window = NULL;
    } else if (window) {
        CHECK_WINDOW_MAGIC(window, -1);
 
        if (!(window->flags & SDL_WINDOW_OPENGL)) {
            return SDL_SetError("The specified window isn't an OpenGL window");
        }
    } else if (!_this->gl_allow_no_surface) {
        return SDL_SetError("Use of OpenGL without a window is not supported on this platform");
    }
 
    retval = _this->GL_MakeCurrent(_this, window, ctx);
    if (retval == 0) {
        _this->current_glwin = window;
        _this->current_glctx = ctx;
        SDL_TLSSet(_this->current_glwin_tls, window, NULL);
        SDL_TLSSet(_this->current_glctx_tls, ctx, NULL);
    }
    return retval;
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::current_glctx, SDL_VideoDevice::current_glctx_tls, SDL_VideoDevice::current_glwin, SDL_VideoDevice::current_glwin_tls, SDL_VideoDevice::gl_allow_no_surface, SDL_VideoDevice::GL_MakeCurrent, NULL, retval, SDL_GL_GetCurrentContext(), SDL_GL_GetCurrentWindow(), SDL_SetError, SDL_TLSSet, and SDL_WINDOW_OPENGL.

Referenced by SDL_DestroyWindow(), and SDL_GL_DeleteContext().

SDL_GL_ResetAttributes()

void SDL_GL_ResetAttributes

(

void

)

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

Definition at line 3187 of file SDL_video.c.

{
    if (!_this) {
        return;
    }
 
    _this->gl_config.red_size = 3;
    _this->gl_config.green_size = 3;
    _this->gl_config.blue_size = 2;
    _this->gl_config.alpha_size = 0;
    _this->gl_config.buffer_size = 0;
    _this->gl_config.depth_size = 16;
    _this->gl_config.stencil_size = 0;
    _this->gl_config.double_buffer = 1;
    _this->gl_config.accum_red_size = 0;
    _this->gl_config.accum_green_size = 0;
    _this->gl_config.accum_blue_size = 0;
    _this->gl_config.accum_alpha_size = 0;
    _this->gl_config.stereo = 0;
    _this->gl_config.multisamplebuffers = 0;
    _this->gl_config.multisamplesamples = 0;
    _this->gl_config.retained_backing = 1;
    _this->gl_config.accelerated = -1;  /* accelerated or not, both are fine */
 
#if SDL_VIDEO_OPENGL
    _this->gl_config.major_version = 2;
    _this->gl_config.minor_version = 1;
    _this->gl_config.profile_mask = 0;
#elif SDL_VIDEO_OPENGL_ES2
    _this->gl_config.major_version = 2;
    _this->gl_config.minor_version = 0;
    _this->gl_config.profile_mask = SDL_GL_CONTEXT_PROFILE_ES;
#elif SDL_VIDEO_OPENGL_ES
    _this->gl_config.major_version = 1;
    _this->gl_config.minor_version = 1;
    _this->gl_config.profile_mask = SDL_GL_CONTEXT_PROFILE_ES;
#endif
 
    if (_this->GL_DefaultProfileConfig) {
        _this->GL_DefaultProfileConfig(_this, &_this->gl_config.profile_mask,
                                       &_this->gl_config.major_version,
                                       &_this->gl_config.minor_version);
    }
 
    _this->gl_config.flags = 0;
    _this->gl_config.framebuffer_srgb_capable = 0;
    _this->gl_config.no_error = 0;
    _this->gl_config.release_behavior = SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH;
    _this->gl_config.reset_notification = SDL_GL_CONTEXT_RESET_NO_NOTIFICATION;
 
    _this->gl_config.share_with_current_context = 0;
}

References _this, SDL_VideoDevice::accelerated, SDL_VideoDevice::accum_alpha_size, SDL_VideoDevice::accum_blue_size, SDL_VideoDevice::accum_green_size, SDL_VideoDevice::accum_red_size, SDL_VideoDevice::alpha_size, SDL_VideoDevice::blue_size, SDL_VideoDevice::buffer_size, SDL_VideoDevice::depth_size, SDL_VideoDevice::double_buffer, SDL_VideoDevice::flags, SDL_VideoDevice::framebuffer_srgb_capable, SDL_VideoDevice::gl_config, SDL_VideoDevice::GL_DefaultProfileConfig, SDL_VideoDevice::green_size, SDL_VideoDevice::major_version, SDL_VideoDevice::minor_version, SDL_VideoDevice::multisamplebuffers, SDL_VideoDevice::multisamplesamples, SDL_VideoDevice::no_error, SDL_VideoDevice::profile_mask, SDL_VideoDevice::red_size, SDL_VideoDevice::release_behavior, SDL_VideoDevice::reset_notification, SDL_VideoDevice::retained_backing, SDL_GL_CONTEXT_PROFILE_ES, SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH, SDL_GL_CONTEXT_RESET_NO_NOTIFICATION, SDL_VideoDevice::share_with_current_context, SDL_VideoDevice::stencil_size, and SDL_VideoDevice::stereo.

Referenced by SDL_VideoInit().

SDL_GL_SetAttribute()

int SDL_GL_SetAttribute	(	SDL_GLattr	attr,
		int	value
	)

Set an OpenGL window attribute before window creation.

Returns

0 on success, or -1 if the attribute could not be set.

Definition at line 3241 of file SDL_video.c.

{
#if SDL_VIDEO_OPENGL || SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
    int retval;
 
    if (!_this) {
        return SDL_UninitializedVideo();
    }
    retval = 0;
    switch (attr) {
    case SDL_GL_RED_SIZE:
        _this->gl_config.red_size = value;
        break;
    case SDL_GL_GREEN_SIZE:
        _this->gl_config.green_size = value;
        break;
    case SDL_GL_BLUE_SIZE:
        _this->gl_config.blue_size = value;
        break;
    case SDL_GL_ALPHA_SIZE:
        _this->gl_config.alpha_size = value;
        break;
    case SDL_GL_DOUBLEBUFFER:
        _this->gl_config.double_buffer = value;
        break;
    case SDL_GL_BUFFER_SIZE:
        _this->gl_config.buffer_size = value;
        break;
    case SDL_GL_DEPTH_SIZE:
        _this->gl_config.depth_size = value;
        break;
    case SDL_GL_STENCIL_SIZE:
        _this->gl_config.stencil_size = value;
        break;
    case SDL_GL_ACCUM_RED_SIZE:
        _this->gl_config.accum_red_size = value;
        break;
    case SDL_GL_ACCUM_GREEN_SIZE:
        _this->gl_config.accum_green_size = value;
        break;
    case SDL_GL_ACCUM_BLUE_SIZE:
        _this->gl_config.accum_blue_size = value;
        break;
    case SDL_GL_ACCUM_ALPHA_SIZE:
        _this->gl_config.accum_alpha_size = value;
        break;
    case SDL_GL_STEREO:
        _this->gl_config.stereo = value;
        break;
    case SDL_GL_MULTISAMPLEBUFFERS:
        _this->gl_config.multisamplebuffers = value;
        break;
    case SDL_GL_MULTISAMPLESAMPLES:
        _this->gl_config.multisamplesamples = value;
        break;
    case SDL_GL_ACCELERATED_VISUAL:
        _this->gl_config.accelerated = value;
        break;
    case SDL_GL_RETAINED_BACKING:
        _this->gl_config.retained_backing = value;
        break;
    case SDL_GL_CONTEXT_MAJOR_VERSION:
        _this->gl_config.major_version = value;
        break;
    case SDL_GL_CONTEXT_MINOR_VERSION:
        _this->gl_config.minor_version = value;
        break;
    case SDL_GL_CONTEXT_EGL:
        /* FIXME: SDL_GL_CONTEXT_EGL to be deprecated in SDL 2.1 */
        if (value != 0) {
            SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_ES);
        } else {
            SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, 0);
        };
        break;
    case SDL_GL_CONTEXT_FLAGS:
        if (value & ~(SDL_GL_CONTEXT_DEBUG_FLAG |
                      SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG |
                      SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG |
                      SDL_GL_CONTEXT_RESET_ISOLATION_FLAG)) {
            retval = SDL_SetError("Unknown OpenGL context flag %d", value);
            break;
        }
        _this->gl_config.flags = value;
        break;
    case SDL_GL_CONTEXT_PROFILE_MASK:
        if (value != 0 &&
            value != SDL_GL_CONTEXT_PROFILE_CORE &&
            value != SDL_GL_CONTEXT_PROFILE_COMPATIBILITY &&
            value != SDL_GL_CONTEXT_PROFILE_ES) {
            retval = SDL_SetError("Unknown OpenGL context profile %d", value);
            break;
        }
        _this->gl_config.profile_mask = value;
        break;
    case SDL_GL_SHARE_WITH_CURRENT_CONTEXT:
        _this->gl_config.share_with_current_context = value;
        break;
    case SDL_GL_FRAMEBUFFER_SRGB_CAPABLE:
        _this->gl_config.framebuffer_srgb_capable = value;
        break;
    case SDL_GL_CONTEXT_RELEASE_BEHAVIOR:
        _this->gl_config.release_behavior = value;
        break;
    case SDL_GL_CONTEXT_RESET_NOTIFICATION:
        _this->gl_config.reset_notification = value;
        break;
    case SDL_GL_CONTEXT_NO_ERROR:
        _this->gl_config.no_error = value;
        break;
    default:
        retval = SDL_SetError("Unknown OpenGL attribute");
        break;
    }
    return retval;
#else
    return SDL_Unsupported();
#endif /* SDL_VIDEO_OPENGL */
}

References _this, SDL_VideoDevice::accelerated, SDL_VideoDevice::accum_alpha_size, SDL_VideoDevice::accum_blue_size, SDL_VideoDevice::accum_green_size, SDL_VideoDevice::accum_red_size, SDL_VideoDevice::alpha_size, SDL_VideoDevice::blue_size, SDL_VideoDevice::buffer_size, SDL_VideoDevice::depth_size, SDL_VideoDevice::double_buffer, SDL_VideoDevice::flags, SDL_VideoDevice::framebuffer_srgb_capable, SDL_VideoDevice::gl_config, SDL_VideoDevice::green_size, SDL_VideoDevice::major_version, SDL_VideoDevice::minor_version, SDL_VideoDevice::multisamplebuffers, SDL_VideoDevice::multisamplesamples, SDL_VideoDevice::no_error, SDL_VideoDevice::profile_mask, SDL_VideoDevice::red_size, SDL_VideoDevice::release_behavior, SDL_VideoDevice::reset_notification, SDL_VideoDevice::retained_backing, retval, SDL_GL_ACCELERATED_VISUAL, SDL_GL_ACCUM_ALPHA_SIZE, SDL_GL_ACCUM_BLUE_SIZE, SDL_GL_ACCUM_GREEN_SIZE, SDL_GL_ACCUM_RED_SIZE, SDL_GL_ALPHA_SIZE, SDL_GL_BLUE_SIZE, SDL_GL_BUFFER_SIZE, SDL_GL_CONTEXT_DEBUG_FLAG, SDL_GL_CONTEXT_EGL, SDL_GL_CONTEXT_FLAGS, SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG, SDL_GL_CONTEXT_MAJOR_VERSION, SDL_GL_CONTEXT_MINOR_VERSION, SDL_GL_CONTEXT_NO_ERROR, SDL_GL_CONTEXT_PROFILE_COMPATIBILITY, SDL_GL_CONTEXT_PROFILE_CORE, SDL_GL_CONTEXT_PROFILE_ES, SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_RELEASE_BEHAVIOR, SDL_GL_CONTEXT_RESET_ISOLATION_FLAG, SDL_GL_CONTEXT_RESET_NOTIFICATION, SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG, SDL_GL_DEPTH_SIZE, SDL_GL_DOUBLEBUFFER, SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, SDL_GL_GREEN_SIZE, SDL_GL_MULTISAMPLEBUFFERS, SDL_GL_MULTISAMPLESAMPLES, SDL_GL_RED_SIZE, SDL_GL_RETAINED_BACKING, SDL_GL_SetAttribute(), SDL_GL_SHARE_WITH_CURRENT_CONTEXT, SDL_GL_STENCIL_SIZE, SDL_GL_STEREO, SDL_SetError, SDL_UninitializedVideo(), SDL_Unsupported, SDL_VideoDevice::share_with_current_context, SDL_VideoDevice::stencil_size, and SDL_VideoDevice::stereo.

Referenced by SDL_GL_SetAttribute().

SDL_GL_SetSwapInterval()

int SDL_GL_SetSwapInterval

(

int

interval

)

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

Definition at line 3698 of file SDL_video.c.

{
    if (!_this) {
        return SDL_UninitializedVideo();
    } else if (SDL_GL_GetCurrentContext() == NULL) {
        return SDL_SetError("No OpenGL context has been made current");
    } else if (_this->GL_SetSwapInterval) {
        return _this->GL_SetSwapInterval(_this, interval);
    } else {
        return SDL_SetError("Setting the swap interval is not supported");
    }
}

References _this, SDL_VideoDevice::GL_SetSwapInterval, NULL, SDL_GL_GetCurrentContext(), SDL_SetError, and SDL_UninitializedVideo().

SDL_GL_SwapWindow()

void SDL_GL_SwapWindow

(

SDL_Window *

window

)

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

Definition at line 3726 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (!(window->flags & SDL_WINDOW_OPENGL)) {
        SDL_SetError("The specified window isn't an OpenGL window");
        return;
    }
 
    if (SDL_GL_GetCurrentWindow() != window) {
        SDL_SetError("The specified window has not been made current");
        return;
    }
 
    _this->GL_SwapWindow(_this, window);
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GL_SwapWindow, SDL_GL_GetCurrentWindow(), SDL_SetError, and SDL_WINDOW_OPENGL.

SDL_GL_UnloadLibrary()

void SDL_GL_UnloadLibrary

(

void

)

Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().

See also

SDL_GL_LoadLibrary()

Definition at line 583 of file SDL_dynapi_procs.h.

References _this, SDL_VideoDevice::driver_loaded, SDL_VideoDevice::gl_config, SDL_VideoDevice::GL_UnloadLibrary, and SDL_UninitializedVideo().

Referenced by SDL_DestroyWindow(), and SDL_RecreateWindow().

SDL_HideWindow()

void SDL_HideWindow

(

SDL_Window *

window

)

Hide a window.

See also

SDL_ShowWindow()

Definition at line 2279 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (!(window->flags & SDL_WINDOW_SHOWN)) {
        return;
    }
 
    window->is_hiding = SDL_TRUE;
    SDL_UpdateFullscreenMode(window, SDL_FALSE);
 
    if (_this->HideWindow) {
        _this->HideWindow(_this, window);
    }
    window->is_hiding = SDL_FALSE;
    SDL_SendWindowEvent(window, SDL_WINDOWEVENT_HIDDEN, 0, 0);
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::HideWindow, SDL_FALSE, SDL_SendWindowEvent(), SDL_TRUE, SDL_UpdateFullscreenMode(), SDL_WINDOW_SHOWN, and SDL_WINDOWEVENT_HIDDEN.

Referenced by SDL_DestroyWindow(), and SDL_RecreateWindow().

SDL_IsScreenSaverEnabled()

SDL_bool SDL_IsScreenSaverEnabled

(

void

)

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

See also

SDL_EnableScreenSaver()

SDL_DisableScreenSaver()

Definition at line 2907 of file SDL_video.c.

{
    if (!_this) {
        return SDL_TRUE;
    }
    return _this->suspend_screensaver ? SDL_FALSE : SDL_TRUE;
}

References _this, SDL_FALSE, SDL_TRUE, and SDL_VideoDevice::suspend_screensaver.

SDL_MaximizeWindow()

void SDL_MaximizeWindow

(

SDL_Window *

window

)

Make a window as large as possible.

See also

SDL_RestoreWindow()

Definition at line 2311 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (window->flags & SDL_WINDOW_MAXIMIZED) {
        return;
    }
 
    /* !!! FIXME: should this check if the window is resizable? */
 
    if (_this->MaximizeWindow) {
        _this->MaximizeWindow(_this, window);
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::MaximizeWindow, and SDL_WINDOW_MAXIMIZED.

Referenced by SDL_FinishWindowCreation().

SDL_MinimizeWindow()

void SDL_MinimizeWindow

(

SDL_Window *

window

)

Minimize a window to an iconic representation.

See also

SDL_RestoreWindow()

Definition at line 2336 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (window->flags & SDL_WINDOW_MINIMIZED) {
        return;
    }
 
    if (!CanMinimizeWindow(window)) {
        return;
    }
 
    SDL_UpdateFullscreenMode(window, SDL_FALSE);
 
    if (_this->MinimizeWindow) {
        _this->MinimizeWindow(_this, window);
    }
}

References _this, CanMinimizeWindow(), CHECK_WINDOW_MAGIC, SDL_VideoDevice::MinimizeWindow, SDL_FALSE, SDL_UpdateFullscreenMode(), and SDL_WINDOW_MINIMIZED.

Referenced by SDL_FinishWindowCreation(), SDL_OnWindowFocusLost(), and SDL_UpdateFullscreenMode().

SDL_RaiseWindow()

void SDL_RaiseWindow

(

SDL_Window *

window

)

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

Definition at line 2298 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (!(window->flags & SDL_WINDOW_SHOWN)) {
        return;
    }
    if (_this->RaiseWindow) {
        _this->RaiseWindow(_this, window);
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::RaiseWindow, and SDL_WINDOW_SHOWN.

Referenced by SDL_ShowMessageBox().

SDL_RestoreWindow()

void SDL_RestoreWindow

(

SDL_Window *

window

)

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

See also

SDL_MaximizeWindow()

SDL_MinimizeWindow()

Definition at line 2356 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (!(window->flags & (SDL_WINDOW_MAXIMIZED | SDL_WINDOW_MINIMIZED))) {
        return;
    }
 
    if (_this->RestoreWindow) {
        _this->RestoreWindow(_this, window);
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::RestoreWindow, SDL_WINDOW_MAXIMIZED, and SDL_WINDOW_MINIMIZED.

SDL_SetWindowBordered()

void SDL_SetWindowBordered	(	SDL_Window *	window,
		SDL_bool	bordered
	)

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

Definition at line 2061 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
    if (!(window->flags & SDL_WINDOW_FULLSCREEN)) {
        const int want = (bordered != SDL_FALSE);  /* normalize the flag. */
        const int have = ((window->flags & SDL_WINDOW_BORDERLESS) == 0);
        if ((want != have) && (_this->SetWindowBordered)) {
            if (want) {
                window->flags &= ~SDL_WINDOW_BORDERLESS;
            } else {
                window->flags |= SDL_WINDOW_BORDERLESS;
            }
            _this->SetWindowBordered(_this, window, (SDL_bool) want);
        }
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_FALSE, SDL_WINDOW_BORDERLESS, SDL_WINDOW_FULLSCREEN, and SDL_VideoDevice::SetWindowBordered.

SDL_SetWindowBrightness()

int SDL_SetWindowBrightness	(	SDL_Window *	window,
		float	brightness
	)

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

Definition at line 2471 of file SDL_video.c.

{
    Uint16 ramp[256];
    int status;
 
    CHECK_WINDOW_MAGIC(window, -1);
 
    SDL_CalculateGammaRamp(brightness, ramp);
    status = SDL_SetWindowGammaRamp(window, ramp, ramp, ramp);
    if (status == 0) {
        window->brightness = brightness;
    }
    return status;
}

References CHECK_WINDOW_MAGIC, SDL_CalculateGammaRamp, and SDL_SetWindowGammaRamp().

SDL_SetWindowData()

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

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

Definition at line 1907 of file SDL_video.c.

{
    SDL_WindowUserData *prev, *data;
 
    CHECK_WINDOW_MAGIC(window, NULL);
 
    /* Input validation */
    if (name == NULL || name[0] == '\0') {
      SDL_InvalidParamError("name");
      return NULL;
    }
 
    /* See if the named data already exists */
    prev = NULL;
    for (data = window->data; data; prev = data, data = data->next) {
        if (data->name && SDL_strcmp(data->name, name) == 0) {
            void *last_value = data->data;
 
            if (userdata) {
                /* Set the new value */
                data->data = userdata;
            } else {
                /* Delete this value */
                if (prev) {
                    prev->next = data->next;
                } else {
                    window->data = data->next;
                }
                SDL_free(data->name);
                SDL_free(data);
            }
            return last_value;
        }
    }
 
    /* Add new data to the window */
    if (userdata) {
        data = (SDL_WindowUserData *)SDL_malloc(sizeof(*data));
        data->name = SDL_strdup(name);
        data->data = userdata;
        data->next = window->data;
        window->data = data;
    }
    return NULL;
}

References CHECK_WINDOW_MAGIC, SDL_WindowUserData::data, SDL_WindowUserData::next, NULL, SDL_free, SDL_InvalidParamError, SDL_malloc, SDL_strcmp, and SDL_strdup.

Referenced by SDL_CreateWindowTexture(), and SDL_DestroyWindowTexture().

SDL_SetWindowDisplayMode()

int SDL_SetWindowDisplayMode	(	SDL_Window *	window,
		const SDL_DisplayMode *	mode
	)

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

Definition at line 1141 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (mode) {
        window->fullscreen_mode = *mode;
    } else {
        SDL_zero(window->fullscreen_mode);
    }
 
    if (FULLSCREEN_VISIBLE(window) && (window->flags & SDL_WINDOW_FULLSCREEN_DESKTOP) != SDL_WINDOW_FULLSCREEN_DESKTOP) {
        SDL_DisplayMode fullscreen_mode;
        if (SDL_GetWindowDisplayMode(window, &fullscreen_mode) == 0) {
            SDL_SetDisplayModeForDisplay(SDL_GetDisplayForWindow(window), &fullscreen_mode);
        }
    }
    return 0;
}

References CHECK_WINDOW_MAGIC, FULLSCREEN_VISIBLE, SDL_GetDisplayForWindow(), SDL_GetWindowDisplayMode(), SDL_SetDisplayModeForDisplay(), SDL_WINDOW_FULLSCREEN_DESKTOP, and SDL_zero.

SDL_SetWindowFullscreen()

int SDL_SetWindowFullscreen	(	SDL_Window *	window,
		Uint32	flags
	)

Set a window's fullscreen state.

Returns

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

See also

SDL_SetWindowDisplayMode()

SDL_GetWindowDisplayMode()

Definition at line 2370 of file SDL_video.c.

{
    Uint32 oldflags;
    CHECK_WINDOW_MAGIC(window, -1);
 
    flags &= FULLSCREEN_MASK;
 
    if (flags == (window->flags & FULLSCREEN_MASK)) {
        return 0;
    }
 
    /* clear the previous flags and OR in the new ones */
    oldflags = window->flags & FULLSCREEN_MASK;
    window->flags &= ~FULLSCREEN_MASK;
    window->flags |= flags;
 
    if (SDL_UpdateFullscreenMode(window, FULLSCREEN_VISIBLE(window)) == 0) {
        return 0;
    }
    
    window->flags &= ~FULLSCREEN_MASK;
    window->flags |= oldflags;
    return -1;
}

References CHECK_WINDOW_MAGIC, FULLSCREEN_MASK, FULLSCREEN_VISIBLE, and SDL_UpdateFullscreenMode().

Referenced by SDL_FinishWindowCreation().

SDL_SetWindowGammaRamp()

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

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

Definition at line 2557 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (!_this->SetWindowGammaRamp) {
        return SDL_Unsupported();
    }
 
    if (!window->gamma) {
        if (SDL_GetWindowGammaRamp(window, NULL, NULL, NULL) < 0) {
            return -1;
        }
        SDL_assert(window->gamma != NULL);
    }
 
    if (red) {
        SDL_memcpy(&window->gamma[0*256], red, 256*sizeof(Uint16));
    }
    if (green) {
        SDL_memcpy(&window->gamma[1*256], green, 256*sizeof(Uint16));
    }
    if (blue) {
        SDL_memcpy(&window->gamma[2*256], blue, 256*sizeof(Uint16));
    }
    if (window->flags & SDL_WINDOW_INPUT_FOCUS) {
        return _this->SetWindowGammaRamp(_this, window, window->gamma);
    } else {
        return 0;
    }
}

References _this, CHECK_WINDOW_MAGIC, NULL, red, SDL_assert, SDL_GetWindowGammaRamp(), SDL_memcpy, SDL_Unsupported, SDL_WINDOW_INPUT_FOCUS, and SDL_VideoDevice::SetWindowGammaRamp.

Referenced by SDL_SetWindowBrightness().

SDL_SetWindowGrab()

void SDL_SetWindowGrab	(	SDL_Window *	window,
		SDL_bool	grabbed
	)

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.

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.

See also

SDL_GetWindowGrab()

Definition at line 2667 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (!!grabbed == !!(window->flags & SDL_WINDOW_INPUT_GRABBED)) {
        return;
    }
    if (grabbed) {
        window->flags |= SDL_WINDOW_INPUT_GRABBED;
    } else {
        window->flags &= ~SDL_WINDOW_INPUT_GRABBED;
    }
    SDL_UpdateWindowGrab(window);
}

References CHECK_WINDOW_MAGIC, SDL_UpdateWindowGrab(), and SDL_WINDOW_INPUT_GRABBED.

Referenced by SDL_FinishWindowCreation().

SDL_SetWindowHitTest()

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

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

window	The window to set hit-testing on.
callback	The callback to call when doing a hit-test.
callback_data	An app-defined void pointer passed to the callback.

Returns

0 on success, -1 on error (including unsupported).

Definition at line 4145 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (!_this->SetWindowHitTest) {
        return SDL_Unsupported();
    } else if (_this->SetWindowHitTest(window, callback != NULL) == -1) {
        return -1;
    }
 
    window->hit_test = callback;
    window->hit_test_data = userdata;
 
    return 0;
}

References _this, callback(), CHECK_WINDOW_MAGIC, NULL, SDL_Unsupported, and SDL_VideoDevice::SetWindowHitTest.

SDL_SetWindowIcon()

void SDL_SetWindowIcon	(	SDL_Window *	window,
		SDL_Surface *	icon
	)

Set the icon for a window.

Parameters

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

Definition at line 1885 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (!icon) {
        return;
    }
 
    SDL_FreeSurface(window->icon);
 
    /* Convert the icon into ARGB8888 */
    window->icon = SDL_ConvertSurfaceFormat(icon, SDL_PIXELFORMAT_ARGB8888, 0);
    if (!window->icon) {
        return;
    }
 
    if (_this->SetWindowIcon) {
        _this->SetWindowIcon(_this, window, window->icon);
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_ConvertSurfaceFormat, SDL_FreeSurface, SDL_PIXELFORMAT_ARGB8888, and SDL_VideoDevice::SetWindowIcon.

SDL_SetWindowInputFocus()

int SDL_SetWindowInputFocus

(

SDL_Window *

window

)

Explicitly sets 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's completely obscured by other windows.

Parameters

window

The window that should get the input focus

Returns

0 on success, or -1 otherwise.

See also

SDL_RaiseWindow()

Definition at line 2544 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (!_this->SetWindowInputFocus) {
        return SDL_Unsupported();
    }
    
    return _this->SetWindowInputFocus(_this, window);
}

References _this, CHECK_WINDOW_MAGIC, SDL_Unsupported, and SDL_VideoDevice::SetWindowInputFocus.

SDL_SetWindowMaximumSize()

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

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

Definition at line 2222 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
    if (max_w <= 0) {
        SDL_InvalidParamError("max_w");
        return;
    }
    if (max_h <= 0) {
        SDL_InvalidParamError("max_h");
        return;
    }
 
    if (max_w < window->min_w || max_h < window->min_h) {
        SDL_SetError("SDL_SetWindowMaximumSize(): Tried to set maximum size smaller than minimum size");
        return;
    }
 
    window->max_w = max_w;
    window->max_h = max_h;
 
    if (!(window->flags & SDL_WINDOW_FULLSCREEN)) {
        if (_this->SetWindowMaximumSize) {
            _this->SetWindowMaximumSize(_this, window);
        }
        /* Ensure that window is not larger than maximal size */
        SDL_SetWindowSize(window, SDL_min(window->w, window->max_w), SDL_min(window->h, window->max_h));
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_InvalidParamError, SDL_min, SDL_SetError, SDL_SetWindowSize(), SDL_WINDOW_FULLSCREEN, and SDL_VideoDevice::SetWindowMaximumSize.

SDL_SetWindowMinimumSize()

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

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

Definition at line 2179 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
    if (min_w <= 0) {
        SDL_InvalidParamError("min_w");
        return;
    }
    if (min_h <= 0) {
        SDL_InvalidParamError("min_h");
        return;
    }
 
    if ((window->max_w && min_w > window->max_w) ||
        (window->max_h && min_h > window->max_h)) {
        SDL_SetError("SDL_SetWindowMinimumSize(): Tried to set minimum size larger than maximum size");
        return;
    }
 
    window->min_w = min_w;
    window->min_h = min_h;
 
    if (!(window->flags & SDL_WINDOW_FULLSCREEN)) {
        if (_this->SetWindowMinimumSize) {
            _this->SetWindowMinimumSize(_this, window);
        }
        /* Ensure that window is not smaller than minimal size */
        SDL_SetWindowSize(window, SDL_max(window->w, window->min_w), SDL_max(window->h, window->min_h));
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_InvalidParamError, SDL_max, SDL_SetError, SDL_SetWindowSize(), SDL_WINDOW_FULLSCREEN, and SDL_VideoDevice::SetWindowMinimumSize.

SDL_SetWindowModalFor()

int SDL_SetWindowModalFor	(	SDL_Window *	modal_window,
		SDL_Window *	parent_window
	)

Sets the window as a modal for another window (TODO: reconsider this function and/or its name)

Parameters

modal_window	The window that should be modal
parent_window	The parent window

Returns

0 on success, or -1 otherwise.

Definition at line 2531 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(modal_window, -1);
    CHECK_WINDOW_MAGIC(parent_window, -1);
 
    if (!_this->SetWindowModalFor) {
        return SDL_Unsupported();
    }
    
    return _this->SetWindowModalFor(_this, modal_window, parent_window);
}

References _this, CHECK_WINDOW_MAGIC, SDL_Unsupported, and SDL_VideoDevice::SetWindowModalFor.

SDL_SetWindowOpacity()

int SDL_SetWindowOpacity	(	SDL_Window *	window,
		float	opacity
	)

Set the opacity for a window.

Parameters

window	The window which will be made transparent or opaque
opacity	Opacity (0.0f - transparent, 1.0f - opaque) This will be clamped internally between 0.0f and 1.0f.

Returns

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

See also

SDL_GetWindowOpacity()

Definition at line 2495 of file SDL_video.c.

{
    int retval;
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (!_this->SetWindowOpacity) {
        return SDL_Unsupported();
    }
 
    if (opacity < 0.0f) {
        opacity = 0.0f;
    } else if (opacity > 1.0f) {
        opacity = 1.0f;
    }
 
    retval = _this->SetWindowOpacity(_this, window, opacity);
    if (retval == 0) {
        window->opacity = opacity;
    }
 
    return retval;
}

References _this, CHECK_WINDOW_MAGIC, retval, SDL_Unsupported, and SDL_VideoDevice::SetWindowOpacity.

SDL_SetWindowPosition()

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

Set the position of a window.

Parameters

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

Note

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

See also

SDL_GetWindowPosition()

Definition at line 1975 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (SDL_WINDOWPOS_ISCENTERED(x) || SDL_WINDOWPOS_ISCENTERED(y)) {
        int displayIndex = (x & 0xFFFF);
        SDL_Rect bounds;
        if (displayIndex >= _this->num_displays) {
            displayIndex = 0;
        }
 
        SDL_zero(bounds);
 
        SDL_GetDisplayBounds(displayIndex, &bounds);
        if (SDL_WINDOWPOS_ISCENTERED(x)) {
            x = bounds.x + (bounds.w - window->w) / 2;
        }
        if (SDL_WINDOWPOS_ISCENTERED(y)) {
            y = bounds.y + (bounds.h - window->h) / 2;
        }
    }
 
    if ((window->flags & SDL_WINDOW_FULLSCREEN)) {
        if (!SDL_WINDOWPOS_ISUNDEFINED(x)) {
            window->windowed.x = x;
        }
        if (!SDL_WINDOWPOS_ISUNDEFINED(y)) {
            window->windowed.y = y;
        }
    } else {
        if (!SDL_WINDOWPOS_ISUNDEFINED(x)) {
            window->x = x;
        }
        if (!SDL_WINDOWPOS_ISUNDEFINED(y)) {
            window->y = y;
        }
 
        if (_this->SetWindowPosition) {
            _this->SetWindowPosition(_this, window);
        }
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_Rect::h, SDL_VideoDevice::num_displays, SDL_GetDisplayBounds(), SDL_WINDOW_FULLSCREEN, SDL_WINDOWPOS_ISCENTERED, SDL_WINDOWPOS_ISUNDEFINED, SDL_zero, SDL_VideoDevice::SetWindowPosition, SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

SDL_SetWindowResizable()

void SDL_SetWindowResizable	(	SDL_Window *	window,
		SDL_bool	resizable
	)

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.

Parameters

window	The window of which to change the resizable state.
resizable	SDL_TRUE to allow resizing, SDL_FALSE to disallow.

Note

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

See also

SDL_GetWindowFlags()

Definition at line 2079 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
    if (!(window->flags & SDL_WINDOW_FULLSCREEN)) {
        const int want = (resizable != SDL_FALSE);  /* normalize the flag. */
        const int have = ((window->flags & SDL_WINDOW_RESIZABLE) != 0);
        if ((want != have) && (_this->SetWindowResizable)) {
            if (want) {
                window->flags |= SDL_WINDOW_RESIZABLE;
            } else {
                window->flags &= ~SDL_WINDOW_RESIZABLE;
            }
            _this->SetWindowResizable(_this, window, (SDL_bool) want);
        }
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_FALSE, SDL_WINDOW_FULLSCREEN, SDL_WINDOW_RESIZABLE, and SDL_VideoDevice::SetWindowResizable.

SDL_SetWindowSize()

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

Set the size of a window's client area.

Parameters

window	The window to resize.
w	The width of the window, in screen coordinates. Must be >0.
h	The height of the window, in screen coordinates. Must be >0.

Note

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

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 OS X). Use SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() to get the real client area size in pixels.

See also

SDL_GetWindowSize()

SDL_SetWindowDisplayMode()

Definition at line 2097 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
    if (w <= 0) {
        SDL_InvalidParamError("w");
        return;
    }
    if (h <= 0) {
        SDL_InvalidParamError("h");
        return;
    }
 
    /* Make sure we don't exceed any window size limits */
    if (window->min_w && w < window->min_w) {
        w = window->min_w;
    }
    if (window->max_w && w > window->max_w) {
        w = window->max_w;
    }
    if (window->min_h && h < window->min_h) {
        h = window->min_h;
    }
    if (window->max_h && h > window->max_h) {
        h = window->max_h;
    }
 
    window->windowed.w = w;
    window->windowed.h = h;
 
    if (window->flags & SDL_WINDOW_FULLSCREEN) {
        if (FULLSCREEN_VISIBLE(window) && (window->flags & SDL_WINDOW_FULLSCREEN_DESKTOP) != SDL_WINDOW_FULLSCREEN_DESKTOP) {
            window->last_fullscreen_flags = 0;
            SDL_UpdateFullscreenMode(window, SDL_TRUE);
        }
    } else {
        window->w = w;
        window->h = h;
        if (_this->SetWindowSize) {
            _this->SetWindowSize(_this, window);
        }
        if (window->w == w && window->h == h) {
            /* We didn't get a SDL_WINDOWEVENT_RESIZED event (by design) */
            SDL_OnWindowResized(window);
        }
    }
}

References _this, CHECK_WINDOW_MAGIC, FULLSCREEN_VISIBLE, SDL_InvalidParamError, SDL_OnWindowResized(), SDL_TRUE, SDL_UpdateFullscreenMode(), SDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP, and SDL_VideoDevice::SetWindowSize.

Referenced by SDL_SetWindowMaximumSize(), and SDL_SetWindowMinimumSize().

SDL_SetWindowTitle()

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

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

See also

SDL_GetWindowTitle()

Definition at line 1860 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (title == window->title) {
        return;
    }
    SDL_free(window->title);
 
    window->title = SDL_strdup(title ? title : "");
 
    if (_this->SetWindowTitle) {
        _this->SetWindowTitle(_this, window);
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_free, SDL_strdup, and SDL_VideoDevice::SetWindowTitle.

Referenced by SDL_CreateWindow().

SDL_ShowWindow()

void SDL_ShowWindow

(

SDL_Window *

window

)

Show a window.

See also

SDL_HideWindow()

Definition at line 2264 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window,);
 
    if (window->flags & SDL_WINDOW_SHOWN) {
        return;
    }
 
    if (_this->ShowWindow) {
        _this->ShowWindow(_this, window);
    }
    SDL_SendWindowEvent(window, SDL_WINDOWEVENT_SHOWN, 0, 0);
}

References _this, CHECK_WINDOW_MAGIC, SDL_SendWindowEvent(), SDL_WINDOW_SHOWN, SDL_WINDOWEVENT_SHOWN, and SDL_VideoDevice::ShowWindow.

Referenced by SDL_FinishWindowCreation().

SDL_UpdateWindowSurface()

int SDL_UpdateWindowSurface

(

SDL_Window *

window

)

Copy the window surface to the screen.

Returns

0 on success, or -1 on error.

See also

SDL_GetWindowSurface()

SDL_UpdateWindowSurfaceRects()

Definition at line 2444 of file SDL_video.c.

{
    SDL_Rect full_rect;
 
    CHECK_WINDOW_MAGIC(window, -1);
 
    full_rect.x = 0;
    full_rect.y = 0;
    full_rect.w = window->w;
    full_rect.h = window->h;
    return SDL_UpdateWindowSurfaceRects(window, &full_rect, 1);
}

References CHECK_WINDOW_MAGIC, SDL_Rect::h, SDL_UpdateWindowSurfaceRects(), SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

SDL_UpdateWindowSurfaceRects()

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

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

Definition at line 2458 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, -1);
 
    if (!window->surface_valid) {
        return SDL_SetError("Window surface is invalid, please call SDL_GetWindowSurface() to get a new surface");
    }
 
    return _this->UpdateWindowFramebuffer(_this, window, rects, numrects);
}

References _this, CHECK_WINDOW_MAGIC, SDL_SetError, and SDL_VideoDevice::UpdateWindowFramebuffer.

Referenced by SDL_UpdateWindowSurface().

SDL_VideoInit()

int SDL_VideoInit

(

const char *

driver_name

)

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

Definition at line 469 of file SDL_video.c.

{
    SDL_VideoDevice *video;
    int index;
    int i;
 
    /* Check to make sure we don't overwrite '_this' */
    if (_this != NULL) {
        SDL_VideoQuit();
    }
 
#if !SDL_TIMERS_DISABLED
    SDL_TicksInit();
#endif
 
    /* Start the event loop */
    if (SDL_InitSubSystem(SDL_INIT_EVENTS) < 0 ||
        SDL_KeyboardInit() < 0 ||
        SDL_MouseInit() < 0 ||
        SDL_TouchInit() < 0) {
        return -1;
    }
 
    /* Select the proper video driver */
    index = 0;
    video = NULL;
    if (driver_name == NULL) {
        driver_name = SDL_getenv("SDL_VIDEODRIVER");
    }
    if (driver_name != NULL) {
        for (i = 0; bootstrap[i]; ++i) {
            if (SDL_strncasecmp(bootstrap[i]->name, driver_name, SDL_strlen(driver_name)) == 0) {
                video = bootstrap[i]->create(index);
                break;
            }
        }
    } else {
        for (i = 0; bootstrap[i]; ++i) {
            video = bootstrap[i]->create(index);
            if (video != NULL) {
                break;
            }
        }
    }
    if (video == NULL) {
        if (driver_name) {
            return SDL_SetError("%s not available", driver_name);
        }
        return SDL_SetError("No available video device");
    }
    _this = video;
    _this->name = bootstrap[i]->name;
    _this->next_object_id = 1;
 
 
    /* Set some very sane GL defaults */
    _this->gl_config.driver_loaded = 0;
    _this->gl_config.dll_handle = NULL;
    SDL_GL_ResetAttributes();
 
    _this->current_glwin_tls = SDL_TLSCreate();
    _this->current_glctx_tls = SDL_TLSCreate();
 
    /* Initialize the video subsystem */
    if (_this->VideoInit(_this) < 0) {
        SDL_VideoQuit();
        return -1;
    }
 
    /* Make sure some displays were added */
    if (_this->num_displays == 0) {
        SDL_VideoQuit();
        return SDL_SetError("The video driver did not add any displays");
    }
 
    /* Add the renderer framebuffer emulation if desired */
    if (ShouldUseTextureFramebuffer()) {
        _this->CreateWindowFramebuffer = SDL_CreateWindowTexture;
        _this->UpdateWindowFramebuffer = SDL_UpdateWindowTexture;
        _this->DestroyWindowFramebuffer = SDL_DestroyWindowTexture;
    }
 
    /* Disable the screen saver by default. This is a change from <= 2.0.1,
       but most things using SDL are games or media players; you wouldn't
       want a screensaver to trigger if you're playing exclusively with a
       joystick, or passively watching a movie. Things that use SDL but
       function more like a normal desktop app should explicitly reenable the
       screensaver. */
    if (!SDL_GetHintBoolean(SDL_HINT_VIDEO_ALLOW_SCREENSAVER, SDL_FALSE)) {
        SDL_DisableScreenSaver();
    }
 
    /* If we don't use a screen keyboard, turn on text input by default,
       otherwise programs that expect to get text events without enabling
       UNICODE input won't get any events.
 
       Actually, come to think of it, you needed to call SDL_EnableUNICODE(1)
       in SDL 1.2 before you got text input events.  Hmm...
     */
    if (!SDL_HasScreenKeyboardSupport()) {
        SDL_StartTextInput();
    }
 
    /* We're ready to go! */
    return 0;
}

References _this, bootstrap, VideoBootStrap::create, SDL_VideoDevice::CreateWindowFramebuffer, SDL_VideoDevice::current_glctx_tls, SDL_VideoDevice::current_glwin_tls, SDL_VideoDevice::DestroyWindowFramebuffer, SDL_VideoDevice::dll_handle, SDL_VideoDevice::driver_loaded, SDL_VideoDevice::gl_config, i, SDL_VideoDevice::name, VideoBootStrap::name, SDL_VideoDevice::next_object_id, NULL, SDL_VideoDevice::num_displays, SDL_CreateWindowTexture(), SDL_DestroyWindowTexture(), SDL_DisableScreenSaver(), SDL_FALSE, SDL_getenv, SDL_GetHintBoolean, SDL_GL_ResetAttributes(), SDL_HasScreenKeyboardSupport(), SDL_HINT_VIDEO_ALLOW_SCREENSAVER, SDL_INIT_EVENTS, SDL_InitSubSystem, SDL_KeyboardInit(), SDL_MouseInit(), SDL_SetError, SDL_StartTextInput(), SDL_strlen, SDL_strncasecmp, SDL_TicksInit(), SDL_TLSCreate, SDL_TouchInit(), SDL_UpdateWindowTexture(), SDL_VideoQuit(), ShouldUseTextureFramebuffer(), SDL_VideoDevice::UpdateWindowFramebuffer, and SDL_VideoDevice::VideoInit.

SDL_VideoQuit()

void SDL_VideoQuit

(

void

)

Shuts down the video subsystem.

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

See also

SDL_VideoInit()

Definition at line 2946 of file SDL_video.c.

{
    int i, j;
 
    if (!_this) {
        return;
    }
 
    /* Halt event processing before doing anything else */
    SDL_TouchQuit();
    SDL_MouseQuit();
    SDL_KeyboardQuit();
    SDL_QuitSubSystem(SDL_INIT_EVENTS);
 
    SDL_EnableScreenSaver();
 
    /* Clean up the system video */
    while (_this->windows) {
        SDL_DestroyWindow(_this->windows);
    }
    _this->VideoQuit(_this);
 
    for (i = 0; i < _this->num_displays; ++i) {
        SDL_VideoDisplay *display = &_this->displays[i];
        for (j = display->num_display_modes; j--;) {
            SDL_free(display->display_modes[j].driverdata);
            display->display_modes[j].driverdata = NULL;
        }
        SDL_free(display->display_modes);
        display->display_modes = NULL;
        SDL_free(display->desktop_mode.driverdata);
        display->desktop_mode.driverdata = NULL;
        SDL_free(display->driverdata);
        display->driverdata = NULL;
    }
    if (_this->displays) {
        for (i = 0; i < _this->num_displays; ++i) {
            SDL_free(_this->displays[i].name);
        }
        SDL_free(_this->displays);
        _this->displays = NULL;
        _this->num_displays = 0;
    }
    SDL_free(_this->clipboard_text);
    _this->clipboard_text = NULL;
    _this->free(_this);
    _this = NULL;
}

References _this, SDL_VideoDevice::clipboard_text, SDL_VideoDisplay::desktop_mode, SDL_VideoDisplay::display_modes, SDL_VideoDevice::displays, SDL_DisplayMode::driverdata, SDL_VideoDisplay::driverdata, SDL_VideoDevice::free, i, j, SDL_VideoDisplay::name, NULL, SDL_VideoDisplay::num_display_modes, SDL_VideoDevice::num_displays, SDL_DestroyWindow(), SDL_EnableScreenSaver(), SDL_free, SDL_INIT_EVENTS, SDL_KeyboardQuit(), SDL_MouseQuit(), SDL_QuitSubSystem, SDL_TouchQuit(), SDL_VideoDevice::VideoQuit, and SDL_VideoDevice::windows.

Referenced by SDL_VideoInit().