SDL
2.0
|
#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.
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... | |
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... | |
Header file for SDL video functions.
Definition in file SDL_video.h.
#define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0) |
Definition at line 139 of file SDL_video.h.
#define SDL_WINDOWPOS_CENTERED_DISPLAY | ( | X | ) | (SDL_WINDOWPOS_CENTERED_MASK|(X)) |
Definition at line 138 of file SDL_video.h.
#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.
#define SDL_WINDOWPOS_ISCENTERED | ( | X | ) | (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK) |
Definition at line 140 of file SDL_video.h.
#define SDL_WINDOWPOS_ISUNDEFINED | ( | X | ) | (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK) |
Definition at line 131 of file SDL_video.h.
#define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0) |
Definition at line 130 of file SDL_video.h.
#define SDL_WINDOWPOS_UNDEFINED_DISPLAY | ( | X | ) | (SDL_WINDOWPOS_UNDEFINED_MASK|(X)) |
Definition at line 129 of file SDL_video.h.
#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 void* SDL_GLContext |
An opaque handle to an OpenGL context.
Definition at line 193 of file SDL_video.h.
typedef SDL_HitTestResult( * SDL_HitTest) (SDL_Window *win, const SDL_Point *area, void *data) |
Callback used for hit-testing.
Definition at line 1039 of file SDL_video.h.
enum SDL_DisplayEventID |
Event subtype for display events.
Enumerator | |
---|---|
SDL_DISPLAYEVENT_NONE | Never used |
SDL_DISPLAYEVENT_ORIENTATION | Display orientation has changed to data1 |
Definition at line 175 of file SDL_video.h.
Definition at line 181 of file SDL_video.h.
enum SDL_GLattr |
OpenGL configuration attributes.
Definition at line 198 of file SDL_video.h.
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 236 of file SDL_video.h.
Enumerator | |
---|---|
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE | |
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH |
Definition at line 244 of file SDL_video.h.
Enumerator | |
---|---|
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION | |
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT |
Definition at line 250 of file SDL_video.h.
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 229 of file SDL_video.h.
enum SDL_HitTestResult |
Possible return values from the SDL_HitTest callback.
Definition at line 1020 of file SDL_video.h.
enum SDL_WindowEventID |
Event subtype for window events.
Definition at line 146 of file SDL_video.h.
enum SDL_WindowFlags |
The flags on a window.
Definition at line 97 of file SDL_video.h.
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.
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. |
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.
Definition at line 1405 of file SDL_video.c.
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::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_OutOfMemory, SDL_SetError, SDL_SetWindowTitle(), SDL_UpdateFullscreenMode(), SDL_VideoInit(), SDL_Vulkan_LoadLibrary(), SDL_WINDOW_ALLOW_HIGHDPI, SDL_WINDOW_FULLSCREEN, SDL_WINDOW_HIDDEN, 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_Window* SDL_CreateWindowFrom | ( | const void * | data | ) |
Create an SDL window from an existing native window.
data | A pointer to driver-dependent window creation data |
Definition at line 1573 of file SDL_video.c.
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.
void SDL_DestroyWindow | ( | SDL_Window * | window | ) |
Destroy a window.
Definition at line 2712 of file SDL_video.c.
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_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().
Prevent the screen from being blanked by a screensaver.
Definition at line 2813 of file SDL_video.c.
References _this, SDL_TRUE, SDL_VideoDevice::suspend_screensaver, and SDL_VideoDevice::SuspendScreenSaver.
Referenced by SDL_VideoInit().
Allow the screen to be blanked by a screensaver.
Definition at line 2798 of file SDL_video.c.
References _this, SDL_FALSE, SDL_VideoDevice::suspend_screensaver, and SDL_VideoDevice::SuspendScreenSaver.
Referenced by SDL_VideoQuit().
SDL_DisplayMode* SDL_GetClosestDisplayMode | ( | int | displayIndex, |
const SDL_DisplayMode * | mode, | ||
SDL_DisplayMode * | closest | ||
) |
Get the closest match to the requested display mode.
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. |
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.
Definition at line 959 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, NULL, and SDL_GetClosestDisplayModeForDisplay().
int SDL_GetCurrentDisplayMode | ( | int | displayIndex, |
SDL_DisplayMode * | mode | ||
) |
Fill in information about the current display mode.
Definition at line 838 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDisplay::current_mode, and SDL_VideoDevice::displays.
const char* SDL_GetCurrentVideoDriver | ( | void | ) |
Returns the name of the currently initialized video driver.
Definition at line 573 of file SDL_video.c.
References _this, SDL_VideoDevice::name, NULL, and SDL_UninitializedVideo().
int SDL_GetDesktopDisplayMode | ( | int | displayIndex, |
SDL_DisplayMode * | mode | ||
) |
Fill in information about the desktop display mode.
Definition at line 824 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDisplay::desktop_mode, and SDL_VideoDevice::displays.
int SDL_GetDisplayBounds | ( | int | displayIndex, |
SDL_Rect * | rect | ||
) |
Get the desktop area represented by a display, with the primary display located at 0,0.
Definition at line 673 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDisplay::current_mode, SDL_VideoDevice::displays, SDL_VideoDevice::GetDisplayBounds, SDL_DisplayMode::h, SDL_Rect::h, rect, SDL_DisplayMode::w, SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.
Referenced by SDL_CreateWindow(), SDL_GetDisplayUsableBounds(), SDL_GetWindowDisplayIndex(), SDL_GetWindowPosition(), and SDL_SetWindowPosition().
int SDL_GetDisplayDPI | ( | int | displayIndex, |
float * | ddpi, | ||
float * | hdpi, | ||
float * | vdpi | ||
) |
Get the dots/pixels-per-inch for a display.
Definition at line 720 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, SDL_VideoDevice::GetDisplayDPI, and SDL_Unsupported.
int SDL_GetDisplayMode | ( | int | displayIndex, |
int | modeIndex, | ||
SDL_DisplayMode * | mode | ||
) |
Fill in information about a specific display mode.
Definition at line 806 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDisplay::display_modes, SDL_VideoDevice::displays, SDL_GetNumDisplayModesForDisplay(), and SDL_SetError.
const char* SDL_GetDisplayName | ( | int | displayIndex | ) |
Get the name of a display in UTF-8 encoding.
Definition at line 665 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, SDL_VideoDisplay::name, and NULL.
SDL_DisplayOrientation SDL_GetDisplayOrientation | ( | int | displayIndex | ) |
Get the orientation of a display.
Definition at line 740 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, SDL_VideoDisplay::orientation, and SDL_ORIENTATION_UNKNOWN.
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.
Definition at line 700 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, SDL_VideoDevice::GetDisplayUsableBounds, rect, and SDL_GetDisplayBounds().
SDL_Window* SDL_GetGrabbedWindow | ( | void | ) |
Get the window that currently has an input grab enabled.
Definition at line 2575 of file SDL_video.c.
References _this, SDL_Window::flags, SDL_VideoDevice::grabbed_window, SDL_assert, and SDL_WINDOW_INPUT_GRABBED.
int SDL_GetNumDisplayModes | ( | int | displayIndex | ) |
Returns the number of available display modes.
Definition at line 798 of file SDL_video.c.
References _this, CHECK_DISPLAY_INDEX, SDL_VideoDevice::displays, and SDL_GetNumDisplayModesForDisplay().
int SDL_GetNumVideoDisplays | ( | void | ) |
Returns the number of available video displays.
Definition at line 632 of file SDL_video.c.
References _this, SDL_VideoDevice::num_displays, and SDL_UninitializedVideo().
int SDL_GetNumVideoDrivers | ( | void | ) |
Get the number of video drivers compiled into SDL.
Definition at line 443 of file SDL_video.c.
References bootstrap, and SDL_arraysize.
Referenced by SDL_GetVideoDriver().
const char* SDL_GetVideoDriver | ( | int | index | ) |
Get the name of a built in video driver.
Definition at line 449 of file SDL_video.c.
References bootstrap, VideoBootStrap::name, NULL, and SDL_GetNumVideoDrivers().
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.
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. |
Definition at line 2046 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GetWindowBordersSize, and SDL_Unsupported.
float SDL_GetWindowBrightness | ( | SDL_Window * | window | ) |
Get the brightness (gamma correction) for a window.
Definition at line 2371 of file SDL_video.c.
References CHECK_WINDOW_MAGIC.
void* SDL_GetWindowData | ( | SDL_Window * | window, |
const char * | name | ||
) |
Retrieve the data pointer associated with a window.
window | The window to query. |
name | The name of the pointer. |
Definition at line 1843 of file SDL_video.c.
References CHECK_WINDOW_MAGIC, NULL, SDL_InvalidParamError, and SDL_strcmp.
Referenced by SDL_CreateWindowTexture(), and SDL_UpdateWindowTexture().
int SDL_GetWindowDisplayIndex | ( | SDL_Window * | window | ) |
Get the display index associated with a window.
Definition at line 1029 of file SDL_video.c.
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().
int SDL_GetWindowDisplayMode | ( | SDL_Window * | window, |
SDL_DisplayMode * | mode | ||
) |
Fill in information about the display mode used when a fullscreen window is visible.
Definition at line 1120 of file SDL_video.c.
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().
Uint32 SDL_GetWindowFlags | ( | SDL_Window * | window | ) |
Get the window flags.
Definition at line 1741 of file SDL_video.c.
References CHECK_WINDOW_MAGIC.
Referenced by SDL_ShowMessageBox().
SDL_Window* SDL_GetWindowFromID | ( | Uint32 | id | ) |
Get a window from a stored ID, or NULL if it doesn't exist.
Definition at line 1725 of file SDL_video.c.
References _this, SDL_Window::next, NULL, and SDL_VideoDevice::windows.
int SDL_GetWindowGammaRamp | ( | SDL_Window * | window, |
Uint16 * | red, | ||
Uint16 * | green, | ||
Uint16 * | blue | ||
) |
Get the gamma ramp for a window.
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. |
Definition at line 2475 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GetWindowGammaRamp, i, red, SDL_malloc, SDL_memcpy, and SDL_OutOfMemory.
Referenced by SDL_SetWindowGammaRamp().
SDL_bool SDL_GetWindowGrab | ( | SDL_Window * | window | ) |
Get a window's input grab mode.
Definition at line 2567 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_VideoDevice::grabbed_window, SDL_assert, SDL_FALSE, and SDL_WINDOW_INPUT_GRABBED.
Uint32 SDL_GetWindowID | ( | SDL_Window * | window | ) |
Get the numeric ID of a window, for logging purposes.
Definition at line 1717 of file SDL_video.c.
References CHECK_WINDOW_MAGIC.
void SDL_GetWindowMaximumSize | ( | SDL_Window * | window, |
int * | w, | ||
int * | h | ||
) |
Get the maximum size of a window's client area.
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 |
Definition at line 2141 of file SDL_video.c.
References CHECK_WINDOW_MAGIC.
void SDL_GetWindowMinimumSize | ( | SDL_Window * | window, |
int * | w, | ||
int * | h | ||
) |
Get the minimum size of a window's client area.
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 |
Definition at line 2099 of file SDL_video.c.
References CHECK_WINDOW_MAGIC.
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.
window | The window in question. |
out_opacity | Opacity (0.0f - transparent, 1.0f - opaque) |
Definition at line 2403 of file SDL_video.c.
References CHECK_WINDOW_MAGIC.
Uint32 SDL_GetWindowPixelFormat | ( | SDL_Window * | window | ) |
Get the pixel format associated with the window.
Definition at line 1157 of file SDL_video.c.
References CHECK_WINDOW_MAGIC, SDL_VideoDisplay::current_mode, SDL_DisplayMode::format, SDL_GetDisplayForWindow(), and SDL_PIXELFORMAT_UNKNOWN.
void SDL_GetWindowPosition | ( | SDL_Window * | window, |
int * | x, | ||
int * | y | ||
) |
Get the position of a window.
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. |
Definition at line 1908 of file SDL_video.c.
References CHECK_WINDOW_MAGIC, SDL_GetDisplayBounds(), SDL_GetWindowDisplayIndex(), SDL_WINDOW_FULLSCREEN, SDL_zero, SDL_Rect::x, and SDL_Rect::y.
void SDL_GetWindowSize | ( | SDL_Window * | window, |
int * | w, | ||
int * | h | ||
) |
Get the size of a window's client area.
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.
Definition at line 2034 of file SDL_video.c.
References CHECK_WINDOW_MAGIC.
Referenced by SDL_GL_GetDrawableSize(), and SDL_Vulkan_GetDrawableSize().
SDL_Surface* SDL_GetWindowSurface | ( | SDL_Window * | window | ) |
Get the SDL surface associated with the window.
A new surface will be created with the optimal format for the window, if necessary. This surface will be freed when the window is destroyed.
Definition at line 2309 of file SDL_video.c.
References CHECK_WINDOW_MAGIC, NULL, SDL_CreateWindowFramebuffer(), SDL_DONTFREE, SDL_FreeSurface, and SDL_TRUE.
const char* SDL_GetWindowTitle | ( | SDL_Window * | window | ) |
Get the title of a window, in UTF-8 format.
Definition at line 1766 of file SDL_video.c.
References CHECK_WINDOW_MAGIC.
SDL_GLContext SDL_GL_CreateContext | ( | SDL_Window * | window | ) |
Create an OpenGL context for use with an OpenGL window, and make it current.
Definition at line 3493 of file SDL_video.c.
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().
void SDL_GL_DeleteContext | ( | SDL_GLContext | context | ) |
Delete an OpenGL context.
Definition at line 3624 of file SDL_video.c.
References _this, context, SDL_VideoDevice::GL_DeleteContext, NULL, SDL_GL_GetCurrentContext(), and SDL_GL_MakeCurrent().
Referenced by ShouldUseTextureFramebuffer().
SDL_bool SDL_GL_ExtensionSupported | ( | const char * | extension | ) |
Return true if an OpenGL extension is supported for the current context.
Definition at line 2954 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, SDL_TRUE, and void.
Referenced by SDL_GL_DeduceMaxSupportedESProfile().
int SDL_GL_GetAttribute | ( | SDL_GLattr | attr, |
int * | value | ||
) |
Get the actual value for an attribute from the current context.
value
will be modified in either case. Definition at line 3244 of file SDL_video.c.
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_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.
SDL_GLContext SDL_GL_GetCurrentContext | ( | void | ) |
Get the currently active OpenGL context.
Definition at line 3557 of file SDL_video.c.
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_Window* SDL_GL_GetCurrentWindow | ( | void | ) |
Get the currently active OpenGL window.
Definition at line 3547 of file SDL_video.c.
References _this, SDL_VideoDevice::current_glwin_tls, NULL, SDL_TLSGet, and SDL_UninitializedVideo().
Referenced by SDL_GL_MakeCurrent(), and SDL_GL_SwapWindow().
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).
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.
Definition at line 3566 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GL_GetDrawableSize, and SDL_GetWindowSize().
void* SDL_GL_GetProcAddress | ( | const char * | proc | ) |
Get the address of an OpenGL function.
Definition at line 2907 of file SDL_video.c.
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().
int SDL_GL_GetSwapInterval | ( | void | ) |
Get the swap interval for the current OpenGL context.
Definition at line 3592 of file SDL_video.c.
References _this, SDL_VideoDevice::GL_GetSwapInterval, NULL, and SDL_GL_GetCurrentContext().
int SDL_GL_LoadLibrary | ( | const char * | path | ) |
Dynamically load an OpenGL library.
path | The platform dependent OpenGL library name, or NULL to open the default OpenGL library. |
This should be done after initializing the video driver, but before creating any OpenGL windows. If no OpenGL library is loaded, the default library will be loaded upon creation of the first OpenGL window.
Definition at line 2878 of file SDL_video.c.
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().
int SDL_GL_MakeCurrent | ( | SDL_Window * | window, |
SDL_GLContext | context | ||
) |
Set up an OpenGL context for rendering into an OpenGL window.
Definition at line 3516 of file SDL_video.c.
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_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().
Reset all previously set OpenGL context attributes to their default values.
Definition at line 3069 of file SDL_video.c.
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().
int SDL_GL_SetAttribute | ( | SDL_GLattr | attr, |
int | value | ||
) |
Set an OpenGL window attribute before window creation.
Definition at line 3123 of file SDL_video.c.
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_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.
int SDL_GL_SetSwapInterval | ( | int | interval | ) |
Set the swap interval for the current OpenGL context.
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. |
Definition at line 3578 of file SDL_video.c.
References _this, SDL_VideoDevice::GL_SetSwapInterval, NULL, SDL_GL_GetCurrentContext(), SDL_SetError, and SDL_UninitializedVideo().
void SDL_GL_SwapWindow | ( | SDL_Window * | window | ) |
Swap the OpenGL buffers for a window, if double-buffering is supported.
Definition at line 3606 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GL_SwapWindow, SDL_GL_GetCurrentWindow(), SDL_SetError, and SDL_WINDOW_OPENGL.
Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
Definition at line 2929 of file SDL_video.c.
References _this, SDL_VideoDevice::driver_loaded, SDL_VideoDevice::gl_config, SDL_VideoDevice::GL_UnloadLibrary, and SDL_UninitializedVideo().
Referenced by SDL_DestroyWindow(), and SDL_RecreateWindow().
void SDL_HideWindow | ( | SDL_Window * | window | ) |
Hide a window.
Definition at line 2168 of file SDL_video.c.
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().
Returns whether the screensaver is currently enabled (default off).
Definition at line 2789 of file SDL_video.c.
References _this, SDL_FALSE, SDL_TRUE, and SDL_VideoDevice::suspend_screensaver.
void SDL_MaximizeWindow | ( | SDL_Window * | window | ) |
Make a window as large as possible.
Definition at line 2200 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::MaximizeWindow, and SDL_WINDOW_MAXIMIZED.
Referenced by SDL_FinishWindowCreation().
void SDL_MinimizeWindow | ( | SDL_Window * | window | ) |
Minimize a window to an iconic representation.
Definition at line 2225 of file SDL_video.c.
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().
void SDL_RaiseWindow | ( | SDL_Window * | window | ) |
Raise a window above other windows and set the input focus.
Definition at line 2187 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::RaiseWindow, and SDL_WINDOW_SHOWN.
Referenced by SDL_ShowMessageBox().
void SDL_RestoreWindow | ( | SDL_Window * | window | ) |
Restore the size and position of a minimized or maximized window.
Definition at line 2245 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::RestoreWindow, SDL_WINDOW_MAXIMIZED, and SDL_WINDOW_MINIMIZED.
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.
window | The window of which to change the border state. |
bordered | SDL_FALSE to remove border, SDL_TRUE to add border. |
Definition at line 1950 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_FALSE, SDL_WINDOW_BORDERLESS, SDL_WINDOW_FULLSCREEN, and SDL_VideoDevice::SetWindowBordered.
int SDL_SetWindowBrightness | ( | SDL_Window * | window, |
float | brightness | ||
) |
Set the brightness (gamma correction) for a window.
Definition at line 2355 of file SDL_video.c.
References CHECK_WINDOW_MAGIC, SDL_CalculateGammaRamp, and SDL_SetWindowGammaRamp().
void* SDL_SetWindowData | ( | SDL_Window * | window, |
const char * | name, | ||
void * | userdata | ||
) |
Associate an arbitrary named pointer with a window.
window | The window to associate with the pointer. |
name | The name of the pointer. |
userdata | The associated pointer. |
Definition at line 1796 of file SDL_video.c.
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().
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.
window | The window for which the display mode should be set. |
mode | The mode to use, or NULL for the default mode. |
Definition at line 1100 of file SDL_video.c.
References CHECK_WINDOW_MAGIC, FULLSCREEN_VISIBLE, SDL_GetDisplayForWindow(), SDL_GetWindowDisplayMode(), SDL_SetDisplayModeForDisplay(), SDL_WINDOW_FULLSCREEN_DESKTOP, and SDL_zero.
int SDL_SetWindowFullscreen | ( | SDL_Window * | window, |
Uint32 | flags | ||
) |
Set a window's fullscreen state.
Definition at line 2259 of file SDL_video.c.
References CHECK_WINDOW_MAGIC, FULLSCREEN_MASK, FULLSCREEN_VISIBLE, and SDL_UpdateFullscreenMode().
Referenced by SDL_FinishWindowCreation().
int SDL_SetWindowGammaRamp | ( | SDL_Window * | window, |
const Uint16 * | red, | ||
const Uint16 * | green, | ||
const Uint16 * | blue | ||
) |
Set the gamma ramp for a window.
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. |
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.
Definition at line 2441 of file SDL_video.c.
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().
void SDL_SetWindowGrab | ( | SDL_Window * | window, |
SDL_bool | grabbed | ||
) |
Set a window's input grab mode.
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.
Definition at line 2551 of file SDL_video.c.
References CHECK_WINDOW_MAGIC, SDL_UpdateWindowGrab(), and SDL_WINDOW_INPUT_GRABBED.
Referenced by SDL_FinishWindowCreation().
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.
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. |
Definition at line 3998 of file SDL_video.c.
References _this, callback(), CHECK_WINDOW_MAGIC, NULL, SDL_Unsupported, and SDL_VideoDevice::SetWindowHitTest.
void SDL_SetWindowIcon | ( | SDL_Window * | window, |
SDL_Surface * | icon | ||
) |
Set the icon for a window.
window | The window for which the icon should be set. |
icon | The icon for the window. |
Definition at line 1774 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_ConvertSurfaceFormat, SDL_FreeSurface, SDL_PIXELFORMAT_ARGB8888, and SDL_VideoDevice::SetWindowIcon.
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.
window | The window that should get the input focus |
Definition at line 2428 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_Unsupported, and SDL_VideoDevice::SetWindowInputFocus.
void SDL_SetWindowMaximumSize | ( | SDL_Window * | window, |
int | max_w, | ||
int | max_h | ||
) |
Set the maximum size of a window's client area.
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 |
Definition at line 2111 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_InvalidParamError, SDL_min, SDL_SetError, SDL_SetWindowSize(), SDL_WINDOW_FULLSCREEN, and SDL_VideoDevice::SetWindowMaximumSize.
void SDL_SetWindowMinimumSize | ( | SDL_Window * | window, |
int | min_w, | ||
int | min_h | ||
) |
Set the minimum size of a window's client area.
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 |
Definition at line 2068 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_InvalidParamError, SDL_max, SDL_SetError, SDL_SetWindowSize(), SDL_WINDOW_FULLSCREEN, and SDL_VideoDevice::SetWindowMinimumSize.
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)
modal_window | The window that should be modal |
parent_window | The parent window |
Definition at line 2415 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_Unsupported, and SDL_VideoDevice::SetWindowModalFor.
int SDL_SetWindowOpacity | ( | SDL_Window * | window, |
float | opacity | ||
) |
Set the opacity for a window.
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. |
Definition at line 2379 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, retval, SDL_Unsupported, and SDL_VideoDevice::SetWindowOpacity.
void SDL_SetWindowPosition | ( | SDL_Window * | window, |
int | x, | ||
int | y | ||
) |
Set the position of a window.
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. |
Definition at line 1864 of file SDL_video.c.
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.
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.
window | The window of which to change the resizable state. |
resizable | SDL_TRUE to allow resizing, SDL_FALSE to disallow. |
Definition at line 1968 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_FALSE, SDL_WINDOW_FULLSCREEN, SDL_WINDOW_RESIZABLE, and SDL_VideoDevice::SetWindowResizable.
void SDL_SetWindowSize | ( | SDL_Window * | window, |
int | w, | ||
int | h | ||
) |
Set the size of a window's client area.
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. |
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.
Definition at line 1986 of file SDL_video.c.
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().
void SDL_SetWindowTitle | ( | SDL_Window * | window, |
const char * | title | ||
) |
Set the title of a window, in UTF-8 format.
Definition at line 1749 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_free, SDL_strdup, and SDL_VideoDevice::SetWindowTitle.
Referenced by SDL_CreateWindow().
void SDL_ShowWindow | ( | SDL_Window * | window | ) |
Show a window.
Definition at line 2153 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_SendWindowEvent(), SDL_WINDOW_SHOWN, SDL_WINDOWEVENT_SHOWN, and SDL_VideoDevice::ShowWindow.
Referenced by SDL_FinishWindowCreation().
int SDL_UpdateWindowSurface | ( | SDL_Window * | window | ) |
Copy the window surface to the screen.
Definition at line 2328 of file SDL_video.c.
References CHECK_WINDOW_MAGIC, SDL_Rect::h, SDL_UpdateWindowSurfaceRects(), SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.
int SDL_UpdateWindowSurfaceRects | ( | SDL_Window * | window, |
const SDL_Rect * | rects, | ||
int | numrects | ||
) |
Copy a number of rectangles on the window surface to the screen.
Definition at line 2342 of file SDL_video.c.
References _this, CHECK_WINDOW_MAGIC, SDL_SetError, and SDL_VideoDevice::UpdateWindowFramebuffer.
Referenced by SDL_UpdateWindowSurface().
int SDL_VideoInit | ( | const char * | driver_name | ) |
Initialize the video subsystem, optionally specifying a video driver.
driver_name | Initialize a specific driver by name, or NULL for the default video driver. |
This function initializes the video subsystem; setting up a connection to the window manager, etc, and determines the available display modes and pixel formats, but does not initialize a window or graphics mode.
Definition at line 461 of file SDL_video.c.
References _this, available(), 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.
Referenced by SDL_CreateWindow().
Shuts down the video subsystem.
This function closes all windows, and restores the original video mode.
Definition at line 2828 of file SDL_video.c.
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().