Классы
struct	SDL_DisplayMode
	The structure that defines a display mode. Подробнее...

Определения типов
typedef struct SDL_Window	SDL_Window
	The type used to identify a window. Подробнее...

typedef void *	SDL_GLContext
	An opaque handle to an OpenGL context. Подробнее...

typedef SDL_HitTestResult(SDLCALL *	SDL_HitTest) (SDL_Window win, const SDL_Point area, void *data)
	Callback used for hit-testing. Подробнее...

Перечисления
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. Подробнее...

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. Подробнее...

enum	SDL_DisplayEventID { SDL_DISPLAYEVENT_NONE, SDL_DISPLAYEVENT_ORIENTATION }
	Event subtype for display events. Подробнее...

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. Подробнее...

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. Подробнее...

Функции
DECLSPEC int SDLCALL	SDL_GetNumVideoDrivers (void)
	Get the number of video drivers compiled into SDL. Подробнее...

const DECLSPEC char *SDLCALL	SDL_GetVideoDriver (int index)
	Get the name of a built in video driver. Подробнее...

DECLSPEC int SDLCALL	SDL_VideoInit (const char *driver_name)
	Initialize the video subsystem, optionally specifying a video driver. Подробнее...

DECLSPEC void SDLCALL	SDL_VideoQuit (void)
	Shuts down the video subsystem. Подробнее...

const DECLSPEC char *SDLCALL	SDL_GetCurrentVideoDriver (void)
	Returns the name of the currently initialized video driver. Подробнее...

DECLSPEC int SDLCALL	SDL_GetNumVideoDisplays (void)
	Returns the number of available video displays. Подробнее...

const DECLSPEC char *SDLCALL	SDL_GetDisplayName (int displayIndex)
	Get the name of a display in UTF-8 encoding. Подробнее...

DECLSPEC int SDLCALL	SDL_GetDisplayBounds (int displayIndex, SDL_Rect *rect)
	Get the desktop area represented by a display, with the primary display located at 0,0. Подробнее...

DECLSPEC int SDLCALL	SDL_GetDisplayUsableBounds (int displayIndex, SDL_Rect *rect)
	Get the usable desktop area represented by a display, with the primary display located at 0,0. Подробнее...

DECLSPEC int SDLCALL	SDL_GetDisplayDPI (int displayIndex, float ddpi, float hdpi, float *vdpi)
	Get the dots/pixels-per-inch for a display. Подробнее...

DECLSPEC SDL_DisplayOrientation SDLCALL	SDL_GetDisplayOrientation (int displayIndex)
	Get the orientation of a display. Подробнее...

DECLSPEC int SDLCALL	SDL_GetNumDisplayModes (int displayIndex)
	Returns the number of available display modes. Подробнее...

DECLSPEC int SDLCALL	SDL_GetDisplayMode (int displayIndex, int modeIndex, SDL_DisplayMode *mode)
	Fill in information about a specific display mode. Подробнее...

DECLSPEC int SDLCALL	SDL_GetDesktopDisplayMode (int displayIndex, SDL_DisplayMode *mode)
	Fill in information about the desktop display mode. Подробнее...

DECLSPEC int SDLCALL	SDL_GetCurrentDisplayMode (int displayIndex, SDL_DisplayMode *mode)
	Fill in information about the current display mode. Подробнее...

DECLSPEC SDL_DisplayMode *SDLCALL	SDL_GetClosestDisplayMode (int displayIndex, const SDL_DisplayMode mode, SDL_DisplayMode closest)
	Get the closest match to the requested display mode. Подробнее...

DECLSPEC int SDLCALL	SDL_GetWindowDisplayIndex (SDL_Window *window)
	Get the display index associated with a window. Подробнее...

DECLSPEC int SDLCALL	SDL_SetWindowDisplayMode (SDL_Window window, const SDL_DisplayMode mode)
	Set the display mode used when a fullscreen window is visible. Подробнее...

DECLSPEC int SDLCALL	SDL_GetWindowDisplayMode (SDL_Window window, SDL_DisplayMode mode)
	Fill in information about the display mode used when a fullscreen window is visible. Подробнее...

DECLSPEC Uint32 SDLCALL	SDL_GetWindowPixelFormat (SDL_Window *window)
	Get the pixel format associated with the window. Подробнее...

DECLSPEC SDL_Window *SDLCALL	SDL_CreateWindow (const char *title, int x, int y, int w, int h, Uint32 flags)
	Create a window with the specified position, dimensions, and flags. Подробнее...

DECLSPEC SDL_Window *SDLCALL	SDL_CreateWindowFrom (const void *data)
	Create an SDL window from an existing native window. Подробнее...

DECLSPEC Uint32 SDLCALL	SDL_GetWindowID (SDL_Window *window)
	Get the numeric ID of a window, for logging purposes. Подробнее...

DECLSPEC SDL_Window *SDLCALL	SDL_GetWindowFromID (Uint32 id)
	Get a window from a stored ID, or NULL if it doesn't exist. Подробнее...

DECLSPEC Uint32 SDLCALL	SDL_GetWindowFlags (SDL_Window *window)
	Get the window flags. Подробнее...

DECLSPEC void SDLCALL	SDL_SetWindowTitle (SDL_Window window, const char title)
	Set the title of a window, in UTF-8 format. Подробнее...

const DECLSPEC char *SDLCALL	SDL_GetWindowTitle (SDL_Window *window)
	Get the title of a window, in UTF-8 format. Подробнее...

DECLSPEC void SDLCALL	SDL_SetWindowIcon (SDL_Window window, SDL_Surface icon)
	Set the icon for a window. Подробнее...

DECLSPEC void *SDLCALL	SDL_SetWindowData (SDL_Window window, const char name, void *userdata)
	Associate an arbitrary named pointer with a window. Подробнее...

DECLSPEC void *SDLCALL	SDL_GetWindowData (SDL_Window window, const char name)
	Retrieve the data pointer associated with a window. Подробнее...

