zenilib  0.5.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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"

Go to the source code of this file.

Classes

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

Macros

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

Typedefs

typedef voidSDL_GLContext
 An opaque handle to an OpenGL context. More...
 
typedef struct SDL_Window SDL_Window
 The type used to identify a window. More...
 

Enumerations

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
}
 OpenGL configuration attributes. More...
 
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_GLprofile { SDL_GL_CONTEXT_PROFILE_CORE = 0x0001, SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002, SDL_GL_CONTEXT_PROFILE_ES = 0x0004 }
 
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
}
 Event subtype for window events. More...
 
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
}
 The flags on a window. More...
 

Functions

DECLSPEC SDL_Window *SDLCALL SDL_CreateWindow (const char *title, int x, int y, int w, int h, Uint32 flags)
 Create a window with the specified position, dimensions, and flags. More...
 
DECLSPEC SDL_Window *SDLCALL SDL_CreateWindowFrom (const void *data)
 Create an SDL window from an existing native window. More...
 
DECLSPEC void SDLCALL SDL_DestroyWindow (SDL_Window *window)
 Destroy a window. More...
 
DECLSPEC void SDLCALL SDL_DisableScreenSaver (void)
 Prevent the screen from being blanked by a screensaver. More...
 
DECLSPEC void SDLCALL SDL_EnableScreenSaver (void)
 Allow the screen to be blanked by a screensaver. More...
 
DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode (int displayIndex, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
 Get the closest match to the requested display mode. More...
 
DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode (int displayIndex, SDL_DisplayMode *mode)
 Fill in information about the current display mode. More...
 
DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver (void)
 Returns the name of the currently initialized video driver. More...
 
DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode (int displayIndex, SDL_DisplayMode *mode)
 Fill in information about the desktop display mode. More...
 
DECLSPEC int SDLCALL SDL_GetDisplayBounds (int displayIndex, SDL_Rect *rect)
 Get the desktop area represented by a display, with the primary display located at 0,0. More...
 
DECLSPEC int SDLCALL SDL_GetDisplayMode (int displayIndex, int modeIndex, SDL_DisplayMode *mode)
 Fill in information about a specific display mode. More...
 
DECLSPEC const char *SDLCALL SDL_GetDisplayName (int displayIndex)
 Get the name of a display in UTF-8 encoding. More...
 
DECLSPEC int SDLCALL SDL_GetNumDisplayModes (int displayIndex)
 Returns the number of available display modes. More...
 
DECLSPEC int SDLCALL SDL_GetNumVideoDisplays (void)
 Returns the number of available video displays. More...
 
DECLSPEC int SDLCALL SDL_GetNumVideoDrivers (void)
 Get the number of video drivers compiled into SDL. More...
 
DECLSPEC const char *SDLCALL SDL_GetVideoDriver (int index)
 Get the name of a built in video driver. More...
 
DECLSPEC float SDLCALL SDL_GetWindowBrightness (SDL_Window *window)
 Get the brightness (gamma correction) for a window. More...
 
DECLSPEC void *SDLCALL SDL_GetWindowData (SDL_Window *window, const char *name)
 Retrieve the data pointer associated with a window. More...
 
DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex (SDL_Window *window)
 Get the display index associated with a window. More...
 
DECLSPEC int SDLCALL SDL_GetWindowDisplayMode (SDL_Window *window, SDL_DisplayMode *mode)
 Fill in information about the display mode used when a fullscreen window is visible. More...
 
DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags (SDL_Window *window)
 Get the window flags. More...
 
DECLSPEC SDL_Window *SDLCALL SDL_GetWindowFromID (Uint32 id)
 Get a window from a stored ID, or NULL if it doesn't exist. More...
 
DECLSPEC int SDLCALL SDL_GetWindowGammaRamp (SDL_Window *window, Uint16 *red, Uint16 *green, Uint16 *blue)
 Get the gamma ramp for a window. More...
 
DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab (SDL_Window *window)
 Get a window's input grab mode. More...
 
DECLSPEC Uint32 SDLCALL SDL_GetWindowID (SDL_Window *window)
 Get the numeric ID of a window, for logging purposes. More...
 
DECLSPEC void SDLCALL SDL_GetWindowMaximumSize (SDL_Window *window, int *w, int *h)
 Get the maximum size of a window's client area. More...
 
DECLSPEC void SDLCALL SDL_GetWindowMinimumSize (SDL_Window *window, int *w, int *h)
 Get the minimum size of a window's client area. More...
 
DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat (SDL_Window *window)
 Get the pixel format associated with the window. More...
 
DECLSPEC void SDLCALL SDL_GetWindowPosition (SDL_Window *window, int *x, int *y)
 Get the position of a window. More...
 
DECLSPEC void SDLCALL SDL_GetWindowSize (SDL_Window *window, int *w, int *h)
 Get the size of a window's client area. More...
 
DECLSPEC SDL_Surface *SDLCALL SDL_GetWindowSurface (SDL_Window *window)
 Get the SDL surface associated with the window. More...
 
DECLSPEC const char *SDLCALL SDL_GetWindowTitle (SDL_Window *window)
 Get the title of a window, in UTF-8 format. More...
 
DECLSPEC void SDLCALL SDL_HideWindow (SDL_Window *window)
 Hide a window. More...
 
DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled (void)
 Returns whether the screensaver is currently enabled (default on). More...
 
DECLSPEC void SDLCALL SDL_MaximizeWindow (SDL_Window *window)
 Make a window as large as possible. More...
 
DECLSPEC void SDLCALL SDL_MinimizeWindow (SDL_Window *window)
 Minimize a window to an iconic representation. More...
 
DECLSPEC void SDLCALL SDL_RaiseWindow (SDL_Window *window)
 Raise a window above other windows and set the input focus. More...
 
DECLSPEC void SDLCALL SDL_RestoreWindow (SDL_Window *window)
 Restore the size and position of a minimized or maximized window. More...
 
DECLSPEC void SDLCALL SDL_SetWindowBordered (SDL_Window *window, SDL_bool bordered)
 Set the border state of a window. More...
 
DECLSPEC int SDLCALL SDL_SetWindowBrightness (SDL_Window *window, float brightness)
 Set the brightness (gamma correction) for a window. More...
 
DECLSPEC void *SDLCALL SDL_SetWindowData (SDL_Window *window, const char *name, void *userdata)
 Associate an arbitrary named pointer with a window. More...
 
DECLSPEC int SDLCALL SDL_SetWindowDisplayMode (SDL_Window *window, const SDL_DisplayMode *mode)
 Set the display mode used when a fullscreen window is visible. More...
 
DECLSPEC int SDLCALL SDL_SetWindowFullscreen (SDL_Window *window, Uint32 flags)
 Set a window's fullscreen state. More...
 
DECLSPEC int SDLCALL SDL_SetWindowGammaRamp (SDL_Window *window, const Uint16 *red, const Uint16 *green, const Uint16 *blue)
 Set the gamma ramp for a window. More...
 
DECLSPEC void SDLCALL SDL_SetWindowGrab (SDL_Window *window, SDL_bool grabbed)
 Set a window's input grab mode. More...
 
DECLSPEC void SDLCALL SDL_SetWindowIcon (SDL_Window *window, SDL_Surface *icon)
 Set the icon for a window. More...
 
DECLSPEC void SDLCALL SDL_SetWindowMaximumSize (SDL_Window *window, int max_w, int max_h)
 Set the maximum size of a window's client area. More...
 
DECLSPEC void SDLCALL SDL_SetWindowMinimumSize (SDL_Window *window, int min_w, int min_h)
 Set the minimum size of a window's client area. More...
 
DECLSPEC void SDLCALL SDL_SetWindowPosition (SDL_Window *window, int x, int y)
 Set the position of a window. More...
 
DECLSPEC void SDLCALL SDL_SetWindowSize (SDL_Window *window, int w, int h)
 Set the size of a window's client area. More...
 
DECLSPEC void SDLCALL SDL_SetWindowTitle (SDL_Window *window, const char *title)
 Set the title of a window, in UTF-8 format. More...
 
DECLSPEC void SDLCALL SDL_ShowWindow (SDL_Window *window)
 Show a window. More...
 
DECLSPEC int SDLCALL SDL_UpdateWindowSurface (SDL_Window *window)
 Copy the window surface to the screen. More...
 
DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects (SDL_Window *window, const SDL_Rect *rects, int numrects)
 Copy a number of rectangles on the window surface to the screen. More...
 
DECLSPEC int SDLCALL SDL_VideoInit (const char *driver_name)
 Initialize the video subsystem, optionally specifying a video driver. More...
 
DECLSPEC void SDLCALL SDL_VideoQuit (void)
 Shuts down the video subsystem. More...
 
OpenGL support functions
DECLSPEC int SDLCALL SDL_GL_LoadLibrary (const char *path)
 Dynamically load an OpenGL library. More...
 
DECLSPEC void *SDLCALL SDL_GL_GetProcAddress (const char *proc)
 Get the address of an OpenGL function. More...
 
DECLSPEC void SDLCALL SDL_GL_UnloadLibrary (void)
 Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary(). More...
 
DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported (const char *extension)
 Return true if an OpenGL extension is supported for the current context. More...
 
DECLSPEC int SDLCALL SDL_GL_SetAttribute (SDL_GLattr attr, int value)
 Set an OpenGL window attribute before window creation. More...
 
DECLSPEC int SDLCALL SDL_GL_GetAttribute (SDL_GLattr attr, int *value)
 Get the actual value for an attribute from the current context. More...
 
DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext (SDL_Window *window)
 Create an OpenGL context for use with an OpenGL window, and make it current. More...
 
DECLSPEC int SDLCALL SDL_GL_MakeCurrent (SDL_Window *window, SDL_GLContext context)
 Set up an OpenGL context for rendering into an OpenGL window. More...
 
DECLSPEC SDL_Window *SDLCALL SDL_GL_GetCurrentWindow (void)
 Get the currently active OpenGL window. More...
 
DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext (void)
 Get the currently active OpenGL context. More...
 
DECLSPEC void SDLCALL SDL_GL_GetDrawableSize (SDL_Window *window, int *w, int *h)
 Get the size of a window's underlying drawable (for use with glViewport). More...
 
DECLSPEC int SDLCALL SDL_GL_SetSwapInterval (int interval)
 Set the swap interval for the current OpenGL context. More...
 
DECLSPEC int SDLCALL SDL_GL_GetSwapInterval (void)
 Get the swap interval for the current OpenGL context. More...
 
DECLSPEC void SDLCALL SDL_GL_SwapWindow (SDL_Window *window)
 Swap the OpenGL buffers for a window, if double-buffering is supported. More...
 
DECLSPEC void SDLCALL 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

#define SDL_WINDOWPOS_CENTERED   SDL_WINDOWPOS_CENTERED_DISPLAY(0)

Definition at line 128 of file SDL_video.h.

Referenced by SDLTest_CommonArg(), and Zeni::Window::Window().

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

Definition at line 127 of file SDL_video.h.

Referenced by SDLTest_CommonArg().

#define SDL_WINDOWPOS_CENTERED_MASK   0x2FFF0000

Used to indicate that the window position should be centered.

Definition at line 126 of file SDL_video.h.

#define SDL_WINDOWPOS_ISCENTERED (   X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
#define SDL_WINDOWPOS_ISUNDEFINED (   X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

Definition at line 119 of file SDL_video.h.

Referenced by SDL_CreateWindowAndRenderer(), and SDLTest_CommonCreateState().

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

Definition at line 118 of file SDL_video.h.

Referenced by SDLTest_CommonArg().

#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000

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

Definition at line 117 of file SDL_video.h.

Typedef Documentation

typedef void* SDL_GLContext

An opaque handle to an OpenGL context.

Definition at line 161 of file SDL_video.h.

Enumeration Type Documentation

enum SDL_GLattr

OpenGL configuration attributes.

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

Definition at line 166 of file SDL_video.h.

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

Enumerator
SDL_GL_CONTEXT_PROFILE_CORE 
SDL_GL_CONTEXT_PROFILE_COMPATIBILITY 
SDL_GL_CONTEXT_PROFILE_ES 

Definition at line 193 of file SDL_video.h.

Event subtype for window events.

Enumerator
SDL_WINDOWEVENT_NONE 

Never used

SDL_WINDOWEVENT_SHOWN 

Window has been shown

SDL_WINDOWEVENT_HIDDEN 

Window has been hidden

SDL_WINDOWEVENT_EXPOSED 

Window has been exposed and should be redrawn

SDL_WINDOWEVENT_MOVED 

Window has been moved to data1, data2

SDL_WINDOWEVENT_RESIZED 

Window has been resized to data1xdata2

SDL_WINDOWEVENT_SIZE_CHANGED 

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

SDL_WINDOWEVENT_MINIMIZED 

Window has been minimized

SDL_WINDOWEVENT_MAXIMIZED 

Window has been maximized

SDL_WINDOWEVENT_RESTORED 

Window has been restored to normal size and position

SDL_WINDOWEVENT_ENTER 

Window has gained mouse focus

SDL_WINDOWEVENT_LEAVE 

Window has lost mouse focus

SDL_WINDOWEVENT_FOCUS_GAINED 

Window has gained keyboard focus

SDL_WINDOWEVENT_FOCUS_LOST 

Window has lost keyboard focus

SDL_WINDOWEVENT_CLOSE 

The window manager requests that the window be closed

Definition at line 135 of file SDL_video.h.

The flags on a window.

See Also
SDL_GetWindowFlags()
Enumerator
SDL_WINDOW_FULLSCREEN 

fullscreen window

SDL_WINDOW_OPENGL 

window usable with OpenGL context

SDL_WINDOW_SHOWN 

window is visible

SDL_WINDOW_HIDDEN 

window is not visible

SDL_WINDOW_BORDERLESS 

no window decoration

SDL_WINDOW_RESIZABLE 

window can be resized

SDL_WINDOW_MINIMIZED 

window is minimized

SDL_WINDOW_MAXIMIZED 

window is maximized

SDL_WINDOW_INPUT_GRABBED 

window has grabbed input focus

SDL_WINDOW_INPUT_FOCUS 

window has input focus

SDL_WINDOW_MOUSE_FOCUS 

window has mouse focus

SDL_WINDOW_FULLSCREEN_DESKTOP 
SDL_WINDOW_FOREIGN 

window not created by SDL

SDL_WINDOW_ALLOW_HIGHDPI 

window should be created in high-DPI mode if supported

Definition at line 96 of file SDL_video.h.

Function Documentation

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

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

Parameters
titleThe title of the window, in UTF-8 encoding.
xThe x position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.
yThe y position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.
wThe width of the window.
hThe height of the window.
flagsThe flags for the window, a mask of any of the following: SDL_WINDOW_FULLSCREEN, SDL_WINDOW_OPENGL, SDL_WINDOW_HIDDEN, SDL_WINDOW_BORDERLESS, SDL_WINDOW_RESIZABLE, SDL_WINDOW_MAXIMIZED, SDL_WINDOW_MINIMIZED, SDL_WINDOW_INPUT_GRABBED, SDL_WINDOW_ALLOW_HIGHDPI.
Returns
The id of the window created, or zero if window creation failed.
See Also
SDL_DestroyWindow()

Definition at line 1190 of file SDL_video.c.

References SDL_Window::brightness, CREATE_FLAGS, SDL_VideoDevice::CreateWindow, display, SDL_Window::flags, FULLSCREEN_VISIBLE, SDL_VideoDevice::GL_CreateContext, SDL_Rect::h, SDL_Window::h, SDL_Window::id, SDL_Window::magic, SDL_Window::next, SDL_VideoDevice::next_object_id, NULL, SDL_Window::prev, SDL_calloc(), SDL_DestroyWindow(), SDL_FinishWindowCreation(), SDL_GetDisplayBounds(), SDL_GetDisplayForWindow(), SDL_GetHint(), SDL_GetIndexOfDisplay(), SDL_GL_LoadLibrary(), SDL_HINT_VIDEO_HIGHDPI_DISABLED, SDL_OutOfMemory, SDL_SetError(), SDL_SetWindowTitle(), SDL_UpdateFullscreenMode(), SDL_VideoInit(), SDL_WINDOW_ALLOW_HIGHDPI, SDL_WINDOW_HIDDEN, SDL_WINDOW_OPENGL, SDL_WINDOWPOS_ISCENTERED, SDL_WINDOWPOS_ISUNDEFINED, SDL_Rect::w, SDL_Window::w, SDL_VideoDevice::window_magic, SDL_VideoDevice::windows, SDL_Rect::x, SDL_Window::x, SDL_Rect::y, and SDL_Window::y.

Referenced by SDL_CreateShapedWindow(), SDL_CreateWindowAndRenderer(), SDLTest_CommonInit(), ShouldUseTextureFramebuffer(), and Zeni::Window::Window().

DECLSPEC SDL_Window* SDLCALL SDL_CreateWindowFrom ( const void data)

Create an SDL window from an existing native window.

Parameters
dataA pointer to driver-dependent window creation data
Returns
The id of the window created, or zero if window creation failed.
See Also
SDL_DestroyWindow()

Definition at line 1285 of file SDL_video.c.

References SDL_Window::brightness, SDL_VideoDevice::CreateWindowFrom, SDL_Window::flags, SDL_Window::id, SDL_Window::magic, SDL_Window::next, SDL_VideoDevice::next_object_id, NULL, SDL_Window::prev, SDL_calloc(), SDL_DestroyWindow(), SDL_OutOfMemory, SDL_UninitializedVideo(), SDL_WINDOW_FOREIGN, SDL_VideoDevice::window_magic, and SDL_VideoDevice::windows.

DECLSPEC void SDLCALL SDL_DisableScreenSaver ( void  )

Prevent the screen from being blanked by a screensaver.

See Also
SDL_IsScreenSaverEnabled()
SDL_EnableScreenSaver()

Definition at line 2250 of file SDL_video.c.

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

Referenced by Zeni::Core::set_screen_saver().

DECLSPEC void SDLCALL SDL_EnableScreenSaver ( void  )

Allow the screen to be blanked by a screensaver.

See Also
SDL_IsScreenSaverEnabled()
SDL_DisableScreenSaver()

Definition at line 2235 of file SDL_video.c.

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

Referenced by SDL_VideoQuit(), and Zeni::Core::set_screen_saver().

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

Get the closest match to the requested display mode.

Parameters
displayIndexThe index of display from which mode should be queried.
modeThe desired display mode
closestA 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 874 of file SDL_video.c.

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

DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode ( int  displayIndex,
SDL_DisplayMode mode 
)

Fill in information about the current display mode.

Definition at line 753 of file SDL_video.c.

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

DECLSPEC const char* SDLCALL 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 538 of file SDL_video.c.

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

Referenced by SDLTest_CommonInit().

DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode ( int  displayIndex,
SDL_DisplayMode mode 
)

Fill in information about the desktop display mode.

Definition at line 739 of file SDL_video.c.

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

Referenced by SDLTest_CommonInit().

DECLSPEC int SDLCALL SDL_GetDisplayBounds ( int  displayIndex,
SDL_Rect rect 
)
DECLSPEC int SDLCALL 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 721 of file SDL_video.c.

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

Referenced by SDLTest_CommonInit(), and Zeni::Window::Window().

DECLSPEC const char* SDLCALL 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 630 of file SDL_video.c.

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

Referenced by SDLTest_CommonInit().

DECLSPEC int SDLCALL SDL_GetNumDisplayModes ( int  displayIndex)

Returns the number of available display modes.

See Also
SDL_GetDisplayMode()

Definition at line 713 of file SDL_video.c.

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

Referenced by SDLTest_CommonInit(), and Zeni::Window::Window().

DECLSPEC int SDLCALL SDL_GetNumVideoDisplays ( void  )

Returns the number of available video displays.

See Also
SDL_GetDisplayBounds()

Definition at line 597 of file SDL_video.c.

References SDL_VideoDevice::num_displays, and SDL_UninitializedVideo().

Referenced by SDLTest_CommonInit().

DECLSPEC int SDLCALL SDL_GetNumVideoDrivers ( void  )

Get the number of video drivers compiled into SDL.

See Also
SDL_GetVideoDriver()

Definition at line 388 of file SDL_video.c.

References SDL_arraysize.

Referenced by SDL_GetVideoDriver(), and SDLTest_CommonInit().

DECLSPEC const char* SDLCALL 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 394 of file SDL_video.c.

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

Referenced by SDLTest_CommonInit().

DECLSPEC float SDLCALL 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 1920 of file SDL_video.c.

References SDL_Window::brightness, and CHECK_WINDOW_MAGIC.

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

Retrieve the data pointer associated with a window.

Parameters
windowThe window to query.
nameThe name of the pointer.
Returns
The value associated with 'name'
See Also
SDL_SetWindowData()

Definition at line 1514 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_WindowUserData::data, SDL_Window::data, SDL_WindowUserData::name, SDL_WindowUserData::next, NULL, SDL_InvalidParamError, and SDL_strcmp().

Referenced by SDL_CreateWindowTexture(), SDL_GetRenderer(), and SDL_UpdateWindowTexture().

DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex ( SDL_Window window)
DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags ( SDL_Window window)

Get the window flags.

Definition at line 1409 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, and SDL_Window::flags.

Referenced by FullscreenTo(), SDL_CreateRenderer(), SDL_PromptAssertion(), SDL_RendererEventWatch(), and SDLTest_CommonEvent().

DECLSPEC SDL_Window* SDLCALL SDL_GetWindowFromID ( Uint32  id)

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

Definition at line 1393 of file SDL_video.c.

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

Referenced by FullscreenTo(), SDL_RendererEventWatch(), and SDLTest_CommonEvent().

DECLSPEC int SDLCALL SDL_GetWindowGammaRamp ( SDL_Window window,
Uint16 red,
Uint16 green,
Uint16 blue 
)

Get the gamma ramp for a window.

Parameters
windowThe window from which the gamma ramp should be queried.
redA pointer to a 256 element array of 16-bit quantities to hold the translation table for the red channel, or NULL.
greenA pointer to a 256 element array of 16-bit quantities to hold the translation table for the green channel, or NULL.
blueA 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 1961 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::gamma, SDL_VideoDevice::GetWindowGammaRamp, i, SDL_Window::saved_gamma, SDL_malloc(), SDL_memcpy(), and SDL_OutOfMemory.

Referenced by SDL_SetWindowGammaRamp().

DECLSPEC SDL_bool SDLCALL 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 2037 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_FALSE, and SDL_WINDOW_INPUT_GRABBED.

Referenced by Zeni::Window::get_mouse_state(), and SDLTest_CommonEvent().

DECLSPEC Uint32 SDLCALL SDL_GetWindowID ( SDL_Window window)

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

Definition at line 1385 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, and SDL_Window::id.

Referenced by Zeni::Game::run().

DECLSPEC void SDLCALL SDL_GetWindowMaximumSize ( SDL_Window window,
int w,
int h 
)

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

Parameters
windowThe window to query.
wPointer to variable for storing the maximum width, may be NULL
hPointer to variable for storing the maximum height, may be NULL
See Also
SDL_GetWindowMinimumSize()
SDL_SetWindowMaximumSize()

Definition at line 1710 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::max_h, and SDL_Window::max_w.

DECLSPEC void SDLCALL SDL_GetWindowMinimumSize ( SDL_Window window,
int w,
int h 
)

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

Parameters
windowThe window to query.
wPointer to variable for storing the minimum width, may be NULL
hPointer to variable for storing the minimum height, may be NULL
See Also
SDL_GetWindowMaximumSize()
SDL_SetWindowMinimumSize()

Definition at line 1674 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::min_h, and SDL_Window::min_w.

DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat ( SDL_Window window)

Get the pixel format associated with the window.

Definition at line 1059 of file SDL_video.c.

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

Referenced by SDL_RenderReadPixels().

DECLSPEC void SDLCALL SDL_GetWindowPosition ( SDL_Window window,
int x,
int y 
)

Get the position of a window.

Parameters
windowThe window to query.
xPointer to variable for storing the x position, may be NULL
yPointer to variable for storing the y position, may be NULL
See Also
SDL_SetWindowPosition()

Definition at line 1570 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_WINDOW_FULLSCREEN, SDL_Window::x, and SDL_Window::y.

DECLSPEC void SDLCALL SDL_GetWindowSize ( SDL_Window window,
int w,
int h 
)

Get the size of a window's client area.

Parameters
windowThe window to query.
wPointer to variable for storing the width, may be NULL
hPointer to variable for storing the height, may be NULL
See Also
SDL_SetWindowSize()

Definition at line 1638 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::h, and SDL_Window::w.

Referenced by SDL_GetRendererOutputSize(), SDL_GL_GetDrawableSize(), SDL_PrivateSendMouseMotion(), SDL_RendererEventWatch(), SDL_UpdateMouseFocus(), SDLTest_CommonEvent(), and SDLTest_CommonInit().

DECLSPEC SDL_Surface* SDLCALL 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 1858 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Surface::flags, NULL, SDL_CreateWindowFramebuffer(), SDL_DONTFREE, SDL_FreeSurface(), SDL_TRUE, SDL_Window::surface, and SDL_Window::surface_valid.

Referenced by SW_ActivateRenderer(), and SW_CreateRenderer().

DECLSPEC const char* SDLCALL SDL_GetWindowTitle ( SDL_Window window)

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

See Also
SDL_SetWindowTitle()

Definition at line 1437 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, and SDL_Window::title.

DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported ( const char *  extension)

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

Definition at line 2385 of file SDL_video.c.

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(), and SDL_TRUE.

DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext ( void  )

Get the currently active OpenGL context.

Definition at line 2822 of file SDL_video.c.

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

DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow ( void  )

Get the currently active OpenGL window.

Definition at line 2812 of file SDL_video.c.

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

Referenced by SDL_GL_MakeCurrent(), and SDL_GL_SwapWindow().

DECLSPEC void SDLCALL SDL_GL_GetDrawableSize ( SDL_Window window,
int w,
int h 
)

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

Parameters
windowWindow from which the drawable size should be queried
wPointer to variable for storing the width, may be NULL
hPointer to variable for storing the height, may be NULL

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

See Also
SDL_GetWindowSize()
SDL_CreateWindow()

Definition at line 2831 of file SDL_video.c.

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

DECLSPEC int SDLCALL 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 2857 of file SDL_video.c.

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

DECLSPEC int SDLCALL SDL_GL_LoadLibrary ( const char *  path)

Dynamically load an OpenGL library.

Parameters
pathThe 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 2315 of file SDL_video.c.

References SDL_VideoDevice::driver_loaded, SDL_VideoDevice::driver_path, SDL_VideoDevice::gl_config, SDL_VideoDevice::GL_LoadLibrary, SDL_SetError(), SDL_strcmp(), and SDL_UninitializedVideo().

Referenced by SDL_CreateWindow(), and SDL_RecreateWindow().

DECLSPEC int SDLCALL SDL_GL_MakeCurrent ( SDL_Window window,
SDL_GLContext  context 
)
DECLSPEC int SDLCALL SDL_GL_SetAttribute ( SDL_GLattr  attr,
int  value 
)

Set an OpenGL window attribute before window creation.

Definition at line 2469 of file SDL_video.c.

References 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::gl_config, SDL_VideoDevice::green_size, SDL_VideoDevice::major_version, SDL_VideoDevice::minor_version, SDL_VideoDevice::multisamplebuffers, SDL_VideoDevice::multisamplesamples, SDL_VideoDevice::profile_mask, SDL_VideoDevice::red_size, 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_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_PROFILE_COMPATIBILITY, SDL_GL_CONTEXT_PROFILE_CORE, SDL_GL_CONTEXT_PROFILE_ES, SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_RESET_ISOLATION_FLAG, SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG, SDL_GL_DEPTH_SIZE, SDL_GL_DOUBLEBUFFER, 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 Zeni::Video_GL_Shader::init(), Zeni::Video_GL_Fixed::init(), SDL_GL_SetAttribute(), SDLTest_CommonInit(), Zeni::Video_GL_Shader::set_vertical_sync(), Zeni::Video_GL_Fixed::set_vertical_sync(), and Zeni::Window::Window().

DECLSPEC int SDLCALL SDL_GL_SetSwapInterval ( int  interval)

Set the swap interval for the current OpenGL context.

Parameters
interval0 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 2843 of file SDL_video.c.

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

Referenced by Zeni::Video_GL_Shader::init(), Zeni::Video_GL_Fixed::init(), Zeni::Video_GL_Shader::set_vertical_sync(), and Zeni::Video_GL_Fixed::set_vertical_sync().

DECLSPEC void SDLCALL SDL_GL_SwapWindow ( SDL_Window window)

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

Definition at line 2871 of file SDL_video.c.

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

Referenced by Zeni::Video_GL_Fixed::end_render(), and Zeni::Video_GL_Shader::end_render().

DECLSPEC void SDLCALL SDL_GL_UnloadLibrary ( void  )
DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled ( void  )

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

See Also
SDL_EnableScreenSaver()
SDL_DisableScreenSaver()

Definition at line 2226 of file SDL_video.c.

References SDL_FALSE, SDL_TRUE, and SDL_VideoDevice::suspend_screensaver.

Referenced by Zeni::Core::is_screen_saver_enabled().

DECLSPEC void SDLCALL SDL_MaximizeWindow ( SDL_Window window)

Make a window as large as possible.

See Also
SDL_RestoreWindow()

Definition at line 1767 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_VideoDevice::MaximizeWindow, and SDL_WINDOW_MAXIMIZED.

Referenced by SDL_FinishWindowCreation(), and SDLTest_CommonEvent().

DECLSPEC void SDLCALL SDL_RaiseWindow ( SDL_Window window)

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

Definition at line 1754 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_VideoDevice::RaiseWindow, and SDL_WINDOW_SHOWN.

Referenced by SDL_OnWindowRestored().

DECLSPEC void SDLCALL 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 1799 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_VideoDevice::RestoreWindow, SDL_WINDOW_MAXIMIZED, and SDL_WINDOW_MINIMIZED.

Referenced by SDL_PromptAssertion(), and SDLTest_CommonEvent().

DECLSPEC void SDLCALL 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
windowThe window of which to change the border state.
borderedSDL_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 1593 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_FALSE, SDL_WINDOW_BORDERLESS, SDL_WINDOW_FULLSCREEN, and SDL_VideoDevice::SetWindowBordered.

Referenced by SDLTest_CommonEvent().

DECLSPEC int SDLCALL 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 1904 of file SDL_video.c.

References SDL_Window::brightness, CHECK_WINDOW_MAGIC, SDL_CalculateGammaRamp(), and SDL_SetWindowGammaRamp().

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

Associate an arbitrary named pointer with a window.

Parameters
windowThe window to associate with the pointer.
nameThe name of the pointer.
userdataThe associated pointer.
Returns
The previous value associated with 'name'
Note
The name is case-sensitive.
See Also
SDL_GetWindowData()

Definition at line 1467 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_WindowUserData::data, SDL_Window::data, SDL_WindowUserData::name, SDL_WindowUserData::next, NULL, SDL_free(), SDL_InvalidParamError, SDL_malloc(), SDL_strcmp(), and SDL_strdup().

Referenced by SDL_CreateRenderer(), SDL_CreateWindowTexture(), SDL_DestroyRenderer(), and SDL_DestroyWindowTexture().

DECLSPEC int SDLCALL 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
windowThe window for which the display mode should be set.
modeThe 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 1007 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::fullscreen_mode, and SDL_zero.

Referenced by SDLTest_CommonInit().

DECLSPEC int SDLCALL 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 1814 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, FULLSCREEN_MASK, FULLSCREEN_VISIBLE, and SDL_UpdateFullscreenMode().

Referenced by FullscreenTo(), SDL_FinishWindowCreation(), and SDLTest_CommonEvent().

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

Set the gamma ramp for a window.

Parameters
windowThe window for which the gamma ramp should be set.
redThe translation table for the red channel, or NULL.
greenThe translation table for the green channel, or NULL.
blueThe 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 1928 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_Window::gamma, NULL, SDL_GetWindowGammaRamp(), SDL_memcpy(), SDL_Unsupported, SDL_WINDOW_INPUT_FOCUS, and SDL_VideoDevice::SetWindowGammaRamp.

Referenced by SDL_SetWindowBrightness().

DECLSPEC void SDLCALL SDL_SetWindowGrab ( SDL_Window window,
SDL_bool  grabbed 
)

Set a window's input grab mode.

Parameters
windowThe window for which the input grab mode should be set.
grabbedThis is SDL_TRUE to grab input, and SDL_FALSE to release input.
See Also
SDL_GetWindowGrab()

Definition at line 2021 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_UpdateWindowGrab(), and SDL_WINDOW_INPUT_GRABBED.

Referenced by SDL_FinishWindowCreation(), SDLTest_CommonEvent(), and Zeni::Window::set_mouse_state().

DECLSPEC void SDLCALL SDL_SetWindowIcon ( SDL_Window window,
SDL_Surface icon 
)

Set the icon for a window.

Parameters
windowThe window for which the icon should be set.
iconThe icon for the window.

Definition at line 1445 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::icon, SDL_ConvertSurfaceFormat(), SDL_FreeSurface(), SDL_PIXELFORMAT_ARGB8888, and SDL_VideoDevice::SetWindowIcon.

Referenced by Zeni::Window::alert_window_resized(), SDL_RecreateWindow(), and SDLTest_CommonInit().

DECLSPEC void SDLCALL SDL_SetWindowMaximumSize ( SDL_Window window,
int  max_w,
int  max_h 
)

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

Parameters
windowThe window to set a new maximum size.
max_wThe maximum width of the window, must be >0
max_hThe 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 1686 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_Window::h, SDL_Window::max_h, SDL_Window::max_w, SDL_InvalidParamError, SDL_min, SDL_SetWindowSize(), SDL_WINDOW_FULLSCREEN, SDL_VideoDevice::SetWindowMaximumSize, and SDL_Window::w.

Referenced by SDLTest_CommonInit().

DECLSPEC void SDLCALL SDL_SetWindowMinimumSize ( SDL_Window window,
int  min_w,
int  min_h 
)

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

Parameters
windowThe window to set a new minimum size.
min_wThe minimum width of the window, must be >0
min_hThe 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 1650 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_Window::h, SDL_Window::min_h, SDL_Window::min_w, SDL_InvalidParamError, SDL_max, SDL_SetWindowSize(), SDL_WINDOW_FULLSCREEN, SDL_VideoDevice::SetWindowMinimumSize, and SDL_Window::w.

Referenced by SDLTest_CommonInit().

DECLSPEC void SDLCALL SDL_SetWindowPosition ( SDL_Window window,
int  x,
int  y 
)
DECLSPEC void SDLCALL SDL_SetWindowSize ( SDL_Window window,
int  w,
int  h 
)

Set the size of a window's client area.

Parameters
windowThe window to resize.
wThe width of the window, must be >0
hThe height of the window, must be >0
Note
You can't change the size of a fullscreen window, it automatically matches the size of the display mode.
See Also
SDL_GetWindowSize()

Definition at line 1611 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_Window::h, SDL_InvalidParamError, SDL_OnWindowResized(), SDL_WINDOW_FULLSCREEN, SDL_VideoDevice::SetWindowSize, and SDL_Window::w.

Referenced by SDL_SetWindowMaximumSize(), SDL_SetWindowMinimumSize(), and SDLTest_CommonEvent().

DECLSPEC void SDLCALL 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 1417 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, NULL, SDL_free(), SDL_strdup(), SDL_VideoDevice::SetWindowTitle, and SDL_Window::title.

Referenced by Zeni::Window::alert_window_resized(), SDL_CreateWindow(), and SDL_RecreateWindow().

DECLSPEC int SDLCALL 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 1877 of file SDL_video.c.

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

Referenced by SW_RenderPresent().

DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects ( SDL_Window window,
const SDL_Rect rects,
int  numrects 
)

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

Returns
0 on success, or -1 on error.
See Also
SDL_GetWindowSurface()
SDL_UpdateWindowSurfaceRect()

Definition at line 1891 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_SetError(), SDL_Window::surface_valid, and SDL_VideoDevice::UpdateWindowFramebuffer.

Referenced by SDL_UpdateWindowSurface().

DECLSPEC int SDLCALL SDL_VideoInit ( const char *  driver_name)

Initialize the video subsystem, optionally specifying a video driver.

Parameters
driver_nameInitialize 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 406 of file SDL_video.c.

References 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, VideoBootStrap::create, SDL_VideoDevice::CreateWindowFramebuffer, SDL_VideoDevice::current_glctx_tls, SDL_VideoDevice::current_glwin_tls, SDL_VideoDevice::depth_size, SDL_VideoDevice::DestroyWindowFramebuffer, SDL_VideoDevice::dll_handle, SDL_VideoDevice::double_buffer, SDL_VideoDevice::driver_loaded, SDL_VideoDevice::flags, SDL_VideoDevice::gl_config, SDL_VideoDevice::green_size, i, SDL_VideoDevice::major_version, SDL_VideoDevice::minor_version, SDL_VideoDevice::multisamplebuffers, SDL_VideoDevice::multisamplesamples, SDL_VideoDevice::name, VideoBootStrap::name, SDL_VideoDevice::next_object_id, NULL, SDL_VideoDevice::num_displays, SDL_VideoDevice::profile_mask, SDL_VideoDevice::red_size, SDL_VideoDevice::retained_backing, SDL_CreateWindowTexture(), SDL_DestroyWindowTexture(), SDL_getenv(), SDL_GL_CONTEXT_PROFILE_ES, SDL_HasScreenKeyboardSupport(), SDL_INIT_EVENTS, SDL_InitSubSystem(), SDL_InitTicks(), SDL_KeyboardInit(), SDL_MouseInit(), SDL_SetError(), SDL_StartTextInput(), SDL_strlen(), SDL_strncasecmp(), SDL_TLSCreate(), SDL_TouchInit(), SDL_UpdateWindowTexture(), SDL_VideoQuit(), SDL_VideoDevice::share_with_current_context, ShouldUseTextureFramebuffer(), SDL_VideoDevice::stencil_size, SDL_VideoDevice::stereo, SDL_VideoDevice::UpdateWindowFramebuffer, and SDL_VideoDevice::VideoInit.

Referenced by SDL_CreateWindow(), SDL_InitSubSystem(), and SDLTest_CommonInit().