SDL_video.c File Reference

#include "../SDL_internal.h"
#include "SDL.h"
#include "SDL_video.h"
#include "SDL_sysvideo.h"
#include "SDL_blit.h"
#include "SDL_pixels_c.h"
#include "SDL_rect_c.h"
#include "../events/SDL_events_c.h"
#include "../timer/SDL_timer_c.h"
#include "SDL_syswm.h"
#include "SDL_opengl.h"
#include "x11/SDL_x11messagebox.h"

Include dependency graph for SDL_video.c:

Go to the source code of this file.

Data Structures
struct	SDL_WindowTextureData

Macros
#define	CHECK_WINDOW_MAGIC(window, retval)
#define	CHECK_DISPLAY_INDEX(displayIndex, retval)
#define	FULLSCREEN_MASK   (SDL_WINDOW_FULLSCREEN_DESKTOP | SDL_WINDOW_FULLSCREEN)
#define	SDL_WINDOWTEXTUREDATA   "_SDL_WindowTextureData"
#define	CREATE_FLAGS    (SDL_WINDOW_OPENGL | SDL_WINDOW_BORDERLESS | SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI | SDL_WINDOW_ALWAYS_ON_TOP | SDL_WINDOW_SKIP_TASKBAR | SDL_WINDOW_POPUP_MENU | SDL_WINDOW_UTILITY | SDL_WINDOW_TOOLTIP | SDL_WINDOW_VULKAN | SDL_WINDOW_MINIMIZED | SDL_WINDOW_METAL)
#define	GL_NUM_EXTENSIONS   0x821D
#define	NOT_A_VULKAN_WINDOW   "The specified window isn't a Vulkan window"

Functions
static SDL_bool	ShouldUseTextureFramebuffer ()
static int	SDL_CreateWindowTexture (SDL_VideoDevice *unused, SDL_Window *window, Uint32 *format, void **pixels, int *pitch)
static int	SDL_UpdateWindowTexture (SDL_VideoDevice *unused, SDL_Window *window, const SDL_Rect *rects, int numrects)
static void	SDL_DestroyWindowTexture (SDL_VideoDevice *unused, SDL_Window *window)
static int	cmpmodes (const void *A, const void *B)
static int	SDL_UninitializedVideo ()
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...
const char *	SDL_GetCurrentVideoDriver ()
	Returns the name of the currently initialized video driver. More...
SDL_VideoDevice *	SDL_GetVideoDevice (void)
int	SDL_AddBasicVideoDisplay (const SDL_DisplayMode *desktop_mode)
int	SDL_AddVideoDisplay (const SDL_VideoDisplay *display, SDL_bool send_event)
void	SDL_DelVideoDisplay (int index)
int	SDL_GetNumVideoDisplays (void)
	Returns the number of available video displays. More...
int	SDL_GetIndexOfDisplay (SDL_VideoDisplay *display)
void *	SDL_GetDisplayDriverData (int displayIndex)
SDL_bool	SDL_IsVideoContextExternal (void)
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...
static int	ParseDisplayUsableBoundsHint (SDL_Rect *rect)
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...
SDL_bool	SDL_AddDisplayMode (SDL_VideoDisplay *display, const SDL_DisplayMode *mode)
static int	SDL_GetNumDisplayModesForDisplay (SDL_VideoDisplay *display)
int	SDL_GetNumDisplayModes (int displayIndex)
	Returns the number of available display modes. More...
int	SDL_GetDisplayMode (int displayIndex, int index, 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...
static SDL_DisplayMode *	SDL_GetClosestDisplayModeForDisplay (SDL_VideoDisplay *display, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
SDL_DisplayMode *	SDL_GetClosestDisplayMode (int displayIndex, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
	Get the closest match to the requested display mode. More...
static int	SDL_SetDisplayModeForDisplay (SDL_VideoDisplay *display, const SDL_DisplayMode *mode)
SDL_VideoDisplay *	SDL_GetDisplay (int displayIndex)
int	SDL_GetWindowDisplayIndex (SDL_Window *window)
	Get the display index associated with a window. More...
SDL_VideoDisplay *	SDL_GetDisplayForWindow (SDL_Window *window)
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...
static void	SDL_RestoreMousePosition (SDL_Window *window)
static int	SDL_UpdateFullscreenMode (SDL_Window *window, SDL_bool fullscreen)
static SDL_INLINE SDL_bool	IsAcceptingDragAndDrop (void)
static SDL_INLINE void	PrepareDragAndDropSupport (SDL_Window *window)
void	SDL_ToggleDragAndDropSupport (void)
static void	SDL_FinishWindowCreation (SDL_Window *window, Uint32 flags)
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...
int	SDL_RecreateWindow (SDL_Window *window, Uint32 flags)
SDL_bool	SDL_HasWindows (void)
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_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_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 *min_w, int *min_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 *max_w, int *max_h)
	Get the maximum size of a window's client area. 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...
static SDL_bool	CanMinimizeWindow (SDL_Window *window)
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...
static SDL_Surface *	SDL_CreateWindowFramebuffer (SDL_Window *window)
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...
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...
void	SDL_UpdateWindowGrab (SDL_Window *window)
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...
void	SDL_OnWindowShown (SDL_Window *window)
void	SDL_OnWindowHidden (SDL_Window *window)
void	SDL_OnWindowResized (SDL_Window *window)
void	SDL_OnWindowMinimized (SDL_Window *window)
void	SDL_OnWindowRestored (SDL_Window *window)
void	SDL_OnWindowEnter (SDL_Window *window)
void	SDL_OnWindowLeave (SDL_Window *window)
void	SDL_OnWindowFocusGained (SDL_Window *window)
static SDL_bool	ShouldMinimizeOnFocusLoss (SDL_Window *window)
void	SDL_OnWindowFocusLost (SDL_Window *window)
SDL_Window *	SDL_GetFocusWindow (void)
void	SDL_DestroyWindow (SDL_Window *window)
	Destroy a window. More...
SDL_bool	SDL_IsScreenSaverEnabled ()
	Returns whether the screensaver is currently enabled (default off). More...
void	SDL_EnableScreenSaver ()
	Allow the screen to be blanked by a screensaver. More...
void	SDL_DisableScreenSaver ()
	Prevent the screen from being blanked by a screensaver. More...
void	SDL_VideoQuit (void)
	Shuts down the video subsystem. More...
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...
static SDL_INLINE SDL_bool	isAtLeastGL3 (const char *verstr)
SDL_bool	SDL_GL_ExtensionSupported (const char *extension)
	Return true if an OpenGL extension is supported for the current context. More...
void	SDL_GL_DeduceMaxSupportedESProfile (int *major, int *minor)
void	SDL_GL_ResetAttributes ()
	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 ctx)
	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...
SDL_bool	SDL_GetWindowWMInfo (SDL_Window *window, struct SDL_SysWMinfo *info)
	This function allows access to driver-dependent window information. More...
void	SDL_StartTextInput (void)
	Start accepting Unicode text input events. This function will show the on-screen keyboard if supported. More...
SDL_bool	SDL_IsTextInputActive (void)
	Return whether or not Unicode text input events are enabled. More...
void	SDL_StopTextInput (void)
	Stop receiving any text input events. This function will hide the on-screen keyboard if supported. More...
void	SDL_SetTextInputRect (SDL_Rect *rect)
	Set the rectangle used to type Unicode text inputs. This is used as a hint for IME and on-screen keyboard placement. More...
SDL_bool	SDL_HasScreenKeyboardSupport (void)
	Returns whether the platform has some screen keyboard support. More...
SDL_bool	SDL_IsScreenKeyboardShown (SDL_Window *window)
	Returns whether the screen keyboard is shown for given window. More...
static SDL_bool	SDL_MessageboxValidForDriver (const SDL_MessageBoxData *messageboxdata, SDL_SYSWM_TYPE drivertype)
int	SDL_ShowMessageBox (const SDL_MessageBoxData *messageboxdata, int *buttonid)
	Create a modal message box. More...
int	SDL_ShowSimpleMessageBox (Uint32 flags, const char *title, const char *message, SDL_Window *window)
	Create a simple modal message box. More...
SDL_bool	SDL_ShouldAllowTopmost (void)
int	SDL_SetWindowHitTest (SDL_Window *window, SDL_HitTest callback, void *userdata)
	Provide a callback that decides if a window region has special properties. More...
float	SDL_ComputeDiagonalDPI (int hpix, int vpix, float hinches, float vinches)
void	SDL_OnApplicationWillTerminate (void)
void	SDL_OnApplicationDidReceiveMemoryWarning (void)
void	SDL_OnApplicationWillResignActive (void)
void	SDL_OnApplicationDidEnterBackground (void)
void	SDL_OnApplicationWillEnterForeground (void)
void	SDL_OnApplicationDidBecomeActive (void)
int	SDL_Vulkan_LoadLibrary (const char *path)
	Dynamically load a Vulkan loader library. More...
void *	SDL_Vulkan_GetVkGetInstanceProcAddr (void)
	Get the address of the vkGetInstanceProcAddr function. More...
void	SDL_Vulkan_UnloadLibrary (void)
	Unload the Vulkan loader library previously loaded by SDL_Vulkan_LoadLibrary(). More...
SDL_bool	SDL_Vulkan_GetInstanceExtensions (SDL_Window *window, unsigned *count, const char **names)
SDL_bool	SDL_Vulkan_CreateSurface (SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface)
	Create a Vulkan rendering surface for a window. More...
void	SDL_Vulkan_GetDrawableSize (SDL_Window *window, int *w, int *h)
	Get the size of a window's underlying drawable in pixels (for use with setting viewport, scissor & etc). More...
SDL_MetalView	SDL_Metal_CreateView (SDL_Window *window)
	Create a CAMetalLayer-backed NSView/UIView and attach it to the specified window. More...
void	SDL_Metal_DestroyView (SDL_MetalView view)
	Destroy an existing SDL_MetalView object. More...
void *	SDL_Metal_GetLayer (SDL_MetalView view)
	Get a pointer to the backing CAMetalLayer for the given view. More...
void	SDL_Metal_GetDrawableSize (SDL_Window *window, int *w, int *h)
	Get the size of a window's underlying drawable in pixels (for use with setting viewport, scissor & etc). More...

Variables
static VideoBootStrap *	bootstrap []
static SDL_VideoDevice *	_this = NULL

Macro Definition Documentation

CHECK_DISPLAY_INDEX

#define CHECK_DISPLAY_INDEX	(		displayIndex,
			retval
	)

Value:

    if (!_this) { \
        SDL_UninitializedVideo(); \
        return retval; \
    } \
    SDL_assert(_this->displays != NULL); \
    SDL_assert(displayIndex >= 0 && displayIndex < _this->num_displays); \
    if (displayIndex < 0 || displayIndex >= _this->num_displays) { \
        SDL_SetError("displayIndex must be in the range 0 - %d", \
                     _this->num_displays - 1); \
        return retval; \
    }

Definition at line 139 of file SDL_video.c.

CHECK_WINDOW_MAGIC

#define CHECK_WINDOW_MAGIC	(		window,
			retval
	)

Value:

    if (!_this) { \
        SDL_UninitializedVideo(); \
        return retval; \
    } \
    SDL_assert(window && window->magic == &_this->window_magic); \
    if (!window || window->magic != &_this->window_magic) { \
        SDL_SetError("Invalid window"); \
        return retval; \
    }

Definition at line 128 of file SDL_video.c.

CREATE_FLAGS

#define CREATE_FLAGS    (SDL_WINDOW_OPENGL | SDL_WINDOW_BORDERLESS | SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI | SDL_WINDOW_ALWAYS_ON_TOP | SDL_WINDOW_SKIP_TASKBAR | SDL_WINDOW_POPUP_MENU | SDL_WINDOW_UTILITY | SDL_WINDOW_TOOLTIP | SDL_WINDOW_VULKAN | SDL_WINDOW_MINIMIZED | SDL_WINDOW_METAL)

Definition at line 1388 of file SDL_video.c.

FULLSCREEN_MASK

#define FULLSCREEN_MASK   (SDL_WINDOW_FULLSCREEN_DESKTOP | SDL_WINDOW_FULLSCREEN)

Definition at line 152 of file SDL_video.c.

GL_NUM_EXTENSIONS

#define GL_NUM_EXTENSIONS   0x821D

NOT_A_VULKAN_WINDOW

#define NOT_A_VULKAN_WINDOW   "The specified window isn't a Vulkan window"

Definition at line 4221 of file SDL_video.c.

SDL_WINDOWTEXTUREDATA

#define SDL_WINDOWTEXTUREDATA   "_SDL_WindowTextureData"

Definition at line 163 of file SDL_video.c.

Function Documentation

CanMinimizeWindow()

static SDL_bool CanMinimizeWindow ( SDL_Window *  window )

static

Definition at line 2327 of file SDL_video.c.

{
    if (!_this->MinimizeWindow) {
        return SDL_FALSE;
    }
    return SDL_TRUE;
}

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

Referenced by SDL_MinimizeWindow().

cmpmodes()

static int cmpmodes ( const void *  A, const void *  B  )

static

Definition at line 424 of file SDL_video.c.

{
    const SDL_DisplayMode *a = (const SDL_DisplayMode *) A;
    const SDL_DisplayMode *b = (const SDL_DisplayMode *) B;
    if (a == b) {
        return 0;
    } else if (a->w != b->w) {
        return b->w - a->w;
    } else if (a->h != b->h) {
        return b->h - a->h;
    } else if (SDL_BITSPERPIXEL(a->format) != SDL_BITSPERPIXEL(b->format)) {
        return SDL_BITSPERPIXEL(b->format) - SDL_BITSPERPIXEL(a->format);
    } else if (SDL_PIXELLAYOUT(a->format) != SDL_PIXELLAYOUT(b->format)) {
        return SDL_PIXELLAYOUT(b->format) - SDL_PIXELLAYOUT(a->format);
    } else if (a->refresh_rate != b->refresh_rate) {
        return b->refresh_rate - a->refresh_rate;
    }
    return 0;
}

References SDL_BITSPERPIXEL, SDL_PIXELLAYOUT, and SDL_DisplayMode::w.

Referenced by SDL_AddDisplayMode(), and SDL_GetNumDisplayModesForDisplay().

IsAcceptingDragAndDrop()

static SDL_INLINE SDL_bool IsAcceptingDragAndDrop ( void  )

static

Definition at line 1392 of file SDL_video.c.

{
    if ((SDL_GetEventState(SDL_DROPFILE) == SDL_ENABLE) ||
        (SDL_GetEventState(SDL_DROPTEXT) == SDL_ENABLE)) {
        return SDL_TRUE;
    }
    return SDL_FALSE;
}

References SDL_DROPFILE, SDL_DROPTEXT, SDL_ENABLE, SDL_FALSE, SDL_GetEventState, and SDL_TRUE.

Referenced by PrepareDragAndDropSupport(), and SDL_ToggleDragAndDropSupport().

isAtLeastGL3()

static SDL_INLINE SDL_bool isAtLeastGL3 ( const char *  verstr )

static

Definition at line 3065 of file SDL_video.c.

{
    return (verstr && (SDL_atoi(verstr) >= 3));
}

References SDL_atoi.

Referenced by SDL_GL_ExtensionSupported(), and SDL_GL_GetAttribute().

ParseDisplayUsableBoundsHint()

static int ParseDisplayUsableBoundsHint ( SDL_Rect *  rect )

static

Definition at line 730 of file SDL_video.c.

{
    const char *hint = SDL_GetHint(SDL_HINT_DISPLAY_USABLE_BOUNDS);
    return hint && (SDL_sscanf(hint, "%d,%d,%d,%d", &rect->x, &rect->y, &rect->w, &rect->h) == 4);
}

References SDL_Rect::h, rect, SDL_GetHint, SDL_HINT_DISPLAY_USABLE_BOUNDS, SDL_sscanf, SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

Referenced by SDL_GetDisplayUsableBounds().

PrepareDragAndDropSupport()

static SDL_INLINE void PrepareDragAndDropSupport ( SDL_Window *  window )

static

Definition at line 1403 of file SDL_video.c.