DECLSPEC void SDLCALL	SDL_SetWindowPosition (SDL_Window *window, int x, int y)
	Set the position of a window. Подробнее...

DECLSPEC void SDLCALL	SDL_GetWindowPosition (SDL_Window window, int x, int *y)
	Get the position of a window. Подробнее...

DECLSPEC void SDLCALL	SDL_SetWindowSize (SDL_Window *window, int w, int h)
	Set the size of a window's client area. Подробнее...

DECLSPEC void SDLCALL	SDL_GetWindowSize (SDL_Window window, int w, int *h)
	Get the size of a window's client area. Подробнее...

DECLSPEC int SDLCALL	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. Подробнее...

DECLSPEC void SDLCALL	SDL_SetWindowMinimumSize (SDL_Window *window, int min_w, int min_h)
	Set the minimum size of a window's client area. Подробнее...

DECLSPEC void SDLCALL	SDL_GetWindowMinimumSize (SDL_Window window, int w, int *h)
	Get the minimum size of a window's client area. Подробнее...

DECLSPEC void SDLCALL	SDL_SetWindowMaximumSize (SDL_Window *window, int max_w, int max_h)
	Set the maximum size of a window's client area. Подробнее...

DECLSPEC void SDLCALL	SDL_GetWindowMaximumSize (SDL_Window window, int w, int *h)
	Get the maximum size of a window's client area. Подробнее...

DECLSPEC void SDLCALL	SDL_SetWindowBordered (SDL_Window *window, SDL_bool bordered)
	Set the border state of a window. Подробнее...

DECLSPEC void SDLCALL	SDL_SetWindowResizable (SDL_Window *window, SDL_bool resizable)
	Set the user-resizable state of a window. Подробнее...

DECLSPEC void SDLCALL	SDL_ShowWindow (SDL_Window *window)
	Show a window. Подробнее...

DECLSPEC void SDLCALL	SDL_HideWindow (SDL_Window *window)
	Hide a window. Подробнее...

DECLSPEC void SDLCALL	SDL_RaiseWindow (SDL_Window *window)
	Raise a window above other windows and set the input focus. Подробнее...

DECLSPEC void SDLCALL	SDL_MaximizeWindow (SDL_Window *window)
	Make a window as large as possible. Подробнее...

DECLSPEC void SDLCALL	SDL_MinimizeWindow (SDL_Window *window)
	Minimize a window to an iconic representation. Подробнее...

DECLSPEC void SDLCALL	SDL_RestoreWindow (SDL_Window *window)
	Restore the size and position of a minimized or maximized window. Подробнее...

DECLSPEC int SDLCALL	SDL_SetWindowFullscreen (SDL_Window *window, Uint32 flags)
	Set a window's fullscreen state. Подробнее...

DECLSPEC SDL_Surface *SDLCALL	SDL_GetWindowSurface (SDL_Window *window)
	Get the SDL surface associated with the window. Подробнее...

DECLSPEC int SDLCALL	SDL_UpdateWindowSurface (SDL_Window *window)
	Copy the window surface to the screen. Подробнее...

DECLSPEC int SDLCALL	SDL_UpdateWindowSurfaceRects (SDL_Window window, const SDL_Rect rects, int numrects)
	Copy a number of rectangles on the window surface to the screen. Подробнее...

DECLSPEC void SDLCALL	SDL_SetWindowGrab (SDL_Window *window, SDL_bool grabbed)
	Set a window's input grab mode. Подробнее...

DECLSPEC SDL_bool SDLCALL	SDL_GetWindowGrab (SDL_Window *window)
	Get a window's input grab mode. Подробнее...

DECLSPEC SDL_Window *SDLCALL	SDL_GetGrabbedWindow (void)
	Get the window that currently has an input grab enabled. Подробнее...

DECLSPEC int SDLCALL	SDL_SetWindowBrightness (SDL_Window *window, float brightness)
	Set the brightness (gamma correction) for a window. Подробнее...

DECLSPEC float SDLCALL	SDL_GetWindowBrightness (SDL_Window *window)
	Get the brightness (gamma correction) for a window. Подробнее...

DECLSPEC int SDLCALL	SDL_SetWindowOpacity (SDL_Window *window, float opacity)
	Set the opacity for a window. Подробнее...

DECLSPEC int SDLCALL	SDL_GetWindowOpacity (SDL_Window window, float out_opacity)
	Get the opacity of a window. Подробнее...

DECLSPEC int SDLCALL	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) Подробнее...

DECLSPEC int SDLCALL	SDL_SetWindowInputFocus (SDL_Window *window)
	Explicitly sets input focus to the window. Подробнее...

DECLSPEC int SDLCALL	SDL_SetWindowGammaRamp (SDL_Window window, const Uint16 red, const Uint16 green, const Uint16 blue)
	Set the gamma ramp for a window. Подробнее...

DECLSPEC int SDLCALL	SDL_GetWindowGammaRamp (SDL_Window window, Uint16 red, Uint16 green, Uint16 blue)
	Get the gamma ramp for a window. Подробнее...

DECLSPEC int SDLCALL	SDL_SetWindowHitTest (SDL_Window window, SDL_HitTest callback, void callback_data)
	Provide a callback that decides if a window region has special properties. Подробнее...

DECLSPEC void SDLCALL	SDL_DestroyWindow (SDL_Window *window)
	Destroy a window. Подробнее...

DECLSPEC SDL_bool SDLCALL	SDL_IsScreenSaverEnabled (void)
	Returns whether the screensaver is currently enabled (default off). Подробнее...

DECLSPEC void SDLCALL	SDL_EnableScreenSaver (void)
	Allow the screen to be blanked by a screensaver. Подробнее...

DECLSPEC void SDLCALL	SDL_DisableScreenSaver (void)
	Prevent the screen from being blanked by a screensaver. Подробнее...

OpenGL support functions
DECLSPEC int SDLCALL	SDL_GL_LoadLibrary (const char *path)
	Dynamically load an OpenGL library. Подробнее...

DECLSPEC void *SDLCALL	SDL_GL_GetProcAddress (const char *proc)
	Get the address of an OpenGL function. Подробнее...

