SDL  2.0
SDL_video.h File Reference
#include "SDL_stdinc.h"
#include "SDL_pixels.h"
#include "SDL_rect.h"
#include "SDL_surface.h"
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_video.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

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

Macros

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

Typedefs

typedef voidSDL_GLContext
 An opaque handle to an OpenGL context. More...
 
typedef SDL_HitTestResult(* SDL_HitTest) (SDL_Window *win, const SDL_Point *area, void *data)
 Callback used for hit-testing. More...
 

Enumerations

enum  SDL_WindowFlags {
  SDL_WINDOW_FULLSCREEN = 0x00000001,
  SDL_WINDOW_OPENGL = 0x00000002,
  SDL_WINDOW_SHOWN = 0x00000004,
  SDL_WINDOW_HIDDEN = 0x00000008,
  SDL_WINDOW_BORDERLESS = 0x00000010,
  SDL_WINDOW_RESIZABLE = 0x00000020,
  SDL_WINDOW_MINIMIZED = 0x00000040,
  SDL_WINDOW_MAXIMIZED = 0x00000080,
  SDL_WINDOW_INPUT_GRABBED = 0x00000100,
  SDL_WINDOW_INPUT_FOCUS = 0x00000200,
  SDL_WINDOW_MOUSE_FOCUS = 0x00000400,
  SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
  SDL_WINDOW_FOREIGN = 0x00000800,
  SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000,
  SDL_WINDOW_MOUSE_CAPTURE = 0x00004000,
  SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000,
  SDL_WINDOW_SKIP_TASKBAR = 0x00010000,
  SDL_WINDOW_UTILITY = 0x00020000,
  SDL_WINDOW_TOOLTIP = 0x00040000,
  SDL_WINDOW_POPUP_MENU = 0x00080000,
  SDL_WINDOW_VULKAN = 0x10000000
}
 The flags on a window. More...
 
enum  SDL_WindowEventID {
  SDL_WINDOWEVENT_NONE,
  SDL_WINDOWEVENT_SHOWN,
  SDL_WINDOWEVENT_HIDDEN,
  SDL_WINDOWEVENT_EXPOSED,
  SDL_WINDOWEVENT_MOVED,
  SDL_WINDOWEVENT_RESIZED,
  SDL_WINDOWEVENT_SIZE_CHANGED,
  SDL_WINDOWEVENT_MINIMIZED,
  SDL_WINDOWEVENT_MAXIMIZED,
  SDL_WINDOWEVENT_RESTORED,
  SDL_WINDOWEVENT_ENTER,
  SDL_WINDOWEVENT_LEAVE,
  SDL_WINDOWEVENT_FOCUS_GAINED,
  SDL_WINDOWEVENT_FOCUS_LOST,
  SDL_WINDOWEVENT_CLOSE,
  SDL_WINDOWEVENT_TAKE_FOCUS,
  SDL_WINDOWEVENT_HIT_TEST
}
 Event subtype for window events. More...
 
enum  SDL_DisplayEventID {
  SDL_DISPLAYEVENT_NONE,
  SDL_DISPLAYEVENT_ORIENTATION
}
 Event subtype for display events. More...
 
enum  SDL_DisplayOrientation {
  SDL_ORIENTATION_UNKNOWN,
  SDL_ORIENTATION_LANDSCAPE,
  SDL_ORIENTATION_LANDSCAPE_FLIPPED,
  SDL_ORIENTATION_PORTRAIT,
  SDL_ORIENTATION_PORTRAIT_FLIPPED
}
 
enum  SDL_GLattr {
  SDL_GL_RED_SIZE,
  SDL_GL_GREEN_SIZE,
  SDL_GL_BLUE_SIZE,
  SDL_GL_ALPHA_SIZE,
  SDL_GL_BUFFER_SIZE,
  SDL_GL_DOUBLEBUFFER,
  SDL_GL_DEPTH_SIZE,
  SDL_GL_STENCIL_SIZE,
  SDL_GL_ACCUM_RED_SIZE,
  SDL_GL_ACCUM_GREEN_SIZE,
  SDL_GL_ACCUM_BLUE_SIZE,
  SDL_GL_ACCUM_ALPHA_SIZE,
  SDL_GL_STEREO,
  SDL_GL_MULTISAMPLEBUFFERS,
  SDL_GL_MULTISAMPLESAMPLES,
  SDL_GL_ACCELERATED_VISUAL,
  SDL_GL_RETAINED_BACKING,
  SDL_GL_CONTEXT_MAJOR_VERSION,
  SDL_GL_CONTEXT_MINOR_VERSION,
  SDL_GL_CONTEXT_EGL,
  SDL_GL_CONTEXT_FLAGS,
  SDL_GL_CONTEXT_PROFILE_MASK,
  SDL_GL_SHARE_WITH_CURRENT_CONTEXT,
  SDL_GL_FRAMEBUFFER_SRGB_CAPABLE,
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR,
  SDL_GL_CONTEXT_RESET_NOTIFICATION,
  SDL_GL_CONTEXT_NO_ERROR
}
 OpenGL configuration attributes. More...
 
enum  SDL_GLprofile {
  SDL_GL_CONTEXT_PROFILE_CORE = 0x0001,
  SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002,
  SDL_GL_CONTEXT_PROFILE_ES = 0x0004
}
 
enum  SDL_GLcontextFlag {
  SDL_GL_CONTEXT_DEBUG_FLAG = 0x0001,
  SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
  SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG = 0x0004,
  SDL_GL_CONTEXT_RESET_ISOLATION_FLAG = 0x0008
}
 
enum  SDL_GLcontextReleaseFlag {
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE = 0x0000,
  SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH = 0x0001
}
 
enum  SDL_GLContextResetNotification {
  SDL_GL_CONTEXT_RESET_NO_NOTIFICATION = 0x0000,
  SDL_GL_CONTEXT_RESET_LOSE_CONTEXT = 0x0001
}
 
enum  SDL_HitTestResult {
  SDL_HITTEST_NORMAL,
  SDL_HITTEST_DRAGGABLE,
  SDL_HITTEST_RESIZE_TOPLEFT,
  SDL_HITTEST_RESIZE_TOP,
  SDL_HITTEST_RESIZE_TOPRIGHT,
  SDL_HITTEST_RESIZE_RIGHT,
  SDL_HITTEST_RESIZE_BOTTOMRIGHT,
  SDL_HITTEST_RESIZE_BOTTOM,
  SDL_HITTEST_RESIZE_BOTTOMLEFT,
  SDL_HITTEST_RESIZE_LEFT
}
 Possible return values from the SDL_HitTest callback. More...
 

Functions

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

Detailed Description

Header file for SDL video functions.

Definition in file SDL_video.h.

Macro Definition Documentation

◆ SDL_WINDOWPOS_CENTERED

◆ SDL_WINDOWPOS_CENTERED_DISPLAY

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

Definition at line 138 of file SDL_video.h.

Referenced by SDLTest_CommonArg(), and SDLTest_CommonEvent().

◆ SDL_WINDOWPOS_CENTERED_MASK

#define SDL_WINDOWPOS_CENTERED_MASK   0x2FFF0000u

Used to indicate that the window position should be centered.

Definition at line 137 of file SDL_video.h.

◆ SDL_WINDOWPOS_ISCENTERED

#define SDL_WINDOWPOS_ISCENTERED (   X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)

◆ SDL_WINDOWPOS_ISUNDEFINED

#define SDL_WINDOWPOS_ISUNDEFINED (   X)    (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)

◆ SDL_WINDOWPOS_UNDEFINED

#define SDL_WINDOWPOS_UNDEFINED   SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)

◆ SDL_WINDOWPOS_UNDEFINED_DISPLAY

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

Definition at line 129 of file SDL_video.h.

Referenced by SDLTest_CommonArg().

◆ SDL_WINDOWPOS_UNDEFINED_MASK

#define SDL_WINDOWPOS_UNDEFINED_MASK   0x1FFF0000u

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

Definition at line 128 of file SDL_video.h.

Typedef Documentation

◆ SDL_GLContext

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

An opaque handle to an OpenGL context.

Definition at line 193 of file SDL_video.h.

◆ SDL_HitTest

typedef SDL_HitTestResult( * SDL_HitTest) (SDL_Window *win, const SDL_Point *area, void *data)

Callback used for hit-testing.

See also
SDL_SetWindowHitTest

Definition at line 1039 of file SDL_video.h.

Enumeration Type Documentation

◆ SDL_DisplayEventID

Event subtype for display events.

Enumerator
SDL_DISPLAYEVENT_NONE 

Never used

SDL_DISPLAYEVENT_ORIENTATION 

Display orientation has changed to data1

Definition at line 175 of file SDL_video.h.