{
    if (_this->AcceptDragAndDrop) {
        _this->AcceptDragAndDrop(window, IsAcceptingDragAndDrop());
    }
}

References _this, SDL_VideoDevice::AcceptDragAndDrop, and IsAcceptingDragAndDrop().

Referenced by SDL_CreateWindowFrom(), and SDL_FinishWindowCreation().

SDL_AddBasicVideoDisplay()

int SDL_AddBasicVideoDisplay

(

const SDL_DisplayMode *

desktop_mode

)

Definition at line 593 of file SDL_video.c.

{
    SDL_VideoDisplay display;
 
    SDL_zero(display);
    if (desktop_mode) {
        display.desktop_mode = *desktop_mode;
    }
    display.current_mode = display.desktop_mode;
 
    return SDL_AddVideoDisplay(&display, SDL_FALSE);
}

References SDL_VideoDisplay::current_mode, SDL_VideoDisplay::desktop_mode, SDL_AddVideoDisplay(), SDL_FALSE, and SDL_zero.

SDL_AddDisplayMode()

SDL_bool SDL_AddDisplayMode	(	SDL_VideoDisplay *	display,
		const SDL_DisplayMode *	mode
	)

Definition at line 792 of file SDL_video.c.

{
    SDL_DisplayMode *modes;
    int i, nmodes;
 
    /* Make sure we don't already have the mode in the list */
    modes = display->display_modes;
    nmodes = display->num_display_modes;
    for (i = 0; i < nmodes; ++i) {
        if (cmpmodes(mode, &modes[i]) == 0) {
            return SDL_FALSE;
        }
    }
 
    /* Go ahead and add the new mode */
    if (nmodes == display->max_display_modes) {
        modes =
            SDL_realloc(modes,
                        (display->max_display_modes + 32) * sizeof(*modes));
        if (!modes) {
            return SDL_FALSE;
        }
        display->display_modes = modes;
        display->max_display_modes += 32;
    }
    modes[nmodes] = *mode;
    display->num_display_modes++;
 
    /* Re-sort video modes */
    SDL_qsort(display->display_modes, display->num_display_modes,
              sizeof(SDL_DisplayMode), cmpmodes);
 
    return SDL_TRUE;
}

References cmpmodes(), SDL_VideoDisplay::display_modes, i, SDL_VideoDisplay::max_display_modes, SDL_VideoDisplay::num_display_modes, SDL_FALSE, SDL_qsort, SDL_realloc, and SDL_TRUE.

SDL_AddVideoDisplay()

int SDL_AddVideoDisplay	(	const SDL_VideoDisplay *	display,
		SDL_bool	send_event
	)

Definition at line 607 of file SDL_video.c.

{
    SDL_VideoDisplay *displays;
    int index = -1;
 
    displays =
        SDL_realloc(_this->displays,
                    (_this->num_displays + 1) * sizeof(*displays));
    if (displays) {
        index = _this->num_displays++;
        displays[index] = *display;
        displays[index].device = _this;
        _this->displays = displays;
 
        if (display->name) {
            displays[index].name = SDL_strdup(display->name);
        } else {
            char name[32];
 
            SDL_itoa(index, name, 10);
            displays[index].name = SDL_strdup(name);
        }
 
        if (send_event) {
            SDL_SendDisplayEvent(&_this->displays[index], SDL_DISPLAYEVENT_CONNECTED, 0);
        }
    } else {
        SDL_OutOfMemory();
    }
    return index;
}

References _this, SDL_VideoDisplay::device, SDL_VideoDevice::displays, SDL_VideoDisplay::name, SDL_VideoDevice::num_displays, SDL_DISPLAYEVENT_CONNECTED, SDL_itoa, SDL_OutOfMemory, SDL_realloc, SDL_SendDisplayEvent(), and SDL_strdup.

Referenced by SDL_AddBasicVideoDisplay(), and videoInit().

SDL_ComputeDiagonalDPI()

float SDL_ComputeDiagonalDPI	(	int	hpix,
		int	vpix,
		float	hinches,
		float	vinches
	)

Definition at line 4162 of file SDL_video.c.

{
    float den2 = hinches * hinches + vinches * vinches;
    if (den2 <= 0.0f) {
        return 0.0f;
    }
 
    return (float)(SDL_sqrt((double)hpix * (double)hpix + (double)vpix * (double)vpix) /
                   SDL_sqrt((double)den2));
}

References SDL_sqrt.

SDL_CreateWindow()

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

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

Parameters

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

Returns

The created window, or NULL if window creation failed.

If the window is created with the SDL_WINDOW_ALLOW_HIGHDPI flag, its size in pixels may differ from its size in screen coordinates on platforms with high-DPI support (e.g. iOS and Mac OS X). Use SDL_GetWindowSize() to query the client area's size in screen coordinates, and SDL_GL_GetDrawableSize(), SDL_Vulkan_GetDrawableSize(), or SDL_GetRendererOutputSize() to query the drawable size in pixels.

If the window is created with any of the SDL_WINDOW_OPENGL or SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the corresponding UnloadLibrary function is called by SDL_DestroyWindow().

If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver, SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail.

If SDL_WINDOW_METAL is specified on an OS that does not support Metal, SDL_CreateWindow() will fail.

Note

On non-Apple devices, SDL requires you to either not link to the Vulkan loader or link to a dynamic library version. This limitation may be removed in a future version of SDL.

See also

SDL_DestroyWindow()

SDL_GL_LoadLibrary()

SDL_Vulkan_LoadLibrary()

Definition at line 1446 of file SDL_video.c.

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

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

Referenced by ShouldUseTextureFramebuffer().

SDL_CreateWindowFramebuffer()

static SDL_Surface* SDL_CreateWindowFramebuffer ( SDL_Window *  window )

static

Definition at line 2396 of file SDL_video.c.

{
    Uint32 format;
    void *pixels;
    int pitch;
    int bpp;
    Uint32 Rmask, Gmask, Bmask, Amask;
 
    if (!_this->CreateWindowFramebuffer || !_this->UpdateWindowFramebuffer) {
        return NULL;
    }
 
    if (_this->CreateWindowFramebuffer(_this, window, &format, &pixels, &pitch) < 0) {
        return NULL;
    }
 
    if (window->surface) {
        return window->surface;
    }
 
    if (!SDL_PixelFormatEnumToMasks(format, &bpp, &Rmask, &Gmask, &Bmask, &Amask)) {
        return NULL;
    }
 
    return SDL_CreateRGBSurfaceFrom(pixels, window->w, window->h, bpp, pitch, Rmask, Gmask, Bmask, Amask);
}

References _this, bpp, SDL_VideoDevice::CreateWindowFramebuffer, NULL, SDL_CreateRGBSurfaceFrom, SDL_PixelFormatEnumToMasks, and SDL_VideoDevice::UpdateWindowFramebuffer.

Referenced by SDL_GetWindowSurface().

SDL_CreateWindowFrom()

SDL_Window* SDL_CreateWindowFrom

(

const void *

data

)

Create an SDL window from an existing native window.

Parameters

data	A pointer to driver-dependent window creation data

Returns

The created window, or NULL if window creation failed.

See also

SDL_DestroyWindow()

Definition at line 1632 of file SDL_video.c.

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

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

SDL_CreateWindowTexture()

static int SDL_CreateWindowTexture ( SDL_VideoDevice *  unused, SDL_Window *  window, Uint32 *  format, void **  pixels, int *  pitch  )

static

Definition at line 264 of file SDL_video.c.

{
    SDL_WindowTextureData *data;
 
    data = SDL_GetWindowData(window, SDL_WINDOWTEXTUREDATA);
    if (!data) {
        SDL_Renderer *renderer = NULL;
        int i;
        const char *hint = SDL_GetHint(SDL_HINT_FRAMEBUFFER_ACCELERATION);
 
        /* Check to see if there's a specific driver requested */
        if (hint && *hint != '0' && *hint != '1' &&
            SDL_strcasecmp(hint, "true") != 0 &&
            SDL_strcasecmp(hint, "false") != 0 &&
            SDL_strcasecmp(hint, "software") != 0) {
            for (i = 0; i < SDL_GetNumRenderDrivers(); ++i) {
                SDL_RendererInfo info;
                SDL_GetRenderDriverInfo(i, &info);
                if (SDL_strcasecmp(info.name, hint) == 0) {
                    renderer = SDL_CreateRenderer(window, i, 0);
                    break;
                }
            }
        }
        
        if (!renderer) {
            for (i = 0; i < SDL_GetNumRenderDrivers(); ++i) {
                SDL_RendererInfo info;
                SDL_GetRenderDriverInfo(i, &info);
                if (SDL_strcmp(info.name, "software") != 0) {
                    renderer = SDL_CreateRenderer(window, i, 0);
                    if (renderer) {
                        break;
                    }
                }
            }
        }
        if (!renderer) {
            return SDL_SetError("No hardware accelerated renderers available");
        }
 
        /* Create the data after we successfully create the renderer (bug #1116) */
        data = (SDL_WindowTextureData *)SDL_calloc(1, sizeof(*data));
        if (!data) {
            SDL_DestroyRenderer(renderer);
            return SDL_OutOfMemory();
        }
        SDL_SetWindowData(window, SDL_WINDOWTEXTUREDATA, data);
 
        data->renderer = renderer;
    }
 
    /* Free any old texture and pixel data */
    if (data->texture) {
        SDL_DestroyTexture(data->texture);
        data->texture = NULL;
    }
    SDL_free(data->pixels);
    data->pixels = NULL;
 
    {
        SDL_RendererInfo info;
        Uint32 i;
 
        if (SDL_GetRendererInfo(data->renderer, &info) < 0) {
            return -1;
        }
 
        /* Find the first format without an alpha channel */
        *format = info.texture_formats[0];
 
        for (i = 0; i < info.num_texture_formats; ++i) {
            if (!SDL_ISPIXELFORMAT_FOURCC(info.texture_formats[i]) &&
                    !SDL_ISPIXELFORMAT_ALPHA(info.texture_formats[i])) {
                *format = info.texture_formats[i];
                break;
            }
        }
    }
 
    data->texture = SDL_CreateTexture(data->renderer, *format,
                                      SDL_TEXTUREACCESS_STREAMING,
                                      window->w, window->h);
    if (!data->texture) {
        return -1;
    }
 
    /* Create framebuffer data */
    data->bytes_per_pixel = SDL_BYTESPERPIXEL(*format);
    data->pitch = (((window->w * data->bytes_per_pixel) + 3) & ~3);
 
    {
        /* Make static analysis happy about potential malloc(0) calls. */
        const size_t allocsize = window->h * data->pitch;
        data->pixels = SDL_malloc((allocsize > 0) ? allocsize : 1);
        if (!data->pixels) {
            return SDL_OutOfMemory();
        }
    }
 
    *pixels = data->pixels;
    *pitch = data->pitch;
 
    /* Make sure we're not double-scaling the viewport */
    SDL_RenderSetViewport(data->renderer, NULL);
 
    return 0;
}

References i, SDL_RendererInfo::name, NULL, SDL_RendererInfo::num_texture_formats, renderer, SDL_BYTESPERPIXEL, SDL_calloc, SDL_CreateRenderer, SDL_CreateTexture, SDL_DestroyRenderer, SDL_DestroyTexture, SDL_free, SDL_GetHint, SDL_GetNumRenderDrivers, SDL_GetRenderDriverInfo, SDL_GetRendererInfo, SDL_GetWindowData(), SDL_HINT_FRAMEBUFFER_ACCELERATION, SDL_ISPIXELFORMAT_ALPHA, SDL_ISPIXELFORMAT_FOURCC, SDL_malloc, SDL_OutOfMemory, SDL_RenderSetViewport, SDL_SetError, SDL_SetWindowData(), SDL_strcasecmp, SDL_strcmp, SDL_TEXTUREACCESS_STREAMING, SDL_WINDOWTEXTUREDATA, and SDL_RendererInfo::texture_formats.

Referenced by SDL_VideoInit().

SDL_DelVideoDisplay()

void SDL_DelVideoDisplay

(

int

index

)

Definition at line 640 of file SDL_video.c.

{
    if (index < 0 || index >= _this->num_displays) {
        return;
    }
 
    SDL_SendDisplayEvent(&_this->displays[index], SDL_DISPLAYEVENT_DISCONNECTED, 0);
 
    if (index < (_this->num_displays - 1)) {
        SDL_memmove(&_this->displays[index], &_this->displays[index+1], (_this->num_displays - index - 1)*sizeof(_this->displays[index]));
    }
    --_this->num_displays;
}

References _this, SDL_VideoDevice::displays, SDL_VideoDevice::num_displays, SDL_DISPLAYEVENT_DISCONNECTED, SDL_memmove, and SDL_SendDisplayEvent().

SDL_DestroyWindow()

void SDL_DestroyWindow

(

SDL_Window *

window

)

Destroy a window.

Definition at line 2828 of file SDL_video.c.

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

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

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

SDL_DestroyWindowTexture()

static void SDL_DestroyWindowTexture ( SDL_VideoDevice *  unused, SDL_Window *  window  )

static

Definition at line 404 of file SDL_video.c.

{
    SDL_WindowTextureData *data;
 
    data = SDL_SetWindowData(window, SDL_WINDOWTEXTUREDATA, NULL);
    if (!data) {
        return;
    }
    if (data->texture) {
        SDL_DestroyTexture(data->texture);
    }
    if (data->renderer) {
        SDL_DestroyRenderer(data->renderer);
    }
    SDL_free(data->pixels);
    SDL_free(data);
}

References NULL, SDL_DestroyRenderer, SDL_DestroyTexture, SDL_free, SDL_SetWindowData(), and SDL_WINDOWTEXTUREDATA.

Referenced by SDL_VideoInit().

SDL_DisableScreenSaver()

void SDL_DisableScreenSaver

(

void

)

Prevent the screen from being blanked by a screensaver.

See also

SDL_IsScreenSaverEnabled()

SDL_EnableScreenSaver()

Definition at line 2931 of file SDL_video.c.

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

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

Referenced by SDL_VideoInit().

SDL_EnableScreenSaver()

void SDL_EnableScreenSaver

(

void

)

Allow the screen to be blanked by a screensaver.

See also

SDL_IsScreenSaverEnabled()

SDL_DisableScreenSaver()

Definition at line 2916 of file SDL_video.c.

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

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

Referenced by SDL_VideoQuit().

SDL_FinishWindowCreation()

static void SDL_FinishWindowCreation ( SDL_Window *  window, Uint32  flags  )

static

Definition at line 1424 of file SDL_video.c.

{
    PrepareDragAndDropSupport(window);
 
    if (flags & SDL_WINDOW_MAXIMIZED) {
        SDL_MaximizeWindow(window);
    }
    if (flags & SDL_WINDOW_MINIMIZED) {
        SDL_MinimizeWindow(window);
    }
    if (flags & SDL_WINDOW_FULLSCREEN) {
        SDL_SetWindowFullscreen(window, flags);
    }
    if (flags & SDL_WINDOW_INPUT_GRABBED) {
        SDL_SetWindowGrab(window, SDL_TRUE);
    }
    if (!(flags & SDL_WINDOW_HIDDEN)) {
        SDL_ShowWindow(window);
    }
}

References PrepareDragAndDropSupport(), SDL_MaximizeWindow(), SDL_MinimizeWindow(), SDL_SetWindowFullscreen(), SDL_SetWindowGrab(), SDL_ShowWindow(), SDL_TRUE, SDL_WINDOW_FULLSCREEN, SDL_WINDOW_HIDDEN, SDL_WINDOW_INPUT_GRABBED, SDL_WINDOW_MAXIMIZED, and SDL_WINDOW_MINIMIZED.

Referenced by SDL_CreateWindow(), and SDL_RecreateWindow().

SDL_GetClosestDisplayMode()

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

Get the closest match to the requested display mode.

Parameters

displayIndex	The index of display from which mode should be queried.
mode	The desired display mode
closest	A pointer to a display mode to be filled in with the closest match of the available display modes.

Returns

The passed in value closest, or NULL if no matching video mode was available.