DECLSPEC void SDLCALL	SDL_GL_UnloadLibrary (void)
	Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary(). Подробнее...

DECLSPEC SDL_bool SDLCALL	SDL_GL_ExtensionSupported (const char *extension)
	Return true if an OpenGL extension is supported for the current context. Подробнее...

DECLSPEC void SDLCALL	SDL_GL_ResetAttributes (void)
	Reset all previously set OpenGL context attributes to their default values. Подробнее...

DECLSPEC int SDLCALL	SDL_GL_SetAttribute (SDL_GLattr attr, int value)
	Set an OpenGL window attribute before window creation. Подробнее...

DECLSPEC int SDLCALL	SDL_GL_GetAttribute (SDL_GLattr attr, int *value)
	Get the actual value for an attribute from the current context. Подробнее...

DECLSPEC SDL_GLContext SDLCALL	SDL_GL_CreateContext (SDL_Window *window)
	Create an OpenGL context for use with an OpenGL window, and make it current. Подробнее...

DECLSPEC int SDLCALL	SDL_GL_MakeCurrent (SDL_Window *window, SDL_GLContext context)
	Set up an OpenGL context for rendering into an OpenGL window. Подробнее...

DECLSPEC SDL_Window *SDLCALL	SDL_GL_GetCurrentWindow (void)
	Get the currently active OpenGL window. Подробнее...

DECLSPEC SDL_GLContext SDLCALL	SDL_GL_GetCurrentContext (void)
	Get the currently active OpenGL context. Подробнее...

DECLSPEC void SDLCALL	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). Подробнее...

DECLSPEC int SDLCALL	SDL_GL_SetSwapInterval (int interval)
	Set the swap interval for the current OpenGL context. Подробнее...

DECLSPEC int SDLCALL	SDL_GL_GetSwapInterval (void)
	Get the swap interval for the current OpenGL context. Подробнее...

DECLSPEC void SDLCALL	SDL_GL_SwapWindow (SDL_Window *window)
	Swap the OpenGL buffers for a window, if double-buffering is supported. Подробнее...

DECLSPEC void SDLCALL	SDL_GL_DeleteContext (SDL_GLContext context)
	Delete an OpenGL context. Подробнее...

Подробное описание

Header file for SDL video functions.

См. определение в файле SDL_video.h

Типы

◆ SDL_Window

typedef struct SDL_Window SDL_Window

The type used to identify a window.

См. определение в файле SDL_video.h строка 90

◆ SDL_GLContext

typedef void* SDL_GLContext

An opaque handle to an OpenGL context.

См. определение в файле SDL_video.h строка 192

◆ SDL_HitTest

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

Callback used for hit-testing.

См. также: SDL_SetWindowHitTest

См. определение в файле SDL_video.h строка 1038

Перечисления

◆ SDL_WindowFlags

enum SDL_WindowFlags

The flags on a window.

См. также: SDL_GetWindowFlags()

Элементы перечислений
SDL_WINDOW_FULLSCREEN	fullscreen window
SDL_WINDOW_OPENGL	window usable with OpenGL context
SDL_WINDOW_SHOWN	window is visible
SDL_WINDOW_HIDDEN	window is not visible
SDL_WINDOW_BORDERLESS	no window decoration
SDL_WINDOW_RESIZABLE	window can be resized
SDL_WINDOW_MINIMIZED	window is minimized
SDL_WINDOW_MAXIMIZED	window is maximized
SDL_WINDOW_INPUT_GRABBED	window has grabbed input focus
SDL_WINDOW_INPUT_FOCUS	window has input focus
SDL_WINDOW_MOUSE_FOCUS	window has mouse focus
SDL_WINDOW_FULLSCREEN_DESKTOP
SDL_WINDOW_FOREIGN	window not created by SDL
SDL_WINDOW_ALLOW_HIGHDPI	window should be created in high-DPI mode if supported. On macOS NSHighResolutionCapable must be set true in the application's Info.plist for this to have any effect.
SDL_WINDOW_MOUSE_CAPTURE	window has mouse captured (unrelated to INPUT_GRABBED)
SDL_WINDOW_ALWAYS_ON_TOP	window should always be above others
SDL_WINDOW_SKIP_TASKBAR	window should not be added to the taskbar
SDL_WINDOW_UTILITY	window should be treated as a utility window
SDL_WINDOW_TOOLTIP	window should be treated as a tooltip
SDL_WINDOW_POPUP_MENU	window should be treated as a popup menu
SDL_WINDOW_VULKAN	window usable for Vulkan surface

См. определение в файле SDL_video.h строка 97

 {
     SDL_WINDOW_FULLSCREEN = 0x00000001,         
     SDL_WINDOW_OPENGL = 0x00000002,             
     SDL_WINDOW_SHOWN = 0x00000004,              
     SDL_WINDOW_HIDDEN = 0x00000008,             
     SDL_WINDOW_BORDERLESS = 0x00000010,         
     SDL_WINDOW_RESIZABLE = 0x00000020,          
     SDL_WINDOW_MINIMIZED = 0x00000040,          
     SDL_WINDOW_MAXIMIZED = 0x00000080,          
     SDL_WINDOW_INPUT_GRABBED = 0x00000100,      
     SDL_WINDOW_INPUT_FOCUS = 0x00000200,        
     SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        
     SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
     SDL_WINDOW_FOREIGN = 0x00000800,            
     SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000,      
     SDL_WINDOW_MOUSE_CAPTURE = 0x00004000,      
     SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000,      
     SDL_WINDOW_SKIP_TASKBAR  = 0x00010000,      
     SDL_WINDOW_UTILITY       = 0x00020000,      
     SDL_WINDOW_TOOLTIP       = 0x00040000,      
     SDL_WINDOW_POPUP_MENU    = 0x00080000,      
     SDL_WINDOW_VULKAN        = 0x10000000       
 } SDL_WindowFlags;

◆ SDL_WindowEventID

enum SDL_WindowEventID

Event subtype for window events.