176 {
177  SDL_DISPLAYEVENT_NONE, /**< Never used */
178  SDL_DISPLAYEVENT_ORIENTATION /**< Display orientation has changed to data1 */
SDL_DisplayEventID
Event subtype for display events.
Definition: SDL_video.h:175

◆ SDL_DisplayOrientation

Enumerator
SDL_ORIENTATION_UNKNOWN 

The display orientation can't be determined

SDL_ORIENTATION_LANDSCAPE 

The display is in landscape mode, with the right side up, relative to portrait mode

SDL_ORIENTATION_LANDSCAPE_FLIPPED 

The display is in landscape mode, with the left side up, relative to portrait mode

SDL_ORIENTATION_PORTRAIT 

The display is in portrait mode

SDL_ORIENTATION_PORTRAIT_FLIPPED 

The display is in portrait mode, upside down

Definition at line 181 of file SDL_video.h.

182 {
183  SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
184  SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
185  SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
186  SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
187  SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
SDL_DisplayOrientation
Definition: SDL_video.h:181

◆ SDL_GLattr

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

OpenGL configuration attributes.

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

Definition at line 198 of file SDL_video.h.

199 {
227 } SDL_GLattr;
SDL_GLattr
OpenGL configuration attributes.
Definition: SDL_video.h:198

◆ SDL_GLcontextFlag

Enumerator
SDL_GL_CONTEXT_DEBUG_FLAG 
SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG 
SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG 
SDL_GL_CONTEXT_RESET_ISOLATION_FLAG 

Definition at line 236 of file SDL_video.h.

◆ SDL_GLcontextReleaseFlag

Enumerator
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 

Definition at line 244 of file SDL_video.h.

◆ SDL_GLContextResetNotification

Enumerator
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 

Definition at line 250 of file SDL_video.h.

◆ SDL_GLprofile

Enumerator
SDL_GL_CONTEXT_PROFILE_CORE 
SDL_GL_CONTEXT_PROFILE_COMPATIBILITY 
SDL_GL_CONTEXT_PROFILE_ES 

GLX_CONTEXT_ES2_PROFILE_BIT_EXT

Definition at line 229 of file SDL_video.h.

◆ SDL_HitTestResult

Possible return values from the SDL_HitTest callback.

See also
SDL_HitTest
Enumerator
SDL_HITTEST_NORMAL 

Region is normal. No special properties.

SDL_HITTEST_DRAGGABLE 

Region can drag entire window.

SDL_HITTEST_RESIZE_TOPLEFT 
SDL_HITTEST_RESIZE_TOP 
SDL_HITTEST_RESIZE_TOPRIGHT 
SDL_HITTEST_RESIZE_RIGHT 
SDL_HITTEST_RESIZE_BOTTOMRIGHT 
SDL_HITTEST_RESIZE_BOTTOM 
SDL_HITTEST_RESIZE_BOTTOMLEFT 
SDL_HITTEST_RESIZE_LEFT 

Definition at line 1020 of file SDL_video.h.

◆ SDL_WindowEventID

Event subtype for window events.

Enumerator
SDL_WINDOWEVENT_NONE 

Never used

SDL_WINDOWEVENT_SHOWN 

Window has been shown

SDL_WINDOWEVENT_HIDDEN 

Window has been hidden

SDL_WINDOWEVENT_EXPOSED 

Window has been exposed and should be redrawn

SDL_WINDOWEVENT_MOVED 

Window has been moved to data1, data2

SDL_WINDOWEVENT_RESIZED 

Window has been resized to data1xdata2

SDL_WINDOWEVENT_SIZE_CHANGED 

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

SDL_WINDOWEVENT_MINIMIZED 

Window has been minimized

SDL_WINDOWEVENT_MAXIMIZED 

Window has been maximized

SDL_WINDOWEVENT_RESTORED 

Window has been restored to normal size and position

SDL_WINDOWEVENT_ENTER 

Window has gained mouse focus

SDL_WINDOWEVENT_LEAVE 

Window has lost mouse focus

SDL_WINDOWEVENT_FOCUS_GAINED 

Window has gained keyboard focus

SDL_WINDOWEVENT_FOCUS_LOST 

Window has lost keyboard focus

SDL_WINDOWEVENT_CLOSE 

The window manager requests that the window be closed

SDL_WINDOWEVENT_TAKE_FOCUS 

Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore)

SDL_WINDOWEVENT_HIT_TEST 

Window had a hit test that wasn't SDL_HITTEST_NORMAL.

Definition at line 146 of file SDL_video.h.

147 {
148  SDL_WINDOWEVENT_NONE, /**< Never used */
149  SDL_WINDOWEVENT_SHOWN, /**< Window has been shown */
150  SDL_WINDOWEVENT_HIDDEN, /**< Window has been hidden */
151  SDL_WINDOWEVENT_EXPOSED, /**< Window has been exposed and should be
152  redrawn */
153  SDL_WINDOWEVENT_MOVED, /**< Window has been moved to data1, data2
154  */
155  SDL_WINDOWEVENT_RESIZED, /**< Window has been resized to data1xdata2 */
156  SDL_WINDOWEVENT_SIZE_CHANGED, /**< The window size has changed, either as
157  a result of an API call or through the
158  system or user changing the window size. */
159  SDL_WINDOWEVENT_MINIMIZED, /**< Window has been minimized */
160  SDL_WINDOWEVENT_MAXIMIZED, /**< Window has been maximized */
161  SDL_WINDOWEVENT_RESTORED, /**< Window has been restored to normal size
162  and position */
163  SDL_WINDOWEVENT_ENTER, /**< Window has gained mouse focus */
164  SDL_WINDOWEVENT_LEAVE, /**< Window has lost mouse focus */
165  SDL_WINDOWEVENT_FOCUS_GAINED, /**< Window has gained keyboard focus */
166  SDL_WINDOWEVENT_FOCUS_LOST, /**< Window has lost keyboard focus */
167  SDL_WINDOWEVENT_CLOSE, /**< The window manager requests that the window be closed */
168  SDL_WINDOWEVENT_TAKE_FOCUS, /**< Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore) */
169  SDL_WINDOWEVENT_HIT_TEST /**< Window had a hit test that wasn't SDL_HITTEST_NORMAL. */
SDL_WindowEventID
Event subtype for window events.
Definition: SDL_video.h:146

◆ SDL_WindowFlags

The flags on a window.

See also
SDL_GetWindowFlags()
Enumerator
SDL_WINDOW_FULLSCREEN 

fullscreen window

SDL_WINDOW_OPENGL 

window usable with OpenGL context

SDL_WINDOW_SHOWN 

window is visible

SDL_WINDOW_HIDDEN 

window is not visible

SDL_WINDOW_BORDERLESS 

no window decoration

SDL_WINDOW_RESIZABLE 

window can be resized

SDL_WINDOW_MINIMIZED 

window is minimized

SDL_WINDOW_MAXIMIZED 

window is maximized

SDL_WINDOW_INPUT_GRABBED 

window has grabbed input focus

SDL_WINDOW_INPUT_FOCUS 

window has input focus

SDL_WINDOW_MOUSE_FOCUS 

window has mouse focus

SDL_WINDOW_FULLSCREEN_DESKTOP 
SDL_WINDOW_FOREIGN 

window not created by SDL

SDL_WINDOW_ALLOW_HIGHDPI 

window should be created in high-DPI mode if supported. On macOS NSHighResolutionCapable must be set true in the application's Info.plist for this to have any effect.

SDL_WINDOW_MOUSE_CAPTURE 

window has mouse captured (unrelated to INPUT_GRABBED)

SDL_WINDOW_ALWAYS_ON_TOP 

window should always be above others

SDL_WINDOW_SKIP_TASKBAR 

window should not be added to the taskbar

SDL_WINDOW_UTILITY 

window should be treated as a utility window

SDL_WINDOW_TOOLTIP 

window should be treated as a tooltip

SDL_WINDOW_POPUP_MENU 

window should be treated as a popup menu

SDL_WINDOW_VULKAN 

window usable for Vulkan surface

Definition at line 97 of file SDL_video.h.

98 {
99  /* !!! FIXME: change this to name = (1<<x). */
100  SDL_WINDOW_FULLSCREEN = 0x00000001, /**< fullscreen window */
101  SDL_WINDOW_OPENGL = 0x00000002, /**< window usable with OpenGL context */
102  SDL_WINDOW_SHOWN = 0x00000004, /**< window is visible */
103  SDL_WINDOW_HIDDEN = 0x00000008, /**< window is not visible */
104  SDL_WINDOW_BORDERLESS = 0x00000010, /**< no window decoration */
105  SDL_WINDOW_RESIZABLE = 0x00000020, /**< window can be resized */
106  SDL_WINDOW_MINIMIZED = 0x00000040, /**< window is minimized */
107  SDL_WINDOW_MAXIMIZED = 0x00000080, /**< window is maximized */
108  SDL_WINDOW_INPUT_GRABBED = 0x00000100, /**< window has grabbed input focus */
109  SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */
110  SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
112  SDL_WINDOW_FOREIGN = 0x00000800, /**< window not created by SDL */
113  SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000, /**< window should be created in high-DPI mode if supported.
114  On macOS NSHighResolutionCapable must be set true in the
115  application's Info.plist for this to have any effect. */
116  SDL_WINDOW_MOUSE_CAPTURE = 0x00004000, /**< window has mouse captured (unrelated to INPUT_GRABBED) */
117  SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000, /**< window should always be above others */
118  SDL_WINDOW_SKIP_TASKBAR = 0x00010000, /**< window should not be added to the taskbar */
119  SDL_WINDOW_UTILITY = 0x00020000, /**< window should be treated as a utility window */
120  SDL_WINDOW_TOOLTIP = 0x00040000, /**< window should be treated as a tooltip */
121  SDL_WINDOW_POPUP_MENU = 0x00080000, /**< window should be treated as a popup menu */
122  SDL_WINDOW_VULKAN = 0x10000000 /**< window usable for Vulkan surface */
SDL_WindowFlags
The flags on a window.
Definition: SDL_video.h:97

Function Documentation

◆ SDL_CreateWindow()

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

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

Parameters
titleThe title of the window, in UTF-8 encoding.
xThe x position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.
yThe y position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.
wThe width of the window, in screen coordinates.
hThe height of the window, in screen coordinates.
flagsThe flags for the window, a mask of any of the following: SDL_WINDOW_FULLSCREEN, SDL_WINDOW_OPENGL, SDL_WINDOW_HIDDEN, SDL_WINDOW_BORDERLESS, SDL_WINDOW_RESIZABLE, SDL_WINDOW_MAXIMIZED, SDL_WINDOW_MINIMIZED, SDL_WINDOW_INPUT_GRABBED, SDL_WINDOW_ALLOW_HIGHDPI, SDL_WINDOW_VULKAN.
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.

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 1408 of file SDL_video.c.

References SDL_Window::brightness, CREATE_FLAGS, SDL_VideoDevice::CreateSDLWindow, SDL_Window::flags, FULLSCREEN_VISIBLE, SDL_VideoDevice::GL_CreateContext, SDL_Rect::h, SDL_Window::h, SDL_Window::id, SDL_Window::is_destroying, SDL_VideoDevice::is_dummy, SDL_Window::last_fullscreen_flags, SDL_Window::magic, SDL_VideoDevice::name, SDL_Window::next, SDL_VideoDevice::next_object_id, NULL, SDL_Window::opacity, SDL_Window::prev, SDL_calloc, SDL_DestroyWindow(), SDL_FALSE, SDL_FinishWindowCreation(), SDL_GetDisplayBounds(), SDL_GetDisplayForWindow(), SDL_GetHintBoolean, SDL_GetIndexOfDisplay(), SDL_GL_LoadLibrary(), SDL_HINT_VIDEO_HIGHDPI_DISABLED, SDL_OutOfMemory, SDL_SetError, SDL_SetWindowTitle(), SDL_UpdateFullscreenMode(), SDL_VideoInit(), SDL_Vulkan_LoadLibrary(), SDL_WINDOW_ALLOW_HIGHDPI, SDL_WINDOW_FULLSCREEN, SDL_WINDOW_HIDDEN, SDL_WINDOW_MINIMIZED, SDL_WINDOW_OPENGL, SDL_WINDOW_POPUP_MENU, SDL_WINDOW_TOOLTIP, SDL_WINDOW_UTILITY, SDL_WINDOW_VULKAN, SDL_WINDOWPOS_ISCENTERED, SDL_WINDOWPOS_ISUNDEFINED, SDL_VideoDevice::Vulkan_CreateSurface, SDL_Rect::w, SDL_Window::w, SDL_VideoDevice::window_magic, SDL_Window::windowed, SDL_VideoDevice::windows, SDL_Rect::x, SDL_Window::x, SDL_Rect::y, and SDL_Window::y.

Referenced by ShouldUseTextureFramebuffer().

1409 {
1410  SDL_Window *window;
1411 
1412  if (!_this) {
1413  /* Initialize the video system if needed */
1414  if (SDL_VideoInit(NULL) < 0) {
1415  return NULL;
1416  }
1417  }
1418 
1419  if ((((flags & SDL_WINDOW_UTILITY) != 0) + ((flags & SDL_WINDOW_TOOLTIP) != 0) + ((flags & SDL_WINDOW_POPUP_MENU) != 0)) > 1) {
1420  SDL_SetError("Conflicting window flags specified");
1421  return NULL;
1422  }
1423 
1424  /* Some platforms can't create zero-sized windows */
1425  if (w < 1) {
1426  w = 1;
1427  }
1428  if (h < 1) {
1429  h = 1;
1430  }
1431 
1432  /* Some platforms blow up if the windows are too large. Raise it later? */
1433  if ((w > 16384) || (h > 16384)) {
1434  SDL_SetError("Window is too large.");
1435  return NULL;
1436  }
1437 
1438  /* Some platforms have OpenGL enabled by default */
1439 #if (SDL_VIDEO_OPENGL && __MACOSX__) || __IPHONEOS__ || __ANDROID__ || __NACL__
1440  if (!_this->is_dummy && !(flags & SDL_WINDOW_VULKAN)) {
1442  }
1443 #endif
1444  if (flags & SDL_WINDOW_OPENGL) {
1445  if (!_this->GL_CreateContext) {
1446  SDL_SetError("OpenGL support is either not configured in SDL "
1447  "or not available in current SDL video driver "
1448  "(%s) or platform", _this->name);
1449  return NULL;
1450  }
1451  if (SDL_GL_LoadLibrary(NULL) < 0) {
1452  return NULL;
1453  }
1454  }
1455 
1456  if (flags & SDL_WINDOW_VULKAN) {
1457  if (!_this->Vulkan_CreateSurface) {
1458  SDL_SetError("Vulkan support is either not configured in SDL "
1459  "or not available in current SDL video driver "
1460  "(%s) or platform", _this->name);
1461  return NULL;
1462  }
1463  if (flags & SDL_WINDOW_OPENGL) {
1464  SDL_SetError("Vulkan and OpenGL not supported on same window");
1465  return NULL;
1466  }
1467  if (SDL_Vulkan_LoadLibrary(NULL) < 0) {
1468  return NULL;
1469  }
1470  }
1471 
1472  /* Unless the user has specified the high-DPI disabling hint, respect the
1473  * SDL_WINDOW_ALLOW_HIGHDPI flag.
1474  */
1477  flags &= ~SDL_WINDOW_ALLOW_HIGHDPI;
1478  }
1479  }
1480 
1481  window = (SDL_Window *)SDL_calloc(1, sizeof(*window));
1482  if (!window) {
1483  SDL_OutOfMemory();
1484  return NULL;
1485  }
1486  window->magic = &_this->window_magic;
1487  window->id = _this->next_object_id++;
1488  window->x = x;
1489  window->y = y;
1490  window->w = w;
1491  window->h = h;
1494  SDL_VideoDisplay *display = SDL_GetDisplayForWindow(window);
1495  int displayIndex;
1496  SDL_Rect bounds;
1497 
1498  displayIndex = SDL_GetIndexOfDisplay(display);
1499  SDL_GetDisplayBounds(displayIndex, &bounds);
1501  window->x = bounds.x + (bounds.w - w) / 2;
1502  }
1504  window->y = bounds.y + (bounds.h - h) / 2;
1505  }
1506  }
1507  window->windowed.x = window->x;
1508  window->windowed.y = window->y;
1509  window->windowed.w = window->w;
1510  window->windowed.h = window->h;
1511 
1512  if (flags & SDL_WINDOW_FULLSCREEN) {
1513  SDL_VideoDisplay *display = SDL_GetDisplayForWindow(window);
1514  int displayIndex;
1515  SDL_Rect bounds;
1516 
1517  displayIndex = SDL_GetIndexOfDisplay(display);
1518  SDL_GetDisplayBounds(displayIndex, &bounds);
1519 
1520  window->x = bounds.x;
1521  window->y = bounds.y;
1522  window->w = bounds.w;
1523  window->h = bounds.h;
1524  }
1525 
1526  window->flags = ((flags & CREATE_FLAGS) | SDL_WINDOW_HIDDEN);
1527  window->last_fullscreen_flags = window->flags;
1528  window->opacity = 1.0f;
1529  window->brightness = 1.0f;
1530  window->next = _this->windows;
1531  window->is_destroying = SDL_FALSE;
1532 
1533  if (_this->windows) {
1534  _this->windows->prev = window;
1535  }
1536  _this->windows = window;
1537 
1538  if (_this->CreateSDLWindow && _this->CreateSDLWindow(_this, window) < 0) {
1539  SDL_DestroyWindow(window);
1540  return NULL;
1541  }
1542 
1543  /* Clear minimized if not on windows, only windows handles it at create rather than FinishWindowCreation,
1544  * but it's important or window focus will get broken on windows!
1545  */
1546 #if !defined(__WIN32__)
1547  if (window->flags & SDL_WINDOW_MINIMIZED) {
1548  window->flags &= ~SDL_WINDOW_MINIMIZED;
1549  }
1550 #endif
1551 
1552 #if __WINRT__ && (NTDDI_VERSION < NTDDI_WIN10)
1553  /* HACK: WinRT 8.x apps can't choose whether or not they are fullscreen
1554  or not. The user can choose this, via OS-provided UI, but this can't
1555  be set programmatically.
1556 
1557  Just look at what SDL's WinRT video backend code detected with regards
1558  to fullscreen (being active, or not), and figure out a return/error code
1559  from that.
1560  */
1561  flags = window->flags;
1562 #endif
1563 
1564  if (title) {
1565  SDL_SetWindowTitle(window, title);
1566  }
1568 
1569  /* If the window was created fullscreen, make sure the mode code matches */
1571 
1572  return window;
1573 }
#define SDL_WINDOWPOS_ISUNDEFINED(X)
Definition: SDL_video.h:131
SDL_Window * next
Definition: SDL_sysvideo.h:114
const char * name
Definition: SDL_sysvideo.h:152
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
#define FULLSCREEN_VISIBLE(W)
Definition: SDL_sysvideo.h:116
const void * magic
Definition: SDL_sysvideo.h:75
GLfloat GLfloat GLfloat GLfloat h
#define SDL_HINT_VIDEO_HIGHDPI_DISABLED
If set to 1, then do not allow high-DPI windows. ("Retina" on Mac and iOS)
Definition: SDL_hints.h:632
int SDL_GL_LoadLibrary(const char *path)
Dynamically load an OpenGL library.
Definition: SDL_video.c:2853
void SDL_SetWindowTitle(SDL_Window *window, const char *title)
Set the title of a window, in UTF-8 format.
Definition: SDL_video.c:1745
#define SDL_WINDOWPOS_ISCENTERED(X)
Definition: SDL_video.h:140
SDL_bool is_destroying
Definition: SDL_sysvideo.h:101
SDL_bool is_dummy
Definition: SDL_sysvideo.h:313
SDL_Rect windowed
Definition: SDL_sysvideo.h:87
#define SDL_GetHintBoolean
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define CREATE_FLAGS
Definition: SDL_video.c:1350
float opacity
Definition: SDL_sysvideo.h:91
SDL_VideoDisplay * SDL_GetDisplayForWindow(SDL_Window *window)
Definition: SDL_video.c:1092
int SDL_GetIndexOfDisplay(SDL_VideoDisplay *display)
Definition: SDL_video.c:645
SDL_GLContext(* GL_CreateContext)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:258
SDL_bool(* Vulkan_CreateSurface)(_THIS, SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface)
Definition: SDL_sysvideo.h:274
void SDL_DestroyWindow(SDL_Window *window)
Destroy a window.
Definition: SDL_video.c:2687
GLubyte GLubyte GLubyte GLubyte w
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
int x
Definition: SDL_rect.h:66
static int SDL_UpdateFullscreenMode(SDL_Window *window, SDL_bool fullscreen)
Definition: SDL_video.c:1186
SDL_Window * windows
Definition: SDL_sysvideo.h:317
int SDL_GetDisplayBounds(int displayIndex, SDL_Rect *rect)
Get the desktop area represented by a display, with the primary display located at 0...
Definition: SDL_video.c:676
int w
Definition: SDL_rect.h:67
float brightness
Definition: SDL_sysvideo.h:93
#define NULL
Definition: begin_code.h:164
int(* CreateSDLWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:211
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
Uint32 last_fullscreen_flags
Definition: SDL_sysvideo.h:84
#define SDL_SetError
GLbitfield flags
#define SDL_calloc
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_Window * prev
Definition: SDL_sysvideo.h:113
int SDL_VideoInit(const char *driver_name)
Initialize the video subsystem, optionally specifying a video driver.
Definition: SDL_video.c:464
int h
Definition: SDL_rect.h:67
The type used to identify a window.
Definition: SDL_sysvideo.h:73
static void SDL_FinishWindowCreation(SDL_Window *window, Uint32 flags)
Definition: SDL_video.c:1386
Uint32 id
Definition: SDL_sysvideo.h:76
int SDL_Vulkan_LoadLibrary(const char *path)
Dynamically load a Vulkan loader library.
Definition: SDL_video.c:4051
Uint32 flags
Definition: SDL_sysvideo.h:83
Uint32 next_object_id
Definition: SDL_sysvideo.h:320
int y
Definition: SDL_rect.h:66
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64

◆ SDL_CreateWindowFrom()

SDL_Window* SDL_CreateWindowFrom ( const void data)

Create an SDL window from an existing native window.

Parameters
dataA pointer to driver-dependent window creation data
Returns
The created window, or NULL if window creation failed.
See also
SDL_DestroyWindow()

Definition at line 1576 of file SDL_video.c.

References SDL_Window::brightness, SDL_VideoDevice::CreateSDLWindowFrom, SDL_Window::flags, SDL_Window::id, SDL_Window::is_destroying, SDL_Window::last_fullscreen_flags, SDL_Window::magic, SDL_Window::next, SDL_VideoDevice::next_object_id, NULL, SDL_Window::opacity, 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.

1577 {
1578  SDL_Window *window;
1579 
1580  if (!_this) {
1582  return NULL;
1583  }
1584  if (!_this->CreateSDLWindowFrom) {
1585  SDL_Unsupported();
1586  return NULL;
1587  }
1588  window = (SDL_Window *)SDL_calloc(1, sizeof(*window));
1589  if (!window) {
1590  SDL_OutOfMemory();
1591  return NULL;
1592  }
1593  window->magic = &_this->window_magic;
1594  window->id = _this->next_object_id++;
1595  window->flags = SDL_WINDOW_FOREIGN;
1596  window->last_fullscreen_flags = window->flags;
1597  window->is_destroying = SDL_FALSE;
1598  window->opacity = 1.0f;
1599  window->brightness = 1.0f;
1600  window->next = _this->windows;
1601  if (_this->windows) {
1602  _this->windows->prev = window;
1603  }
1604  _this->windows = window;
1605 
1606  if (_this->CreateSDLWindowFrom(_this, window, data) < 0) {
1607  SDL_DestroyWindow(window);
1608  return NULL;
1609  }
1610 
1611  PrepareDragAndDropSupport(window);
1612 
1613  return window;
1614 }
SDL_Window * next
Definition: SDL_sysvideo.h:114
const void * magic
Definition: SDL_sysvideo.h:75
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
SDL_bool is_destroying
Definition: SDL_sysvideo.h:101
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
float opacity
Definition: SDL_sysvideo.h:91
void SDL_DestroyWindow(SDL_Window *window)
Destroy a window.
Definition: SDL_video.c:2687
SDL_Window * windows
Definition: SDL_sysvideo.h:317
float brightness
Definition: SDL_sysvideo.h:93
#define NULL
Definition: begin_code.h:164
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
Uint32 last_fullscreen_flags
Definition: SDL_sysvideo.h:84
#define SDL_calloc
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_Window * prev
Definition: SDL_sysvideo.h:113
The type used to identify a window.
Definition: SDL_sysvideo.h:73
Uint32 id
Definition: SDL_sysvideo.h:76
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440
int(* CreateSDLWindowFrom)(_THIS, SDL_Window *window, const void *data)
Definition: SDL_sysvideo.h:212
static SDL_INLINE void PrepareDragAndDropSupport(SDL_Window *window)
Definition: SDL_video.c:1365
Uint32 flags
Definition: SDL_sysvideo.h:83
Uint32 next_object_id
Definition: SDL_sysvideo.h:320
#define SDL_Unsupported()
Definition: SDL_error.h:53

◆ SDL_DestroyWindow()

void SDL_DestroyWindow ( SDL_Window window)

Destroy a window.

Definition at line 2687 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_VideoDevice::current_glwin, SDL_Window::data, SDL_VideoDevice::DestroyWindow, SDL_VideoDevice::DestroyWindowFramebuffer, SDL_Surface::flags, SDL_Window::flags, SDL_VideoDisplay::fullscreen_window, SDL_Window::gamma, SDL_Window::icon, SDL_Window::is_destroying, SDL_Window::magic, SDL_WindowUserData::name, SDL_WindowUserData::next, SDL_Window::next, NULL, SDL_Window::prev, SDL_DONTFREE, SDL_free, SDL_FreeSurface, SDL_GetDisplayForWindow(), SDL_GetKeyboardFocus, SDL_GetMouseFocus, SDL_GL_MakeCurrent(), SDL_GL_UnloadLibrary(), SDL_HideWindow(), SDL_SetKeyboardFocus(), SDL_SetMouseFocus(), SDL_TRUE, SDL_Vulkan_UnloadLibrary(), SDL_WINDOW_OPENGL, SDL_WINDOW_VULKAN, SDL_Window::surface, SDL_Window::title, and SDL_VideoDevice::windows.

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

2688 {
2689  SDL_VideoDisplay *display;
2690 
2691  CHECK_WINDOW_MAGIC(window,);
2692 
2693  window->is_destroying = SDL_TRUE;
2694 
2695  /* Restore video mode, etc. */
2696  SDL_HideWindow(window);
2697 
2698  /* Make sure this window no longer has focus */
2699  if (SDL_GetKeyboardFocus() == window) {
2701  }
2702  if (SDL_GetMouseFocus() == window) {
2704  }
2705 
2706  /* make no context current if this is the current context window. */
2707  if (window->flags & SDL_WINDOW_OPENGL) {
2708  if (_this->current_glwin == window) {
2709  SDL_GL_MakeCurrent(window, NULL);
2710  }
2711  }
2712 
2713  if (window->surface) {
2714  window->surface->flags &= ~SDL_DONTFREE;
2715  SDL_FreeSurface(window->surface);
2716  }
2719  }
2720  if (_this->DestroyWindow) {
2721  _this->DestroyWindow(_this, window);
2722  }
2723  if (window->flags & SDL_WINDOW_OPENGL) {
2725  }
2726  if (window->flags & SDL_WINDOW_VULKAN) {
2728  }
2729 
2730  display = SDL_GetDisplayForWindow(window);
2731  if (display->fullscreen_window == window) {
2732  display->fullscreen_window = NULL;
2733  }
2734 
2735  /* Now invalidate magic */
2736  window->magic = NULL;
2737 
2738  /* Free memory associated with the window */
2739  SDL_free(window->title);
2740  SDL_FreeSurface(window->icon);
2741  SDL_free(window->gamma);
2742  while (window->data) {
2743  SDL_WindowUserData *data = window->data;
2744 
2745  window->data = data->next;
2746  SDL_free(data->name);
2747  SDL_free(data);
2748  }
2749 
2750  /* Unlink the window from the list */
2751  if (window->next) {
2752  window->next->prev = window->prev;
2753  }
2754  if (window->prev) {
2755  window->prev->next = window->next;
2756  } else {
2757  _this->windows = window->next;
2758  }
2759 
2760  SDL_free(window);
2761 }
SDL_Window * next
Definition: SDL_sysvideo.h:114
void SDL_SetKeyboardFocus(SDL_Window *window)
Definition: SDL_keyboard.c:630
const void * magic
Definition: SDL_sysvideo.h:75
#define SDL_DONTFREE
Definition: SDL_surface.h:55
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
SDL_bool is_destroying
Definition: SDL_sysvideo.h:101
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:177
void SDL_HideWindow(SDL_Window *window)
Hide a window.
Definition: SDL_video.c:2165
#define SDL_GetKeyboardFocus
Uint32 flags
Definition: SDL_surface.h:71
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
struct SDL_WindowUserData * next
Definition: SDL_sysvideo.h:69
SDL_VideoDisplay * SDL_GetDisplayForWindow(SDL_Window *window)
Definition: SDL_video.c:1092
#define SDL_FreeSurface
#define SDL_free
int SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext ctx)
Set up an OpenGL context for rendering into an OpenGL window.
Definition: SDL_video.c:3491
void SDL_GL_UnloadLibrary(void)
Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
Definition: SDL_video.c:2904
void(* DestroyWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:235
char * title
Definition: SDL_sysvideo.h:77
SDL_Window * windows
Definition: SDL_sysvideo.h:317
SDL_Window * fullscreen_window
Definition: SDL_sysvideo.h:135
void(* DestroyWindowFramebuffer)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:238
#define NULL
Definition: begin_code.h:164
#define SDL_GetMouseFocus
SDL_Surface * icon
Definition: SDL_sysvideo.h:78
SDL_Window * prev
Definition: SDL_sysvideo.h:113
void SDL_Vulkan_UnloadLibrary(void)
Unload the Vulkan loader library previously loaded by SDL_Vulkan_LoadLibrary().
Definition: SDL_video.c:4090
Uint16 * gamma
Definition: SDL_sysvideo.h:94
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83
SDL_Surface * surface
Definition: SDL_sysvideo.h:97
SDL_Window * current_glwin
Definition: SDL_sysvideo.h:363
SDL_WindowUserData * data
Definition: SDL_sysvideo.h:109

◆ SDL_DisableScreenSaver()

void SDL_DisableScreenSaver ( void  )

Prevent the screen from being blanked by a screensaver.

See also
SDL_IsScreenSaverEnabled()
SDL_EnableScreenSaver()

Definition at line 2788 of file SDL_video.c.

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

Referenced by SDL_VideoInit().

2789 {
2790  if (!_this) {
2791  return;
2792  }
2793  if (_this->suspend_screensaver) {
2794  return;
2795  }
2797  if (_this->SuspendScreenSaver) {
2799  }
2800 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_bool suspend_screensaver
Definition: SDL_sysvideo.h:314
void(* SuspendScreenSaver)(_THIS)
Definition: SDL_sysvideo.h:284

◆ SDL_EnableScreenSaver()

void SDL_EnableScreenSaver ( void  )

Allow the screen to be blanked by a screensaver.

See also
SDL_IsScreenSaverEnabled()
SDL_DisableScreenSaver()

Definition at line 2773 of file SDL_video.c.

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

Referenced by SDL_VideoQuit().

2774 {
2775  if (!_this) {
2776  return;
2777  }
2778  if (!_this->suspend_screensaver) {
2779  return;
2780  }
2782  if (_this->SuspendScreenSaver) {
2784  }
2785 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_bool suspend_screensaver
Definition: SDL_sysvideo.h:314
void(* SuspendScreenSaver)(_THIS)
Definition: SDL_sysvideo.h:284

◆ 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
displayIndexThe index of display from which mode should be queried.
modeThe desired display mode
closestA pointer to a display mode to be filled in with the closest match of the available display modes.
Returns
The passed in value closest, or NULL if no matching video mode was available.

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

See also
SDL_GetNumDisplayModes()
SDL_GetDisplayMode()

Definition at line 962 of file SDL_video.c.

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

965 {
966  SDL_VideoDisplay *display;
967 
968  CHECK_DISPLAY_INDEX(displayIndex, NULL);
969 
970  display = &_this->displays[displayIndex];
971  return SDL_GetClosestDisplayModeForDisplay(display, mode, closest);
972 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
#define NULL
Definition: begin_code.h:164
static SDL_DisplayMode * SDL_GetClosestDisplayModeForDisplay(SDL_VideoDisplay *display, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
Definition: SDL_video.c:855
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134

◆ SDL_GetCurrentDisplayMode()

int SDL_GetCurrentDisplayMode ( int  displayIndex,
SDL_DisplayMode mode 
)

Fill in information about the current display mode.

Definition at line 841 of file SDL_video.c.

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

842 {
843  SDL_VideoDisplay *display;
844 
845  CHECK_DISPLAY_INDEX(displayIndex, -1);
846 
847  display = &_this->displays[displayIndex];
848  if (mode) {
849  *mode = display->current_mode;
850  }
851  return 0;
852 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_DisplayMode current_mode
Definition: SDL_sysvideo.h:132
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134

◆ 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 576 of file SDL_video.c.

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

577 {
578  if (!_this) {
580  return NULL;
581  }
582  return _this->name;
583 }
const char * name
Definition: SDL_sysvideo.h:152
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define NULL
Definition: begin_code.h:164
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440

◆ SDL_GetDesktopDisplayMode()

int SDL_GetDesktopDisplayMode ( int  displayIndex,
SDL_DisplayMode mode 
)

Fill in information about the desktop display mode.

Definition at line 827 of file SDL_video.c.

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

828 {
829  SDL_VideoDisplay *display;
830 
831  CHECK_DISPLAY_INDEX(displayIndex, -1);
832 
833  display = &_this->displays[displayIndex];
834  if (mode) {
835  *mode = display->desktop_mode;
836  }
837  return 0;
838 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
SDL_DisplayMode desktop_mode
Definition: SDL_sysvideo.h:131
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134

◆ 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 676 of file SDL_video.c.

References CHECK_DISPLAY_INDEX, SDL_VideoDisplay::current_mode, SDL_VideoDevice::displays, SDL_VideoDevice::GetDisplayBounds, SDL_DisplayMode::h, SDL_Rect::h, SDL_DisplayMode::w, SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

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

677 {
678  CHECK_DISPLAY_INDEX(displayIndex, -1);
679 
680  if (rect) {
681  SDL_VideoDisplay *display = &_this->displays[displayIndex];
682 
683  if (_this->GetDisplayBounds) {
684  if (_this->GetDisplayBounds(_this, display, rect) == 0) {
685  return 0;
686  }
687  }
688 
689  /* Assume that the displays are left to right */
690  if (displayIndex == 0) {
691  rect->x = 0;
692  rect->y = 0;
693  } else {
694  SDL_GetDisplayBounds(displayIndex-1, rect);
695  rect->x += rect->w;
696  }
697  rect->w = display->current_mode.w;
698  rect->h = display->current_mode.h;
699  }
700  return 0; /* !!! FIXME: should this be an error if (rect==NULL) ? */
701 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_DisplayMode current_mode
Definition: SDL_sysvideo.h:132
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
int(* GetDisplayBounds)(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
Definition: SDL_sysvideo.h:182
int x
Definition: SDL_rect.h:66
int SDL_GetDisplayBounds(int displayIndex, SDL_Rect *rect)
Get the desktop area represented by a display, with the primary display located at 0...
Definition: SDL_video.c:676
int w
Definition: SDL_rect.h:67
int h
Definition: SDL_rect.h:67
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134
int y
Definition: SDL_rect.h:66

◆ 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 723 of file SDL_video.c.

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

724 {
725  SDL_VideoDisplay *display;
726 
727  CHECK_DISPLAY_INDEX(displayIndex, -1);
728 
729  display = &_this->displays[displayIndex];
730 
731  if (_this->GetDisplayDPI) {
732  if (_this->GetDisplayDPI(_this, display, ddpi, hdpi, vdpi) == 0) {
733  return 0;
734  }
735  } else {
736  return SDL_Unsupported();
737  }
738 
739  return -1;
740 }
int(* GetDisplayDPI)(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hdpi, float *vdpi)
Definition: SDL_sysvideo.h:192
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134
#define SDL_Unsupported()
Definition: SDL_error.h:53

◆ 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 809 of file SDL_video.c.

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

810 {
811  SDL_VideoDisplay *display;
812 
813  CHECK_DISPLAY_INDEX(displayIndex, -1);
814 
815  display = &_this->displays[displayIndex];
817  return SDL_SetError("index must be in the range of 0 - %d",
818  SDL_GetNumDisplayModesForDisplay(display) - 1);
819  }
820  if (mode) {
821  *mode = display->display_modes[index];
822  }
823  return 0;
824 }
static int SDL_GetNumDisplayModesForDisplay(SDL_VideoDisplay *display)
Definition: SDL_video.c:790
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_DisplayMode * display_modes
Definition: SDL_sysvideo.h:130
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
GLuint index
#define SDL_SetError
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134

◆ 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 668 of file SDL_video.c.

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

669 {
670  CHECK_DISPLAY_INDEX(displayIndex, NULL);
671 
672  return _this->displays[displayIndex].name;
673 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
#define NULL
Definition: begin_code.h:164
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134

◆ 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 743 of file SDL_video.c.

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

744 {
745  SDL_VideoDisplay *display;
746 
748 
749  display = &_this->displays[displayIndex];
750  return display->orientation;
751 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134
SDL_DisplayOrientation orientation
Definition: SDL_sysvideo.h:133

◆ 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 703 of file SDL_video.c.

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

704 {
705  CHECK_DISPLAY_INDEX(displayIndex, -1);
706 
707  if (rect) {
708  SDL_VideoDisplay *display = &_this->displays[displayIndex];
709 
711  if (_this->GetDisplayUsableBounds(_this, display, rect) == 0) {
712  return 0;
713  }
714  }
715 
716  /* Oh well, just give the entire display bounds. */
717  return SDL_GetDisplayBounds(displayIndex, rect);
718  }
719  return 0; /* !!! FIXME: should this be an error if (rect==NULL) ? */
720 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
int SDL_GetDisplayBounds(int displayIndex, SDL_Rect *rect)
Get the desktop area represented by a display, with the primary display located at 0...
Definition: SDL_video.c:676
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134
int(* GetDisplayUsableBounds)(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
Definition: SDL_sysvideo.h:187

◆ 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 2559 of file SDL_video.c.

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

2560 {
2562  return _this->grabbed_window;
2563 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_assert(condition)
Definition: SDL_assert.h:169
SDL_Window * grabbed_window
Definition: SDL_sysvideo.h:318
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ SDL_GetNumDisplayModes()

int SDL_GetNumDisplayModes ( int  displayIndex)

Returns the number of available display modes.

See also
SDL_GetDisplayMode()

Definition at line 801 of file SDL_video.c.

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

802 {
803  CHECK_DISPLAY_INDEX(displayIndex, -1);
804 
805  return SDL_GetNumDisplayModesForDisplay(&_this->displays[displayIndex]);
806 }
static int SDL_GetNumDisplayModesForDisplay(SDL_VideoDisplay *display)
Definition: SDL_video.c:790
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
#define CHECK_DISPLAY_INDEX(displayIndex, retval)
Definition: SDL_video.c:134

◆ SDL_GetNumVideoDisplays()

int SDL_GetNumVideoDisplays ( void  )

Returns the number of available video displays.

See also
SDL_GetDisplayBounds()

Definition at line 635 of file SDL_video.c.

References SDL_VideoDevice::num_displays, and SDL_UninitializedVideo().

636 {
637  if (!_this) {
639  return 0;
640  }
641  return _this->num_displays;
642 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440

◆ SDL_GetNumVideoDrivers()

int SDL_GetNumVideoDrivers ( void  )

Get the number of video drivers compiled into SDL.

See also
SDL_GetVideoDriver()

Definition at line 446 of file SDL_video.c.

References SDL_arraysize.

Referenced by SDL_GetVideoDriver().

447 {
448  return SDL_arraysize(bootstrap) - 1;
449 }
static VideoBootStrap * bootstrap[]
Definition: SDL_video.c:60
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:115

◆ 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 452 of file SDL_video.c.

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

453 {
454  if (index >= 0 && index < SDL_GetNumVideoDrivers()) {
455  return bootstrap[index]->name;
456  }
457  return NULL;
458 }
int SDL_GetNumVideoDrivers(void)
Get the number of video drivers compiled into SDL.
Definition: SDL_video.c:446
GLuint index
#define NULL
Definition: begin_code.h:164
static VideoBootStrap * bootstrap[]
Definition: SDL_video.c:60
const char * name
Definition: SDL_sysvideo.h:399

◆ 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
windowThe window to query.
topPointer to variable for storing the size of the top border. NULL is permitted.
leftPointer to variable for storing the size of the left border. NULL is permitted.
bottomPointer to variable for storing the size of the bottom border. NULL is permitted.
rightPointer 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 2043 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_VideoDevice::GetWindowBordersSize, and SDL_Unsupported.

2044 {
2045  int dummy = 0;
2046 
2047  if (!top) { top = &dummy; }
2048  if (!left) { left = &dummy; }
2049  if (!right) { right = &dummy; }
2050  if (!bottom) { bottom = &dummy; }
2051 
2052  /* Always initialize, so applications don't have to care */
2053  *top = *left = *bottom = *right = 0;
2054 
2055  CHECK_WINDOW_MAGIC(window, -1);
2056 
2057  if (!_this->GetWindowBordersSize) {
2058  return SDL_Unsupported();
2059  }
2060 
2061  return _this->GetWindowBordersSize(_this, window, top, left, bottom, right);
2062 }
GLdouble GLdouble right
GLint GLint bottom
int(* GetWindowBordersSize)(_THIS, SDL_Window *window, int *top, int *left, int *bottom, int *right)
Definition: SDL_sysvideo.h:219
GLdouble GLdouble GLdouble GLdouble top
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
#define SDL_Unsupported()
Definition: SDL_error.h:53
GLint left

◆ 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 2355 of file SDL_video.c.

References SDL_Window::brightness, and CHECK_WINDOW_MAGIC.

2356 {
2357  CHECK_WINDOW_MAGIC(window, 1.0f);
2358 
2359  return window->brightness;
2360 }
GLfloat f
float brightness
Definition: SDL_sysvideo.h:93
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ SDL_GetWindowData()

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

Retrieve the data pointer associated with a window.

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

Definition at line 1839 of file SDL_video.c.

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

Referenced by SDL_CreateWindowTexture(), and SDL_UpdateWindowTexture().

1840 {
1842 
1843  CHECK_WINDOW_MAGIC(window, NULL);
1844 
1845  /* Input validation */
1846  if (name == NULL || name[0] == '\0') {
1847  SDL_InvalidParamError("name");
1848  return NULL;
1849  }
1850 
1851  for (data = window->data; data; data = data->next) {
1852  if (data->name && SDL_strcmp(data->name, name) == 0) {
1853  return data->data;
1854  }
1855  }
1856  return NULL;
1857 }
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
GLuint const GLchar * name
struct SDL_WindowUserData * next
Definition: SDL_sysvideo.h:69
#define NULL
Definition: begin_code.h:164
#define SDL_strcmp
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
SDL_WindowUserData * data
Definition: SDL_sysvideo.h:109

◆ 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 1032 of file SDL_video.c.

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

Referenced by SDL_GetDisplayForWindow(), and SDL_GetWindowPosition().

1033 {
1034  int displayIndex;
1035  int i, dist;
1036  int closest = -1;
1037  int closest_dist = 0x7FFFFFFF;
1038  SDL_Point center;
1039  SDL_Point delta;
1040  SDL_Rect rect;
1041 
1042  CHECK_WINDOW_MAGIC(window, -1);
1043 
1044  if (SDL_WINDOWPOS_ISUNDEFINED(window->x) ||
1045  SDL_WINDOWPOS_ISCENTERED(window->x)) {
1046  displayIndex = (window->x & 0xFFFF);
1047  if (displayIndex >= _this->num_displays) {
1048  displayIndex = 0;
1049  }
1050  return displayIndex;
1051  }
1052  if (SDL_WINDOWPOS_ISUNDEFINED(window->y) ||
1053  SDL_WINDOWPOS_ISCENTERED(window->y)) {
1054  displayIndex = (window->y & 0xFFFF);
1055  if (displayIndex >= _this->num_displays) {
1056  displayIndex = 0;
1057  }
1058  return displayIndex;
1059  }
1060 
1061  /* Find the display containing the window */
1062  for (i = 0; i < _this->num_displays; ++i) {
1063  SDL_VideoDisplay *display = &_this->displays[i];
1064 
1065  if (display->fullscreen_window == window) {
1066  return i;
1067  }
1068  }
1069  center.x = window->x + window->w / 2;
1070  center.y = window->y + window->h / 2;
1071  for (i = 0; i < _this->num_displays; ++i) {
1072  SDL_GetDisplayBounds(i, &rect);
1073  if (SDL_EnclosePoints(&center, 1, &rect, NULL)) {
1074  return i;
1075  }
1076 
1077  delta.x = center.x - (rect.x + rect.w / 2);
1078  delta.y = center.y - (rect.y + rect.h / 2);
1079  dist = (delta.x*delta.x + delta.y*delta.y);
1080  if (dist < closest_dist) {
1081  closest = i;
1082  closest_dist = dist;
1083  }
1084  }
1085  if (closest < 0) {
1086  SDL_SetError("Couldn't find any displays");
1087  }
1088  return closest;
1089 }
#define SDL_WINDOWPOS_ISUNDEFINED(X)
Definition: SDL_video.h:131
SDL_Rect rect
Definition: testrelative.c:27
The structure that defines a point.
Definition: SDL_rect.h:48
#define SDL_WINDOWPOS_ISCENTERED(X)
Definition: SDL_video.h:140
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
int x
Definition: SDL_rect.h:50
int y
Definition: SDL_rect.h:51
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
int x
Definition: SDL_rect.h:66
int SDL_GetDisplayBounds(int displayIndex, SDL_Rect *rect)
Get the desktop area represented by a display, with the primary display located at 0...
Definition: SDL_video.c:676
int w
Definition: SDL_rect.h:67
SDL_Window * fullscreen_window
Definition: SDL_sysvideo.h:135
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define NULL
Definition: begin_code.h:164
#define SDL_SetError
int h
Definition: SDL_rect.h:67
#define SDL_EnclosePoints
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
int y
Definition: SDL_rect.h:66
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64

◆ 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 1123 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_VideoDisplay::desktop_mode, SDL_Window::flags, SDL_Window::fullscreen_mode, SDL_DisplayMode::h, SDL_Rect::h, SDL_GetClosestDisplayModeForDisplay(), SDL_GetDisplayForWindow(), SDL_InvalidParamError, SDL_SetError, SDL_WINDOW_FULLSCREEN_DESKTOP, SDL_DisplayMode::w, SDL_Rect::w, and SDL_Window::windowed.

Referenced by SDL_SetWindowDisplayMode(), and SDL_UpdateFullscreenMode().

1124 {
1125  SDL_DisplayMode fullscreen_mode;
1126  SDL_VideoDisplay *display;
1127 
1128  CHECK_WINDOW_MAGIC(window, -1);
1129 
1130  if (!mode) {
1131  return SDL_InvalidParamError("mode");
1132  }
1133 
1134  fullscreen_mode = window->fullscreen_mode;
1135  if (!fullscreen_mode.w) {
1136  fullscreen_mode.w = window->windowed.w;
1137  }
1138  if (!fullscreen_mode.h) {
1139  fullscreen_mode.h = window->windowed.h;
1140  }
1141 
1142  display = SDL_GetDisplayForWindow(window);
1143 
1144  /* if in desktop size mode, just return the size of the desktop */
1146  fullscreen_mode = display->desktop_mode;
1148  &fullscreen_mode,
1149  &fullscreen_mode)) {
1150  return SDL_SetError("Couldn't find display mode match");
1151  }
1152 
1153  if (mode) {
1154  *mode = fullscreen_mode;
1155  }
1156  return 0;
1157 }
SDL_DisplayMode fullscreen_mode
Definition: SDL_sysvideo.h:89
The structure that defines a display mode.
Definition: SDL_video.h:53
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
SDL_Rect windowed
Definition: SDL_sysvideo.h:87
SDL_VideoDisplay * SDL_GetDisplayForWindow(SDL_Window *window)
Definition: SDL_video.c:1092
int w
Definition: SDL_rect.h:67
SDL_DisplayMode desktop_mode
Definition: SDL_sysvideo.h:131
#define SDL_SetError
int h
Definition: SDL_rect.h:67
static SDL_DisplayMode * SDL_GetClosestDisplayModeForDisplay(SDL_VideoDisplay *display, const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
Definition: SDL_video.c:855
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ SDL_GetWindowFlags()

Uint32 SDL_GetWindowFlags ( SDL_Window window)

Get the window flags.

Definition at line 1737 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, and SDL_Window::flags.

Referenced by SDL_ShowMessageBox().

1738 {
1739  CHECK_WINDOW_MAGIC(window, 0);
1740 
1741  return window->flags;
1742 }
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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 1721 of file SDL_video.c.

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

1722 {
1723  SDL_Window *window;
1724 
1725  if (!_this) {
1726  return NULL;
1727  }
1728  for (window = _this->windows; window; window = window->next) {
1729  if (window->id == id) {
1730  return window;
1731  }
1732  }
1733  return NULL;
1734 }
SDL_Window * next
Definition: SDL_sysvideo.h:114
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_Window * windows
Definition: SDL_sysvideo.h:317
#define NULL
Definition: begin_code.h:164
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
The type used to identify a window.
Definition: SDL_sysvideo.h:73
Uint32 id
Definition: SDL_sysvideo.h:76

◆ SDL_GetWindowGammaRamp()

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

Get the gamma ramp for a window.

Parameters
windowThe window from which the gamma ramp should be queried.
redA pointer to a 256 element array of 16-bit quantities to hold the translation table for the red channel, or NULL.
greenA pointer to a 256 element array of 16-bit quantities to hold the translation table for the green channel, or NULL.
blueA pointer to a 256 element array of 16-bit quantities to hold the translation table for the blue channel, or NULL.
Returns
0 on success, or -1 if gamma ramps are unsupported.
See also
SDL_SetWindowGammaRamp()

Definition at line 2459 of file SDL_video.c.

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

Referenced by SDL_SetWindowGammaRamp().

2462 {
2463  CHECK_WINDOW_MAGIC(window, -1);
2464 
2465  if (!window->gamma) {
2466  int i;
2467 
2468  window->gamma = (Uint16 *)SDL_malloc(256*6*sizeof(Uint16));
2469  if (!window->gamma) {
2470  return SDL_OutOfMemory();
2471  }
2472  window->saved_gamma = window->gamma + 3*256;
2473 
2474  if (_this->GetWindowGammaRamp) {
2475  if (_this->GetWindowGammaRamp(_this, window, window->gamma) < 0) {
2476  return -1;
2477  }
2478  } else {
2479  /* Create an identity gamma ramp */
2480  for (i = 0; i < 256; ++i) {
2481  Uint16 value = (Uint16)((i << 8) | i);
2482 
2483  window->gamma[0*256+i] = value;
2484  window->gamma[1*256+i] = value;
2485  window->gamma[2*256+i] = value;
2486  }
2487  }
2488  SDL_memcpy(window->saved_gamma, window->gamma, 3*256*sizeof(Uint16));
2489  }
2490 
2491  if (red) {
2492  SDL_memcpy(red, &window->gamma[0*256], 256*sizeof(Uint16));
2493  }
2494  if (green) {
2495  SDL_memcpy(green, &window->gamma[1*256], 256*sizeof(Uint16));
2496  }
2497  if (blue) {
2498  SDL_memcpy(blue, &window->gamma[2*256], 256*sizeof(Uint16));
2499  }
2500  return 0;
2501 }
uint16_t Uint16
Definition: SDL_stdinc.h:191
GLbyte green
Uint16 * saved_gamma
Definition: SDL_sysvideo.h:95
const GLubyte GLuint red
Definition: SDL_glfuncs.h:79
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_memcpy
GLsizei const GLfloat * value
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
GLbyte GLbyte blue
int(* GetWindowGammaRamp)(_THIS, SDL_Window *window, Uint16 *ramp)
Definition: SDL_sysvideo.h:233
#define SDL_malloc
Uint16 * gamma
Definition: SDL_sysvideo.h:94
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ 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 2551 of file SDL_video.c.

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

2552 {
2553  CHECK_WINDOW_MAGIC(window, SDL_FALSE);
2555  return window == _this->grabbed_window;
2556 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_assert(condition)
Definition: SDL_assert.h:169
SDL_Window * grabbed_window
Definition: SDL_sysvideo.h:318
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ SDL_GetWindowID()

Uint32 SDL_GetWindowID ( SDL_Window window)

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

Definition at line 1713 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, and SDL_Window::id.

1714 {
1715  CHECK_WINDOW_MAGIC(window, 0);
1716 
1717  return window->id;
1718 }
Uint32 id
Definition: SDL_sysvideo.h:76
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ SDL_GetWindowMaximumSize()

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

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

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

Definition at line 2138 of file SDL_video.c.

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

2139 {
2140  CHECK_WINDOW_MAGIC(window,);
2141  if (max_w) {
2142  *max_w = window->max_w;
2143  }
2144  if (max_h) {
2145  *max_h = window->max_h;
2146  }
2147 }
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ SDL_GetWindowMinimumSize()

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

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

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

Definition at line 2096 of file SDL_video.c.

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

2097 {
2098  CHECK_WINDOW_MAGIC(window,);
2099  if (min_w) {
2100  *min_w = window->min_w;
2101  }
2102  if (min_h) {
2103  *min_h = window->min_h;
2104  }
2105 }
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ 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
windowThe window in question.
out_opacityOpacity (0.0f - transparent, 1.0f - opaque)
Returns
0 on success, or -1 on error (invalid window, etc).
See also
SDL_SetWindowOpacity()

Definition at line 2387 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, and SDL_Window::opacity.

2388 {
2389  CHECK_WINDOW_MAGIC(window, -1);
2390 
2391  if (out_opacity) {
2392  *out_opacity = window->opacity;
2393  }
2394 
2395  return 0;
2396 }
float opacity
Definition: SDL_sysvideo.h:91
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ SDL_GetWindowPixelFormat()

Uint32 SDL_GetWindowPixelFormat ( SDL_Window window)

Get the pixel format associated with the window.

Definition at line 1160 of file SDL_video.c.

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

1161 {
1162  SDL_VideoDisplay *display;
1163 
1165 
1166  display = SDL_GetDisplayForWindow(window);
1167  return display->current_mode.format;
1168 }
SDL_VideoDisplay * SDL_GetDisplayForWindow(SDL_Window *window)
Definition: SDL_video.c:1092
SDL_DisplayMode current_mode
Definition: SDL_sysvideo.h:132
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 format
Definition: SDL_video.h:55

◆ SDL_GetWindowPosition()

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

Get the position of a window.

Parameters
windowThe window to query.
xPointer to variable for storing the x position, in screen coordinates. May be NULL.
yPointer to variable for storing the y position, in screen coordinates. May be NULL.
See also
SDL_SetWindowPosition()

Definition at line 1905 of file SDL_video.c.

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

1906 {
1907  CHECK_WINDOW_MAGIC(window,);
1908 
1909  /* Fullscreen windows are always at their display's origin */
1910  if (window->flags & SDL_WINDOW_FULLSCREEN) {
1911  int displayIndex;
1912 
1913  if (x) {
1914  *x = 0;
1915  }
1916  if (y) {
1917  *y = 0;
1918  }
1919 
1920  /* Find the window's monitor and update to the
1921  monitor offset. */
1922  displayIndex = SDL_GetWindowDisplayIndex(window);
1923  if (displayIndex >= 0) {
1924  SDL_Rect bounds;
1925 
1926  SDL_zero(bounds);
1927 
1928  SDL_GetDisplayBounds(displayIndex, &bounds);
1929  if (x) {
1930  *x = bounds.x;
1931  }
1932  if (y) {
1933  *y = bounds.y;
1934  }
1935  }
1936  } else {
1937  if (x) {
1938  *x = window->x;
1939  }
1940  if (y) {
1941  *y = window->y;
1942  }
1943  }
1944 }
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
#define SDL_zero(x)
Definition: SDL_stdinc.h:416
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
int x
Definition: SDL_rect.h:66
int SDL_GetDisplayBounds(int displayIndex, SDL_Rect *rect)
Get the desktop area represented by a display, with the primary display located at 0...
Definition: SDL_video.c:676
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
int SDL_GetWindowDisplayIndex(SDL_Window *window)
Get the display index associated with a window.
Definition: SDL_video.c:1032
Uint32 flags
Definition: SDL_sysvideo.h:83
int y
Definition: SDL_rect.h:66
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64

◆ SDL_GetWindowSize()

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

Get the size of a window's client area.

Parameters
windowThe window to query.
wPointer to variable for storing the width, in screen coordinates. May be NULL.
hPointer 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 2031 of file SDL_video.c.

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

Referenced by SDL_GL_GetDrawableSize(), and SDL_Vulkan_GetDrawableSize().

2032 {
2033  CHECK_WINDOW_MAGIC(window,);
2034  if (w) {
2035  *w = window->w;
2036  }
2037  if (h) {
2038  *h = window->h;
2039  }
2040 }
GLfloat GLfloat GLfloat GLfloat h
GLubyte GLubyte GLubyte GLubyte w
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ 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 2293 of file SDL_video.c.

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

2294 {
2295  CHECK_WINDOW_MAGIC(window, NULL);
2296 
2297  if (!window->surface_valid) {
2298  if (window->surface) {
2299  window->surface->flags &= ~SDL_DONTFREE;
2300  SDL_FreeSurface(window->surface);
2301  }
2302  window->surface = SDL_CreateWindowFramebuffer(window);
2303  if (window->surface) {
2304  window->surface_valid = SDL_TRUE;
2305  window->surface->flags |= SDL_DONTFREE;
2306  }
2307  }
2308  return window->surface;
2309 }
#define SDL_DONTFREE
Definition: SDL_surface.h:55
Uint32 flags
Definition: SDL_surface.h:71
#define SDL_FreeSurface
#define NULL
Definition: begin_code.h:164
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
SDL_bool surface_valid
Definition: SDL_sysvideo.h:98
SDL_Surface * surface
Definition: SDL_sysvideo.h:97
static SDL_Surface * SDL_CreateWindowFramebuffer(SDL_Window *window)
Definition: SDL_video.c:2269

◆ 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 1762 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, and SDL_Window::title.

1763 {
1764  CHECK_WINDOW_MAGIC(window, "");
1765 
1766  return window->title ? window->title : "";
1767 }
char * title
Definition: SDL_sysvideo.h:77
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ 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 3468 of file SDL_video.c.

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

Referenced by ShouldUseTextureFramebuffer().

3469 {
3471  CHECK_WINDOW_MAGIC(window, NULL);
3472 
3473  if (!(window->flags & SDL_WINDOW_OPENGL)) {
3474  SDL_SetError("The specified window isn't an OpenGL window");
3475  return NULL;
3476  }
3477 
3478  ctx = _this->GL_CreateContext(_this, window);
3479 
3480  /* Creating a context is assumed to make it current in the SDL driver. */
3481  if (ctx) {
3483  _this->current_glctx = ctx;
3486  }
3487  return ctx;
3488 }
#define SDL_TLSSet
SDL_TLSID current_glwin_tls
Definition: SDL_sysvideo.h:365
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
void * SDL_GLContext
An opaque handle to an OpenGL context.
Definition: SDL_video.h:193
SDL_GLContext current_glctx
Definition: SDL_sysvideo.h:364
SDL_GLContext(* GL_CreateContext)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:258
#define NULL
Definition: begin_code.h:164
#define SDL_SetError
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_TLSID current_glctx_tls
Definition: SDL_sysvideo.h:366
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83
SDL_Window * current_glwin
Definition: SDL_sysvideo.h:363
EGLContext ctx
Definition: eglext.h:208

◆ SDL_GL_DeleteContext()

void SDL_GL_DeleteContext ( SDL_GLContext  context)

Delete an OpenGL context.

See also
SDL_GL_CreateContext()

Definition at line 3599 of file SDL_video.c.

References SDL_PixelFormat::Amask, SDL_PixelFormat::BytesPerPixel, SDL_Surface::flags, SDL_Surface::format, SDL_VideoDevice::GL_DeleteContext, SDL_Surface::h, NULL, SDL_Surface::pitch, SDL_Surface::pixels, SDL_free, SDL_GL_GetCurrentContext(), SDL_GL_MakeCurrent(), SDL_malloc, SDL_memset, and SDL_Surface::w.

Referenced by ShouldUseTextureFramebuffer().

3600 {
3601  if (!_this || !context) {
3602  return;
3603  }
3604 
3605  if (SDL_GL_GetCurrentContext() == context) {
3607  }
3608 
3610 }
static screen_context_t context
Definition: video.c:25
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
int SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext ctx)
Set up an OpenGL context for rendering into an OpenGL window.
Definition: SDL_video.c:3491
#define NULL
Definition: begin_code.h:164
SDL_GLContext SDL_GL_GetCurrentContext(void)
Get the currently active OpenGL context.
Definition: SDL_video.c:3532
void(* GL_DeleteContext)(_THIS, SDL_GLContext context)
Definition: SDL_sysvideo.h:264

◆ 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 2929 of file SDL_video.c.

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

Referenced by SDL_GL_DeduceMaxSupportedESProfile().

2930 {
2931 #if SDL_VIDEO_OPENGL || SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
2932  const GLubyte *(APIENTRY * glGetStringFunc) (GLenum);
2933  const char *extensions;
2934  const char *start;
2935  const char *where, *terminator;
2936 
2937  /* Extension names should not have spaces. */
2938  where = SDL_strchr(extension, ' ');
2939  if (where || *extension == '\0') {
2940  return SDL_FALSE;
2941  }
2942  /* See if there's an environment variable override */
2943  start = SDL_getenv(extension);
2944  if (start && *start == '0') {
2945  return SDL_FALSE;
2946  }
2947 
2948  /* Lookup the available extensions */
2949 
2950  glGetStringFunc = SDL_GL_GetProcAddress("glGetString");
2951  if (!glGetStringFunc) {
2952  return SDL_FALSE;
2953  }
2954 
2955  if (isAtLeastGL3((const char *) glGetStringFunc(GL_VERSION))) {
2956  const GLubyte *(APIENTRY * glGetStringiFunc) (GLenum, GLuint);
2957  void (APIENTRY * glGetIntegervFunc) (GLenum pname, GLint * params);
2958  GLint num_exts = 0;
2959  GLint i;
2960 
2961  glGetStringiFunc = SDL_GL_GetProcAddress("glGetStringi");
2962  glGetIntegervFunc = SDL_GL_GetProcAddress("glGetIntegerv");
2963  if ((!glGetStringiFunc) || (!glGetIntegervFunc)) {
2964  return SDL_FALSE;
2965  }
2966 
2967  #ifndef GL_NUM_EXTENSIONS
2968  #define GL_NUM_EXTENSIONS 0x821D
2969  #endif
2970  glGetIntegervFunc(GL_NUM_EXTENSIONS, &num_exts);
2971  for (i = 0; i < num_exts; i++) {
2972  const char *thisext = (const char *) glGetStringiFunc(GL_EXTENSIONS, i);
2973  if (SDL_strcmp(thisext, extension) == 0) {
2974  return SDL_TRUE;
2975  }
2976  }
2977 
2978  return SDL_FALSE;
2979  }
2980 
2981  /* Try the old way with glGetString(GL_EXTENSIONS) ... */
2982 
2983  extensions = (const char *) glGetStringFunc(GL_EXTENSIONS);
2984  if (!extensions) {
2985  return SDL_FALSE;
2986  }
2987  /*
2988  * It takes a bit of care to be fool-proof about parsing the OpenGL
2989  * extensions string. Don't be fooled by sub-strings, etc.
2990  */
2991 
2992  start = extensions;
2993 
2994  for (;;) {
2995  where = SDL_strstr(start, extension);
2996  if (!where)
2997  break;
2998 
2999  terminator = where + SDL_strlen(extension);
3000  if (where == extensions || *(where - 1) == ' ')
3001  if (*terminator == ' ' || *terminator == '\0')
3002  return SDL_TRUE;
3003 
3004  start = terminator;
3005  }
3006  return SDL_FALSE;
3007 #else
3008  return SDL_FALSE;
3009 #endif
3010 }
#define APIENTRY
Definition: SDL_opengl.h:139
int GLint
Definition: SDL_opengl.h:182
#define GL_EXTENSIONS
Definition: SDL_opengl.h:716
GLuint start
Definition: SDL_opengl.h:1571
#define GL_VERSION
Definition: SDL_opengl.h:715
#define SDL_strchr
#define GL_NUM_EXTENSIONS
static SDL_INLINE SDL_bool isAtLeastGL3(const char *verstr)
Definition: SDL_video.c:2922
unsigned char GLubyte
Definition: SDL_opengl.h:183
#define SDL_getenv
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
unsigned int GLenum
Definition: SDL_opengl.h:176
unsigned int GLuint
Definition: SDL_opengl.h:185
#define SDL_strlen
SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const char return SDL_ThreadFunction const char void return Uint32 return Uint32 void
const GLfloat * params
void * SDL_GL_GetProcAddress(const char *proc)
Get the address of an OpenGL function.
Definition: SDL_video.c:2882
#define SDL_strcmp
GLenum pname
#define SDL_strstr

◆ 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 3219 of file SDL_video.c.

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

3220 {
3221 #if SDL_VIDEO_OPENGL || SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
3222  GLenum (APIENTRY *glGetErrorFunc) (void);
3223  GLenum attrib = 0;
3224  GLenum error = 0;
3225 
3226  /*
3227  * Some queries in Core Profile desktop OpenGL 3+ contexts require
3228  * glGetFramebufferAttachmentParameteriv instead of glGetIntegerv. Note that
3229  * the enums we use for the former function don't exist in OpenGL ES 2, and
3230  * the function itself doesn't exist prior to OpenGL 3 and OpenGL ES 2.
3231  */
3232 #if SDL_VIDEO_OPENGL
3233  const GLubyte *(APIENTRY *glGetStringFunc) (GLenum name);
3234  void (APIENTRY *glGetFramebufferAttachmentParameterivFunc) (GLenum target, GLenum attachment, GLenum pname, GLint* params);
3235  GLenum attachment = GL_BACK_LEFT;
3236  GLenum attachmentattrib = 0;
3237 #endif
3238 
3239  if (!value) {
3240  return SDL_InvalidParamError("value");
3241  }
3242 
3243  /* Clear value in any case */
3244  *value = 0;
3245 
3246  if (!_this) {
3247  return SDL_UninitializedVideo();
3248  }
3249 
3250  switch (attr) {
3251  case SDL_GL_RED_SIZE:
3252 #if SDL_VIDEO_OPENGL
3253  attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_RED_SIZE;
3254 #endif
3255  attrib = GL_RED_BITS;
3256  break;
3257  case SDL_GL_BLUE_SIZE:
3258 #if SDL_VIDEO_OPENGL
3259  attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_BLUE_SIZE;
3260 #endif
3261  attrib = GL_BLUE_BITS;
3262  break;
3263  case SDL_GL_GREEN_SIZE:
3264 #if SDL_VIDEO_OPENGL
3265  attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_GREEN_SIZE;
3266 #endif
3267  attrib = GL_GREEN_BITS;
3268  break;
3269  case SDL_GL_ALPHA_SIZE:
3270 #if SDL_VIDEO_OPENGL
3271  attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE;
3272 #endif
3273  attrib = GL_ALPHA_BITS;
3274  break;
3275  case SDL_GL_DOUBLEBUFFER:
3276 #if SDL_VIDEO_OPENGL
3277  attrib = GL_DOUBLEBUFFER;
3278  break;
3279 #else
3280  /* OpenGL ES 1.0 and above specifications have EGL_SINGLE_BUFFER */
3281  /* parameter which switches double buffer to single buffer. OpenGL ES */
3282  /* SDL driver must set proper value after initialization */
3284  return 0;
3285 #endif
3286  case SDL_GL_DEPTH_SIZE:
3287 #if SDL_VIDEO_OPENGL
3288  attachment = GL_DEPTH;
3289  attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE;
3290 #endif
3291  attrib = GL_DEPTH_BITS;
3292  break;
3293  case SDL_GL_STENCIL_SIZE:
3294 #if SDL_VIDEO_OPENGL
3295  attachment = GL_STENCIL;
3296  attachmentattrib = GL_FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE;
3297 #endif
3298  attrib = GL_STENCIL_BITS;
3299  break;
3300 #if SDL_VIDEO_OPENGL
3301  case SDL_GL_ACCUM_RED_SIZE:
3302  attrib = GL_ACCUM_RED_BITS;
3303  break;
3305  attrib = GL_ACCUM_GREEN_BITS;
3306  break;
3308  attrib = GL_ACCUM_BLUE_BITS;
3309  break;
3311  attrib = GL_ACCUM_ALPHA_BITS;
3312  break;
3313  case SDL_GL_STEREO:
3314  attrib = GL_STEREO;
3315  break;
3316 #else
3317  case SDL_GL_ACCUM_RED_SIZE:
3321  case SDL_GL_STEREO:
3322  /* none of these are supported in OpenGL ES */
3323  *value = 0;
3324  return 0;
3325 #endif
3327  attrib = GL_SAMPLE_BUFFERS;
3328  break;
3330  attrib = GL_SAMPLES;
3331  break;
3333 #if SDL_VIDEO_OPENGL
3334  attrib = GL_CONTEXT_RELEASE_BEHAVIOR;
3335 #else
3337 #endif
3338  break;
3339  case SDL_GL_BUFFER_SIZE:
3340  {
3341  int rsize = 0, gsize = 0, bsize = 0, asize = 0;
3342 
3343  /* There doesn't seem to be a single flag in OpenGL for this! */
3344  if (SDL_GL_GetAttribute(SDL_GL_RED_SIZE, &rsize) < 0) {
3345  return -1;
3346  }
3347  if (SDL_GL_GetAttribute(SDL_GL_GREEN_SIZE, &gsize) < 0) {
3348  return -1;
3349  }
3350  if (SDL_GL_GetAttribute(SDL_GL_BLUE_SIZE, &bsize) < 0) {
3351  return -1;
3352  }
3353  if (SDL_GL_GetAttribute(SDL_GL_ALPHA_SIZE, &asize) < 0) {
3354  return -1;
3355  }
3356 
3357  *value = rsize + gsize + bsize + asize;
3358  return 0;
3359  }
3361  {
3362  /* FIXME: How do we get this information? */
3363  *value = (_this->gl_config.accelerated != 0);
3364  return 0;
3365  }
3367  {
3369  return 0;
3370  }
3372  {
3374  return 0;
3375  }
3377  {
3379  return 0;
3380  }
3381  case SDL_GL_CONTEXT_EGL:
3382  /* FIXME: SDL_GL_CONTEXT_EGL to be deprecated in SDL 2.1 */
3383  {
3385  *value = 1;
3386  }
3387  else {
3388  *value = 0;
3389  }
3390  return 0;
3391  }
3392  case SDL_GL_CONTEXT_FLAGS:
3393  {
3394  *value = _this->gl_config.flags;
3395  return 0;
3396  }
3398  {
3400  return 0;
3401  }
3403  {
3405  return 0;
3406  }
3408  {
3410  return 0;
3411  }
3413  {
3415  return 0;
3416  }
3417  default:
3418  return SDL_SetError("Unknown OpenGL attribute");
3419  }
3420 
3421 #if SDL_VIDEO_OPENGL
3422  glGetStringFunc = SDL_GL_GetProcAddress("glGetString");
3423  if (!glGetStringFunc) {
3424  return -1;
3425  }
3426 
3427  if (attachmentattrib && isAtLeastGL3((const char *) glGetStringFunc(GL_VERSION))) {
3428  glGetFramebufferAttachmentParameterivFunc = SDL_GL_GetProcAddress("glGetFramebufferAttachmentParameteriv");
3429 
3430  if (glGetFramebufferAttachmentParameterivFunc) {
3431  glGetFramebufferAttachmentParameterivFunc(GL_FRAMEBUFFER, attachment, attachmentattrib, (GLint *) value);
3432  } else {
3433  return -1;
3434  }
3435  } else
3436 #endif
3437  {
3438  void (APIENTRY *glGetIntegervFunc) (GLenum pname, GLint * params);
3439  glGetIntegervFunc = SDL_GL_GetProcAddress("glGetIntegerv");
3440  if (glGetIntegervFunc) {
3441  glGetIntegervFunc(attrib, (GLint *) value);
3442  } else {
3443  return -1;
3444  }
3445  }
3446 
3447  glGetErrorFunc = SDL_GL_GetProcAddress("glGetError");
3448  if (!glGetErrorFunc) {
3449  return -1;
3450  }
3451 
3452  error = glGetErrorFunc();
3453  if (error != GL_NO_ERROR) {
3454  if (error == GL_INVALID_ENUM) {
3455  return SDL_SetError("OpenGL error: GL_INVALID_ENUM");
3456  } else if (error == GL_INVALID_VALUE) {
3457  return SDL_SetError("OpenGL error: GL_INVALID_VALUE");
3458  }
3459  return SDL_SetError("OpenGL error: %08X", error);
3460  }
3461  return 0;
3462 #else
3463  return SDL_Unsupported();
3464 #endif /* SDL_VIDEO_OPENGL */
3465 }
#define GL_STENCIL_BITS
Definition: SDL_opengl.h:474
#define GL_INVALID_ENUM
Definition: SDL_opengl.h:720
#define GL_SAMPLE_BUFFERS
Definition: SDL_opengl.h:1839
#define GL_BACK_LEFT
Definition: SDL_opengl.h:499
#define GL_DOUBLEBUFFER
Definition: SDL_opengl.h:521
#define APIENTRY
Definition: SDL_opengl.h:139
#define GL_RED_BITS
Definition: SDL_opengl.h:513
int GLint
Definition: SDL_opengl.h:182
#define GL_CONTEXT_RELEASE_BEHAVIOR
#define GL_FRAMEBUFFER_ATTACHMENT_RED_SIZE
#define GL_FRAMEBUFFER_ATTACHMENT_BLUE_SIZE
#define GL_SAMPLES
Definition: SDL_opengl.h:1840
#define GL_DEPTH_BITS
Definition: SDL_opengl.h:328
#define GL_VERSION
Definition: SDL_opengl.h:715
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
#define GL_FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE
#define GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE
#define GL_ACCUM_ALPHA_BITS
Definition: SDL_opengl.h:383
#define GL_FRAMEBUFFER
GLuint const GLchar * name
#define GL_NO_ERROR
Definition: SDL_opengl.h:719
struct SDL_VideoDevice::@33 gl_config
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define GL_BLUE_BITS
Definition: SDL_opengl.h:515
static SDL_INLINE SDL_bool isAtLeastGL3(const char *verstr)
Definition: SDL_video.c:2922
#define GL_STENCIL
Definition: SDL_opengl.h:526
#define GL_ALPHA_BITS
Definition: SDL_opengl.h:512
GLsizei const GLfloat * value
#define GL_DEPTH
Definition: SDL_opengl.h:525
#define GL_ACCUM_RED_BITS
Definition: SDL_opengl.h:380
#define GL_INVALID_VALUE
Definition: SDL_opengl.h:721
int framebuffer_srgb_capable
Definition: SDL_sysvideo.h:350
unsigned char GLubyte
Definition: SDL_opengl.h:183
#define GL_CONTEXT_RELEASE_BEHAVIOR_KHR
Definition: gl2ext.h:83
#define GL_ACCUM_GREEN_BITS
Definition: SDL_opengl.h:381
#define GL_STEREO
Definition: SDL_opengl.h:522
int share_with_current_context
Definition: SDL_sysvideo.h:347
GLenum target
unsigned int GLenum
Definition: SDL_opengl.h:176
#define SDL_SetError
#define GL_ACCUM_BLUE_BITS
Definition: SDL_opengl.h:382
SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const char return SDL_ThreadFunction const char void return Uint32 return Uint32 void
GLenum attachment
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440
const GLfloat * params
void * SDL_GL_GetProcAddress(const char *proc)
Get the address of an OpenGL function.
Definition: SDL_video.c:2882
#define GL_FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE
int SDL_GL_GetAttribute(SDL_GLattr attr, int *value)
Get the actual value for an attribute from the current context.
Definition: SDL_video.c:3219
#define GL_GREEN_BITS
Definition: SDL_opengl.h:514
GLenum pname
#define SDL_Unsupported()
Definition: SDL_error.h:53
#define GL_FRAMEBUFFER_ATTACHMENT_GREEN_SIZE

◆ SDL_GL_GetCurrentContext()

SDL_GLContext SDL_GL_GetCurrentContext ( void  )

Get the currently active OpenGL context.

Definition at line 3532 of file SDL_video.c.

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

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

3533 {
3534  if (!_this) {
3536  return NULL;
3537  }
3539 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
void * SDL_GLContext
An opaque handle to an OpenGL context.
Definition: SDL_video.h:193
#define SDL_TLSGet
#define NULL
Definition: begin_code.h:164
SDL_TLSID current_glctx_tls
Definition: SDL_sysvideo.h:366
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440

◆ SDL_GL_GetCurrentWindow()

SDL_Window* SDL_GL_GetCurrentWindow ( void  )

Get the currently active OpenGL window.

Definition at line 3522 of file SDL_video.c.

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

Referenced by SDL_GL_MakeCurrent(), and SDL_GL_SwapWindow().

3523 {
3524  if (!_this) {
3526  return NULL;
3527  }
3529 }
SDL_TLSID current_glwin_tls
Definition: SDL_sysvideo.h:365
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_TLSGet
#define NULL
Definition: begin_code.h:164
The type used to identify a window.
Definition: SDL_sysvideo.h:73
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440

◆ 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
windowWindow from which the drawable size should be queried
wPointer to variable for storing the width in pixels, may be NULL
hPointer 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 3541 of file SDL_video.c.

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

3542 {
3543  CHECK_WINDOW_MAGIC(window,);
3544 
3545  if (_this->GL_GetDrawableSize) {
3546  _this->GL_GetDrawableSize(_this, window, w, h);
3547  } else {
3548  SDL_GetWindowSize(window, w, h);
3549  }
3550 }
GLfloat GLfloat GLfloat GLfloat h
void(* GL_GetDrawableSize)(_THIS, SDL_Window *window, int *w, int *h)
Definition: SDL_sysvideo.h:260
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
GLubyte GLubyte GLubyte GLubyte w
void SDL_GetWindowSize(SDL_Window *window, int *w, int *h)
Get the size of a window&#39;s client area.
Definition: SDL_video.c:2031
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ SDL_GL_GetProcAddress()

void* SDL_GL_GetProcAddress ( const char *  proc)

Get the address of an OpenGL function.

Definition at line 2882 of file SDL_video.c.

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

2883 {
2884  void *func;
2885 
2886  if (!_this) {
2888  return NULL;
2889  }
2890  func = NULL;
2891  if (_this->GL_GetProcAddress) {
2892  if (_this->gl_config.driver_loaded) {
2893  func = _this->GL_GetProcAddress(_this, proc);
2894  } else {
2895  SDL_SetError("No GL driver has been loaded");
2896  }
2897  } else {
2898  SDL_SetError("No dynamic GL support in current SDL video driver (%s)", _this->name);
2899  }
2900  return func;
2901 }
const char * name
Definition: SDL_sysvideo.h:152
struct SDL_VideoDevice::@33 gl_config
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define NULL
Definition: begin_code.h:164
#define SDL_SetError
GLenum func
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440
void *(* GL_GetProcAddress)(_THIS, const char *proc)
Definition: SDL_sysvideo.h:256

◆ 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 3567 of file SDL_video.c.

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

3568 {
3569  if (!_this) {
3570  return 0;
3571  } else if (SDL_GL_GetCurrentContext() == NULL) {
3572  return 0;
3573  } else if (_this->GL_GetSwapInterval) {
3574  return _this->GL_GetSwapInterval(_this);
3575  } else {
3576  return 0;
3577  }
3578 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define NULL
Definition: begin_code.h:164
SDL_GLContext SDL_GL_GetCurrentContext(void)
Get the currently active OpenGL context.
Definition: SDL_video.c:3532
int(* GL_GetSwapInterval)(_THIS)
Definition: SDL_sysvideo.h:262

◆ SDL_GL_LoadLibrary()

int SDL_GL_LoadLibrary ( const char *  path)

Dynamically load an OpenGL library.

Parameters
pathThe platform dependent OpenGL library name, or NULL to open the default OpenGL library.
Returns
0 on success, or -1 if the library couldn't be loaded.

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

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

Definition at line 2853 of file SDL_video.c.

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

2854 {
2855  int retval;
2856 
2857  if (!_this) {
2858  return SDL_UninitializedVideo();
2859  }
2860  if (_this->gl_config.driver_loaded) {
2861  if (path && SDL_strcmp(path, _this->gl_config.driver_path) != 0) {
2862  return SDL_SetError("OpenGL library already loaded");
2863  }
2864  retval = 0;
2865  } else {
2866  if (!_this->GL_LoadLibrary) {
2867  return SDL_SetError("No dynamic GL support in current SDL video driver (%s)", _this->name);
2868  }
2869  retval = _this->GL_LoadLibrary(_this, path);
2870  }
2871  if (retval == 0) {
2873  } else {
2874  if (_this->GL_UnloadLibrary) {
2876  }
2877  }
2878  return (retval);
2879 }
const char * name
Definition: SDL_sysvideo.h:152
int(* GL_LoadLibrary)(_THIS, const char *path)
Definition: SDL_sysvideo.h:255
struct SDL_VideoDevice::@33 gl_config
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_bool retval
char driver_path[256]
Definition: SDL_sysvideo.h:354
void(* GL_UnloadLibrary)(_THIS)
Definition: SDL_sysvideo.h:257
#define SDL_SetError
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440
GLsizei const GLchar *const * path
#define SDL_strcmp

◆ 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 3491 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_VideoDevice::current_glctx, SDL_VideoDevice::current_glctx_tls, SDL_VideoDevice::current_glwin, SDL_VideoDevice::current_glwin_tls, SDL_Window::flags, 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().

3492 {
3493  int retval;
3494 
3495  if (window == SDL_GL_GetCurrentWindow() &&
3497  /* We're already current. */
3498  return 0;
3499  }
3500 
3501  if (!ctx) {
3502  window = NULL;
3503  } else {
3504  CHECK_WINDOW_MAGIC(window, -1);
3505 
3506  if (!(window->flags & SDL_WINDOW_OPENGL)) {
3507  return SDL_SetError("The specified window isn't an OpenGL window");
3508  }
3509  }
3510 
3511  retval = _this->GL_MakeCurrent(_this, window, ctx);
3512  if (retval == 0) {
3514  _this->current_glctx = ctx;
3517  }
3518  return retval;
3519 }
#define SDL_TLSSet
SDL_TLSID current_glwin_tls
Definition: SDL_sysvideo.h:365
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_bool retval
SDL_GLContext current_glctx
Definition: SDL_sysvideo.h:364
int(* GL_MakeCurrent)(_THIS, SDL_Window *window, SDL_GLContext context)
Definition: SDL_sysvideo.h:259
#define NULL
Definition: begin_code.h:164
#define SDL_SetError
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_TLSID current_glctx_tls
Definition: SDL_sysvideo.h:366
SDL_GLContext SDL_GL_GetCurrentContext(void)
Get the currently active OpenGL context.
Definition: SDL_video.c:3532
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83
SDL_Window * SDL_GL_GetCurrentWindow(void)
Get the currently active OpenGL window.
Definition: SDL_video.c:3522
SDL_Window * current_glwin
Definition: SDL_sysvideo.h:363
EGLContext ctx
Definition: eglext.h:208

◆ SDL_GL_ResetAttributes()

void SDL_GL_ResetAttributes ( void  )

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

Definition at line 3044 of file SDL_video.c.

References SDL_VideoDevice::accelerated, SDL_VideoDevice::accum_alpha_size, SDL_VideoDevice::accum_blue_size, SDL_VideoDevice::accum_green_size, SDL_VideoDevice::accum_red_size, SDL_VideoDevice::alpha_size, SDL_VideoDevice::blue_size, SDL_VideoDevice::buffer_size, SDL_VideoDevice::depth_size, SDL_VideoDevice::double_buffer, SDL_VideoDevice::flags, SDL_VideoDevice::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().

3045 {
3046  if (!_this) {
3047  return;
3048  }
3049 
3050  _this->gl_config.red_size = 3;
3051  _this->gl_config.green_size = 3;
3052  _this->gl_config.blue_size = 2;
3053  _this->gl_config.alpha_size = 0;
3055  _this->gl_config.depth_size = 16;
3062  _this->gl_config.stereo = 0;
3066  _this->gl_config.accelerated = -1; /* accelerated or not, both are fine */
3067 
3072  } else {
3073 #if SDL_VIDEO_OPENGL
3077 #elif SDL_VIDEO_OPENGL_ES2
3081 #elif SDL_VIDEO_OPENGL_ES
3085 #endif
3086  }
3087 
3088  _this->gl_config.flags = 0;
3090  _this->gl_config.no_error = 0;
3093 
3095 }
struct SDL_VideoDevice::@33 gl_config
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
int framebuffer_srgb_capable
Definition: SDL_sysvideo.h:350
int share_with_current_context
Definition: SDL_sysvideo.h:347
void(* GL_DefaultProfileConfig)(_THIS, int *mask, int *major, int *minor)
Definition: SDL_sysvideo.h:265

◆ 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 3098 of file SDL_video.c.

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

3099 {
3100 #if SDL_VIDEO_OPENGL || SDL_VIDEO_OPENGL_ES || SDL_VIDEO_OPENGL_ES2
3101  int retval;
3102 
3103  if (!_this) {
3104  return SDL_UninitializedVideo();
3105  }
3106  retval = 0;
3107  switch (attr) {
3108  case SDL_GL_RED_SIZE:
3110  break;
3111  case SDL_GL_GREEN_SIZE:
3113  break;
3114  case SDL_GL_BLUE_SIZE:
3116  break;
3117  case SDL_GL_ALPHA_SIZE:
3119  break;
3120  case SDL_GL_DOUBLEBUFFER:
3122  break;
3123  case SDL_GL_BUFFER_SIZE:
3125  break;
3126  case SDL_GL_DEPTH_SIZE:
3128  break;
3129  case SDL_GL_STENCIL_SIZE:
3131  break;
3132  case SDL_GL_ACCUM_RED_SIZE:
3134  break;
3137  break;
3140  break;
3143  break;
3144  case SDL_GL_STEREO:
3146  break;
3149  break;
3152  break;
3155  break;
3158  break;
3161  break;
3164  break;
3165  case SDL_GL_CONTEXT_EGL:
3166  /* FIXME: SDL_GL_CONTEXT_EGL to be deprecated in SDL 2.1 */
3167  if (value != 0) {
3169  } else {
3171  };
3172  break;
3173  case SDL_GL_CONTEXT_FLAGS:
3178  retval = SDL_SetError("Unknown OpenGL context flag %d", value);
3179  break;
3180  }
3182  break;
3184  if (value != 0 &&
3188  retval = SDL_SetError("Unknown OpenGL context profile %d", value);
3189  break;
3190  }
3192  break;
3195  break;
3198  break;
3201  break;
3204  break;
3207  break;
3208  default:
3209  retval = SDL_SetError("Unknown OpenGL attribute");
3210  break;
3211  }
3212  return retval;
3213 #else
3214  return SDL_Unsupported();
3215 #endif /* SDL_VIDEO_OPENGL */
3216 }
struct SDL_VideoDevice::@33 gl_config
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_bool retval
GLsizei const GLfloat * value
int framebuffer_srgb_capable
Definition: SDL_sysvideo.h:350
int share_with_current_context
Definition: SDL_sysvideo.h:347
#define SDL_SetError
int SDL_GL_SetAttribute(SDL_GLattr attr, int value)
Set an OpenGL window attribute before window creation.
Definition: SDL_video.c:3098
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440
#define SDL_Unsupported()
Definition: SDL_error.h:53

◆ SDL_GL_SetSwapInterval()

int SDL_GL_SetSwapInterval ( int  interval)

Set the swap interval for the current OpenGL context.

Parameters
interval0 for immediate updates, 1 for updates synchronized with the vertical retrace. If the system supports it, you may specify -1 to allow late swaps to happen immediately instead of waiting for the next retrace.
Returns
0 on success, or -1 if setting the swap interval is not supported.
See also
SDL_GL_GetSwapInterval()

Definition at line 3553 of file SDL_video.c.

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

3554 {
3555  if (!_this) {
3556  return SDL_UninitializedVideo();
3557  } else if (SDL_GL_GetCurrentContext() == NULL) {
3558  return SDL_SetError("No OpenGL context has been made current");
3559  } else if (_this->GL_SetSwapInterval) {
3560  return _this->GL_SetSwapInterval(_this, interval);
3561  } else {
3562  return SDL_SetError("Setting the swap interval is not supported");
3563  }
3564 }
int(* GL_SetSwapInterval)(_THIS, int interval)
Definition: SDL_sysvideo.h:261
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define NULL
Definition: begin_code.h:164
#define SDL_SetError
SDL_GLContext SDL_GL_GetCurrentContext(void)
Get the currently active OpenGL context.
Definition: SDL_video.c:3532
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440

◆ 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 3581 of file SDL_video.c.

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

3582 {
3583  CHECK_WINDOW_MAGIC(window,);
3584 
3585  if (!(window->flags & SDL_WINDOW_OPENGL)) {
3586  SDL_SetError("The specified window isn't an OpenGL window");
3587  return;
3588  }
3589 
3590  if (SDL_GL_GetCurrentWindow() != window) {
3591  SDL_SetError("The specified window has not been made current");
3592  return;
3593  }
3594 
3595  _this->GL_SwapWindow(_this, window);
3596 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_SetError
int(* GL_SwapWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:263
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83
SDL_Window * SDL_GL_GetCurrentWindow(void)
Get the currently active OpenGL window.
Definition: SDL_video.c:3522

◆ 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 2904 of file SDL_video.c.

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

Referenced by SDL_DestroyWindow(), and SDL_RecreateWindow().

2905 {
2906  if (!_this) {
2908  return;
2909  }
2910  if (_this->gl_config.driver_loaded > 0) {
2911  if (--_this->gl_config.driver_loaded > 0) {
2912  return;
2913  }
2914  if (_this->GL_UnloadLibrary) {
2916  }
2917  }
2918 }
struct SDL_VideoDevice::@33 gl_config
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
void(* GL_UnloadLibrary)(_THIS)
Definition: SDL_sysvideo.h:257
static int SDL_UninitializedVideo()
Definition: SDL_video.c:440

◆ SDL_HideWindow()

void SDL_HideWindow ( SDL_Window window)

Hide a window.

See also
SDL_ShowWindow()

Definition at line 2165 of file SDL_video.c.

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

Referenced by SDL_DestroyWindow(), and SDL_RecreateWindow().

2166 {
2167  CHECK_WINDOW_MAGIC(window,);
2168 
2169  if (!(window->flags & SDL_WINDOW_SHOWN)) {
2170  return;
2171  }
2172 
2173  window->is_hiding = SDL_TRUE;
2175 
2176  if (_this->HideWindow) {
2177  _this->HideWindow(_this, window);
2178  }
2179  window->is_hiding = SDL_FALSE;
2181 }
int SDL_SendWindowEvent(SDL_Window *window, Uint8 windowevent, int data1, int data2)
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
void(* HideWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:224
static int SDL_UpdateFullscreenMode(SDL_Window *window, SDL_bool fullscreen)
Definition: SDL_video.c:1186
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83
SDL_bool is_hiding
Definition: SDL_sysvideo.h:100

◆ 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 2764 of file SDL_video.c.

References SDL_FALSE, SDL_TRUE, and SDL_VideoDevice::suspend_screensaver.

2765 {
2766  if (!_this) {
2767  return SDL_TRUE;
2768  }
2770 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_bool suspend_screensaver
Definition: SDL_sysvideo.h:314

◆ SDL_MaximizeWindow()

void SDL_MaximizeWindow ( SDL_Window window)

Make a window as large as possible.

See also
SDL_RestoreWindow()

Definition at line 2197 of file SDL_video.c.

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

Referenced by SDL_FinishWindowCreation().

2198 {
2199  CHECK_WINDOW_MAGIC(window,);
2200 
2201  if (window->flags & SDL_WINDOW_MAXIMIZED) {
2202  return;
2203  }
2204 
2205  /* !!! FIXME: should this check if the window is resizable? */
2206 
2207  if (_this->MaximizeWindow) {
2208  _this->MaximizeWindow(_this, window);
2209  }
2210 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
void(* MaximizeWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:226
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ SDL_MinimizeWindow()

void SDL_MinimizeWindow ( SDL_Window window)

Minimize a window to an iconic representation.

See also
SDL_RestoreWindow()

Definition at line 2213 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_VideoDevice::MinimizeWindow, SDL_FALSE, SDL_UpdateFullscreenMode(), and SDL_WINDOW_MINIMIZED.

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

2214 {
2215  CHECK_WINDOW_MAGIC(window,);
2216 
2217  if (window->flags & SDL_WINDOW_MINIMIZED) {
2218  return;
2219  }
2220 
2222 
2223  if (_this->MinimizeWindow) {
2224  _this->MinimizeWindow(_this, window);
2225  }
2226 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
static int SDL_UpdateFullscreenMode(SDL_Window *window, SDL_bool fullscreen)
Definition: SDL_video.c:1186
void(* MinimizeWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:227
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ SDL_RaiseWindow()

void SDL_RaiseWindow ( SDL_Window window)

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

Definition at line 2184 of file SDL_video.c.

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

Referenced by SDL_ShowMessageBox().

2185 {
2186  CHECK_WINDOW_MAGIC(window,);
2187 
2188  if (!(window->flags & SDL_WINDOW_SHOWN)) {
2189  return;
2190  }
2191  if (_this->RaiseWindow) {
2192  _this->RaiseWindow(_this, window);
2193  }
2194 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
void(* RaiseWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:225
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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 2229 of file SDL_video.c.

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

2230 {
2231  CHECK_WINDOW_MAGIC(window,);
2232 
2233  if (!(window->flags & (SDL_WINDOW_MAXIMIZED | SDL_WINDOW_MINIMIZED))) {
2234  return;
2235  }
2236 
2237  if (_this->RestoreWindow) {
2238  _this->RestoreWindow(_this, window);
2239  }
2240 }
void(* RestoreWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:228
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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
windowThe window of which to change the border state.
borderedSDL_FALSE to remove border, SDL_TRUE to add border.
Note
You can't change the border state of a fullscreen window.
See also
SDL_GetWindowFlags()

Definition at line 1947 of file SDL_video.c.

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

1948 {
1949  CHECK_WINDOW_MAGIC(window,);
1950  if (!(window->flags & SDL_WINDOW_FULLSCREEN)) {
1951  const int want = (bordered != SDL_FALSE); /* normalize the flag. */
1952  const int have = ((window->flags & SDL_WINDOW_BORDERLESS) == 0);
1953  if ((want != have) && (_this->SetWindowBordered)) {
1954  if (want) {
1955  window->flags &= ~SDL_WINDOW_BORDERLESS;
1956  } else {
1957  window->flags |= SDL_WINDOW_BORDERLESS;
1958  }
1959  _this->SetWindowBordered(_this, window, (SDL_bool) want);
1960  }
1961  }
1962 }
void(* SetWindowBordered)(_THIS, SDL_Window *window, SDL_bool bordered)
Definition: SDL_sysvideo.h:229
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_bool
Definition: SDL_stdinc.h:161
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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 2339 of file SDL_video.c.

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

2340 {
2341  Uint16 ramp[256];
2342  int status;
2343 
2344  CHECK_WINDOW_MAGIC(window, -1);
2345 
2346  SDL_CalculateGammaRamp(brightness, ramp);
2347  status = SDL_SetWindowGammaRamp(window, ramp, ramp, ramp);
2348  if (status == 0) {
2349  window->brightness = brightness;
2350  }
2351  return status;
2352 }
uint16_t Uint16
Definition: SDL_stdinc.h:191
int SDL_SetWindowGammaRamp(SDL_Window *window, const Uint16 *red, const Uint16 *green, const Uint16 *blue)
Set the gamma ramp for a window.
Definition: SDL_video.c:2425
float brightness
Definition: SDL_sysvideo.h:93
#define SDL_CalculateGammaRamp
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ SDL_SetWindowData()

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

Associate an arbitrary named pointer with a window.

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

Definition at line 1792 of file SDL_video.c.

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

Referenced by SDL_CreateWindowTexture(), and SDL_DestroyWindowTexture().

1793 {
1794  SDL_WindowUserData *prev, *data;
1795 
1796  CHECK_WINDOW_MAGIC(window, NULL);
1797 
1798  /* Input validation */
1799  if (name == NULL || name[0] == '\0') {
1800  SDL_InvalidParamError("name");
1801  return NULL;
1802  }
1803 
1804  /* See if the named data already exists */
1805  prev = NULL;
1806  for (data = window->data; data; prev = data, data = data->next) {
1807  if (data->name && SDL_strcmp(data->name, name) == 0) {
1808  void *last_value = data->data;
1809 
1810  if (userdata) {
1811  /* Set the new value */
1812  data->data = userdata;
1813  } else {
1814  /* Delete this value */
1815  if (prev) {
1816  prev->next = data->next;
1817  } else {
1818  window->data = data->next;
1819  }
1820  SDL_free(data->name);
1821  SDL_free(data);
1822  }
1823  return last_value;
1824  }
1825  }
1826 
1827  /* Add new data to the window */
1828  if (userdata) {
1829  data = (SDL_WindowUserData *)SDL_malloc(sizeof(*data));
1830  data->name = SDL_strdup(name);
1831  data->data = userdata;
1832  data->next = window->data;
1833  window->data = data;
1834  }
1835  return NULL;
1836 }
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
GLuint const GLchar * name
struct SDL_WindowUserData * next
Definition: SDL_sysvideo.h:69
#define SDL_free
#define NULL
Definition: begin_code.h:164
#define SDL_strdup
#define SDL_malloc
#define SDL_strcmp
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
SDL_WindowUserData * data
Definition: SDL_sysvideo.h:109

◆ 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
windowThe window for which the display mode should be set.
modeThe mode to use, or NULL for the default mode.
Returns
0 on success, or -1 if setting the display mode failed.
See also
SDL_GetWindowDisplayMode()
SDL_SetWindowFullscreen()

Definition at line 1103 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_Window::fullscreen_mode, FULLSCREEN_VISIBLE, SDL_GetDisplayForWindow(), SDL_GetWindowDisplayMode(), SDL_SetDisplayModeForDisplay(), SDL_WINDOW_FULLSCREEN_DESKTOP, and SDL_zero.

1104 {
1105  CHECK_WINDOW_MAGIC(window, -1);
1106 
1107  if (mode) {
1108  window->fullscreen_mode = *mode;
1109  } else {
1110  SDL_zero(window->fullscreen_mode);
1111  }
1112 
1114  SDL_DisplayMode fullscreen_mode;
1115  if (SDL_GetWindowDisplayMode(window, &fullscreen_mode) == 0) {
1116  SDL_SetDisplayModeForDisplay(SDL_GetDisplayForWindow(window), &fullscreen_mode);
1117  }
1118  }
1119  return 0;
1120 }
SDL_DisplayMode fullscreen_mode
Definition: SDL_sysvideo.h:89
#define FULLSCREEN_VISIBLE(W)
Definition: SDL_sysvideo.h:116
The structure that defines a display mode.
Definition: SDL_video.h:53
int SDL_GetWindowDisplayMode(SDL_Window *window, SDL_DisplayMode *mode)
Fill in information about the display mode used when a fullscreen window is visible.
Definition: SDL_video.c:1123
SDL_VideoDisplay * SDL_GetDisplayForWindow(SDL_Window *window)
Definition: SDL_video.c:1092
GLenum mode
#define SDL_zero(x)
Definition: SDL_stdinc.h:416
static int SDL_SetDisplayModeForDisplay(SDL_VideoDisplay *display, const SDL_DisplayMode *mode)
Definition: SDL_video.c:975
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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 2243 of file SDL_video.c.

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

Referenced by SDL_FinishWindowCreation().

2244 {
2245  Uint32 oldflags;
2246  CHECK_WINDOW_MAGIC(window, -1);
2247 
2249 
2250  if (flags == (window->flags & FULLSCREEN_MASK)) {
2251  return 0;
2252  }
2253 
2254  /* clear the previous flags and OR in the new ones */
2255  oldflags = window->flags & FULLSCREEN_MASK;
2256  window->flags &= ~FULLSCREEN_MASK;
2257  window->flags |= flags;
2258 
2259  if (SDL_UpdateFullscreenMode(window, FULLSCREEN_VISIBLE(window)) == 0) {
2260  return 0;
2261  }
2262 
2263  window->flags &= ~FULLSCREEN_MASK;
2264  window->flags |= oldflags;
2265  return -1;
2266 }
#define FULLSCREEN_VISIBLE(W)
Definition: SDL_sysvideo.h:116
static int SDL_UpdateFullscreenMode(SDL_Window *window, SDL_bool fullscreen)
Definition: SDL_video.c:1186
GLbitfield flags
uint32_t Uint32
Definition: SDL_stdinc.h:203
#define FULLSCREEN_MASK
Definition: SDL_video.c:147
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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
windowThe window for which the gamma ramp should be set.
redThe translation table for the red channel, or NULL.
greenThe translation table for the green channel, or NULL.
blueThe translation table for the blue channel, or NULL.
Returns
0 on success, or -1 if gamma ramps are unsupported.

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

See also
SDL_GetWindowGammaRamp()

Definition at line 2425 of file SDL_video.c.

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

Referenced by SDL_SetWindowBrightness().

2428 {
2429  CHECK_WINDOW_MAGIC(window, -1);
2430 
2431  if (!_this->SetWindowGammaRamp) {
2432  return SDL_Unsupported();
2433  }
2434 
2435  if (!window->gamma) {
2436  if (SDL_GetWindowGammaRamp(window, NULL, NULL, NULL) < 0) {
2437  return -1;
2438  }
2439  SDL_assert(window->gamma != NULL);
2440  }
2441 
2442  if (red) {
2443  SDL_memcpy(&window->gamma[0*256], red, 256*sizeof(Uint16));
2444  }
2445  if (green) {
2446  SDL_memcpy(&window->gamma[1*256], green, 256*sizeof(Uint16));
2447  }
2448  if (blue) {
2449  SDL_memcpy(&window->gamma[2*256], blue, 256*sizeof(Uint16));
2450  }
2451  if (window->flags & SDL_WINDOW_INPUT_FOCUS) {
2452  return _this->SetWindowGammaRamp(_this, window, window->gamma);
2453  } else {
2454  return 0;
2455  }
2456 }
uint16_t Uint16
Definition: SDL_stdinc.h:191
GLbyte green
const GLubyte GLuint red
Definition: SDL_glfuncs.h:79
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_memcpy
#define SDL_assert(condition)
Definition: SDL_assert.h:169
#define NULL
Definition: begin_code.h:164
GLbyte GLbyte blue
int SDL_GetWindowGammaRamp(SDL_Window *window, Uint16 *red, Uint16 *green, Uint16 *blue)
Get the gamma ramp for a window.
Definition: SDL_video.c:2459
Uint16 * gamma
Definition: SDL_sysvideo.h:94
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83
int(* SetWindowGammaRamp)(_THIS, SDL_Window *window, const Uint16 *ramp)
Definition: SDL_sysvideo.h:232
#define SDL_Unsupported()
Definition: SDL_error.h:53

◆ SDL_SetWindowGrab()

void SDL_SetWindowGrab ( SDL_Window window,
SDL_bool  grabbed 
)

Set a window's input grab mode.

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

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 2535 of file SDL_video.c.

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

Referenced by SDL_FinishWindowCreation().

2536 {
2537  CHECK_WINDOW_MAGIC(window,);
2538 
2539  if (!!grabbed == !!(window->flags & SDL_WINDOW_INPUT_GRABBED)) {
2540  return;
2541  }
2542  if (grabbed) {
2543  window->flags |= SDL_WINDOW_INPUT_GRABBED;
2544  } else {
2545  window->flags &= ~SDL_WINDOW_INPUT_GRABBED;
2546  }
2547  SDL_UpdateWindowGrab(window);
2548 }
void SDL_UpdateWindowGrab(SDL_Window *window)
Definition: SDL_video.c:2504
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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
windowThe window to set hit-testing on.
callbackThe callback to call when doing a hit-test.
callback_dataAn app-defined void pointer passed to the callback.
Returns
0 on success, -1 on error (including unsupported).

Definition at line 3973 of file SDL_video.c.

References callback(), CHECK_WINDOW_MAGIC, SDL_Window::hit_test, SDL_Window::hit_test_data, NULL, SDL_Unsupported, and SDL_VideoDevice::SetWindowHitTest.

3974 {
3975  CHECK_WINDOW_MAGIC(window, -1);
3976 
3977  if (!_this->SetWindowHitTest) {
3978  return SDL_Unsupported();
3979  } else if (_this->SetWindowHitTest(window, callback != NULL) == -1) {
3980  return -1;
3981  }
3982 
3983  window->hit_test = callback;
3984  window->hit_test_data = userdata;
3985 
3986  return 0;
3987 }
int(* SetWindowHitTest)(SDL_Window *window, SDL_bool enabled)
Definition: SDL_sysvideo.h:306
void * hit_test_data
Definition: SDL_sysvideo.h:107
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
static Uint32 callback(Uint32 interval, void *param)
Definition: testtimer.c:34
#define NULL
Definition: begin_code.h:164
SDL_HitTest hit_test
Definition: SDL_sysvideo.h:106
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
#define SDL_Unsupported()
Definition: SDL_error.h:53

◆ SDL_SetWindowIcon()

void SDL_SetWindowIcon ( SDL_Window window,
SDL_Surface icon 
)

Set the icon for a window.

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

Definition at line 1770 of file SDL_video.c.

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

1771 {
1772  CHECK_WINDOW_MAGIC(window,);
1773 
1774  if (!icon) {
1775  return;
1776  }
1777 
1778  SDL_FreeSurface(window->icon);
1779 
1780  /* Convert the icon into ARGB8888 */
1782  if (!window->icon) {
1783  return;
1784  }
1785 
1786  if (_this->SetWindowIcon) {
1787  _this->SetWindowIcon(_this, window, window->icon);
1788  }
1789 }
#define SDL_ConvertSurfaceFormat
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_FreeSurface
void(* SetWindowIcon)(_THIS, SDL_Window *window, SDL_Surface *icon)
Definition: SDL_sysvideo.h:214
SDL_Surface * icon
Definition: SDL_sysvideo.h:78
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123

◆ 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
windowThe window that should get the input focus
Returns
0 on success, or -1 otherwise.
See also
SDL_RaiseWindow()

Definition at line 2412 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Unsupported, and SDL_VideoDevice::SetWindowInputFocus.

2413 {
2414  CHECK_WINDOW_MAGIC(window, -1);
2415 
2416  if (!_this->SetWindowInputFocus) {
2417  return SDL_Unsupported();
2418  }
2419 
2420  return _this->SetWindowInputFocus(_this, window);
2421 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
int(* SetWindowInputFocus)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:222
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
#define SDL_Unsupported()
Definition: SDL_error.h:53

◆ 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
windowThe window to set a new maximum size.
max_wThe maximum width of the window, must be >0
max_hThe maximum height of the window, must be >0
Note
You can't change the maximum size of a fullscreen window, it automatically matches the size of the display mode.
See also
SDL_GetWindowMaximumSize()
SDL_SetWindowMinimumSize()

Definition at line 2108 of file SDL_video.c.

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

2109 {
2110  CHECK_WINDOW_MAGIC(window,);
2111  if (max_w <= 0) {
2112  SDL_InvalidParamError("max_w");
2113  return;
2114  }
2115  if (max_h <= 0) {
2116  SDL_InvalidParamError("max_h");
2117  return;
2118  }
2119 
2120  if (max_w <= window->min_w || max_h <= window->min_h) {
2121  SDL_SetError("SDL_SetWindowMaximumSize(): Tried to set maximum size smaller than minimum size");
2122  return;
2123  }
2124 
2125  window->max_w = max_w;
2126  window->max_h = max_h;
2127 
2128  if (!(window->flags & SDL_WINDOW_FULLSCREEN)) {
2129  if (_this->SetWindowMaximumSize) {
2130  _this->SetWindowMaximumSize(_this, window);
2131  }
2132  /* Ensure that window is not larger than maximal size */
2133  SDL_SetWindowSize(window, SDL_min(window->w, window->max_w), SDL_min(window->h, window->max_h));
2134  }
2135 }
#define SDL_min(x, y)
Definition: SDL_stdinc.h:406
void SDL_SetWindowSize(SDL_Window *window, int w, int h)
Set the size of a window&#39;s client area.
Definition: SDL_video.c:1983
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
void(* SetWindowMaximumSize)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:218
#define SDL_SetError
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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
windowThe window to set a new minimum size.
min_wThe minimum width of the window, must be >0
min_hThe minimum height of the window, must be >0
Note
You can't change the minimum size of a fullscreen window, it automatically matches the size of the display mode.
See also
SDL_GetWindowMinimumSize()
SDL_SetWindowMaximumSize()

Definition at line 2065 of file SDL_video.c.

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

2066 {
2067  CHECK_WINDOW_MAGIC(window,);
2068  if (min_w <= 0) {
2069  SDL_InvalidParamError("min_w");
2070  return;
2071  }
2072  if (min_h <= 0) {
2073  SDL_InvalidParamError("min_h");
2074  return;
2075  }
2076 
2077  if ((window->max_w && min_w >= window->max_w) ||
2078  (window->max_h && min_h >= window->max_h)) {
2079  SDL_SetError("SDL_SetWindowMinimumSize(): Tried to set minimum size larger than maximum size");
2080  return;
2081  }
2082 
2083  window->min_w = min_w;
2084  window->min_h = min_h;
2085 
2086  if (!(window->flags & SDL_WINDOW_FULLSCREEN)) {
2087  if (_this->SetWindowMinimumSize) {
2088  _this->SetWindowMinimumSize(_this, window);
2089  }
2090  /* Ensure that window is not smaller than minimal size */
2091  SDL_SetWindowSize(window, SDL_max(window->w, window->min_w), SDL_max(window->h, window->min_h));
2092  }
2093 }
void SDL_SetWindowSize(SDL_Window *window, int w, int h)
Set the size of a window&#39;s client area.
Definition: SDL_video.c:1983
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
#define SDL_max(x, y)
Definition: SDL_stdinc.h:407
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
void(* SetWindowMinimumSize)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:217
#define SDL_SetError
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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_windowThe window that should be modal
parent_windowThe parent window
Returns
0 on success, or -1 otherwise.

Definition at line 2399 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Unsupported, and SDL_VideoDevice::SetWindowModalFor.

2400 {
2401  CHECK_WINDOW_MAGIC(modal_window, -1);
2402  CHECK_WINDOW_MAGIC(parent_window, -1);
2403 
2404  if (!_this->SetWindowModalFor) {
2405  return SDL_Unsupported();
2406  }
2407 
2408  return _this->SetWindowModalFor(_this, modal_window, parent_window);
2409 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
int(* SetWindowModalFor)(_THIS, SDL_Window *modal_window, SDL_Window *parent_window)
Definition: SDL_sysvideo.h:221
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
#define SDL_Unsupported()
Definition: SDL_error.h:53

◆ SDL_SetWindowOpacity()

int SDL_SetWindowOpacity ( SDL_Window window,
float  opacity 
)

Set the opacity for a window.

Parameters
windowThe window which will be made transparent or opaque
opacityOpacity (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 2363 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::opacity, retval, SDL_Unsupported, and SDL_VideoDevice::SetWindowOpacity.

2364 {
2365  int retval;
2366  CHECK_WINDOW_MAGIC(window, -1);
2367 
2368  if (!_this->SetWindowOpacity) {
2369  return SDL_Unsupported();
2370  }
2371 
2372  if (opacity < 0.0f) {
2373  opacity = 0.0f;
2374  } else if (opacity > 1.0f) {
2375  opacity = 1.0f;
2376  }
2377 
2378  retval = _this->SetWindowOpacity(_this, window, opacity);
2379  if (retval == 0) {
2380  window->opacity = opacity;
2381  }
2382 
2383  return retval;
2384 }
GLfloat f
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_bool retval
float opacity
Definition: SDL_sysvideo.h:91
int(* SetWindowOpacity)(_THIS, SDL_Window *window, float opacity)
Definition: SDL_sysvideo.h:220
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
#define SDL_Unsupported()
Definition: SDL_error.h:53

◆ SDL_SetWindowPosition()

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

Set the position of a window.

Parameters
windowThe window to reposition.
xThe x coordinate of the window in screen coordinates, or SDL_WINDOWPOS_CENTERED or SDL_WINDOWPOS_UNDEFINED.
yThe 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 1860 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_Rect::h, SDL_Window::h, SDL_VideoDevice::num_displays, SDL_GetDisplayBounds(), SDL_SendWindowEvent(), SDL_WINDOW_FULLSCREEN, SDL_WINDOWEVENT_MOVED, SDL_WINDOWPOS_ISCENTERED, SDL_WINDOWPOS_ISUNDEFINED, SDL_zero, SDL_VideoDevice::SetWindowPosition, SDL_Rect::w, SDL_Window::w, SDL_Window::windowed, SDL_Rect::x, SDL_Window::x, SDL_Rect::y, and SDL_Window::y.

1861 {
1862  CHECK_WINDOW_MAGIC(window,);
1863 
1865  int displayIndex = (x & 0xFFFF);
1866  SDL_Rect bounds;
1867  if (displayIndex >= _this->num_displays) {
1868  displayIndex = 0;
1869  }
1870 
1871  SDL_zero(bounds);
1872 
1873  SDL_GetDisplayBounds(displayIndex, &bounds);
1874  if (SDL_WINDOWPOS_ISCENTERED(x)) {
1875  x = bounds.x + (bounds.w - window->w) / 2;
1876  }
1877  if (SDL_WINDOWPOS_ISCENTERED(y)) {
1878  y = bounds.y + (bounds.h - window->h) / 2;
1879  }
1880  }
1881 
1882  if ((window->flags & SDL_WINDOW_FULLSCREEN)) {
1883  if (!SDL_WINDOWPOS_ISUNDEFINED(x)) {
1884  window->windowed.x = x;
1885  }
1886  if (!SDL_WINDOWPOS_ISUNDEFINED(y)) {
1887  window->windowed.y = y;
1888  }
1889  } else {
1890  if (!SDL_WINDOWPOS_ISUNDEFINED(x)) {
1891  window->x = x;
1892  }
1893  if (!SDL_WINDOWPOS_ISUNDEFINED(y)) {
1894  window->y = y;
1895  }
1896 
1897  if (_this->SetWindowPosition) {
1898  _this->SetWindowPosition(_this, window);
1899  }
1901  }
1902 }
#define SDL_WINDOWPOS_ISUNDEFINED(X)
Definition: SDL_video.h:131
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
#define SDL_WINDOWPOS_ISCENTERED(X)
Definition: SDL_video.h:140
int SDL_SendWindowEvent(SDL_Window *window, Uint8 windowevent, int data1, int data2)
SDL_Rect windowed
Definition: SDL_sysvideo.h:87
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_zero(x)
Definition: SDL_stdinc.h:416
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
int x
Definition: SDL_rect.h:66
int SDL_GetDisplayBounds(int displayIndex, SDL_Rect *rect)
Get the desktop area represented by a display, with the primary display located at 0...
Definition: SDL_video.c:676
int w
Definition: SDL_rect.h:67
void(* SetWindowPosition)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:215
int h
Definition: SDL_rect.h:67
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83
int y
Definition: SDL_rect.h:66
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64

◆ 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
windowThe window of which to change the resizable state.
resizableSDL_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 1965 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, SDL_FALSE, SDL_WINDOW_FULLSCREEN, SDL_WINDOW_RESIZABLE, and SDL_VideoDevice::SetWindowResizable.

1966 {
1967  CHECK_WINDOW_MAGIC(window,);
1968  if (!(window->flags & SDL_WINDOW_FULLSCREEN)) {
1969  const int want = (resizable != SDL_FALSE); /* normalize the flag. */
1970  const int have = ((window->flags & SDL_WINDOW_RESIZABLE) != 0);
1971  if ((want != have) && (_this->SetWindowResizable)) {
1972  if (want) {
1973  window->flags |= SDL_WINDOW_RESIZABLE;
1974  } else {
1975  window->flags &= ~SDL_WINDOW_RESIZABLE;
1976  }
1977  _this->SetWindowResizable(_this, window, (SDL_bool) want);
1978  }
1979  }
1980 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_bool
Definition: SDL_stdinc.h:161
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
void(* SetWindowResizable)(_THIS, SDL_Window *window, SDL_bool resizable)
Definition: SDL_sysvideo.h:230
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ SDL_SetWindowSize()

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

Set the size of a window's client area.

Parameters
windowThe window to resize.
wThe width of the window, in screen coordinates. Must be >0.
hThe 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 1983 of file SDL_video.c.

References CHECK_WINDOW_MAGIC, SDL_Window::flags, FULLSCREEN_VISIBLE, SDL_Rect::h, SDL_Window::h, SDL_Window::last_fullscreen_flags, SDL_Window::max_h, SDL_Window::max_w, SDL_Window::min_h, SDL_Window::min_w, SDL_InvalidParamError, SDL_OnWindowResized(), SDL_TRUE, SDL_UpdateFullscreenMode(), SDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP, SDL_VideoDevice::SetWindowSize, SDL_Rect::w, SDL_Window::w, and SDL_Window::windowed.

Referenced by SDL_SetWindowMaximumSize(), and SDL_SetWindowMinimumSize().

1984 {
1985  CHECK_WINDOW_MAGIC(window,);
1986  if (w <= 0) {
1987  SDL_InvalidParamError("w");
1988  return;
1989  }
1990  if (h <= 0) {
1991  SDL_InvalidParamError("h");
1992  return;
1993  }
1994 
1995  /* Make sure we don't exceed any window size limits */
1996  if (window->min_w && w < window->min_w) {
1997  w = window->min_w;
1998  }
1999  if (window->max_w && w > window->max_w) {
2000  w = window->max_w;
2001  }
2002  if (window->min_h && h < window->min_h) {
2003  h = window->min_h;
2004  }
2005  if (window->max_h && h > window->max_h) {
2006  h = window->max_h;
2007  }
2008 
2009  window->windowed.w = w;
2010  window->windowed.h = h;
2011 
2012  if (window->flags & SDL_WINDOW_FULLSCREEN) {
2014  window->last_fullscreen_flags = 0;
2016  }
2017  } else {
2018  window->w = w;
2019  window->h = h;
2020  if (_this->SetWindowSize) {
2021  _this->SetWindowSize(_this, window);
2022  }
2023  if (window->w == w && window->h == h) {
2024  /* We didn't get a SDL_WINDOWEVENT_RESIZED event (by design) */
2025  SDL_OnWindowResized(window);
2026  }
2027  }
2028 }
#define FULLSCREEN_VISIBLE(W)
Definition: SDL_sysvideo.h:116
GLfloat GLfloat GLfloat GLfloat h
void(* SetWindowSize)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:216
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
SDL_Rect windowed
Definition: SDL_sysvideo.h:87
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
GLubyte GLubyte GLubyte GLubyte w
static int SDL_UpdateFullscreenMode(SDL_Window *window, SDL_bool fullscreen)
Definition: SDL_video.c:1186
int w
Definition: SDL_rect.h:67
Uint32 last_fullscreen_flags
Definition: SDL_sysvideo.h:84
int h
Definition: SDL_rect.h:67
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83
void SDL_OnWindowResized(SDL_Window *window)
Definition: SDL_video.c:2578

◆ 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 1745 of file SDL_video.c.

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

Referenced by SDL_CreateWindow().

1746 {
1747  CHECK_WINDOW_MAGIC(window,);
1748 
1749  if (title == window->title) {
1750  return;
1751  }
1752  SDL_free(window->title);
1753 
1754  window->title = SDL_strdup(title ? title : "");
1755 
1756  if (_this->SetWindowTitle) {
1757  _this->SetWindowTitle(_this, window);
1758  }
1759 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_free
char * title
Definition: SDL_sysvideo.h:77
#define SDL_strdup
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
void(* SetWindowTitle)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:213

◆ SDL_ShowWindow()

void SDL_ShowWindow ( SDL_Window window)

Show a window.

See also
SDL_HideWindow()

Definition at line 2150 of file SDL_video.c.

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

Referenced by SDL_FinishWindowCreation().

2151 {
2152  CHECK_WINDOW_MAGIC(window,);
2153 
2154  if (window->flags & SDL_WINDOW_SHOWN) {
2155  return;
2156  }
2157 
2158  if (_this->ShowWindow) {
2159  _this->ShowWindow(_this, window);
2160  }
2162 }
void(* ShowWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:223
int SDL_SendWindowEvent(SDL_Window *window, Uint8 windowevent, int data1, int data2)
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
Uint32 flags
Definition: SDL_sysvideo.h:83

◆ 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 2312 of file SDL_video.c.

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

2313 {
2314  SDL_Rect full_rect;
2315 
2316  CHECK_WINDOW_MAGIC(window, -1);
2317 
2318  full_rect.x = 0;
2319  full_rect.y = 0;
2320  full_rect.w = window->w;
2321  full_rect.h = window->h;
2322  return SDL_UpdateWindowSurfaceRects(window, &full_rect, 1);
2323 }
int SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects)
Copy a number of rectangles on the window surface to the screen.
Definition: SDL_video.c:2326
int x
Definition: SDL_rect.h:66
int w
Definition: SDL_rect.h:67
int h
Definition: SDL_rect.h:67
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
int y
Definition: SDL_rect.h:66
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64

◆ 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 2326 of file SDL_video.c.

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

Referenced by SDL_UpdateWindowSurface().

2328 {
2329  CHECK_WINDOW_MAGIC(window, -1);
2330 
2331  if (!window->surface_valid) {
2332  return SDL_SetError("Window surface is invalid, please call SDL_GetWindowSurface() to get a new surface");
2333  }
2334 
2335  return _this->UpdateWindowFramebuffer(_this, window, rects, numrects);
2336 }
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_SetError
int(* UpdateWindowFramebuffer)(_THIS, SDL_Window *window, const SDL_Rect *rects, int numrects)
Definition: SDL_sysvideo.h:237
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:123
SDL_bool surface_valid
Definition: SDL_sysvideo.h:98

◆ SDL_VideoInit()

int SDL_VideoInit ( const char *  driver_name)

Initialize the video subsystem, optionally specifying a video driver.

Parameters
driver_nameInitialize a specific driver by name, or NULL for the default video driver.
Returns
0 on success, -1 on error

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

See also
SDL_VideoQuit()

Definition at line 464 of file SDL_video.c.

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

Referenced by SDL_CreateWindow().

465 {
466  SDL_VideoDevice *video;
467  int index;
468  int i;
469 
470  /* Check to make sure we don't overwrite '_this' */
471  if (_this != NULL) {
472  SDL_VideoQuit();
473  }
474 
475 #if !SDL_TIMERS_DISABLED
476  SDL_TicksInit();
477 #endif
478 
479  /* Start the event loop */
481  SDL_KeyboardInit() < 0 ||
482  SDL_MouseInit() < 0 ||
483  SDL_TouchInit() < 0) {
484  return -1;
485  }
486 
487  /* Select the proper video driver */
488  index = 0;
489  video = NULL;
490  if (driver_name == NULL) {
491  driver_name = SDL_getenv("SDL_VIDEODRIVER");
492  }
493  if (driver_name != NULL) {
494  for (i = 0; bootstrap[i]; ++i) {
495  if (SDL_strncasecmp(bootstrap[i]->name, driver_name, SDL_strlen(driver_name)) == 0) {
496  if (bootstrap[i]->available()) {
497  video = bootstrap[i]->create(index);
498  break;
499  }
500  }
501  }
502  } else {
503  for (i = 0; bootstrap[i]; ++i) {
504  if (bootstrap[i]->available()) {
505  video = bootstrap[i]->create(index);
506  if (video != NULL) {
507  break;
508  }
509  }
510  }
511  }
512  if (video == NULL) {
513  if (driver_name) {
514  return SDL_SetError("%s not available", driver_name);
515  }
516  return SDL_SetError("No available video device");
517  }
518  _this = video;
519  _this->name = bootstrap[i]->name;
520  _this->next_object_id = 1;
521 
522 
523  /* Set some very sane GL defaults */
527 
530 
531  /* Initialize the video subsystem */
532  if (_this->VideoInit(_this) < 0) {
533  SDL_VideoQuit();
534  return -1;
535  }
536 
537  /* Make sure some displays were added */
538  if (_this->num_displays == 0) {
539  SDL_VideoQuit();
540  return SDL_SetError("The video driver did not add any displays");
541  }
542 
543  /* Add the renderer framebuffer emulation if desired */
548  }
549 
550  /* Disable the screen saver by default. This is a change from <= 2.0.1,
551  but most things using SDL are games or media players; you wouldn't
552  want a screensaver to trigger if you're playing exclusively with a
553  joystick, or passively watching a movie. Things that use SDL but
554  function more like a normal desktop app should explicitly reenable the
555  screensaver. */
558  }
559 
560  /* If we don't use a screen keyboard, turn on text input by default,
561  otherwise programs that expect to get text events without enabling
562  UNICODE input won't get any events.
563 
564  Actually, come to think of it, you needed to call SDL_EnableUNICODE(1)
565  in SDL 1.2 before you got text input events. Hmm...
566  */
569  }
570 
571  /* We're ready to go! */
572  return 0;
573 }
void SDL_GL_ResetAttributes()
Reset all previously set OpenGL context attributes to their default values.
Definition: SDL_video.c:3044
const char * name
Definition: SDL_sysvideo.h:152
#define SDL_INIT_EVENTS
Definition: SDL.h:83
void SDL_VideoQuit(void)
Shuts down the video subsystem.
Definition: SDL_video.c:2803
SDL_TLSID current_glwin_tls
Definition: SDL_sysvideo.h:365
static int available()
Definition: video.c:356
#define SDL_HINT_VIDEO_ALLOW_SCREENSAVER
A variable controlling whether the screensaver is enabled.
Definition: SDL_hints.h:165
#define SDL_InitSubSystem
int SDL_KeyboardInit(void)
Definition: SDL_keyboard.c:562
#define SDL_strncasecmp
GLuint const GLchar * name
int SDL_MouseInit(void)
Definition: SDL_mouse.c:106
#define SDL_GetHintBoolean
struct SDL_VideoDevice::@33 gl_config
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
static int SDL_UpdateWindowTexture(SDL_VideoDevice *unused, SDL_Window *window, const SDL_Rect *rects, int numrects)
Definition: SDL_video.c:369
#define SDL_TLSCreate
static int SDL_CreateWindowTexture(SDL_VideoDevice *unused, SDL_Window *window, Uint32 *format, void **pixels, int *pitch)
Definition: SDL_video.c:259
static void SDL_DestroyWindowTexture(SDL_VideoDevice *unused, SDL_Window *window)
Definition: SDL_video.c:399
GLuint index
void SDL_StartTextInput(void)
Start accepting Unicode text input events. This function will show the on-screen keyboard if supporte...
Definition: SDL_video.c:3730
#define SDL_getenv
void(* DestroyWindowFramebuffer)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:238
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define NULL
Definition: begin_code.h:164
#define SDL_SetError
static SDL_bool ShouldUseTextureFramebuffer()
Definition: SDL_video.c:169
#define SDL_strlen
SDL_TLSID current_glctx_tls
Definition: SDL_sysvideo.h:366
void SDL_TicksInit(void)
SDL_VideoDevice *(* create)(int devindex)
Definition: SDL_sysvideo.h:402
static VideoBootStrap * bootstrap[]
Definition: SDL_video.c:60
const char * name
Definition: SDL_sysvideo.h:399
int(* VideoInit)(_THIS)
Definition: SDL_sysvideo.h:161
int(* UpdateWindowFramebuffer)(_THIS, SDL_Window *window, const SDL_Rect *rects, int numrects)
Definition: SDL_sysvideo.h:237
Uint32 next_object_id
Definition: SDL_sysvideo.h:320
SDL_bool SDL_HasScreenKeyboardSupport(void)
Returns whether the platform has some screen keyboard support.
Definition: SDL_video.c:3786
int(* CreateWindowFramebuffer)(_THIS, SDL_Window *window, Uint32 *format, void **pixels, int *pitch)
Definition: SDL_sysvideo.h:236
int SDL_TouchInit(void)
Definition: SDL_touch.c:37
void SDL_DisableScreenSaver()
Prevent the screen from being blanked by a screensaver.
Definition: SDL_video.c:2788

◆ 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 2803 of file SDL_video.c.

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

2804 {
2805  int i, j;
2806 
2807  if (!_this) {
2808  return;
2809  }
2810 
2811  /* Halt event processing before doing anything else */
2812  SDL_TouchQuit();
2813  SDL_MouseQuit();
2814  SDL_KeyboardQuit();
2816 
2818 
2819  /* Clean up the system video */
2820  while (_this->windows) {
2822  }
2823  _this->VideoQuit(_this);
2824 
2825  for (i = 0; i < _this->num_displays; ++i) {
2826  SDL_VideoDisplay *display = &_this->displays[i];
2827  for (j = display->num_display_modes; j--;) {
2828  SDL_free(display->display_modes[j].driverdata);
2829  display->display_modes[j].driverdata = NULL;
2830  }
2831  SDL_free(display->display_modes);
2832  display->display_modes = NULL;
2833  SDL_free(display->desktop_mode.driverdata);
2834  display->desktop_mode.driverdata = NULL;
2835  SDL_free(display->driverdata);
2836  display->driverdata = NULL;
2837  }
2838  if (_this->displays) {
2839  for (i = 0; i < _this->num_displays; ++i) {
2840  SDL_free(_this->displays[i].name);
2841  }
2843  _this->displays = NULL;
2844  _this->num_displays = 0;
2845  }
2848  _this->free(_this);
2849  _this = NULL;
2850 }
#define SDL_INIT_EVENTS
Definition: SDL.h:83
void(* free)(_THIS)
Definition: SDL_sysvideo.h:394
#define SDL_QuitSubSystem
void SDL_MouseQuit(void)
Definition: SDL_mouse.c:592
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
#define SDL_free
void * driverdata
Definition: SDL_video.h:59
void SDL_DestroyWindow(SDL_Window *window)
Destroy a window.
Definition: SDL_video.c:2687
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int int in j)
Definition: SDL_x11sym.h:50
SDL_DisplayMode * display_modes
Definition: SDL_sysvideo.h:130
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
SDL_Window * windows
Definition: SDL_sysvideo.h:317
void SDL_KeyboardQuit(void)
Definition: SDL_keyboard.c:832
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define NULL
Definition: begin_code.h:164
SDL_DisplayMode desktop_mode
Definition: SDL_sysvideo.h:131
void(* VideoQuit)(_THIS)
Definition: SDL_sysvideo.h:167
void SDL_EnableScreenSaver()
Allow the screen to be blanked by a screensaver.
Definition: SDL_video.c:2773
void SDL_TouchQuit(void)
Definition: SDL_touch.c:361
char * clipboard_text
Definition: SDL_sysvideo.h:321