The available display modes are scanned, and closest is filled in with the closest mode matching the requested mode and returned. The mode format and refresh_rate default to the desktop mode if they are 0. The modes are scanned with size being first priority, format being second priority, and finally checking the refresh_rate. If all the available modes are too small, then NULL is returned.

See also

SDL_GetNumDisplayModes()

SDL_GetDisplayMode()

Definition at line 1000 of file SDL_video.c.

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

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

SDL_GetClosestDisplayModeForDisplay()

static SDL_DisplayMode* SDL_GetClosestDisplayModeForDisplay ( SDL_VideoDisplay *  display, const SDL_DisplayMode *  mode, SDL_DisplayMode *  closest  )

static

Definition at line 893 of file SDL_video.c.

{
    Uint32 target_format;
    int target_refresh_rate;
    int i;
    SDL_DisplayMode *current, *match;
 
    if (!mode || !closest) {
        SDL_SetError("Missing desired mode or closest mode parameter");
        return NULL;
    }
 
    /* Default to the desktop format */
    if (mode->format) {
        target_format = mode->format;
    } else {
        target_format = display->desktop_mode.format;
    }
 
    /* Default to the desktop refresh rate */
    if (mode->refresh_rate) {
        target_refresh_rate = mode->refresh_rate;
    } else {
        target_refresh_rate = display->desktop_mode.refresh_rate;
    }
 
    match = NULL;
    for (i = 0; i < SDL_GetNumDisplayModesForDisplay(display); ++i) {
        current = &display->display_modes[i];
 
        if (current->w && (current->w < mode->w)) {
            /* Out of sorted modes large enough here */
            break;
        }
        if (current->h && (current->h < mode->h)) {
            if (current->w && (current->w == mode->w)) {
                /* Out of sorted modes large enough here */
                break;
            }
            /* Wider, but not tall enough, due to a different
               aspect ratio. This mode must be skipped, but closer
               modes may still follow. */
            continue;
        }
        if (!match || current->w < match->w || current->h < match->h) {
            match = current;
            continue;
        }
        if (current->format != match->format) {
            /* Sorted highest depth to lowest */
            if (current->format == target_format ||
                (SDL_BITSPERPIXEL(current->format) >=
                 SDL_BITSPERPIXEL(target_format)
                 && SDL_PIXELTYPE(current->format) ==
                 SDL_PIXELTYPE(target_format))) {
                match = current;
            }
            continue;
        }
        if (current->refresh_rate != match->refresh_rate) {
            /* Sorted highest refresh to lowest */
            if (current->refresh_rate >= target_refresh_rate) {
                match = current;
            }
        }
    }
    if (match) {
        if (match->format) {
            closest->format = match->format;
        } else {
            closest->format = mode->format;
        }
        if (match->w && match->h) {
            closest->w = match->w;
            closest->h = match->h;
        } else {
            closest->w = mode->w;
            closest->h = mode->h;
        }
        if (match->refresh_rate) {
            closest->refresh_rate = match->refresh_rate;
        } else {
            closest->refresh_rate = mode->refresh_rate;
        }
        closest->driverdata = match->driverdata;
 
        /*
         * Pick some reasonable defaults if the app and driver don't
         * care
         */
        if (!closest->format) {
            closest->format = SDL_PIXELFORMAT_RGB888;
        }
        if (!closest->w) {
            closest->w = 640;
        }
        if (!closest->h) {
            closest->h = 480;
        }
        return closest;
    }
    return NULL;
}

References SDL_VideoDisplay::desktop_mode, SDL_VideoDisplay::display_modes, SDL_DisplayMode::driverdata, SDL_DisplayMode::format, SDL_DisplayMode::h, i, NULL, SDL_DisplayMode::refresh_rate, SDL_BITSPERPIXEL, SDL_GetNumDisplayModesForDisplay(), SDL_PIXELFORMAT_RGB888, SDL_PIXELTYPE, SDL_SetError, and SDL_DisplayMode::w.

Referenced by SDL_GetClosestDisplayMode(), SDL_GetWindowDisplayMode(), and SDL_SetDisplayModeForDisplay().

SDL_GetCurrentDisplayMode()

int SDL_GetCurrentDisplayMode	(	int	displayIndex,
		SDL_DisplayMode *	mode
	)

Fill in information about the current display mode.

Definition at line 879 of file SDL_video.c.

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

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

SDL_GetCurrentVideoDriver()

const char* SDL_GetCurrentVideoDriver

(

void

)

Returns the name of the currently initialized video driver.

Returns

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

See also

SDL_GetNumVideoDrivers()

SDL_GetVideoDriver()

Definition at line 577 of file SDL_video.c.

{
    if (!_this) {
        SDL_UninitializedVideo();
        return NULL;
    }
    return _this->name;
}

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

SDL_GetDesktopDisplayMode()

int SDL_GetDesktopDisplayMode	(	int	displayIndex,
		SDL_DisplayMode *	mode
	)

Fill in information about the desktop display mode.

Definition at line 865 of file SDL_video.c.

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

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

SDL_GetDisplay()

SDL_VideoDisplay* SDL_GetDisplay

(

int

displayIndex

)

Definition at line 1062 of file SDL_video.c.

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

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

SDL_GetDisplayBounds()

int SDL_GetDisplayBounds	(	int	displayIndex,
		SDL_Rect *	rect
	)

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

Returns

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

See also

SDL_GetNumVideoDisplays()

Definition at line 702 of file SDL_video.c.

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

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

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

SDL_GetDisplayDPI()

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

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

Note

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

Returns

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

See also

SDL_GetNumVideoDisplays()

Definition at line 761 of file SDL_video.c.

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

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

SDL_GetDisplayDriverData()

void* SDL_GetDisplayDriverData

(

int

displayIndex

)

Definition at line 680 of file SDL_video.c.

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

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

SDL_GetDisplayForWindow()

SDL_VideoDisplay* SDL_GetDisplayForWindow

(

SDL_Window *

window

)

Definition at line 1130 of file SDL_video.c.

{
    int displayIndex = SDL_GetWindowDisplayIndex(window);
    if (displayIndex >= 0) {
        return &_this->displays[displayIndex];
    } else {
        return NULL;
    }
}

References _this, SDL_VideoDevice::displays, NULL, and SDL_GetWindowDisplayIndex().

Referenced by SDL_CreateWindow(), SDL_DestroyWindow(), SDL_Fcitx_UpdateTextRect(), SDL_GetWindowDisplayMode(), SDL_GetWindowPixelFormat(), SDL_SetWindowDisplayMode(), and SDL_UpdateFullscreenMode().

SDL_GetDisplayMode()

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

Fill in information about a specific display mode.

Note

The display modes are sorted in this priority:

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

See also

SDL_GetNumDisplayModes()

Definition at line 847 of file SDL_video.c.

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

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

SDL_GetDisplayName()

const char* SDL_GetDisplayName

(

int

displayIndex

)

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

Returns

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

See also

SDL_GetNumVideoDisplays()

Definition at line 694 of file SDL_video.c.

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

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

SDL_GetDisplayOrientation()

SDL_DisplayOrientation SDL_GetDisplayOrientation

(

int

displayIndex

)

Get the orientation of a display.

Returns

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

See also

SDL_GetNumVideoDisplays()

Definition at line 781 of file SDL_video.c.

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

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

SDL_GetDisplayUsableBounds()

int SDL_GetDisplayUsableBounds	(	int	displayIndex,
		SDL_Rect *	rect
	)

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

This is the same area as SDL_GetDisplayBounds() reports, but with portions reserved by the system removed. For example, on Mac OS X, this subtracts the area occupied by the menu bar and dock.

Setting a window to be fullscreen generally bypasses these unusable areas, so these are good guidelines for the maximum space available to a non-fullscreen window.

Returns

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

See also

SDL_GetDisplayBounds()

SDL_GetNumVideoDisplays()

Definition at line 737 of file SDL_video.c.

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

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

SDL_GetFocusWindow()

SDL_Window* SDL_GetFocusWindow

(

void

)

Definition at line 2812 of file SDL_video.c.

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

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

Referenced by SDL_PromptAssertion(), SDL_StartTextInput(), and SDL_StopTextInput().

SDL_GetGrabbedWindow()

SDL_Window* SDL_GetGrabbedWindow

(

void

)

Get the window that currently has an input grab enabled.

Returns

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

See also

SDL_SetWindowGrab()

Definition at line 2691 of file SDL_video.c.

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

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

SDL_GetIndexOfDisplay()

int SDL_GetIndexOfDisplay

(

SDL_VideoDisplay *

display

)

Definition at line 665 of file SDL_video.c.

{
    int displayIndex;
 
    for (displayIndex = 0; displayIndex < _this->num_displays; ++displayIndex) {
        if (display == &_this->displays[displayIndex]) {
            return displayIndex;
        }
    }
 
    /* Couldn't find the display, just use index 0 */
    return 0;
}

References _this, SDL_VideoDevice::displays, and SDL_VideoDevice::num_displays.

Referenced by SDL_CreateWindow(), and SDL_SendDisplayEvent().

SDL_GetNumDisplayModes()

int SDL_GetNumDisplayModes

(

int

displayIndex

)

Returns the number of available display modes.

See also

SDL_GetDisplayMode()

Definition at line 839 of file SDL_video.c.

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

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

SDL_GetNumDisplayModesForDisplay()

static int SDL_GetNumDisplayModesForDisplay ( SDL_VideoDisplay *  display )

static

Definition at line 828 of file SDL_video.c.

{
    if (!display->num_display_modes && _this->GetDisplayModes) {
        _this->GetDisplayModes(_this, display);
        SDL_qsort(display->display_modes, display->num_display_modes,
                  sizeof(SDL_DisplayMode), cmpmodes);
    }
    return display->num_display_modes;
}

References _this, cmpmodes(), SDL_VideoDisplay::display_modes, SDL_VideoDevice::GetDisplayModes, SDL_VideoDisplay::num_display_modes, and SDL_qsort.

Referenced by SDL_GetClosestDisplayModeForDisplay(), SDL_GetDisplayMode(), and SDL_GetNumDisplayModes().

SDL_GetNumVideoDisplays()

int SDL_GetNumVideoDisplays

(

void

)

Returns the number of available video displays.

See also

SDL_GetDisplayBounds()

Definition at line 655 of file SDL_video.c.

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

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

SDL_GetNumVideoDrivers()

int SDL_GetNumVideoDrivers

(

void

)

Get the number of video drivers compiled into SDL.

See also

SDL_GetVideoDriver()

Definition at line 451 of file SDL_video.c.

{
    return SDL_arraysize(bootstrap) - 1;
}

References bootstrap, and SDL_arraysize.

Referenced by SDL_GetVideoDriver().

SDL_GetVideoDevice()

SDL_VideoDevice* SDL_GetVideoDevice

(

void

)

Definition at line 587 of file SDL_video.c.

{
    return _this;
}

References _this.

Referenced by SDL_CreateShapedWindow(), SDL_GetClipboardText(), SDL_GetTouch(), SDL_HasClipboardText(), SDL_PumpEvents(), SDL_SetClipboardText(), SDL_SetKeyboardFocus(), and SDL_SetWindowShape().

SDL_GetVideoDriver()

const char* SDL_GetVideoDriver

(

int

index

)

Get the name of a built in video driver.

Note

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

See also

SDL_GetNumVideoDrivers()

Definition at line 457 of file SDL_video.c.

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

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

SDL_GetWindowBordersSize()

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

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

Parameters

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

Returns

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

Note

if this function fails (returns -1), the size values will be initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the window in question was borderless.

Definition at line 2157 of file SDL_video.c.

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

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

SDL_GetWindowBrightness()

float SDL_GetWindowBrightness

(

SDL_Window *

window

)

Get the brightness (gamma correction) for a window.

Returns

The last brightness value passed to SDL_SetWindowBrightness()

See also

SDL_SetWindowBrightness()

Definition at line 2487 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC.

SDL_GetWindowData()

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

Retrieve the data pointer associated with a window.

Parameters

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

Returns

The value associated with 'name'

See also

SDL_SetWindowData()

Definition at line 1954 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC, NULL, SDL_InvalidParamError, and SDL_strcmp.

Referenced by SDL_CreateWindowTexture(), and SDL_UpdateWindowTexture().

SDL_GetWindowDisplayIndex()

int SDL_GetWindowDisplayIndex

(

SDL_Window *

window

)

Get the display index associated with a window.

Returns

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

Definition at line 1070 of file SDL_video.c.

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

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

Referenced by SDL_GetDisplayForWindow(), and SDL_GetWindowPosition().

SDL_GetWindowDisplayMode()

int SDL_GetWindowDisplayMode	(	SDL_Window *	window,
		SDL_DisplayMode *	mode
	)

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

See also

SDL_SetWindowDisplayMode()

SDL_SetWindowFullscreen()

Definition at line 1161 of file SDL_video.c.

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

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

Referenced by SDL_SetWindowDisplayMode(), and SDL_UpdateFullscreenMode().

SDL_GetWindowFlags()

Uint32 SDL_GetWindowFlags

(

SDL_Window *

window

)

Get the window flags.

Definition at line 1852 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC.

Referenced by SDL_ShowMessageBox().

SDL_GetWindowFromID()

SDL_Window* SDL_GetWindowFromID

(

Uint32

id

)

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

Definition at line 1836 of file SDL_video.c.

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

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

SDL_GetWindowGammaRamp()

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

Get the gamma ramp for a window.

Parameters

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

Returns

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

See also

SDL_SetWindowGammaRamp()

Definition at line 2591 of file SDL_video.c.

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

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

Referenced by SDL_SetWindowGammaRamp().

SDL_GetWindowGrab()

SDL_bool SDL_GetWindowGrab

(

SDL_Window *

window

)

Get a window's input grab mode.

Returns

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

See also

SDL_SetWindowGrab()

Definition at line 2683 of file SDL_video.c.

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

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

SDL_GetWindowID()

Uint32 SDL_GetWindowID

(

SDL_Window *

window

)

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

Definition at line 1828 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC.

SDL_GetWindowMaximumSize()

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

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

Parameters

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

See also

SDL_GetWindowMinimumSize()

SDL_SetWindowMaximumSize()

Definition at line 2252 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC.

SDL_GetWindowMinimumSize()

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

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

Parameters

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

See also

SDL_GetWindowMaximumSize()

SDL_SetWindowMinimumSize()

Definition at line 2210 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC.

SDL_GetWindowOpacity()

int SDL_GetWindowOpacity	(	SDL_Window *	window,
		float *	out_opacity
	)

Get the opacity of a window.

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

Parameters

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

Returns

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

See also

SDL_SetWindowOpacity()

Definition at line 2519 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC.

SDL_GetWindowPixelFormat()

Uint32 SDL_GetWindowPixelFormat

(

SDL_Window *

window

)

Get the pixel format associated with the window.

Definition at line 1198 of file SDL_video.c.

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

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

SDL_GetWindowPosition()

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

Get the position of a window.

Parameters

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

See also

SDL_SetWindowPosition()

Definition at line 2019 of file SDL_video.c.

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

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

SDL_GetWindowSize()

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

Get the size of a window's client area.

Parameters

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

The window size in screen coordinates may differ from the size in pixels, if the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() to get the real client area size in pixels.

See also

SDL_SetWindowSize()

Definition at line 2145 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC.

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

SDL_GetWindowSurface()

SDL_Surface* SDL_GetWindowSurface

(

SDL_Window *

window

)

Get the SDL surface associated with the window.

Returns

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

A new surface will be created with the optimal format for the window, if necessary. This surface will be freed when the window is destroyed.

Note

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

See also

SDL_UpdateWindowSurface()

SDL_UpdateWindowSurfaceRects()

Definition at line 2424 of file SDL_video.c.

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

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

SDL_GetWindowTitle()

const char* SDL_GetWindowTitle

(

SDL_Window *

window

)

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

See also

SDL_SetWindowTitle()

Definition at line 1877 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC.

SDL_GetWindowWMInfo()

SDL_bool SDL_GetWindowWMInfo	(	SDL_Window *	window,
		SDL_SysWMinfo *	info
	)

This function allows access to driver-dependent window information.

Parameters