Элементы перечислений
SDL_WINDOWEVENT_NONE	Never used
SDL_WINDOWEVENT_SHOWN	Window has been shown
SDL_WINDOWEVENT_HIDDEN	Window has been hidden
SDL_WINDOWEVENT_EXPOSED	Window has been exposed and should be redrawn
SDL_WINDOWEVENT_MOVED	Window has been moved to data1, data2
SDL_WINDOWEVENT_RESIZED	Window has been resized to data1xdata2
SDL_WINDOWEVENT_SIZE_CHANGED	The window size has changed, either as a result of an API call or through the system or user changing the window size.
SDL_WINDOWEVENT_MINIMIZED	Window has been minimized
SDL_WINDOWEVENT_MAXIMIZED	Window has been maximized
SDL_WINDOWEVENT_RESTORED	Window has been restored to normal size and position
SDL_WINDOWEVENT_ENTER	Window has gained mouse focus
SDL_WINDOWEVENT_LEAVE	Window has lost mouse focus
SDL_WINDOWEVENT_FOCUS_GAINED	Window has gained keyboard focus
SDL_WINDOWEVENT_FOCUS_LOST	Window has lost keyboard focus
SDL_WINDOWEVENT_CLOSE	The window manager requests that the window be closed
SDL_WINDOWEVENT_TAKE_FOCUS	Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore)
SDL_WINDOWEVENT_HIT_TEST	Window had a hit test that wasn't SDL_HITTEST_NORMAL.

См. определение в файле SDL_video.h строка 145

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

◆ SDL_DisplayEventID

enum SDL_DisplayEventID

Event subtype for display events.

Элементы перечислений
SDL_DISPLAYEVENT_NONE	Never used
SDL_DISPLAYEVENT_ORIENTATION	Display orientation has changed to data1

См. определение в файле SDL_video.h строка 174

 {
     SDL_DISPLAYEVENT_NONE,          
     SDL_DISPLAYEVENT_ORIENTATION    
 } SDL_DisplayEventID;

◆ SDL_DisplayOrientation

enum SDL_DisplayOrientation

Элементы перечислений
SDL_ORIENTATION_UNKNOWN	The display orientation can't be determined
SDL_ORIENTATION_LANDSCAPE	The display is in landscape mode, with the right side up, relative to portrait mode
SDL_ORIENTATION_LANDSCAPE_FLIPPED	The display is in landscape mode, with the left side up, relative to portrait mode
SDL_ORIENTATION_PORTRAIT	The display is in portrait mode
SDL_ORIENTATION_PORTRAIT_FLIPPED	The display is in portrait mode, upside down

См. определение в файле SDL_video.h строка 180

 {
     SDL_ORIENTATION_UNKNOWN,            
     SDL_ORIENTATION_LANDSCAPE,          
     SDL_ORIENTATION_LANDSCAPE_FLIPPED,  
     SDL_ORIENTATION_PORTRAIT,           
     SDL_ORIENTATION_PORTRAIT_FLIPPED    
 } SDL_DisplayOrientation;

◆ SDL_GLattr

enum SDL_GLattr

OpenGL configuration attributes.

Элементы перечислений
SDL_GL_RED_SIZE
SDL_GL_GREEN_SIZE
SDL_GL_BLUE_SIZE
SDL_GL_ALPHA_SIZE
SDL_GL_BUFFER_SIZE
SDL_GL_DOUBLEBUFFER
SDL_GL_DEPTH_SIZE
SDL_GL_STENCIL_SIZE
SDL_GL_ACCUM_RED_SIZE
SDL_GL_ACCUM_GREEN_SIZE
SDL_GL_ACCUM_BLUE_SIZE
SDL_GL_ACCUM_ALPHA_SIZE
SDL_GL_STEREO
SDL_GL_MULTISAMPLEBUFFERS
SDL_GL_MULTISAMPLESAMPLES
SDL_GL_ACCELERATED_VISUAL
SDL_GL_RETAINED_BACKING
SDL_GL_CONTEXT_MAJOR_VERSION
SDL_GL_CONTEXT_MINOR_VERSION
SDL_GL_CONTEXT_EGL
SDL_GL_CONTEXT_FLAGS
SDL_GL_CONTEXT_PROFILE_MASK
SDL_GL_SHARE_WITH_CURRENT_CONTEXT
SDL_GL_FRAMEBUFFER_SRGB_CAPABLE
SDL_GL_CONTEXT_RELEASE_BEHAVIOR
SDL_GL_CONTEXT_RESET_NOTIFICATION
SDL_GL_CONTEXT_NO_ERROR

См. определение в файле SDL_video.h строка 197

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

◆ SDL_GLprofile

enum SDL_GLprofile

Элементы перечислений
SDL_GL_CONTEXT_PROFILE_CORE
SDL_GL_CONTEXT_PROFILE_COMPATIBILITY
SDL_GL_CONTEXT_PROFILE_ES	GLX_CONTEXT_ES2_PROFILE_BIT_EXT

См. определение в файле SDL_video.h строка 228

 {
     SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
     SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
     SDL_GL_CONTEXT_PROFILE_ES             = 0x0004 
 } SDL_GLprofile;

◆ SDL_GLcontextFlag

enum SDL_GLcontextFlag

Элементы перечислений
SDL_GL_CONTEXT_DEBUG_FLAG
SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG
SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG
SDL_GL_CONTEXT_RESET_ISOLATION_FLAG

См. определение в файле SDL_video.h строка 235

 {
     SDL_GL_CONTEXT_DEBUG_FLAG              = 0x0001,
     SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
     SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG      = 0x0004,
     SDL_GL_CONTEXT_RESET_ISOLATION_FLAG    = 0x0008
 } SDL_GLcontextFlag;

◆ SDL_GLcontextReleaseFlag

enum SDL_GLcontextReleaseFlag

Элементы перечислений
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE
SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH

См. определение в файле SDL_video.h строка 243

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

◆ SDL_GLContextResetNotification

enum SDL_GLContextResetNotification

Элементы перечислений
SDL_GL_CONTEXT_RESET_NO_NOTIFICATION
SDL_GL_CONTEXT_RESET_LOSE_CONTEXT

См. определение в файле SDL_video.h строка 249

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

◆ SDL_HitTestResult

enum SDL_HitTestResult

Possible return values from the SDL_HitTest callback.

См. также: SDL_HitTest

Элементы перечислений
SDL_HITTEST_NORMAL	Region is normal. No special properties.
SDL_HITTEST_DRAGGABLE	Region can drag entire window.
SDL_HITTEST_RESIZE_TOPLEFT
SDL_HITTEST_RESIZE_TOP
SDL_HITTEST_RESIZE_TOPRIGHT
SDL_HITTEST_RESIZE_RIGHT
SDL_HITTEST_RESIZE_BOTTOMRIGHT
SDL_HITTEST_RESIZE_BOTTOM
SDL_HITTEST_RESIZE_BOTTOMLEFT
SDL_HITTEST_RESIZE_LEFT

См. определение в файле SDL_video.h строка 1019

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

Функции

◆ SDL_GetNumVideoDrivers()

DECLSPEC int SDLCALL SDL_GetNumVideoDrivers ( void )

Get the number of video drivers compiled into SDL.

См. также: SDL_GetVideoDriver()

◆ SDL_GetVideoDriver()

const DECLSPEC char* SDLCALL SDL_GetVideoDriver ( int index )

Get the name of a built in video driver.

Заметки: The video drivers are presented in the order in which they are normally checked during initialization.

См. также: SDL_GetNumVideoDrivers()

◆ SDL_VideoInit()

DECLSPEC int SDLCALL SDL_VideoInit ( const char * driver_name )

Initialize the video subsystem, optionally specifying a video driver.

Аргументы

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

Возвращает: 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.

См. также: SDL_VideoQuit()

◆ SDL_VideoQuit()

DECLSPEC void SDLCALL SDL_VideoQuit ( void )

Shuts down the video subsystem.

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

См. также: SDL_VideoInit()

◆ SDL_GetCurrentVideoDriver()

const DECLSPEC char* SDLCALL SDL_GetCurrentVideoDriver ( void )

Returns the name of the currently initialized video driver.

Возвращает: The name of the current video driver or NULL if no driver has been initialized

См. также: SDL_GetNumVideoDrivers(); SDL_GetVideoDriver()

◆ SDL_GetNumVideoDisplays()

DECLSPEC int SDLCALL SDL_GetNumVideoDisplays ( void )

Returns the number of available video displays.

См. также: SDL_GetDisplayBounds()

◆ SDL_GetDisplayName()

const DECLSPEC char* SDLCALL SDL_GetDisplayName ( int displayIndex )

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

Возвращает: The name of a display, or NULL for an invalid display index.

См. также: SDL_GetNumVideoDisplays()

◆ SDL_GetDisplayBounds()

DECLSPEC int SDLCALL SDL_GetDisplayBounds	(	int	displayIndex,
		SDL_Rect *	rect
	)

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

Возвращает: 0 on success, or -1 if the index is out of range.

См. также: SDL_GetNumVideoDisplays()

◆ SDL_GetDisplayUsableBounds()

DECLSPEC int SDLCALL 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.

Возвращает: 0 on success, or -1 if the index is out of range.

См. также: SDL_GetDisplayBounds(); SDL_GetNumVideoDisplays()

◆ SDL_GetDisplayDPI()

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

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

Заметки: Diagonal, horizontal and vertical DPI can all be optionally returned if the parameter is non-NULL.

Возвращает: 0 on success, or -1 if no DPI information is available or the index is out of range.

См. также: SDL_GetNumVideoDisplays()

◆ SDL_GetDisplayOrientation()

DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetDisplayOrientation ( int displayIndex )

Get the orientation of a display.

Возвращает: The orientation of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available.

См. также: SDL_GetNumVideoDisplays()

◆ SDL_GetNumDisplayModes()

DECLSPEC int SDLCALL SDL_GetNumDisplayModes ( int displayIndex )

Returns the number of available display modes.

См. также: SDL_GetDisplayMode()

◆ SDL_GetDisplayMode()

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

Fill in information about a specific display mode.

Заметки

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

См. также: SDL_GetNumDisplayModes()

◆ SDL_GetDesktopDisplayMode()

DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode	(	int	displayIndex,
		SDL_DisplayMode *	mode
	)

Fill in information about the desktop display mode.

◆ SDL_GetCurrentDisplayMode()

DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode	(	int	displayIndex,
		SDL_DisplayMode *	mode
	)

Fill in information about the current display mode.

◆ SDL_GetClosestDisplayMode()

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

Get the closest match to the requested display mode.

Аргументы

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

Возвращает: 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.

См. также: SDL_GetNumDisplayModes(); SDL_GetDisplayMode()

◆ SDL_GetWindowDisplayIndex()

DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex ( SDL_Window * window )

Get the display index associated with a window.

Возвращает: the display index of the display containing the center of the window, or -1 on error.

◆ SDL_SetWindowDisplayMode()

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

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

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

Аргументы

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

Возвращает: 0 on success, or -1 if setting the display mode failed.

См. также: SDL_GetWindowDisplayMode(); SDL_SetWindowFullscreen()

◆ SDL_GetWindowDisplayMode()

DECLSPEC int SDLCALL SDL_GetWindowDisplayMode	(	SDL_Window *	window,
		SDL_DisplayMode *	mode
	)

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

См. также: SDL_SetWindowDisplayMode(); SDL_SetWindowFullscreen()

◆ SDL_GetWindowPixelFormat()

DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat ( SDL_Window * window )

Get the pixel format associated with the window.

◆ SDL_CreateWindow()

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

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

Аргументы

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

Возвращает: 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.

Заметки: 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.

См. также: SDL_DestroyWindow(); SDL_GL_LoadLibrary(); SDL_Vulkan_LoadLibrary()

Используется в OSWindowFactory::CreateSdl2().

Граф вызова функции:

◆ SDL_CreateWindowFrom()