window	The window about which information is being requested
info	This structure must be initialized with the SDL version, and is then filled in with information about the given window.

Returns

SDL_TRUE if the function is implemented and the version member of the info struct is valid, SDL_FALSE otherwise.

You typically use this function like this:

SDL_SysWMinfo info;
SDL_VERSION(&info.version);
if ( SDL_GetWindowWMInfo(window, &info) ) { ... }

Definition at line 3857 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, SDL_FALSE);
 
    if (!info) {
        SDL_InvalidParamError("info");
        return SDL_FALSE;
    }
    info->subsystem = SDL_SYSWM_UNKNOWN;
 
    if (!_this->GetWindowWMInfo) {
        SDL_Unsupported();
        return SDL_FALSE;
    }
    return (_this->GetWindowWMInfo(_this, window, info));
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GetWindowWMInfo, SDL_FALSE, SDL_InvalidParamError, SDL_SYSWM_UNKNOWN, SDL_Unsupported, and SDL_SysWMinfo::subsystem.

Referenced by SDL_MessageboxValidForDriver().

SDL_GL_CreateContext()

SDL_GLContext SDL_GL_CreateContext

(

SDL_Window *

window

)

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

See also

SDL_GL_DeleteContext()

Definition at line 3611 of file SDL_video.c.

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

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

Referenced by ShouldUseTextureFramebuffer().

SDL_GL_DeduceMaxSupportedESProfile()

void SDL_GL_DeduceMaxSupportedESProfile	(	int *	major,
		int *	minor
	)

Definition at line 3162 of file SDL_video.c.

{
/* THIS REQUIRES AN EXISTING GL CONTEXT THAT HAS BEEN MADE CURRENT. */
/*  Please refer to https://bugzilla.libsdl.org/show_bug.cgi?id=3725 for discussion. */
#if SDL_VIDEO_OPENGL || SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
    /* XXX This is fragile; it will break in the event of release of
     * new versions of OpenGL ES.
     */
    if (SDL_GL_ExtensionSupported("GL_ARB_ES3_2_compatibility")) {
        *major = 3;
        *minor = 2;
    } else if (SDL_GL_ExtensionSupported("GL_ARB_ES3_1_compatibility")) {
        *major = 3;
        *minor = 1;
    } else if (SDL_GL_ExtensionSupported("GL_ARB_ES3_compatibility")) {
        *major = 3;
        *minor = 0;
    } else {
        *major = 2;
        *minor = 0;
    }
#endif
}

References SDL_GL_ExtensionSupported().

SDL_GL_DeleteContext()

void SDL_GL_DeleteContext

(

SDL_GLContext

context

)

Delete an OpenGL context.

See also

SDL_GL_CreateContext()

Definition at line 3744 of file SDL_video.c.

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

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

Referenced by ShouldUseTextureFramebuffer().

SDL_GL_ExtensionSupported()

SDL_bool SDL_GL_ExtensionSupported

(

const char *

extension

)

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

Definition at line 3072 of file SDL_video.c.

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

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

Referenced by SDL_GL_DeduceMaxSupportedESProfile().

SDL_GL_GetAttribute()

int SDL_GL_GetAttribute	(	SDL_GLattr	attr,
		int *	value
	)

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

Returns

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

Definition at line 3362 of file SDL_video.c.

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

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

Referenced by SDL_GL_GetAttribute().

SDL_GL_GetCurrentContext()

SDL_GLContext SDL_GL_GetCurrentContext

(

void

)

Get the currently active OpenGL context.

Definition at line 3677 of file SDL_video.c.

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

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

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

SDL_GL_GetCurrentWindow()

SDL_Window* SDL_GL_GetCurrentWindow

(

void

)

Get the currently active OpenGL window.

Definition at line 3667 of file SDL_video.c.

{
    if (!_this) {
        SDL_UninitializedVideo();
        return NULL;
    }
    return (SDL_Window *)SDL_TLSGet(_this->current_glwin_tls);
}

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

Referenced by SDL_GL_MakeCurrent(), and SDL_GL_SwapWindow().

SDL_GL_GetDrawableSize()

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

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

Parameters

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

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

See also

SDL_GetWindowSize()

SDL_CreateWindow()

Definition at line 3686 of file SDL_video.c.

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

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

SDL_GL_GetProcAddress()

void* SDL_GL_GetProcAddress

(

const char *

proc

)

Get the address of an OpenGL function.

Definition at line 3025 of file SDL_video.c.

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

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

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

SDL_GL_GetSwapInterval()

int SDL_GL_GetSwapInterval

(

void

)

Get the swap interval for the current OpenGL context.

Returns

0 if there is no vertical retrace synchronization, 1 if the buffer swap is synchronized with the vertical retrace, and -1 if late swaps happen immediately instead of waiting for the next retrace. If the system can't determine the swap interval, or there isn't a valid current context, this will return 0 as a safe default.

See also

SDL_GL_SetSwapInterval()

Definition at line 3712 of file SDL_video.c.

{
    if (!_this) {
        return 0;
    } else if (SDL_GL_GetCurrentContext() == NULL) {
        return 0;
    } else if (_this->GL_GetSwapInterval) {
        return _this->GL_GetSwapInterval(_this);
    } else {
        return 0;
    }
}

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

SDL_GL_LoadLibrary()

int SDL_GL_LoadLibrary

(

const char *

path

)

Dynamically load an OpenGL library.

Parameters

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

Returns

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

This should be done after initializing the video driver, but before creating any OpenGL windows. If no OpenGL library is loaded, the default library will be loaded upon creation of the first OpenGL window.

Note

If you do this, you need to retrieve all of the GL functions used in your program from the dynamic library using SDL_GL_GetProcAddress().

See also

SDL_GL_GetProcAddress()

SDL_GL_UnloadLibrary()

Definition at line 2996 of file SDL_video.c.

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

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

Referenced by SDL_CreateWindow(), and SDL_RecreateWindow().

SDL_GL_MakeCurrent()

int SDL_GL_MakeCurrent	(	SDL_Window *	window,
		SDL_GLContext	context
	)

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

Note

The context must have been created with a compatible window.

Definition at line 3634 of file SDL_video.c.

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

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

Referenced by SDL_DestroyWindow(), and SDL_GL_DeleteContext().

SDL_GL_ResetAttributes()

void SDL_GL_ResetAttributes

(

void

)

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

Definition at line 3187 of file SDL_video.c.

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

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

Referenced by SDL_VideoInit().

SDL_GL_SetAttribute()

int SDL_GL_SetAttribute	(	SDL_GLattr	attr,
		int	value
	)

Set an OpenGL window attribute before window creation.

Returns

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

Definition at line 3241 of file SDL_video.c.

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

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

Referenced by SDL_GL_SetAttribute().

SDL_GL_SetSwapInterval()

int SDL_GL_SetSwapInterval

(

int

interval

)

Set the swap interval for the current OpenGL context.

Parameters

interval

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

Returns

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

See also

SDL_GL_GetSwapInterval()

Definition at line 3698 of file SDL_video.c.

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

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

SDL_GL_SwapWindow()

void SDL_GL_SwapWindow

(

SDL_Window *

window

)

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

Definition at line 3726 of file SDL_video.c.

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

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

SDL_GL_UnloadLibrary()

void SDL_GL_UnloadLibrary

(

void

)

Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().

See also

SDL_GL_LoadLibrary()

Definition at line 3047 of file SDL_video.c.

{
    if (!_this) {
        SDL_UninitializedVideo();
        return;
    }
    if (_this->gl_config.driver_loaded > 0) {
        if (--_this->gl_config.driver_loaded > 0) {
            return;
        }
        if (_this->GL_UnloadLibrary) {
            _this->GL_UnloadLibrary(_this);
        }
    }
}

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

Referenced by SDL_DestroyWindow(), and SDL_RecreateWindow().

SDL_HasScreenKeyboardSupport()

SDL_bool SDL_HasScreenKeyboardSupport

(

void

)

Returns whether the platform has some screen keyboard support.

Returns

SDL_TRUE if some keyboard support is available else SDL_FALSE.

Note

Not all screen keyboard functions are supported on all platforms.

See also

SDL_IsScreenKeyboardShown()

Definition at line 3931 of file SDL_video.c.

{
    if (_this && _this->HasScreenKeyboardSupport) {
        return _this->HasScreenKeyboardSupport(_this);
    }
    return SDL_FALSE;
}

References _this, SDL_VideoDevice::HasScreenKeyboardSupport, and SDL_FALSE.

Referenced by SDL_VideoInit().

SDL_HasWindows()

SDL_bool SDL_HasWindows

(

void

)

Definition at line 1822 of file SDL_video.c.

{
    return (_this && _this->windows != NULL);
}

References _this, NULL, and SDL_VideoDevice::windows.

Referenced by SDL_PrivateJoystickShouldIgnoreEvent().

SDL_HideWindow()

void SDL_HideWindow

(

SDL_Window *

window

)

Hide a window.

See also

SDL_ShowWindow()

Definition at line 2279 of file SDL_video.c.

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

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

Referenced by SDL_DestroyWindow(), and SDL_RecreateWindow().

SDL_IsScreenKeyboardShown()

SDL_bool SDL_IsScreenKeyboardShown

(

SDL_Window *

window

)

Returns whether the screen keyboard is shown for given window.

Parameters

window

The window for which screen keyboard should be queried.

Returns

SDL_TRUE if screen keyboard is shown else SDL_FALSE.

See also

SDL_HasScreenKeyboardSupport()

Definition at line 3940 of file SDL_video.c.

{
    if (window && _this && _this->IsScreenKeyboardShown) {
        return _this->IsScreenKeyboardShown(_this, window);
    }
    return SDL_FALSE;
}

References _this, SDL_VideoDevice::IsScreenKeyboardShown, and SDL_FALSE.

SDL_IsScreenSaverEnabled()

SDL_bool SDL_IsScreenSaverEnabled

(

void

)

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

See also

SDL_EnableScreenSaver()

SDL_DisableScreenSaver()

Definition at line 2907 of file SDL_video.c.

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

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

SDL_IsTextInputActive()

SDL_bool SDL_IsTextInputActive

(

void

)

Return whether or not Unicode text input events are enabled.

See also

SDL_StartTextInput()

SDL_StopTextInput()

Definition at line 3896 of file SDL_video.c.

{
    return (SDL_GetEventState(SDL_TEXTINPUT) == SDL_ENABLE);
}

References SDL_ENABLE, SDL_GetEventState, and SDL_TEXTINPUT.

SDL_IsVideoContextExternal()

SDL_bool SDL_IsVideoContextExternal

(

void

)

Definition at line 688 of file SDL_video.c.

{
    return SDL_GetHintBoolean(SDL_HINT_VIDEO_EXTERNAL_CONTEXT, SDL_FALSE);
}

References SDL_FALSE, SDL_GetHintBoolean, and SDL_HINT_VIDEO_EXTERNAL_CONTEXT.

Referenced by SDL_CreateWindow().

SDL_MaximizeWindow()

void SDL_MaximizeWindow

(

SDL_Window *

window

)

Make a window as large as possible.

See also

SDL_RestoreWindow()

Definition at line 2311 of file SDL_video.c.

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

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

Referenced by SDL_FinishWindowCreation().

SDL_MessageboxValidForDriver()

static SDL_bool SDL_MessageboxValidForDriver ( const SDL_MessageBoxData *  messageboxdata, SDL_SYSWM_TYPE  drivertype  )

static

Definition at line 3974 of file SDL_video.c.

{
    SDL_SysWMinfo info;
    SDL_Window *window = messageboxdata->window;
 
    if (!window) {
        return SDL_TRUE;
    }
 
    SDL_VERSION(&info.version);
    if (!SDL_GetWindowWMInfo(window, &info)) {
        return SDL_TRUE;
    } else {
        return (info.subsystem == drivertype);
    }
}

References SDL_GetWindowWMInfo(), SDL_TRUE, SDL_VERSION, SDL_SysWMinfo::subsystem, SDL_SysWMinfo::version, and SDL_MessageBoxData::window.

Referenced by SDL_ShowMessageBox().

SDL_Metal_CreateView()

SDL_MetalView SDL_Metal_CreateView

(

SDL_Window *

window

)

Create a CAMetalLayer-backed NSView/UIView and attach it to the specified window.

On macOS, this does not associate a MTLDevice with the CAMetalLayer on its own. It is up to user code to do that.

The returned handle can be casted directly to a NSView or UIView. To access the backing CAMetalLayer, call SDL_Metal_GetLayer().

Note

window must be created with the SDL_WINDOW_METAL flag.

See also

SDL_Metal_DestroyView

SDL_Metal_GetLayer

Definition at line 4334 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, NULL);
 
    if (!(window->flags & SDL_WINDOW_METAL)) {
        SDL_SetError("The specified window isn't a Metal window");
        return NULL;
    }
 
    if (_this->Metal_CreateView) {
        return _this->Metal_CreateView(_this, window);
    } else {
        SDL_SetError("Metal is not supported.");
        return NULL;
    }
}

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::Metal_CreateView, NULL, SDL_SetError, and SDL_WINDOW_METAL.

SDL_Metal_DestroyView()

void SDL_Metal_DestroyView

(

SDL_MetalView

view

)

Destroy an existing SDL_MetalView object.

This should be called before SDL_DestroyWindow, if SDL_Metal_CreateView was called after SDL_CreateWindow.

See also

SDL_Metal_CreateView

Definition at line 4352 of file SDL_video.c.

{
    if (_this && view && _this->Metal_DestroyView) {
        _this->Metal_DestroyView(_this, view);
    }
}

References _this, and SDL_VideoDevice::Metal_DestroyView.

SDL_Metal_GetDrawableSize()

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

Get the size of a window's underlying drawable in pixels (for use with setting viewport, scissor & etc).

Parameters

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

Note

On macOS high-DPI support must be enabled for an application by setting NSHighResolutionCapable to true in its Info.plist.

See also

SDL_GetWindowSize()

SDL_CreateWindow()

Definition at line 4375 of file SDL_video.c.

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

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

SDL_Metal_GetLayer()

void* SDL_Metal_GetLayer

(

SDL_MetalView

view

)

Get a pointer to the backing CAMetalLayer for the given view.

See also

SDL_MetalCreateView

Definition at line 4360 of file SDL_video.c.

{
    if (_this && _this->Metal_GetLayer) {
        if (view) {
            return _this->Metal_GetLayer(_this, view);
        } else {
            SDL_InvalidParamError("view");
            return NULL;
        }
    } else {
        SDL_SetError("Metal is not supported.");
        return NULL;
    }
}

References _this, SDL_VideoDevice::Metal_GetLayer, NULL, SDL_InvalidParamError, and SDL_SetError.

SDL_MinimizeWindow()

void SDL_MinimizeWindow

(

SDL_Window *

window

)

Minimize a window to an iconic representation.

See also

SDL_RestoreWindow()

Definition at line 2336 of file SDL_video.c.

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

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

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

SDL_OnApplicationDidBecomeActive()

void SDL_OnApplicationDidBecomeActive

(

void

)

Definition at line 4208 of file SDL_video.c.

{
    SDL_SendAppEvent(SDL_APP_DIDENTERFOREGROUND);
 
    if (_this) {
        SDL_Window *window;
        for (window = _this->windows; window != NULL; window = window->next) {
            SDL_SendWindowEvent(window, SDL_WINDOWEVENT_FOCUS_GAINED, 0, 0);
            SDL_SendWindowEvent(window, SDL_WINDOWEVENT_RESTORED, 0, 0);
        }
    }
}

References _this, NULL, SDL_APP_DIDENTERFOREGROUND, SDL_SendAppEvent(), SDL_SendWindowEvent(), SDL_WINDOWEVENT_FOCUS_GAINED, SDL_WINDOWEVENT_RESTORED, and SDL_VideoDevice::windows.

SDL_OnApplicationDidEnterBackground()

void SDL_OnApplicationDidEnterBackground

(

void

)

Definition at line 4198 of file SDL_video.c.

{
    SDL_SendAppEvent(SDL_APP_DIDENTERBACKGROUND);
}

References SDL_APP_DIDENTERBACKGROUND, and SDL_SendAppEvent().