DECLSPEC SDL_Window* SDLCALL SDL_CreateWindowFrom ( const void * data )

Create an SDL window from an existing native window.

Аргументы

data	A pointer to driver-dependent window creation data

Возвращает: The created window, or NULL if window creation failed.

См. также: SDL_DestroyWindow()

◆ SDL_GetWindowID()

DECLSPEC Uint32 SDLCALL SDL_GetWindowID ( SDL_Window * window )

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

◆ SDL_GetWindowFromID()

DECLSPEC SDL_Window* SDLCALL SDL_GetWindowFromID ( Uint32 id )

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

◆ SDL_GetWindowFlags()

DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags ( SDL_Window * window )

Get the window flags.

Используется в Sdl2Window::Focused().

Граф вызова функции:

◆ SDL_SetWindowTitle()

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

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

См. также: SDL_GetWindowTitle()

◆ SDL_GetWindowTitle()

const DECLSPEC char* SDLCALL SDL_GetWindowTitle ( SDL_Window * window )

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

См. также: SDL_SetWindowTitle()

◆ SDL_SetWindowIcon()

DECLSPEC void SDLCALL SDL_SetWindowIcon	(	SDL_Window *	window,
		SDL_Surface *	icon
	)

Set the icon for a window.

Аргументы

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

◆ SDL_SetWindowData()

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

Associate an arbitrary named pointer with a window.

Аргументы

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

Возвращает: The previous value associated with 'name'

Заметки: The name is case-sensitive.

См. также: SDL_GetWindowData()

◆ SDL_GetWindowData()

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

Retrieve the data pointer associated with a window.

Аргументы

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

Возвращает: The value associated with 'name'

См. также: SDL_SetWindowData()

◆ SDL_SetWindowPosition()

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

Set the position of a window.

Аргументы

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

Заметки: The window coordinate origin is the upper left of the display.

См. также: SDL_GetWindowPosition()

◆ SDL_GetWindowPosition()

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

Get the position of a window.

Аргументы

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

См. также: SDL_SetWindowPosition()

Используется в Sdl2Window::GetX() и Sdl2Window::GetY().

Граф вызова функции:

◆ SDL_SetWindowSize()

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

Set the size of a window's client area.

Аргументы

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

Заметки: 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.

См. также: SDL_GetWindowSize(); SDL_SetWindowDisplayMode()

◆ SDL_GetWindowSize()

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

Get the size of a window's client area.

Аргументы

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

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

См. также: SDL_SetWindowSize()

Используется в Sdl2Window::GetHeight() и Sdl2Window::GetWidth().

Граф вызова функции:

◆ SDL_GetWindowBordersSize()

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

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

Аргументы

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

Возвращает: 0 on success, or -1 if getting this information is not supported.

Заметки: 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.

◆ SDL_SetWindowMinimumSize()

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

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

Аргументы

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

Заметки: You can't change the minimum size of a fullscreen window, it automatically matches the size of the display mode.

См. также: SDL_GetWindowMinimumSize(); SDL_SetWindowMaximumSize()

◆ SDL_GetWindowMinimumSize()

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

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

Аргументы

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

См. также: SDL_GetWindowMaximumSize(); SDL_SetWindowMinimumSize()

◆ SDL_SetWindowMaximumSize()

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

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

Аргументы

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

Заметки: You can't change the maximum size of a fullscreen window, it automatically matches the size of the display mode.

См. также: SDL_GetWindowMaximumSize(); SDL_SetWindowMinimumSize()

◆ SDL_GetWindowMaximumSize()

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

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

Аргументы

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

См. также: SDL_GetWindowMinimumSize(); SDL_SetWindowMaximumSize()

◆ SDL_SetWindowBordered()

DECLSPEC void SDLCALL SDL_SetWindowBordered	(	SDL_Window *	window,
		SDL_bool	bordered
	)

Set the border state of a window.

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

Аргументы

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

Заметки: You can't change the border state of a fullscreen window.

См. также: SDL_GetWindowFlags()

◆ SDL_SetWindowResizable()

DECLSPEC void SDLCALL SDL_SetWindowResizable	(	SDL_Window *	window,
		SDL_bool	resizable
	)

Set the user-resizable state of a window.

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

Аргументы

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

Заметки: You can't change the resizable state of a fullscreen window.

См. также: SDL_GetWindowFlags()

◆ SDL_ShowWindow()

DECLSPEC void SDLCALL SDL_ShowWindow ( SDL_Window * window )

Show a window.

См. также: SDL_HideWindow()

Используется в Sdl2Window::Show().

Граф вызова функции:

◆ SDL_HideWindow()

DECLSPEC void SDLCALL SDL_HideWindow ( SDL_Window * window )

Hide a window.

См. также: SDL_ShowWindow()

◆ SDL_RaiseWindow()

DECLSPEC void SDLCALL SDL_RaiseWindow ( SDL_Window * window )

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

Используется в Sdl2Window::Activate() и Sdl2Window::Show().

Граф вызова функции:

◆ SDL_MaximizeWindow()

DECLSPEC void SDLCALL SDL_MaximizeWindow ( SDL_Window * window )

Make a window as large as possible.

См. также: SDL_RestoreWindow()

◆ SDL_MinimizeWindow()

DECLSPEC void SDLCALL SDL_MinimizeWindow ( SDL_Window * window )

Minimize a window to an iconic representation.

См. также: SDL_RestoreWindow()

◆ SDL_RestoreWindow()

DECLSPEC void SDLCALL SDL_RestoreWindow ( SDL_Window * window )

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

См. также: SDL_MaximizeWindow(); SDL_MinimizeWindow()

◆ SDL_SetWindowFullscreen()

DECLSPEC int SDLCALL SDL_SetWindowFullscreen	(	SDL_Window *	window,
		Uint32	flags
	)

Set a window's fullscreen state.

Возвращает: 0 on success, or -1 if setting the display mode failed.

См. также: SDL_SetWindowDisplayMode(); SDL_GetWindowDisplayMode()

◆ SDL_GetWindowSurface()

DECLSPEC SDL_Surface* SDLCALL SDL_GetWindowSurface ( SDL_Window * window )

Get the SDL surface associated with the window.

Возвращает: 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.

Заметки: You may not combine this with 3D or the rendering API on this window.

См. также: SDL_UpdateWindowSurface(); SDL_UpdateWindowSurfaceRects()

Используется в OSWindowFactory::CreateSdl2().

Граф вызова функции:

◆ SDL_UpdateWindowSurface()

DECLSPEC int SDLCALL SDL_UpdateWindowSurface ( SDL_Window * window )

Copy the window surface to the screen.

Возвращает: 0 on success, or -1 on error.

См. также: SDL_GetWindowSurface(); SDL_UpdateWindowSurfaceRects()

◆ SDL_UpdateWindowSurfaceRects()

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

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

Возвращает: 0 on success, or -1 on error.

См. также: SDL_GetWindowSurface(); SDL_UpdateWindowSurface()

◆ SDL_SetWindowGrab()

DECLSPEC void SDLCALL SDL_SetWindowGrab	(	SDL_Window *	window,
		SDL_bool	grabbed
	)

Set a window's input grab mode.

Аргументы

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

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

См. также: SDL_GetWindowGrab()

◆ SDL_GetWindowGrab()

DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab ( SDL_Window * window )

Get a window's input grab mode.

Возвращает: This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.

См. также: SDL_SetWindowGrab()

◆ SDL_GetGrabbedWindow()

DECLSPEC SDL_Window* SDLCALL SDL_GetGrabbedWindow ( void )

Get the window that currently has an input grab enabled.

Возвращает: This returns the window if input is grabbed, and NULL otherwise.

См. также: SDL_SetWindowGrab()

◆ SDL_SetWindowBrightness()

DECLSPEC int SDLCALL SDL_SetWindowBrightness	(	SDL_Window *	window,
		float	brightness
	)

Set the brightness (gamma correction) for a window.

Возвращает: 0 on success, or -1 if setting the brightness isn't supported.

См. также: SDL_GetWindowBrightness(); SDL_SetWindowGammaRamp()

◆ SDL_GetWindowBrightness()

DECLSPEC float SDLCALL SDL_GetWindowBrightness ( SDL_Window * window )

Get the brightness (gamma correction) for a window.

Возвращает: The last brightness value passed to SDL_SetWindowBrightness()

См. также: SDL_SetWindowBrightness()

◆ SDL_SetWindowOpacity()

DECLSPEC int SDLCALL SDL_SetWindowOpacity	(	SDL_Window *	window,
		float	opacity
	)

Set the opacity for a window.

Аргументы

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

Возвращает: 0 on success, or -1 if setting the opacity isn't supported.

См. также: SDL_GetWindowOpacity()

◆ SDL_GetWindowOpacity()

DECLSPEC int SDLCALL SDL_GetWindowOpacity	(	SDL_Window *	window,
		float *	out_opacity
	)

Get the opacity of a window.

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

Аргументы

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

Возвращает: 0 on success, or -1 on error (invalid window, etc).

См. также: SDL_SetWindowOpacity()

◆ SDL_SetWindowModalFor()

DECLSPEC int SDLCALL SDL_SetWindowModalFor	(	SDL_Window *	modal_window,
		SDL_Window *	parent_window
	)

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

Аргументы

modal_window	The window that should be modal
parent_window	The parent window

Возвращает: 0 on success, or -1 otherwise.

◆ SDL_SetWindowInputFocus()

DECLSPEC int SDLCALL SDL_SetWindowInputFocus ( SDL_Window * window )

Explicitly sets input focus to the window.

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

Аргументы

window The window that should get the input focus

Возвращает: 0 on success, or -1 otherwise.

См. также: SDL_RaiseWindow()

◆ SDL_SetWindowGammaRamp()

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

Set the gamma ramp for a window.

Аргументы

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

Возвращает: 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.

См. также: SDL_GetWindowGammaRamp()

◆ SDL_GetWindowGammaRamp()

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

Get the gamma ramp for a window.

Аргументы

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

Возвращает: 0 on success, or -1 if gamma ramps are unsupported.

См. также: SDL_SetWindowGammaRamp()

◆ SDL_SetWindowHitTest()

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

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

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

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

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

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

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

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

Аргументы

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

Возвращает: 0 on success, -1 on error (including unsupported).

◆ SDL_DestroyWindow()

DECLSPEC void SDLCALL SDL_DestroyWindow ( SDL_Window * window )

Destroy a window.

Используется в OSWindowFactory::CreateSdl2().

Граф вызова функции:

◆ SDL_IsScreenSaverEnabled()

DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled ( void )

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

См. также: SDL_EnableScreenSaver(); SDL_DisableScreenSaver()

◆ SDL_EnableScreenSaver()

DECLSPEC void SDLCALL SDL_EnableScreenSaver ( void )

Allow the screen to be blanked by a screensaver.

См. также: SDL_IsScreenSaverEnabled(); SDL_DisableScreenSaver()

◆ SDL_DisableScreenSaver()

DECLSPEC void SDLCALL SDL_DisableScreenSaver ( void )

Prevent the screen from being blanked by a screensaver.

См. также: SDL_IsScreenSaverEnabled(); SDL_EnableScreenSaver()

◆ SDL_GL_LoadLibrary()

DECLSPEC int SDLCALL SDL_GL_LoadLibrary ( const char * path )

Dynamically load an OpenGL library.

Аргументы

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

Возвращает: 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.

Заметки: 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().

См. также: SDL_GL_GetProcAddress(); SDL_GL_UnloadLibrary()

◆ SDL_GL_GetProcAddress()

DECLSPEC void* SDLCALL SDL_GL_GetProcAddress ( const char * proc )

Get the address of an OpenGL function.

◆ SDL_GL_UnloadLibrary()

DECLSPEC void SDLCALL SDL_GL_UnloadLibrary ( void )

Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().

См. также: SDL_GL_LoadLibrary()