SDL_OnApplicationDidReceiveMemoryWarning()

void SDL_OnApplicationDidReceiveMemoryWarning

(

void

)

Definition at line 4181 of file SDL_video.c.

{
    SDL_SendAppEvent(SDL_APP_LOWMEMORY);
}

References SDL_APP_LOWMEMORY, and SDL_SendAppEvent().

SDL_OnApplicationWillEnterForeground()

void SDL_OnApplicationWillEnterForeground

(

void

)

Definition at line 4203 of file SDL_video.c.

{
    SDL_SendAppEvent(SDL_APP_WILLENTERFOREGROUND);
}

References SDL_APP_WILLENTERFOREGROUND, and SDL_SendAppEvent().

SDL_OnApplicationWillResignActive()

void SDL_OnApplicationWillResignActive

(

void

)

Definition at line 4186 of file SDL_video.c.

{
    if (_this) {
        SDL_Window *window;
        for (window = _this->windows; window != NULL; window = window->next) {
            SDL_SendWindowEvent(window, SDL_WINDOWEVENT_FOCUS_LOST, 0, 0);
            SDL_SendWindowEvent(window, SDL_WINDOWEVENT_MINIMIZED, 0, 0);
        }
    }
    SDL_SendAppEvent(SDL_APP_WILLENTERBACKGROUND);
}

References _this, NULL, SDL_APP_WILLENTERBACKGROUND, SDL_SendAppEvent(), SDL_SendWindowEvent(), SDL_WINDOWEVENT_FOCUS_LOST, SDL_WINDOWEVENT_MINIMIZED, and SDL_VideoDevice::windows.

SDL_OnApplicationWillTerminate()

void SDL_OnApplicationWillTerminate

(

void

)

Definition at line 4176 of file SDL_video.c.

{
    SDL_SendAppEvent(SDL_APP_TERMINATING);
}

References SDL_APP_TERMINATING, and SDL_SendAppEvent().

SDL_OnWindowEnter()

void SDL_OnWindowEnter

(

SDL_Window *

window

)

Definition at line 2739 of file SDL_video.c.

{
    if (_this->OnWindowEnter) {
        _this->OnWindowEnter(_this, window);
    }
}

References _this, and SDL_VideoDevice::OnWindowEnter.

Referenced by SDL_SendWindowEvent().

SDL_OnWindowFocusGained()

void SDL_OnWindowFocusGained

(

SDL_Window *

window

)

Definition at line 2752 of file SDL_video.c.

{
    SDL_Mouse *mouse = SDL_GetMouse();
 
    if (window->gamma && _this->SetWindowGammaRamp) {
        _this->SetWindowGammaRamp(_this, window, window->gamma);
    }
 
    if (mouse && mouse->relative_mode) {
        SDL_SetMouseFocus(window);
        SDL_WarpMouseInWindow(window, window->w/2, window->h/2);
    }
 
    SDL_UpdateWindowGrab(window);
}

References _this, SDL_Mouse::relative_mode, SDL_GetMouse(), SDL_SetMouseFocus(), SDL_UpdateWindowGrab(), SDL_WarpMouseInWindow, and SDL_VideoDevice::SetWindowGammaRamp.

Referenced by SDL_SendWindowEvent().

SDL_OnWindowFocusLost()

void SDL_OnWindowFocusLost

(

SDL_Window *

window

)

Definition at line 2796 of file SDL_video.c.

{
    if (window->gamma && _this->SetWindowGammaRamp) {
        _this->SetWindowGammaRamp(_this, window, window->saved_gamma);
    }
 
    SDL_UpdateWindowGrab(window);
 
    if (ShouldMinimizeOnFocusLoss(window)) {
        SDL_MinimizeWindow(window);
    }
}

References _this, SDL_MinimizeWindow(), SDL_UpdateWindowGrab(), SDL_VideoDevice::SetWindowGammaRamp, and ShouldMinimizeOnFocusLoss().

Referenced by SDL_SendWindowEvent().

SDL_OnWindowHidden()

void SDL_OnWindowHidden

(

SDL_Window *

window

)

Definition at line 2704 of file SDL_video.c.

{
    SDL_UpdateFullscreenMode(window, SDL_FALSE);
}

References SDL_FALSE, and SDL_UpdateFullscreenMode().

Referenced by SDL_SendWindowEvent().

SDL_OnWindowLeave()

void SDL_OnWindowLeave

(

SDL_Window *

window

)

Definition at line 2747 of file SDL_video.c.

{
}

Referenced by SDL_SendWindowEvent().

SDL_OnWindowMinimized()

void SDL_OnWindowMinimized

(

SDL_Window *

window

)

Definition at line 2717 of file SDL_video.c.

{
    SDL_UpdateFullscreenMode(window, SDL_FALSE);
}

References SDL_FALSE, and SDL_UpdateFullscreenMode().

Referenced by SDL_SendWindowEvent().

SDL_OnWindowResized()

void SDL_OnWindowResized

(

SDL_Window *

window

)

Definition at line 2710 of file SDL_video.c.

{
    window->surface_valid = SDL_FALSE;
    SDL_SendWindowEvent(window, SDL_WINDOWEVENT_SIZE_CHANGED, window->w, window->h);
}

References SDL_FALSE, SDL_SendWindowEvent(), and SDL_WINDOWEVENT_SIZE_CHANGED.

Referenced by SDL_SendWindowEvent(), SDL_SetWindowSize(), and SDL_UpdateFullscreenMode().

SDL_OnWindowRestored()

void SDL_OnWindowRestored

(

SDL_Window *

window

)

Definition at line 2723 of file SDL_video.c.

{
    /*
     * FIXME: Is this fine to just remove this, or should it be preserved just
     * for the fullscreen case? In principle it seems like just hiding/showing
     * windows shouldn't affect the stacking order; maybe the right fix is to
     * re-decouple OnWindowShown and OnWindowRestored.
     */
    /*SDL_RaiseWindow(window);*/
 
    if (FULLSCREEN_VISIBLE(window)) {
        SDL_UpdateFullscreenMode(window, SDL_TRUE);
    }
}

References FULLSCREEN_VISIBLE, SDL_TRUE, and SDL_UpdateFullscreenMode().

Referenced by SDL_OnWindowShown(), and SDL_SendWindowEvent().

SDL_OnWindowShown()

void SDL_OnWindowShown

(

SDL_Window *

window

)

Definition at line 2698 of file SDL_video.c.

{
    SDL_OnWindowRestored(window);
}

References SDL_OnWindowRestored().

Referenced by SDL_SendWindowEvent().

SDL_RaiseWindow()

void SDL_RaiseWindow

(

SDL_Window *

window

)

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

Definition at line 2298 of file SDL_video.c.

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

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

Referenced by SDL_ShowMessageBox().

SDL_RecreateWindow()

int SDL_RecreateWindow	(	SDL_Window *	window,
		Uint32	flags
	)

Definition at line 1673 of file SDL_video.c.

{
    SDL_bool loaded_opengl = SDL_FALSE;
    SDL_bool need_gl_unload = SDL_FALSE;
    SDL_bool need_gl_load = SDL_FALSE;
    SDL_bool loaded_vulkan = SDL_FALSE;
    SDL_bool need_vulkan_unload = SDL_FALSE;
    SDL_bool need_vulkan_load = SDL_FALSE;
 
    if ((flags & SDL_WINDOW_OPENGL) && !_this->GL_CreateContext) {
        return SDL_SetError("OpenGL support is either not configured in SDL "
                            "or not available in current SDL video driver "
                            "(%s) or platform", _this->name);
    }
 
    if (window->flags & SDL_WINDOW_FOREIGN) {
        /* Can't destroy and re-create foreign windows, hrm */
        flags |= SDL_WINDOW_FOREIGN;
    } else {
        flags &= ~SDL_WINDOW_FOREIGN;
    }
 
    /* Restore video mode, etc. */
    SDL_HideWindow(window);
 
    /* Tear down the old native window */
    if (window->surface) {
        window->surface->flags &= ~SDL_DONTFREE;
        SDL_FreeSurface(window->surface);
        window->surface = NULL;
        window->surface_valid = SDL_FALSE;
    }
    if (_this->DestroyWindowFramebuffer) {
        _this->DestroyWindowFramebuffer(_this, window);
    }
    if (_this->DestroyWindow && !(flags & SDL_WINDOW_FOREIGN)) {
        _this->DestroyWindow(_this, window);
    }
 
    if ((window->flags & SDL_WINDOW_OPENGL) != (flags & SDL_WINDOW_OPENGL)) {
        if (flags & SDL_WINDOW_OPENGL) {
            need_gl_load = SDL_TRUE;
        } else {
            need_gl_unload = SDL_TRUE;
        }
    } else if (window->flags & SDL_WINDOW_OPENGL) {
        need_gl_unload = SDL_TRUE;
        need_gl_load  = SDL_TRUE;
    }
 
    if ((window->flags & SDL_WINDOW_METAL) != (flags & SDL_WINDOW_METAL)) {
        if (flags & SDL_WINDOW_METAL) {
            need_gl_load = SDL_TRUE;
        } else {
            need_gl_unload = SDL_TRUE;
        }
    } else if (window->flags & SDL_WINDOW_METAL) {
        need_gl_unload = SDL_TRUE;
        need_gl_load  = SDL_TRUE;
    }
 
    if ((window->flags & SDL_WINDOW_VULKAN) != (flags & SDL_WINDOW_VULKAN)) {
        if (flags & SDL_WINDOW_VULKAN) {
            need_vulkan_load = SDL_TRUE;
        } else {
            need_vulkan_unload = SDL_TRUE;
        }
    } else if (window->flags & SDL_WINDOW_VULKAN) {
        need_vulkan_unload = SDL_TRUE;
        need_vulkan_load  = SDL_TRUE;
    }
 
    if ((flags & SDL_WINDOW_VULKAN) && (flags & SDL_WINDOW_OPENGL)) {
        SDL_SetError("Vulkan and OpenGL not supported on same window");
        return -1;
    }
 
    if ((flags & SDL_WINDOW_METAL) && (flags & SDL_WINDOW_OPENGL)) {
        SDL_SetError("Metal and OpenGL not supported on same window");
        return -1;
    }
 
    if ((flags & SDL_WINDOW_METAL) && (flags & SDL_WINDOW_VULKAN)) {
        SDL_SetError("Metal and Vulkan not supported on same window");
        return -1;
    }
 
    if (need_gl_unload) {
        SDL_GL_UnloadLibrary();
    }
 
    if (need_vulkan_unload) {
        SDL_Vulkan_UnloadLibrary();
    }
 
    if (need_gl_load) {
        if (SDL_GL_LoadLibrary(NULL) < 0) {
            return -1;
        }
        loaded_opengl = SDL_TRUE;
    }
 
    if (need_vulkan_load) {
        if (SDL_Vulkan_LoadLibrary(NULL) < 0) {
            return -1;
        }
        loaded_vulkan = SDL_TRUE;
    }
 
    window->flags = ((flags & CREATE_FLAGS) | SDL_WINDOW_HIDDEN);
    window->last_fullscreen_flags = window->flags;
    window->is_destroying = SDL_FALSE;
 
    if (_this->CreateSDLWindow && !(flags & SDL_WINDOW_FOREIGN)) {
        if (_this->CreateSDLWindow(_this, window) < 0) {
            if (loaded_opengl) {
                SDL_GL_UnloadLibrary();
                window->flags &= ~SDL_WINDOW_OPENGL;
            }
            if (loaded_vulkan) {
                SDL_Vulkan_UnloadLibrary();
                window->flags &= ~SDL_WINDOW_VULKAN;
            }
            return -1;
        }
    }
 
    if (flags & SDL_WINDOW_FOREIGN) {
        window->flags |= SDL_WINDOW_FOREIGN;
    }
 
    if (_this->SetWindowTitle && window->title) {
        _this->SetWindowTitle(_this, window);
    }
 
    if (_this->SetWindowIcon && window->icon) {
        _this->SetWindowIcon(_this, window, window->icon);
    }
 
    if (window->hit_test) {
        _this->SetWindowHitTest(window, SDL_TRUE);
    }
 
    SDL_FinishWindowCreation(window, flags);
 
    return 0;
}

References _this, CREATE_FLAGS, SDL_VideoDevice::CreateSDLWindow, SDL_VideoDevice::DestroyWindow, SDL_VideoDevice::DestroyWindowFramebuffer, SDL_VideoDevice::GL_CreateContext, SDL_VideoDevice::name, NULL, SDL_DONTFREE, SDL_FALSE, SDL_FinishWindowCreation(), SDL_FreeSurface, SDL_GL_LoadLibrary(), SDL_GL_UnloadLibrary(), SDL_HideWindow(), SDL_SetError, SDL_TRUE, SDL_Vulkan_LoadLibrary(), SDL_Vulkan_UnloadLibrary(), SDL_WINDOW_FOREIGN, SDL_WINDOW_HIDDEN, SDL_WINDOW_METAL, SDL_WINDOW_OPENGL, SDL_WINDOW_VULKAN, SDL_VideoDevice::SetWindowHitTest, SDL_VideoDevice::SetWindowIcon, and SDL_VideoDevice::SetWindowTitle.

SDL_RestoreMousePosition()

static void SDL_RestoreMousePosition ( SDL_Window *  window )

static

Definition at line 1209 of file SDL_video.c.

{
    int x, y;
 
    if (window == SDL_GetMouseFocus()) {
        SDL_GetMouseState(&x, &y);
        SDL_WarpMouseInWindow(window, x, y);
    }
}

References SDL_GetMouseFocus, SDL_GetMouseState, and SDL_WarpMouseInWindow.

Referenced by SDL_UpdateFullscreenMode().

SDL_RestoreWindow()

void SDL_RestoreWindow

(

SDL_Window *

window

)

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

See also

SDL_MaximizeWindow()

SDL_MinimizeWindow()

Definition at line 2356 of file SDL_video.c.

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

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

SDL_SetDisplayModeForDisplay()

static int SDL_SetDisplayModeForDisplay ( SDL_VideoDisplay *  display, const SDL_DisplayMode *  mode  )

static

Definition at line 1013 of file SDL_video.c.

{
    SDL_DisplayMode display_mode;
    SDL_DisplayMode current_mode;
 
    if (mode) {
        display_mode = *mode;
 
        /* Default to the current mode */
        if (!display_mode.format) {
            display_mode.format = display->current_mode.format;
        }
        if (!display_mode.w) {
            display_mode.w = display->current_mode.w;
        }
        if (!display_mode.h) {
            display_mode.h = display->current_mode.h;
        }
        if (!display_mode.refresh_rate) {
            display_mode.refresh_rate = display->current_mode.refresh_rate;
        }
 
        /* Get a good video mode, the closest one possible */
        if (!SDL_GetClosestDisplayModeForDisplay(display, &display_mode, &display_mode)) {
            return SDL_SetError("No video mode large enough for %dx%d",
                                display_mode.w, display_mode.h);
        }
    } else {
        display_mode = display->desktop_mode;
    }
 
    /* See if there's anything left to do */
    current_mode = display->current_mode;
    if (SDL_memcmp(&display_mode, &current_mode, sizeof(display_mode)) == 0) {
        return 0;
    }
 
    /* Actually change the display mode */
    if (!_this->SetDisplayMode) {
        return SDL_SetError("SDL video driver doesn't support changing display mode");
    }
    if (_this->SetDisplayMode(_this, display, &display_mode) < 0) {
        return -1;
    }
    display->current_mode = display_mode;
    return 0;
}

References _this, SDL_VideoDisplay::current_mode, SDL_VideoDisplay::desktop_mode, SDL_DisplayMode::format, SDL_DisplayMode::h, SDL_DisplayMode::refresh_rate, SDL_GetClosestDisplayModeForDisplay(), SDL_memcmp, SDL_SetError, SDL_VideoDevice::SetDisplayMode, and SDL_DisplayMode::w.

Referenced by SDL_SetWindowDisplayMode(), and SDL_UpdateFullscreenMode().

SDL_SetTextInputRect()

void SDL_SetTextInputRect

(

SDL_Rect *

rect

)