◆ SDL_GL_ExtensionSupported()

DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported ( const char * extension )

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

◆ SDL_GL_ResetAttributes()

DECLSPEC void SDLCALL SDL_GL_ResetAttributes ( void )

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

◆ SDL_GL_SetAttribute()

DECLSPEC int SDLCALL SDL_GL_SetAttribute	(	SDL_GLattr	attr,
		int	value
	)

Set an OpenGL window attribute before window creation.

Возвращает: 0 on success, or -1 if the attribute could not be set.

Используется в Sdl2Window::OpenGlCreate().

Граф вызова функции:

◆ SDL_GL_GetAttribute()

DECLSPEC int SDLCALL SDL_GL_GetAttribute	(	SDL_GLattr	attr,
		int *	value
	)

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

Возвращает: 0 on success, or -1 if the attribute could not be retrieved. The integer at value will be modified in either case.

◆ SDL_GL_CreateContext()

DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext ( SDL_Window * window )

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

См. также: SDL_GL_DeleteContext()

Используется в Sdl2Window::OpenGlCreate().

Граф вызова функции:

◆ SDL_GL_MakeCurrent()

DECLSPEC int SDLCALL SDL_GL_MakeCurrent	(	SDL_Window *	window,
		SDL_GLContext	context
	)

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

Заметки: The context must have been created with a compatible window.

◆ SDL_GL_GetCurrentWindow()

DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow ( void )

Get the currently active OpenGL window.

◆ SDL_GL_GetCurrentContext()

DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext ( void )

Get the currently active OpenGL context.

◆ SDL_GL_GetDrawableSize()

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

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

Аргументы

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

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

См. также: SDL_GetWindowSize(); SDL_CreateWindow()

◆ SDL_GL_SetSwapInterval()

DECLSPEC int SDLCALL SDL_GL_SetSwapInterval ( int interval )

Set the swap interval for the current OpenGL context.

Аргументы

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

Возвращает: 0 on success, or -1 if setting the swap interval is not supported.

См. также: SDL_GL_GetSwapInterval()

Используется в Sdl2Window::OpenGlCreate().

Граф вызова функции:

◆ SDL_GL_GetSwapInterval()

DECLSPEC int SDLCALL SDL_GL_GetSwapInterval ( void )

Get the swap interval for the current OpenGL context.

Возвращает: 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.

См. также: SDL_GL_SetSwapInterval()

◆ SDL_GL_SwapWindow()

DECLSPEC void SDLCALL SDL_GL_SwapWindow ( SDL_Window * window )

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

Используется в Sdl2Window::OpenGlSwapBuffers().

Граф вызова функции:

◆ SDL_GL_DeleteContext()

DECLSPEC void SDLCALL SDL_GL_DeleteContext ( SDL_GLContext context )

Delete an OpenGL context.

См. также: SDL_GL_CreateContext()

Классы

Определения типов

Перечисления

Функции

Подробное описание

Типы

◆ SDL_Window

◆ SDL_GLContext

◆ SDL_HitTest

Перечисления

◆ SDL_WindowFlags

◆ SDL_WindowEventID

◆ SDL_DisplayEventID

◆ SDL_DisplayOrientation

◆ SDL_GLattr

◆ SDL_GLprofile

◆ SDL_GLcontextFlag

◆ SDL_GLcontextReleaseFlag

◆ SDL_GLContextResetNotification

◆ SDL_HitTestResult

Функции

◆ SDL_GetNumVideoDrivers()

◆ SDL_GetVideoDriver()

◆ SDL_VideoInit()

◆ SDL_VideoQuit()

◆ SDL_GetCurrentVideoDriver()

◆ SDL_GetNumVideoDisplays()

◆ SDL_GetDisplayName()

◆ SDL_GetDisplayBounds()

◆ SDL_GetDisplayUsableBounds()

◆ SDL_GetDisplayDPI()

◆ SDL_GetDisplayOrientation()

◆ SDL_GetNumDisplayModes()

◆ SDL_GetDisplayMode()

◆ SDL_GetDesktopDisplayMode()

◆ SDL_GetCurrentDisplayMode()

◆ SDL_GetClosestDisplayMode()

◆ SDL_GetWindowDisplayIndex()

◆ SDL_SetWindowDisplayMode()

◆ SDL_GetWindowDisplayMode()

◆ SDL_GetWindowPixelFormat()

◆ SDL_CreateWindow()

◆ SDL_CreateWindowFrom()

◆ SDL_GetWindowID()

◆ SDL_GetWindowFromID()

◆ SDL_GetWindowFlags()

◆ SDL_SetWindowTitle()

◆ SDL_GetWindowTitle()

◆ SDL_SetWindowIcon()

◆ SDL_SetWindowData()

◆ SDL_GetWindowData()

◆ SDL_SetWindowPosition()

◆ SDL_GetWindowPosition()

◆ SDL_SetWindowSize()

◆ SDL_GetWindowSize()

◆ SDL_GetWindowBordersSize()

◆ SDL_SetWindowMinimumSize()

◆ SDL_GetWindowMinimumSize()

◆ SDL_SetWindowMaximumSize()

◆ SDL_GetWindowMaximumSize()

◆ SDL_SetWindowBordered()

◆ SDL_SetWindowResizable()

◆ SDL_ShowWindow()

◆ SDL_HideWindow()

◆ SDL_RaiseWindow()

◆ SDL_MaximizeWindow()

◆ SDL_MinimizeWindow()

◆ SDL_RestoreWindow()

◆ SDL_SetWindowFullscreen()

◆ SDL_GetWindowSurface()

◆ SDL_UpdateWindowSurface()

◆ SDL_UpdateWindowSurfaceRects()

◆ SDL_SetWindowGrab()

◆ SDL_GetWindowGrab()

◆ SDL_GetGrabbedWindow()

◆ SDL_SetWindowBrightness()

◆ SDL_GetWindowBrightness()

◆ SDL_SetWindowOpacity()

◆ SDL_GetWindowOpacity()

◆ SDL_SetWindowModalFor()