Set the rectangle used to type Unicode text inputs. This is used as a hint for IME and on-screen keyboard placement.

See also

SDL_StartTextInput()

Definition at line 3923 of file SDL_video.c.

{
    if (_this && _this->SetTextInputRect) {
        _this->SetTextInputRect(_this, rect);
    }
}

References _this, rect, and SDL_VideoDevice::SetTextInputRect.

SDL_SetWindowBordered()

void SDL_SetWindowBordered	(	SDL_Window *	window,
		SDL_bool	bordered
	)

Set the border state of a window.

This will add or remove the window's SDL_WINDOW_BORDERLESS flag and add or remove the border from the actual window. This is a no-op if the window's border already matches the requested state.

Parameters

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

Note

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

See also

SDL_GetWindowFlags()

Definition at line 2061 of file SDL_video.c.

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

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

SDL_SetWindowBrightness()

int SDL_SetWindowBrightness	(	SDL_Window *	window,
		float	brightness
	)

Set the brightness (gamma correction) for a window.

Returns

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

See also

SDL_GetWindowBrightness()

SDL_SetWindowGammaRamp()

Definition at line 2471 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC, SDL_CalculateGammaRamp, and SDL_SetWindowGammaRamp().

SDL_SetWindowData()

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

Associate an arbitrary named pointer with a window.

Parameters

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

Returns

The previous value associated with 'name'

Note

The name is case-sensitive.

See also

SDL_GetWindowData()

Definition at line 1907 of file SDL_video.c.

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

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

Referenced by SDL_CreateWindowTexture(), and SDL_DestroyWindowTexture().

SDL_SetWindowDisplayMode()

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

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

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

Parameters

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

Returns

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

See also

SDL_GetWindowDisplayMode()

SDL_SetWindowFullscreen()

Definition at line 1141 of file SDL_video.c.

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

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

SDL_SetWindowFullscreen()

int SDL_SetWindowFullscreen	(	SDL_Window *	window,
		Uint32	flags
	)

Set a window's fullscreen state.

Returns

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

See also

SDL_SetWindowDisplayMode()

SDL_GetWindowDisplayMode()

Definition at line 2370 of file SDL_video.c.

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

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

Referenced by SDL_FinishWindowCreation().

SDL_SetWindowGammaRamp()

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

Set the gamma ramp for a window.

Parameters

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

Returns

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

Set the gamma translation table for the red, green, and blue channels of the video hardware. Each table is an array of 256 16-bit quantities, representing a mapping between the input and output for that channel. The input is the index into the array, and the output is the 16-bit gamma value at that index, scaled to the output color precision.

See also

SDL_GetWindowGammaRamp()

Definition at line 2557 of file SDL_video.c.

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

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

Referenced by SDL_SetWindowBrightness().

SDL_SetWindowGrab()

void SDL_SetWindowGrab	(	SDL_Window *	window,
		SDL_bool	grabbed
	)

Set a window's input grab mode.

Parameters

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

If the caller enables a grab while another window is currently grabbed, the other window loses its grab in favor of the caller's window.

See also

SDL_GetWindowGrab()

Definition at line 2667 of file SDL_video.c.

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

References CHECK_WINDOW_MAGIC, SDL_UpdateWindowGrab(), and SDL_WINDOW_INPUT_GRABBED.

Referenced by SDL_FinishWindowCreation().

SDL_SetWindowHitTest()

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

Provide a callback that decides if a window region has special properties.

Normally windows are dragged and resized by decorations provided by the system window manager (a title bar, borders, etc), but for some apps, it makes sense to drag them from somewhere else inside the window itself; for example, one might have a borderless window that wants to be draggable from any part, or simulate its own title bar, etc.

This function lets the app provide a callback that designates pieces of a given window as special. This callback is run during event processing if we need to tell the OS to treat a region of the window specially; the use of this callback is known as "hit testing."

Mouse input may not be delivered to your application if it is within a special area; the OS will often apply that input to moving the window or resizing the window and not deliver it to the application.

Specifying NULL for a callback disables hit-testing. Hit-testing is disabled by default.

Platforms that don't support this functionality will return -1 unconditionally, even if you're attempting to disable hit-testing.

Your callback may fire at any time, and its firing does not indicate any specific behavior (for example, on Windows, this certainly might fire when the OS is deciding whether to drag your window, but it fires for lots of other reasons, too, some unrelated to anything you probably care about and when the mouse isn't actually at the location it is testing). Since this can fire at any time, you should try to keep your callback efficient, devoid of allocations, etc.

Parameters

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

Returns

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

Definition at line 4145 of file SDL_video.c.

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

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

SDL_SetWindowIcon()

void SDL_SetWindowIcon	(	SDL_Window *	window,
		SDL_Surface *	icon
	)

Set the icon for a window.

Parameters

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

Definition at line 1885 of file SDL_video.c.

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

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

SDL_SetWindowInputFocus()

int SDL_SetWindowInputFocus

(

SDL_Window *

window

)

Explicitly sets input focus to the window.

You almost certainly want SDL_RaiseWindow() instead of this function. Use this with caution, as you might give focus to a window that's completely obscured by other windows.

Parameters

window

The window that should get the input focus

Returns

0 on success, or -1 otherwise.

See also

SDL_RaiseWindow()

Definition at line 2544 of file SDL_video.c.

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

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

SDL_SetWindowMaximumSize()

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

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

Parameters

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

Note

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

See also

SDL_GetWindowMaximumSize()

SDL_SetWindowMinimumSize()

Definition at line 2222 of file SDL_video.c.

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

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

SDL_SetWindowMinimumSize()

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

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

Parameters

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

Note

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

See also

SDL_GetWindowMinimumSize()

SDL_SetWindowMaximumSize()

Definition at line 2179 of file SDL_video.c.

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

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

SDL_SetWindowModalFor()

int SDL_SetWindowModalFor	(	SDL_Window *	modal_window,
		SDL_Window *	parent_window
	)

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

Parameters

modal_window	The window that should be modal
parent_window	The parent window

Returns

0 on success, or -1 otherwise.

Definition at line 2531 of file SDL_video.c.

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

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

SDL_SetWindowOpacity()

int SDL_SetWindowOpacity	(	SDL_Window *	window,
		float	opacity
	)

Set the opacity for a window.

Parameters

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

Returns

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

See also

SDL_GetWindowOpacity()

Definition at line 2495 of file SDL_video.c.

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

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

SDL_SetWindowPosition()

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

Set the position of a window.

Parameters

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

Note

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

See also

SDL_GetWindowPosition()

Definition at line 1975 of file SDL_video.c.

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

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

SDL_SetWindowResizable()

void SDL_SetWindowResizable	(	SDL_Window *	window,
		SDL_bool	resizable
	)

Set the user-resizable state of a window.

This will add or remove the window's SDL_WINDOW_RESIZABLE flag and allow/disallow user resizing of the window. This is a no-op if the window's resizable state already matches the requested state.

Parameters

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

Note

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

See also

SDL_GetWindowFlags()

Definition at line 2079 of file SDL_video.c.

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

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

SDL_SetWindowSize()

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

Set the size of a window's client area.

Parameters

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

Note

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

The window size in screen coordinates may differ from the size in pixels, if the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() to get the real client area size in pixels.

See also

SDL_GetWindowSize()

SDL_SetWindowDisplayMode()

Definition at line 2097 of file SDL_video.c.

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

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

Referenced by SDL_SetWindowMaximumSize(), and SDL_SetWindowMinimumSize().

SDL_SetWindowTitle()

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

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

See also

SDL_GetWindowTitle()

Definition at line 1860 of file SDL_video.c.

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

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

Referenced by SDL_CreateWindow().

SDL_ShouldAllowTopmost()

SDL_bool SDL_ShouldAllowTopmost

(

void

)

Definition at line 4139 of file SDL_video.c.

{
    return SDL_GetHintBoolean(SDL_HINT_ALLOW_TOPMOST, SDL_TRUE);
}

References SDL_GetHintBoolean, SDL_HINT_ALLOW_TOPMOST, and SDL_TRUE.

SDL_ShowMessageBox()

int SDL_ShowMessageBox	(	const SDL_MessageBoxData *	messageboxdata,
		int *	buttonid
	)

Create a modal message box.

Parameters

messageboxdata	The SDL_MessageBoxData structure with title, text, etc.
buttonid	The pointer to which user id of hit button should be copied.

Returns

-1 on error, otherwise 0 and buttonid contains user id of button hit or -1 if dialog was closed.

Note

This function should be called on the thread that created the parent window, or on the main thread if the messagebox has no parent. It will block execution of that thread until the user clicks a button or closes the messagebox.

Definition at line 3993 of file SDL_video.c.

{
    int dummybutton;
    int retval = -1;
    SDL_bool relative_mode;
    int show_cursor_prev;
    SDL_bool mouse_captured;
    SDL_Window *current_window;
    SDL_MessageBoxData mbdata;
 
    if (!messageboxdata) {
        return SDL_InvalidParamError("messageboxdata");
    } else if (messageboxdata->numbuttons < 0) {
        return SDL_SetError("Invalid number of buttons");
    }
 
    current_window = SDL_GetKeyboardFocus();
    mouse_captured = current_window && ((SDL_GetWindowFlags(current_window) & SDL_WINDOW_MOUSE_CAPTURE) != 0);
    relative_mode = SDL_GetRelativeMouseMode();
    SDL_CaptureMouse(SDL_FALSE);
    SDL_SetRelativeMouseMode(SDL_FALSE);
    show_cursor_prev = SDL_ShowCursor(1);
    SDL_ResetKeyboard();
 
    if (!buttonid) {
        buttonid = &dummybutton;
    }
 
    SDL_memcpy(&mbdata, messageboxdata, sizeof(*messageboxdata));
    if (!mbdata.title) mbdata.title = "";
    if (!mbdata.message) mbdata.message = "";
    messageboxdata = &mbdata;
 
    if (_this && _this->ShowMessageBox) {
        retval = _this->ShowMessageBox(_this, messageboxdata, buttonid);
    }
 
    /* It's completely fine to call this function before video is initialized */
#if SDL_VIDEO_DRIVER_ANDROID
    if (retval == -1 &&
        Android_ShowMessageBox(messageboxdata, buttonid) == 0) {
        retval = 0;
    }
#endif
#if SDL_VIDEO_DRIVER_WINDOWS
    if (retval == -1 &&
        SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_WINDOWS) &&
        WIN_ShowMessageBox(messageboxdata, buttonid) == 0) {
        retval = 0;
    }
#endif
#if SDL_VIDEO_DRIVER_WINRT
    if (retval == -1 &&
        SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_WINRT) &&
        WINRT_ShowMessageBox(messageboxdata, buttonid) == 0) {
        retval = 0;
    }
#endif
#if SDL_VIDEO_DRIVER_COCOA
    if (retval == -1 &&
        SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_COCOA) &&
        Cocoa_ShowMessageBox(messageboxdata, buttonid) == 0) {
        retval = 0;
    }
#endif
#if SDL_VIDEO_DRIVER_UIKIT
    if (retval == -1 &&
        SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_UIKIT) &&
        UIKit_ShowMessageBox(messageboxdata, buttonid) == 0) {
        retval = 0;
    }
#endif
#if SDL_VIDEO_DRIVER_X11
    if (retval == -1 &&
        SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_X11) &&
        X11_ShowMessageBox(messageboxdata, buttonid) == 0) {
        retval = 0;
    }
#endif
#if SDL_VIDEO_DRIVER_HAIKU
    if (retval == -1 &&
        SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_HAIKU) &&
        HAIKU_ShowMessageBox(messageboxdata, buttonid) == 0) {
        retval = 0;
    }
#endif
#if SDL_VIDEO_DRIVER_OS2
    if (retval == -1 &&
        SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_OS2) &&
        OS2_ShowMessageBox(messageboxdata, buttonid) == 0) {
        retval = 0;
    }
#endif
    if (retval == -1) {
        SDL_SetError("No message system available");
    }
 
    if (current_window) {
        SDL_RaiseWindow(current_window);
        if (mouse_captured) {
            SDL_CaptureMouse(SDL_TRUE);
        }
    }
 
    SDL_ShowCursor(show_cursor_prev);
    SDL_SetRelativeMouseMode(relative_mode);
 
    return retval;
}

References _this, SDL_MessageBoxData::message, SDL_MessageBoxData::numbuttons, retval, SDL_CaptureMouse, SDL_FALSE, SDL_GetKeyboardFocus, SDL_GetRelativeMouseMode, SDL_GetWindowFlags(), SDL_InvalidParamError, SDL_memcpy, SDL_MessageboxValidForDriver(), SDL_RaiseWindow(), SDL_ResetKeyboard(), SDL_SetError, SDL_SetRelativeMouseMode, SDL_ShowCursor, SDL_SYSWM_COCOA, SDL_SYSWM_HAIKU, SDL_SYSWM_OS2, SDL_SYSWM_UIKIT, SDL_SYSWM_WINDOWS, SDL_SYSWM_WINRT, SDL_SYSWM_X11, SDL_TRUE, SDL_WINDOW_MOUSE_CAPTURE, SDL_VideoDevice::ShowMessageBox, and SDL_MessageBoxData::title.

Referenced by SDL_ShowSimpleMessageBox().

SDL_ShowSimpleMessageBox()

int SDL_ShowSimpleMessageBox	(	Uint32	flags,
		const char *	title,
		const char *	message,
		SDL_Window *	window
	)

Create a simple modal message box.

Parameters

flags	SDL_MessageBoxFlags
title	UTF-8 title text
message	UTF-8 message text
window	The parent window, or NULL for no parent

Returns

0 on success, -1 on error

See also

SDL_ShowMessageBox

Definition at line 4104 of file SDL_video.c.

{
#ifdef __EMSCRIPTEN__
    /* !!! FIXME: propose a browser API for this, get this #ifdef out of here? */
    /* Web browsers don't (currently) have an API for a custom message box
       that can block, but for the most common case (SDL_ShowSimpleMessageBox),
       we can use the standard Javascript alert() function. */
    if (!title) title = "";
    if (!message) message = "";
    EM_ASM_({
        alert(UTF8ToString($0) + "\n\n" + UTF8ToString($1));
    }, title, message);
    return 0;
#else
    SDL_MessageBoxData data;
    SDL_MessageBoxButtonData button;
 
    SDL_zero(data);
    data.flags = flags;
    data.title = title;
    data.message = message;
    data.numbuttons = 1;
    data.buttons = &button;
    data.window = window;
 
    SDL_zero(button);
    button.flags |= SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT;
    button.flags |= SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT;
    button.text = "OK";
 
    return SDL_ShowMessageBox(&data, NULL);
#endif
}

References button, NULL, SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, SDL_ShowMessageBox(), and SDL_zero.

SDL_ShowWindow()

void SDL_ShowWindow

(

SDL_Window *

window

)

Show a window.

See also

SDL_HideWindow()

Definition at line 2264 of file SDL_video.c.

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

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

Referenced by SDL_FinishWindowCreation().

SDL_StartTextInput()

void SDL_StartTextInput

(

void

)

Start accepting Unicode text input events. This function will show the on-screen keyboard if supported.

See also

SDL_StopTextInput()

SDL_SetTextInputRect()

SDL_HasScreenKeyboardSupport()

Definition at line 3875 of file SDL_video.c.

{
    SDL_Window *window;
 
    /* First, enable text events */
    SDL_EventState(SDL_TEXTINPUT, SDL_ENABLE);
    SDL_EventState(SDL_TEXTEDITING, SDL_ENABLE);
 
    /* Then show the on-screen keyboard, if any */
    window = SDL_GetFocusWindow();
    if (window && _this && _this->ShowScreenKeyboard) {
        _this->ShowScreenKeyboard(_this, window);
    }
 
    /* Finally start the text input system */
    if (_this && _this->StartTextInput) {
        _this->StartTextInput(_this);
    }
}

References _this, SDL_ENABLE, SDL_EventState, SDL_GetFocusWindow(), SDL_TEXTEDITING, SDL_TEXTINPUT, SDL_VideoDevice::ShowScreenKeyboard, and SDL_VideoDevice::StartTextInput.

Referenced by SDL_VideoInit().

SDL_StopTextInput()

void SDL_StopTextInput

(

void

)

Stop receiving any text input events. This function will hide the on-screen keyboard if supported.

See also

SDL_StartTextInput()

SDL_HasScreenKeyboardSupport()

Definition at line 3902 of file SDL_video.c.

{
    SDL_Window *window;
 
    /* Stop the text input system */
    if (_this && _this->StopTextInput) {
        _this->StopTextInput(_this);
    }
 
    /* Hide the on-screen keyboard, if any */
    window = SDL_GetFocusWindow();
    if (window && _this && _this->HideScreenKeyboard) {
        _this->HideScreenKeyboard(_this, window);
    }
 
    /* Finally disable text events */
    SDL_EventState(SDL_TEXTINPUT, SDL_DISABLE);
    SDL_EventState(SDL_TEXTEDITING, SDL_DISABLE);
}

References _this, SDL_VideoDevice::HideScreenKeyboard, SDL_DISABLE, SDL_EventState, SDL_GetFocusWindow(), SDL_TEXTEDITING, SDL_TEXTINPUT, and SDL_VideoDevice::StopTextInput.

SDL_ToggleDragAndDropSupport()

void SDL_ToggleDragAndDropSupport

(

void

)

Definition at line 1412 of file SDL_video.c.

{
    if (_this && _this->AcceptDragAndDrop) {
        const SDL_bool enable = IsAcceptingDragAndDrop();
        SDL_Window *window;
        for (window = _this->windows; window; window = window->next) {
            _this->AcceptDragAndDrop(window, enable);
        }
    }
}

References _this, SDL_VideoDevice::AcceptDragAndDrop, IsAcceptingDragAndDrop(), SDL_Window::next, and SDL_VideoDevice::windows.

Referenced by SDL_EventState().

SDL_UninitializedVideo()

static int SDL_UninitializedVideo ( )

static

Definition at line 445 of file SDL_video.c.

{
    return SDL_SetError("Video subsystem has not been initialized");
}

References SDL_SetError.

Referenced by SDL_CreateWindowFrom(), SDL_GetCurrentVideoDriver(), SDL_GetNumVideoDisplays(), SDL_GL_GetAttribute(), SDL_GL_GetCurrentContext(), SDL_GL_GetCurrentWindow(), SDL_GL_GetProcAddress(), SDL_GL_LoadLibrary(), SDL_GL_SetAttribute(), SDL_GL_SetSwapInterval(), SDL_GL_UnloadLibrary(), SDL_Vulkan_GetVkGetInstanceProcAddr(), SDL_Vulkan_LoadLibrary(), and SDL_Vulkan_UnloadLibrary().

SDL_UpdateFullscreenMode()

static int SDL_UpdateFullscreenMode ( SDL_Window *  window, SDL_bool  fullscreen  )

static

Definition at line 1224 of file SDL_video.c.

{
    SDL_VideoDisplay *display;
    SDL_Window *other;
 
    CHECK_WINDOW_MAGIC(window,-1);
 
    /* if we are in the process of hiding don't go back to fullscreen */
    if (window->is_hiding && fullscreen) {
        return 0;
    }
 
#ifdef __MACOSX__
    /* if the window is going away and no resolution change is necessary,
       do nothing, or else we may trigger an ugly double-transition
     */
    if (SDL_strcmp(_this->name, "cocoa") == 0) {  /* don't do this for X11, etc */
        if (window->is_destroying && (window->last_fullscreen_flags & FULLSCREEN_MASK) == SDL_WINDOW_FULLSCREEN_DESKTOP)
            return 0;
    
        /* If we're switching between a fullscreen Space and "normal" fullscreen, we need to get back to normal first. */
        if (fullscreen && ((window->last_fullscreen_flags & FULLSCREEN_MASK) == SDL_WINDOW_FULLSCREEN_DESKTOP) && ((window->flags & FULLSCREEN_MASK) == SDL_WINDOW_FULLSCREEN)) {
            if (!Cocoa_SetWindowFullscreenSpace(window, SDL_FALSE)) {
                return -1;
            }
        } else if (fullscreen && ((window->last_fullscreen_flags & FULLSCREEN_MASK) == SDL_WINDOW_FULLSCREEN) && ((window->flags & FULLSCREEN_MASK) == SDL_WINDOW_FULLSCREEN_DESKTOP)) {
            display = SDL_GetDisplayForWindow(window);
            SDL_SetDisplayModeForDisplay(display, NULL);
            if (_this->SetWindowFullscreen) {
                _this->SetWindowFullscreen(_this, window, display, SDL_FALSE);
            }
        }
 
        if (Cocoa_SetWindowFullscreenSpace(window, fullscreen)) {
            if (Cocoa_IsWindowInFullscreenSpace(window) != fullscreen) {
                return -1;
            }
            window->last_fullscreen_flags = window->flags;
            return 0;
        }
    }
#elif __WINRT__ && (NTDDI_VERSION < NTDDI_WIN10)
    /* HACK: WinRT 8.x apps can't choose whether or not they are fullscreen
       or not.  The user can choose this, via OS-provided UI, but this can't
       be set programmatically.
 
       Just look at what SDL's WinRT video backend code detected with regards
       to fullscreen (being active, or not), and figure out a return/error code
       from that.
    */
    if (fullscreen == !(WINRT_DetectWindowFlags(window) & FULLSCREEN_MASK)) {
        /* Uh oh, either:
            1. fullscreen was requested, and we're already windowed
            2. windowed-mode was requested, and we're already fullscreen
 
            WinRT 8.x can't resolve either programmatically, so we're
            giving up.
        */
        return -1;
    } else {
        /* Whatever was requested, fullscreen or windowed mode, is already
            in-place.
        */
        return 0;
    }
#endif
 
    display = SDL_GetDisplayForWindow(window);
 
    if (fullscreen) {
        /* Hide any other fullscreen windows */
        if (display->fullscreen_window &&
            display->fullscreen_window != window) {
            SDL_MinimizeWindow(display->fullscreen_window);
        }
    }
 
    /* See if anything needs to be done now */
    if ((display->fullscreen_window == window) == fullscreen) {
        if ((window->last_fullscreen_flags & FULLSCREEN_MASK) == (window->flags & FULLSCREEN_MASK)) {
            return 0;
        }
    }
 
    /* See if there are any fullscreen windows */
    for (other = _this->windows; other; other = other->next) {
        SDL_bool setDisplayMode = SDL_FALSE;
 
        if (other == window) {
            setDisplayMode = fullscreen;
        } else if (FULLSCREEN_VISIBLE(other) &&
                   SDL_GetDisplayForWindow(other) == display) {
            setDisplayMode = SDL_TRUE;
        }
 
        if (setDisplayMode) {
            SDL_DisplayMode fullscreen_mode;
 
            SDL_zero(fullscreen_mode);
 
            if (SDL_GetWindowDisplayMode(other, &fullscreen_mode) == 0) {
                SDL_bool resized = SDL_TRUE;
 
                if (other->w == fullscreen_mode.w && other->h == fullscreen_mode.h) {
                    resized = SDL_FALSE;
                }
 
                /* only do the mode change if we want exclusive fullscreen */
                if ((window->flags & SDL_WINDOW_FULLSCREEN_DESKTOP) != SDL_WINDOW_FULLSCREEN_DESKTOP) {
                    if (SDL_SetDisplayModeForDisplay(display, &fullscreen_mode) < 0) {
                        return -1;
                    }
                } else {
                    if (SDL_SetDisplayModeForDisplay(display, NULL) < 0) {
                        return -1;
                    }
                }
 
                if (_this->SetWindowFullscreen) {
                    _this->SetWindowFullscreen(_this, other, display, SDL_TRUE);
                }
                display->fullscreen_window = other;
 
                /* Generate a mode change event here */
                if (resized) {
#ifndef ANDROID
                    // Android may not resize the window to exactly what our fullscreen mode is, especially on
                    // windowed Android environments like the Chromebook or Samsung DeX.  Given this, we shouldn't
                    // use fullscreen_mode.w and fullscreen_mode.h, but rather get our current native size.  As such,
                    // Android's SetWindowFullscreen will generate the window event for us with the proper final size.
 
                    SDL_SendWindowEvent(other, SDL_WINDOWEVENT_RESIZED,
                                        fullscreen_mode.w, fullscreen_mode.h);
#endif
                } else {
                    SDL_OnWindowResized(other);
                }
 
                SDL_RestoreMousePosition(other);
 
                window->last_fullscreen_flags = window->flags;
                return 0;
            }
        }
    }
 
    /* Nope, restore the desktop mode */
    SDL_SetDisplayModeForDisplay(display, NULL);
 
    if (_this->SetWindowFullscreen) {
        _this->SetWindowFullscreen(_this, window, display, SDL_FALSE);
    }
    display->fullscreen_window = NULL;
 
    /* Generate a mode change event here */
    SDL_OnWindowResized(window);
 
    /* Restore the cursor position */
    SDL_RestoreMousePosition(window);
 
    window->last_fullscreen_flags = window->flags;
    return 0;
}

References _this, CHECK_WINDOW_MAGIC, FULLSCREEN_MASK, FULLSCREEN_VISIBLE, SDL_VideoDisplay::fullscreen_window, SDL_DisplayMode::h, SDL_Window::h, SDL_VideoDevice::name, SDL_Window::next, NULL, SDL_FALSE, SDL_GetDisplayForWindow(), SDL_GetWindowDisplayMode(), SDL_MinimizeWindow(), SDL_OnWindowResized(), SDL_RestoreMousePosition(), SDL_SendWindowEvent(), SDL_SetDisplayModeForDisplay(), SDL_strcmp, SDL_TRUE, SDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP, SDL_WINDOWEVENT_RESIZED, SDL_zero, SDL_VideoDevice::SetWindowFullscreen, SDL_DisplayMode::w, SDL_Window::w, SDL_VideoDevice::windows, and WINRT_DetectWindowFlags().

Referenced by SDL_CreateWindow(), SDL_HideWindow(), SDL_MinimizeWindow(), SDL_OnWindowHidden(), SDL_OnWindowMinimized(), SDL_OnWindowRestored(), SDL_SetWindowFullscreen(), and SDL_SetWindowSize().

SDL_UpdateWindowGrab()

void SDL_UpdateWindowGrab

(

SDL_Window *

window

)

Definition at line 2636 of file SDL_video.c.

{
    SDL_Window *grabbed_window;
    SDL_bool grabbed;
    if ((SDL_GetMouse()->relative_mode || (window->flags & SDL_WINDOW_INPUT_GRABBED)) &&
         (window->flags & SDL_WINDOW_INPUT_FOCUS)) {
        grabbed = SDL_TRUE;
    } else {
        grabbed = SDL_FALSE;
    }
 
    grabbed_window = _this->grabbed_window;
    if (grabbed) {
        if (grabbed_window && (grabbed_window != window)) {
            /* stealing a grab from another window! */
            grabbed_window->flags &= ~SDL_WINDOW_INPUT_GRABBED;
            if (_this->SetWindowGrab) {
                _this->SetWindowGrab(_this, grabbed_window, SDL_FALSE);
            }
        }
        _this->grabbed_window = window;
    } else if (grabbed_window == window) {
        _this->grabbed_window = NULL;  /* ungrabbing. */
    }
 
    if (_this->SetWindowGrab) {
        _this->SetWindowGrab(_this, window, grabbed);
    }
}

References _this, SDL_Window::flags, SDL_VideoDevice::grabbed_window, NULL, SDL_FALSE, SDL_GetMouse(), SDL_TRUE, SDL_WINDOW_INPUT_FOCUS, SDL_WINDOW_INPUT_GRABBED, and SDL_VideoDevice::SetWindowGrab.

Referenced by SDL_OnWindowFocusGained(), SDL_OnWindowFocusLost(), SDL_SetRelativeMouseMode(), and SDL_SetWindowGrab().

SDL_UpdateWindowSurface()

int SDL_UpdateWindowSurface

(

SDL_Window *

window

)

Copy the window surface to the screen.

Returns

0 on success, or -1 on error.

See also

SDL_GetWindowSurface()

SDL_UpdateWindowSurfaceRects()

Definition at line 2444 of file SDL_video.c.

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

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

SDL_UpdateWindowSurfaceRects()

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

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

Returns

0 on success, or -1 on error.

See also

SDL_GetWindowSurface()

SDL_UpdateWindowSurface()

Definition at line 2458 of file SDL_video.c.

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

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

Referenced by SDL_UpdateWindowSurface().

SDL_UpdateWindowTexture()

static int SDL_UpdateWindowTexture ( SDL_VideoDevice *  unused, SDL_Window *  window, const SDL_Rect *  rects, int  numrects  )

static

Definition at line 374 of file SDL_video.c.

{
    SDL_WindowTextureData *data;
    SDL_Rect rect;
    void *src;
 
    data = SDL_GetWindowData(window, SDL_WINDOWTEXTUREDATA);
    if (!data || !data->texture) {
        return SDL_SetError("No window texture data");
    }
 
    /* Update a single rect that contains subrects for best DMA performance */
    if (SDL_GetSpanEnclosingRect(window->w, window->h, numrects, rects, &rect)) {
        src = (void *)((Uint8 *)data->pixels +
                        rect.y * data->pitch +
                        rect.x * data->bytes_per_pixel);
        if (SDL_UpdateTexture(data->texture, &rect, src, data->pitch) < 0) {
            return -1;
        }
 
        if (SDL_RenderCopy(data->renderer, data->texture, NULL, NULL) < 0) {
            return -1;
        }
 
        SDL_RenderPresent(data->renderer);
    }
    return 0;
}

References NULL, rect, SDL_GetSpanEnclosingRect(), SDL_GetWindowData(), SDL_RenderCopy, SDL_RenderPresent, SDL_SetError, SDL_UpdateTexture, SDL_WINDOWTEXTUREDATA, SDL_Rect::x, and SDL_Rect::y.

Referenced by SDL_VideoInit().

SDL_VideoInit()

int SDL_VideoInit

(

const char *

driver_name

)

Initialize the video subsystem, optionally specifying a video driver.

Parameters

driver_name

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

Returns

0 on success, -1 on error

This function initializes the video subsystem; setting up a connection to the window manager, etc, and determines the available display modes and pixel formats, but does not initialize a window or graphics mode.

See also

SDL_VideoQuit()

Definition at line 469 of file SDL_video.c.

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

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

SDL_VideoQuit()

void SDL_VideoQuit

(

void

)

Shuts down the video subsystem.

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

See also

SDL_VideoInit()

Definition at line 2946 of file SDL_video.c.

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

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

Referenced by SDL_VideoInit().

SDL_Vulkan_CreateSurface()

SDL_bool SDL_Vulkan_CreateSurface	(	SDL_Window *	window,
		VkInstance	instance,
		VkSurfaceKHR *	surface
	)

Create a Vulkan rendering surface for a window.

Parameters

[in]	window	SDL_Window to which to attach the rendering surface.
[in]	instance	handle to the Vulkan instance to use.
[out]	surface	pointer to a VkSurfaceKHR handle to receive the handle of the newly created surface.

Returns

SDL_TRUE on success, SDL_FALSE on error.

VkInstance instance;
SDL_Window *window;
 
// create instance and window
 
// create the Vulkan surface
VkSurfaceKHR surface;
if(!SDL_Vulkan_CreateSurface(window, instance, &surface))
    handle_error();

Note

window should have been created with the SDL_WINDOW_VULKAN flag.

instance should have been created with the extensions returned by SDL_Vulkan_CreateSurface() enabled.

See also

SDL_Vulkan_GetInstanceExtensions()

Definition at line 4298 of file SDL_video.c.

{
    CHECK_WINDOW_MAGIC(window, SDL_FALSE);
 
    if (!(window->flags & SDL_WINDOW_VULKAN)) {
        SDL_SetError(NOT_A_VULKAN_WINDOW);
        return SDL_FALSE;
    }
 
    if (!instance) {
        SDL_InvalidParamError("instance");
        return SDL_FALSE;
    }
 
    if (!surface) {
        SDL_InvalidParamError("surface");
        return SDL_FALSE;
    }
 
    return _this->Vulkan_CreateSurface(_this, window, instance, surface);
}

References _this, CHECK_WINDOW_MAGIC, NOT_A_VULKAN_WINDOW, SDL_FALSE, SDL_InvalidParamError, SDL_SetError, SDL_WINDOW_VULKAN, and SDL_VideoDevice::Vulkan_CreateSurface.

SDL_Vulkan_GetDrawableSize()

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

Get the size of a window's underlying drawable in pixels (for use with setting viewport, scissor & etc).

Parameters

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

Note

On macOS high-DPI support must be enabled for an application by setting NSHighResolutionCapable to true in its Info.plist.

See also

SDL_GetWindowSize()

SDL_CreateWindow()

Definition at line 4322 of file SDL_video.c.

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

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

SDL_Vulkan_GetInstanceExtensions()

SDL_bool SDL_Vulkan_GetInstanceExtensions	(	SDL_Window *	window,
		unsigned *	count,
		const char **	names
	)

Definition at line 4278 of file SDL_video.c.

{
    if (window) {
        CHECK_WINDOW_MAGIC(window, SDL_FALSE);
 
        if (!(window->flags & SDL_WINDOW_VULKAN))
        {
            SDL_SetError(NOT_A_VULKAN_WINDOW);
            return SDL_FALSE;
        }
    }
 
    if (!count) {
        SDL_InvalidParamError("count");
        return SDL_FALSE;
    }
 
    return _this->Vulkan_GetInstanceExtensions(_this, window, count, names);
}

References _this, CHECK_WINDOW_MAGIC, NOT_A_VULKAN_WINDOW, SDL_FALSE, SDL_InvalidParamError, SDL_SetError, SDL_WINDOW_VULKAN, and SDL_VideoDevice::Vulkan_GetInstanceExtensions.

SDL_Vulkan_GetVkGetInstanceProcAddr()

void* SDL_Vulkan_GetVkGetInstanceProcAddr

(

void

)

Get the address of the vkGetInstanceProcAddr function.

Note

This should be called after either calling SDL_Vulkan_LoadLibrary or creating an SDL_Window with the SDL_WINDOW_VULKAN flag.

Definition at line 4249 of file SDL_video.c.

{
    if (!_this) {
        SDL_UninitializedVideo();
        return NULL;
    }
    if (!_this->vulkan_config.loader_loaded) {
        SDL_SetError("No Vulkan loader has been loaded");
        return NULL;
    }
    return _this->vulkan_config.vkGetInstanceProcAddr;
}

References _this, SDL_VideoDevice::loader_loaded, NULL, SDL_SetError, SDL_UninitializedVideo(), SDL_VideoDevice::vkGetInstanceProcAddr, and SDL_VideoDevice::vulkan_config.

SDL_Vulkan_LoadLibrary()

int SDL_Vulkan_LoadLibrary

(

const char *

path

)

Dynamically load a Vulkan loader library.

Parameters

[in]

path

The platform dependent Vulkan loader library name, or NULL.

Returns

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

If path is NULL SDL will use the value of the environment variable SDL_VULKAN_LIBRARY, if set, otherwise it loads the default Vulkan loader library.

This should be called after initializing the video driver, but before creating any Vulkan windows. If no Vulkan loader library is loaded, the default library will be loaded upon creation of the first Vulkan window.

Note

It is fairly common for Vulkan applications to link with libvulkan instead of explicitly loading it at run time. This will work with SDL provided the application links to a dynamic library and both it and SDL use the same search path.

If you specify a non-NULL path, an application should retrieve all of the Vulkan functions it uses from the dynamic library using SDL_Vulkan_GetVkGetInstanceProcAddr() unless you can guarantee path points to the same vulkan loader library the application linked to.

On Apple devices, if path is NULL, SDL will attempt to find the vkGetInstanceProcAddr address within all the mach-o images of the current process. This is because it is fairly common for Vulkan applications to link with libvulkan (and historically MoltenVK was provided as a static library). If it is not found then, on macOS, SDL will attempt to load vulkan.framework/vulkan, libvulkan.1.dylib, followed by libvulkan.dylib, in that order. On iOS SDL will attempt to load libvulkan.dylib only. Applications using a dynamic framework or .dylib must ensure it is included in its application bundle.

On non-Apple devices, application linking with a static libvulkan is not supported. Either do not link to the Vulkan loader or link to a dynamic library version.

This function will fail if there are no working Vulkan drivers installed.

See also

SDL_Vulkan_GetVkGetInstanceProcAddr()

SDL_Vulkan_UnloadLibrary()

Definition at line 4223 of file SDL_video.c.

{
    int retval;
    if (!_this) {
        SDL_UninitializedVideo();
        return -1;
    }
    if (_this->vulkan_config.loader_loaded) {
        if (path && SDL_strcmp(path, _this->vulkan_config.loader_path) != 0) {
            return SDL_SetError("Vulkan loader library already loaded");
        }
        retval = 0;
    } else {
        if (!_this->Vulkan_LoadLibrary) {
            return SDL_SetError("Vulkan support is either not configured in SDL "
                                "or not available in current SDL video driver "
                                "(%s) or platform", _this->name);
        }
        retval = _this->Vulkan_LoadLibrary(_this, path);
    }
    if (retval == 0) {
        _this->vulkan_config.loader_loaded++;
    }
    return retval;
}

References _this, SDL_VideoDevice::loader_loaded, SDL_VideoDevice::loader_path, SDL_VideoDevice::name, retval, SDL_SetError, SDL_strcmp, SDL_UninitializedVideo(), SDL_VideoDevice::vulkan_config, and SDL_VideoDevice::Vulkan_LoadLibrary.

Referenced by SDL_CreateWindow(), and SDL_RecreateWindow().

SDL_Vulkan_UnloadLibrary()

void SDL_Vulkan_UnloadLibrary

(

void

)

Unload the Vulkan loader library previously loaded by SDL_Vulkan_LoadLibrary().

See also

SDL_Vulkan_LoadLibrary()

Definition at line 4262 of file SDL_video.c.

{
    if (!_this) {
        SDL_UninitializedVideo();
        return;
    }
    if (_this->vulkan_config.loader_loaded > 0) {
        if (--_this->vulkan_config.loader_loaded > 0) {
            return;
        }
        if (_this->Vulkan_UnloadLibrary) {
            _this->Vulkan_UnloadLibrary(_this);
        }
    }
}

References _this, SDL_VideoDevice::loader_loaded, SDL_UninitializedVideo(), SDL_VideoDevice::vulkan_config, and SDL_VideoDevice::Vulkan_UnloadLibrary.

Referenced by SDL_DestroyWindow(), and SDL_RecreateWindow().

ShouldMinimizeOnFocusLoss()

static SDL_bool ShouldMinimizeOnFocusLoss ( SDL_Window *  window )

static

Definition at line 2769 of file SDL_video.c.

{
    if (!(window->flags & SDL_WINDOW_FULLSCREEN) || window->is_destroying) {
        return SDL_FALSE;
    }
 
#ifdef __MACOSX__
    if (SDL_strcmp(_this->name, "cocoa") == 0) {  /* don't do this for X11, etc */
        if (Cocoa_IsWindowInFullscreenSpace(window)) {
            return SDL_FALSE;
        }
    }
#endif
 
#ifdef __ANDROID__
    {
        extern SDL_bool Android_JNI_ShouldMinimizeOnFocusLoss(void);
        if (! Android_JNI_ShouldMinimizeOnFocusLoss()) {
            return SDL_FALSE;
        }
    }
#endif
 
    return SDL_GetHintBoolean(SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS, SDL_FALSE);
}

References _this, Android_JNI_ShouldMinimizeOnFocusLoss(), SDL_VideoDevice::name, SDL_FALSE, SDL_GetHintBoolean, SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS, SDL_strcmp, and SDL_WINDOW_FULLSCREEN.

Referenced by SDL_OnWindowFocusLost().

ShouldUseTextureFramebuffer()

static SDL_bool ShouldUseTextureFramebuffer ( )

static

Definition at line 174 of file SDL_video.c.

{
    const char *hint;
 
    /* If there's no native framebuffer support then there's no option */
    if (!_this->CreateWindowFramebuffer) {
        return SDL_TRUE;
    }
 
    /* If this is the dummy driver there is no texture support */
    if (_this->is_dummy) {
        return SDL_FALSE;
    }
 
    /* If the user has specified a software renderer we can't use a
       texture framebuffer, or renderer creation will go recursive.
     */
    hint = SDL_GetHint(SDL_HINT_RENDER_DRIVER);
    if (hint && SDL_strcasecmp(hint, "software") == 0) {
        return SDL_FALSE;
    }
 
    /* See if the user or application wants a specific behavior */
    hint = SDL_GetHint(SDL_HINT_FRAMEBUFFER_ACCELERATION);
    if (hint) {
        if (*hint == '0' || SDL_strcasecmp(hint, "false") == 0) {
            return SDL_FALSE;
        } else {
            return SDL_TRUE;
        }
    }
 
    /* Each platform has different performance characteristics */
#if defined(__WIN32__)
    /* GDI BitBlt() is way faster than Direct3D dynamic textures right now.
     */
    return SDL_FALSE;
 
#elif defined(__MACOSX__)
    /* Mac OS X uses OpenGL as the native fast path (for cocoa and X11) */
    return SDL_TRUE;
 
#elif defined(__LINUX__)
    /* Properly configured OpenGL drivers are faster than MIT-SHM */
#if SDL_VIDEO_OPENGL
    /* Ugh, find a way to cache this value! */
    {
        SDL_Window *window;
        SDL_GLContext context;
        SDL_bool hasAcceleratedOpenGL = SDL_FALSE;
 
        window = SDL_CreateWindow("OpenGL test", -32, -32, 32, 32, SDL_WINDOW_OPENGL|SDL_WINDOW_HIDDEN);
        if (window) {
            context = SDL_GL_CreateContext(window);
            if (context) {
                const GLubyte *(APIENTRY * glGetStringFunc) (GLenum);
                const char *vendor = NULL;
 
                glGetStringFunc = SDL_GL_GetProcAddress("glGetString");
                if (glGetStringFunc) {
                    vendor = (const char *) glGetStringFunc(GL_VENDOR);
                }
                /* Add more vendors here at will... */
                if (vendor &&
                    (SDL_strstr(vendor, "ATI Technologies") ||
                     SDL_strstr(vendor, "NVIDIA"))) {
                    hasAcceleratedOpenGL = SDL_TRUE;
                }
                SDL_GL_DeleteContext(context);
            }
            SDL_DestroyWindow(window);
        }
        return hasAcceleratedOpenGL;
    }
#elif SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
    /* Let's be optimistic about this! */
    return SDL_TRUE;
#else
    return SDL_FALSE;
#endif
 
#else
    /* Play it safe, assume that if there is a framebuffer driver that it's
       optimized for the current platform.
    */
    return SDL_FALSE;
#endif
}

References _this, APIENTRY, context, SDL_VideoDevice::CreateWindowFramebuffer, GL_VENDOR, SDL_VideoDevice::is_dummy, NULL, SDL_CreateWindow(), SDL_DestroyWindow(), SDL_FALSE, SDL_GetHint, SDL_GL_CreateContext(), SDL_GL_DeleteContext(), SDL_GL_GetProcAddress(), SDL_HINT_FRAMEBUFFER_ACCELERATION, SDL_HINT_RENDER_DRIVER, SDL_strcasecmp, SDL_strstr, SDL_TRUE, SDL_WINDOW_HIDDEN, and SDL_WINDOW_OPENGL.

Referenced by SDL_VideoInit().

Variable Documentation

_this

SDL_VideoDevice* _this = NULL

static

Definition at line 126 of file SDL_video.c.

Referenced by CanMinimizeWindow(), PrepareDragAndDropSupport(), SDL_AddVideoDisplay(), SDL_CreateWindow(), SDL_CreateWindowFramebuffer(), SDL_CreateWindowFrom(), SDL_DelVideoDisplay(), SDL_DestroyWindow(), SDL_DisableScreenSaver(), SDL_EnableScreenSaver(), SDL_GetClipboardText(), SDL_GetClosestDisplayMode(), SDL_GetCurrentDisplayMode(), SDL_GetCurrentVideoDriver(), SDL_GetDesktopDisplayMode(), SDL_GetDisplay(), SDL_GetDisplayBounds(), SDL_GetDisplayDPI(), SDL_GetDisplayDriverData(), SDL_GetDisplayForWindow(), SDL_GetDisplayMode(), SDL_GetDisplayName(), SDL_GetDisplayOrientation(), SDL_GetDisplayUsableBounds(), SDL_GetFocusWindow(), SDL_GetGrabbedWindow(), SDL_GetIndexOfDisplay(), SDL_GetNumDisplayModes(), SDL_GetNumDisplayModesForDisplay(), SDL_GetNumVideoDisplays(), SDL_GetVideoDevice(), SDL_GetWindowBordersSize(), SDL_GetWindowDisplayIndex(), SDL_GetWindowFromID(), SDL_GetWindowGammaRamp(), SDL_GetWindowGrab(), SDL_GetWindowWMInfo(), SDL_GL_CreateContext(), SDL_GL_DeleteContext(), SDL_GL_GetAttribute(), SDL_GL_GetCurrentContext(), SDL_GL_GetCurrentWindow(), SDL_GL_GetDrawableSize(), SDL_GL_GetProcAddress(), SDL_GL_GetSwapInterval(), SDL_GL_LoadLibrary(), SDL_GL_MakeCurrent(), SDL_GL_ResetAttributes(), SDL_GL_SetAttribute(), SDL_GL_SetSwapInterval(), SDL_GL_SwapWindow(), SDL_GL_UnloadLibrary(), SDL_HasClipboardText(), SDL_HasScreenKeyboardSupport(), SDL_HasWindows(), SDL_HideWindow(), SDL_IsScreenKeyboardShown(), SDL_IsScreenSaverEnabled(), SDL_MaximizeWindow(), SDL_Metal_CreateView(), SDL_Metal_DestroyView(), SDL_Metal_GetDrawableSize(), SDL_Metal_GetLayer(), SDL_MinimizeWindow(), SDL_OnApplicationDidBecomeActive(), SDL_OnApplicationWillResignActive(), SDL_OnWindowEnter(), SDL_OnWindowFocusGained(), SDL_OnWindowFocusLost(), SDL_PumpEvents(), SDL_RaiseWindow(), SDL_RecreateWindow(), SDL_RestoreWindow(), SDL_SetClipboardText(), SDL_SetDisplayModeForDisplay(), SDL_SetTextInputRect(), SDL_SetWindowBordered(), SDL_SetWindowGammaRamp(), SDL_SetWindowHitTest(), SDL_SetWindowIcon(), SDL_SetWindowInputFocus(), SDL_SetWindowMaximumSize(), SDL_SetWindowMinimumSize(), SDL_SetWindowModalFor(), SDL_SetWindowOpacity(), SDL_SetWindowPosition(), SDL_SetWindowResizable(), SDL_SetWindowSize(), SDL_SetWindowTitle(), SDL_ShowMessageBox(), SDL_ShowWindow(), SDL_StartTextInput(), SDL_StopTextInput(), SDL_ToggleDragAndDropSupport(), SDL_UpdateFullscreenMode(), SDL_UpdateWindowGrab(), SDL_UpdateWindowSurfaceRects(), SDL_VideoInit(), SDL_VideoQuit(), SDL_Vulkan_CreateSurface(), SDL_Vulkan_GetDrawableSize(), SDL_Vulkan_GetInstanceExtensions(), SDL_Vulkan_GetVkGetInstanceProcAddr(), SDL_Vulkan_LoadLibrary(), SDL_Vulkan_UnloadLibrary(), ShouldMinimizeOnFocusLoss(), ShouldUseTextureFramebuffer(), and videoInit().

bootstrap

VideoBootStrap* bootstrap[]

static

Definition at line 60 of file SDL_video.c.

Referenced by SDL_GetNumVideoDrivers(), SDL_GetVideoDriver(), and SDL_VideoInit().