|
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_MOUSE_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_KEYBOARD_GRABBED = 0x00100000
,
SDL_WINDOW_VULKAN = 0x10000000
,
SDL_WINDOW_METAL = 0x20000000
,
SDL_WINDOW_INPUT_GRABBED = SDL_WINDOW_MOUSE_GRABBED
} |
|
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
,
SDL_WINDOWEVENT_ICCPROF_CHANGED
,
SDL_WINDOWEVENT_DISPLAY_CHANGED
} |
|
enum | SDL_DisplayEventID {
SDL_DISPLAYEVENT_NONE
,
SDL_DISPLAYEVENT_ORIENTATION
,
SDL_DISPLAYEVENT_CONNECTED
,
SDL_DISPLAYEVENT_DISCONNECTED
,
SDL_DISPLAYEVENT_MOVED
} |
|
enum | SDL_DisplayOrientation {
SDL_ORIENTATION_UNKNOWN
,
SDL_ORIENTATION_LANDSCAPE
,
SDL_ORIENTATION_LANDSCAPE_FLIPPED
,
SDL_ORIENTATION_PORTRAIT
,
SDL_ORIENTATION_PORTRAIT_FLIPPED
} |
|
enum | SDL_FlashOperation {
SDL_FLASH_CANCEL
,
SDL_FLASH_BRIEFLY
,
SDL_FLASH_UNTIL_FOCUSED
} |
|
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
,
SDL_GL_FLOATBUFFERS
} |
|
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
} |
|
|
int | SDL_GetNumVideoDrivers (void) |
|
const char * | SDL_GetVideoDriver (int index) |
|
int | SDL_VideoInit (const char *driver_name) |
|
void | SDL_VideoQuit (void) |
|
const char * | SDL_GetCurrentVideoDriver (void) |
|
int | SDL_GetNumVideoDisplays (void) |
|
const char * | SDL_GetDisplayName (int displayIndex) |
|
int | SDL_GetDisplayBounds (int displayIndex, SDL_Rect *rect) |
|
int | SDL_GetDisplayUsableBounds (int displayIndex, SDL_Rect *rect) |
|
int | SDL_GetDisplayDPI (int displayIndex, float *ddpi, float *hdpi, float *vdpi) |
|
SDL_DisplayOrientation | SDL_GetDisplayOrientation (int displayIndex) |
|
int | SDL_GetNumDisplayModes (int displayIndex) |
|
int | SDL_GetDisplayMode (int displayIndex, int modeIndex, SDL_DisplayMode *mode) |
|
int | SDL_GetDesktopDisplayMode (int displayIndex, SDL_DisplayMode *mode) |
|
int | SDL_GetCurrentDisplayMode (int displayIndex, SDL_DisplayMode *mode) |
|
SDL_DisplayMode * | SDL_GetClosestDisplayMode (int displayIndex, const SDL_DisplayMode *mode, SDL_DisplayMode *closest) |
|
int | SDL_GetPointDisplayIndex (const SDL_Point *point) |
|
int | SDL_GetRectDisplayIndex (const SDL_Rect *rect) |
|
int | SDL_GetWindowDisplayIndex (SDL_Window *window) |
|
int | SDL_SetWindowDisplayMode (SDL_Window *window, const SDL_DisplayMode *mode) |
|
int | SDL_GetWindowDisplayMode (SDL_Window *window, SDL_DisplayMode *mode) |
|
void * | SDL_GetWindowICCProfile (SDL_Window *window, size_t *size) |
|
Uint32 | SDL_GetWindowPixelFormat (SDL_Window *window) |
|
SDL_Window * | SDL_CreateWindow (const char *title, int x, int y, int w, int h, Uint32 flags) |
|
SDL_Window * | SDL_CreateWindowFrom (const void *data) |
|
Uint32 | SDL_GetWindowID (SDL_Window *window) |
|
SDL_Window * | SDL_GetWindowFromID (Uint32 id) |
|
Uint32 | SDL_GetWindowFlags (SDL_Window *window) |
|
void | SDL_SetWindowTitle (SDL_Window *window, const char *title) |
|
const char * | SDL_GetWindowTitle (SDL_Window *window) |
|
void | SDL_SetWindowIcon (SDL_Window *window, SDL_Surface *icon) |
|
void * | SDL_SetWindowData (SDL_Window *window, const char *name, void *userdata) |
|
void * | SDL_GetWindowData (SDL_Window *window, const char *name) |
|
void | SDL_SetWindowPosition (SDL_Window *window, int x, int y) |
|
void | SDL_GetWindowPosition (SDL_Window *window, int *x, int *y) |
|
void | SDL_SetWindowSize (SDL_Window *window, int w, int h) |
|
void | SDL_GetWindowSize (SDL_Window *window, int *w, int *h) |
|
int | SDL_GetWindowBordersSize (SDL_Window *window, int *top, int *left, int *bottom, int *right) |
|
void | SDL_GetWindowSizeInPixels (SDL_Window *window, int *w, int *h) |
|
void | SDL_SetWindowMinimumSize (SDL_Window *window, int min_w, int min_h) |
|
void | SDL_GetWindowMinimumSize (SDL_Window *window, int *w, int *h) |
|
void | SDL_SetWindowMaximumSize (SDL_Window *window, int max_w, int max_h) |
|
void | SDL_GetWindowMaximumSize (SDL_Window *window, int *w, int *h) |
|
void | SDL_SetWindowBordered (SDL_Window *window, SDL_bool bordered) |
|
void | SDL_SetWindowResizable (SDL_Window *window, SDL_bool resizable) |
|
void | SDL_SetWindowAlwaysOnTop (SDL_Window *window, SDL_bool on_top) |
|
void | SDL_ShowWindow (SDL_Window *window) |
|
void | SDL_HideWindow (SDL_Window *window) |
|
void | SDL_RaiseWindow (SDL_Window *window) |
|
void | SDL_MaximizeWindow (SDL_Window *window) |
|
void | SDL_MinimizeWindow (SDL_Window *window) |
|
void | SDL_RestoreWindow (SDL_Window *window) |
|
int | SDL_SetWindowFullscreen (SDL_Window *window, Uint32 flags) |
|
SDL_bool | SDL_HasWindowSurface (SDL_Window *window) |
|
SDL_Surface * | SDL_GetWindowSurface (SDL_Window *window) |
|
int | SDL_UpdateWindowSurface (SDL_Window *window) |
|
int | SDL_UpdateWindowSurfaceRects (SDL_Window *window, const SDL_Rect *rects, int numrects) |
|
int | SDL_DestroyWindowSurface (SDL_Window *window) |
|
void | SDL_SetWindowGrab (SDL_Window *window, SDL_bool grabbed) |
|
void | SDL_SetWindowKeyboardGrab (SDL_Window *window, SDL_bool grabbed) |
|
void | SDL_SetWindowMouseGrab (SDL_Window *window, SDL_bool grabbed) |
|
SDL_bool | SDL_GetWindowGrab (SDL_Window *window) |
|
SDL_bool | SDL_GetWindowKeyboardGrab (SDL_Window *window) |
|
SDL_bool | SDL_GetWindowMouseGrab (SDL_Window *window) |
|
SDL_Window * | SDL_GetGrabbedWindow (void) |
|
int | SDL_SetWindowMouseRect (SDL_Window *window, const SDL_Rect *rect) |
|
const SDL_Rect * | SDL_GetWindowMouseRect (SDL_Window *window) |
|
int | SDL_SetWindowBrightness (SDL_Window *window, float brightness) |
|
float | SDL_GetWindowBrightness (SDL_Window *window) |
|
int | SDL_SetWindowOpacity (SDL_Window *window, float opacity) |
|
int | SDL_GetWindowOpacity (SDL_Window *window, float *out_opacity) |
|
int | SDL_SetWindowModalFor (SDL_Window *modal_window, SDL_Window *parent_window) |
|
int | SDL_SetWindowInputFocus (SDL_Window *window) |
|
int | SDL_SetWindowGammaRamp (SDL_Window *window, const Uint16 *red, const Uint16 *green, const Uint16 *blue) |
|
int | SDL_GetWindowGammaRamp (SDL_Window *window, Uint16 *red, Uint16 *green, Uint16 *blue) |
|
int | SDL_SetWindowHitTest (SDL_Window *window, SDL_HitTest callback, void *callback_data) |
|
int | SDL_FlashWindow (SDL_Window *window, SDL_FlashOperation operation) |
|
void | SDL_DestroyWindow (SDL_Window *window) |
|
SDL_bool | SDL_IsScreenSaverEnabled (void) |
|
void | SDL_EnableScreenSaver (void) |
|
void | SDL_DisableScreenSaver (void) |
|
|
int | SDL_GL_LoadLibrary (const char *path) |
|
void * | SDL_GL_GetProcAddress (const char *proc) |
|
void | SDL_GL_UnloadLibrary (void) |
|
SDL_bool | SDL_GL_ExtensionSupported (const char *extension) |
|
void | SDL_GL_ResetAttributes (void) |
|
int | SDL_GL_SetAttribute (SDL_GLattr attr, int value) |
|
int | SDL_GL_GetAttribute (SDL_GLattr attr, int *value) |
|
SDL_GLContext | SDL_GL_CreateContext (SDL_Window *window) |
|
int | SDL_GL_MakeCurrent (SDL_Window *window, SDL_GLContext context) |
|
SDL_Window * | SDL_GL_GetCurrentWindow (void) |
|
SDL_GLContext | SDL_GL_GetCurrentContext (void) |
|
void | SDL_GL_GetDrawableSize (SDL_Window *window, int *w, int *h) |
|
int | SDL_GL_SetSwapInterval (int interval) |
|
int | SDL_GL_GetSwapInterval (void) |
|
void | SDL_GL_SwapWindow (SDL_Window *window) |
|
void | SDL_GL_DeleteContext (SDL_GLContext context) |
|
OpenGL configuration attributes.
While you can set most OpenGL attributes normally, the attributes listed above must be known before SDL creates the window that will be used with the OpenGL context. These attributes are set and read with SDL_GL_SetAttribute and SDL_GL_GetAttribute.
In some cases, these attributes are minimum requests; the GL does not promise to give you exactly what you asked for. It's possible to ask for a 16-bit depth buffer and get a 24-bit one instead, for example, or to ask for no stencil buffer and still have one available. Context creation should fail if the GL can't provide your requested attributes at a minimum, but you should check to see exactly what you got.
Multisample anti-aliasing is a type of full screen anti-aliasing. Multipsampling defaults to off but can be turned on by setting SDL_GL_MULTISAMPLEBUFFERS to 1 and SDL_GL_MULTISAMPLESAMPLES to a value greater than 0. Typical values are 2 and 4.
SDL_GL_CONTEXT_PROFILE_MASK determines the type of context created, while both SDL_GL_CONTEXT_MAJOR_VERSION and SDL_GL_CONTEXT_MINOR_VERSION determine which version. All three attributes must be set prior to creating the first window, and in general you can't change the value of SDL_GL_CONTEXT_PROFILE_MASK without first destroying all windows created with the previous setting.
SDL_GL_CONTEXT_RELEASE_BEHAVIOR can be set to SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE or SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH.
Enumerator |
---|
SDL_GL_RED_SIZE | the minimum number of bits for the red channel of the color buffer; defaults to 3.
|
SDL_GL_GREEN_SIZE | the minimum number of bits for the green channel of the color buffer; defaults to 3.
|
SDL_GL_BLUE_SIZE | the minimum number of bits for the blue channel of the color buffer; defaults to 2.
|
SDL_GL_ALPHA_SIZE | the minimum number of bits for the alpha channel of the color buffer; defaults to 0.
|
SDL_GL_BUFFER_SIZE | the minimum number of bits for frame buffer size; defaults to 0.
|
SDL_GL_DOUBLEBUFFER | whether the output is single or double buffered; defaults to double buffering on.
|
SDL_GL_DEPTH_SIZE | the minimum number of bits in the depth buffer; defaults to 16.
|
SDL_GL_STENCIL_SIZE | the minimum number of bits in the stencil buffer; defaults to 0.
|
SDL_GL_ACCUM_RED_SIZE | the minimum number of bits for the red channel of the accumulation buffer; defaults to 0.
|
SDL_GL_ACCUM_GREEN_SIZE | the minimum number of bits for the green channel of the accumulation buffer; defaults to 0.
|
SDL_GL_ACCUM_BLUE_SIZE | the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0.
|
SDL_GL_ACCUM_ALPHA_SIZE | the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0.
|
SDL_GL_STEREO | whether the output is stereo 3D; defaults to off.
|
SDL_GL_MULTISAMPLEBUFFERS | the number of buffers used for multisample anti-aliasing; defaults to 0.
|
SDL_GL_MULTISAMPLESAMPLES | the number of samples used around the current pixel used for multisample anti-aliasing.
|
SDL_GL_ACCELERATED_VISUAL | set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either.
|
SDL_GL_RETAINED_BACKING | not used (deprecated).
|
SDL_GL_CONTEXT_MAJOR_VERSION | OpenGL context major version.
|
SDL_GL_CONTEXT_MINOR_VERSION | OpenGL context minor version.
|
SDL_GL_CONTEXT_EGL | deprecated: set SDL_GL_CONTEXT_PROFILE_MASK to SDL_GL_CONTEXT_PROFILE_ES to enable instead.
|
SDL_GL_CONTEXT_FLAGS | some combination of 0 or more of elements of the SDL_GLcontextFlag enumeration; defaults to 0.
|
SDL_GL_CONTEXT_PROFILE_MASK | type of GL context (Core, Compatibility, ES). See SDL_GLprofile; default value depends on platform.
|
SDL_GL_SHARE_WITH_CURRENT_CONTEXT | OpenGL context sharing; defaults to 0.
|
SDL_GL_FRAMEBUFFER_SRGB_CAPABLE | requests sRGB capable visual; defaults to 0. (>= SDL 2.0.1)
|
SDL_GL_CONTEXT_RELEASE_BEHAVIOR | sets context the release behavior; defaults to 1. (>= SDL 2.0.4)
|
SDL_GL_CONTEXT_RESET_NOTIFICATION | |
SDL_GL_CONTEXT_NO_ERROR | |
SDL_GL_FLOATBUFFERS | |
Definition at line 256 of file SDL_video.h.
257{
@ SDL_GL_FRAMEBUFFER_SRGB_CAPABLE
@ SDL_GL_CONTEXT_RELEASE_BEHAVIOR
@ SDL_GL_CONTEXT_MAJOR_VERSION
@ SDL_GL_CONTEXT_RESET_NOTIFICATION
@ SDL_GL_ACCUM_ALPHA_SIZE
@ SDL_GL_MULTISAMPLESAMPLES
@ SDL_GL_CONTEXT_MINOR_VERSION
@ SDL_GL_MULTISAMPLEBUFFERS
@ SDL_GL_ACCUM_GREEN_SIZE
@ SDL_GL_SHARE_WITH_CURRENT_CONTEXT
@ SDL_GL_RETAINED_BACKING
@ SDL_GL_ACCELERATED_VISUAL
@ SDL_GL_CONTEXT_PROFILE_MASK
@ SDL_GL_CONTEXT_NO_ERROR
SDL_Window * SDL_CreateWindow |
( |
const char * | title, |
|
|
int | x, |
|
|
int | y, |
|
|
int | w, |
|
|
int | h, |
|
|
Uint32 | flags ) |
|
extern |
Create a window with the specified position, dimensions, and flags.
flags
may be any of the following OR'd together:
SDL_WINDOW_FULLSCREEN
: fullscreen window
SDL_WINDOW_FULLSCREEN_DESKTOP
: fullscreen window at desktop resolution
SDL_WINDOW_OPENGL
: window usable with an OpenGL context
SDL_WINDOW_VULKAN
: window usable with a Vulkan instance
SDL_WINDOW_METAL
: window usable with a Metal instance
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_ALLOW_HIGHDPI
: window should be created in high-DPI mode if supported (>= SDL 2.0.1)
SDL_WINDOW_SHOWN
is ignored by SDL_CreateWindow(). The SDL_Window is implicitly shown if SDL_WINDOW_HIDDEN is not set. SDL_WINDOW_SHOWN
may be queried later using SDL_GetWindowFlags().
On Apple's macOS, you must set the NSHighResolutionCapable Info.plist property to YES, otherwise you will not receive a High-DPI OpenGL canvas.
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 macOS). Use SDL_GetWindowSize() to query the client area's size in screen coordinates, and SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() to query the drawable size in pixels. Note that when this flag is set, the drawable size can vary after the window is created and should be queried after major window events such as when the window is resized or moved between displays.
If the window is set fullscreen, the width and height parameters w
and h
will not be used. However, invalid size parameters (e.g. too large) may still fail. Window size is actually limited to 16384 x 16384 for all platforms at window creation.
If the window is created with any of the SDL_WINDOW_OPENGL or SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the corresponding UnloadLibrary function is called by SDL_DestroyWindow().
If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver, SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail.
If SDL_WINDOW_METAL is specified on an OS that does not support Metal, SDL_CreateWindow() will fail.
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.
- Parameters
-
title | the title of the window, in UTF-8 encoding. |
x | the x position of the window, SDL_WINDOWPOS_CENTERED , or SDL_WINDOWPOS_UNDEFINED . |
y | the y position of the window, SDL_WINDOWPOS_CENTERED , or SDL_WINDOWPOS_UNDEFINED . |
w | the width of the window, in screen coordinates. |
h | the height of the window, in screen coordinates. |
flags | 0, or one or more SDL_WindowFlags OR'd together. |
- Returns
- the
SDL_Window
that was created or NULL on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 2.0.0.
- See also
- SDL_CreateWindowFrom
-
SDL_DestroyWindow
int SDL_GetDisplayDPI |
( |
int | displayIndex, |
|
|
float * | ddpi, |
|
|
float * | hdpi, |
|
|
float * | vdpi ) |
|
extern |
Get the dots/pixels-per-inch for a display.
Diagonal, horizontal and vertical DPI can all be optionally returned if the appropriate parameter is non-NULL.
A failure of this function usually means that either no DPI information is available or the displayIndex
is out of range.
WARNING: This reports the DPI that the hardware reports, and it is not always reliable! It is almost always better to use SDL_GetWindowSize() to find the window size, which might be in logical points instead of pixels, and then SDL_GL_GetDrawableSize(), SDL_Vulkan_GetDrawableSize(), SDL_Metal_GetDrawableSize(), or SDL_GetRendererOutputSize(), and compare the two values to get an actual scaling value between the two. We will be rethinking how high-dpi details should be managed in SDL3 to make things more consistent, reliable, and clear.
- Parameters
-
displayIndex | the index of the display from which DPI information should be queried. |
ddpi | a pointer filled in with the diagonal DPI of the display; may be NULL. |
hdpi | a pointer filled in with the horizontal DPI of the display; may be NULL. |
vdpi | a pointer filled in with the vertical DPI of the display; may be NULL. |
- Returns
- 0 on success or a negative error code on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 2.0.4.
- See also
- SDL_GetNumVideoDisplays
int SDL_GetDisplayUsableBounds |
( |
int | displayIndex, |
|
|
SDL_Rect * | rect ) |
|
extern |
Get the usable desktop area represented by a display.
The primary display (displayIndex
zero) is always located at 0,0.
This is the same area as SDL_GetDisplayBounds() reports, but with portions reserved by the system removed. For example, on Apple's macOS, 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.
The parameter rect
is ignored if it is NULL.
This function also returns -1 if the parameter displayIndex
is out of range.
- Parameters
-
displayIndex | the index of the display to query the usable bounds from. |
rect | the SDL_Rect structure filled in with the display bounds. |
- Returns
- 0 on success or a negative error code on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 2.0.5.
- See also
- SDL_GetDisplayBounds
-
SDL_GetNumVideoDisplays
int SDL_GetWindowBordersSize |
( |
SDL_Window * | window, |
|
|
int * | top, |
|
|
int * | left, |
|
|
int * | bottom, |
|
|
int * | right ) |
|
extern |
Get the size of a window's borders (decorations) around the client area.
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.
Note: This function may fail on systems where the window has not yet been decorated by the display server (for example, immediately after calling SDL_CreateWindow). It is recommended that you wait at least until the window has been presented and composited, so that the window system has a chance to decorate the window and provide the border dimensions to SDL.
This function also returns -1 if getting the information is not supported.
- Parameters
-
window | the window to query the size values of the border (decorations) from. |
top | pointer to variable for storing the size of the top border; NULL is permitted. |
left | pointer to variable for storing the size of the left border; NULL is permitted. |
bottom | pointer to variable for storing the size of the bottom border; NULL is permitted. |
right | pointer to variable for storing the size of the right border; NULL is permitted. |
- Returns
- 0 on success or a negative error code on failure; call SDL_GetError() for more information.
- Since
- This function is available since SDL 2.0.5.
- See also
- SDL_GetWindowSize
int SDL_GL_SetSwapInterval |
( |
int | interval | ) |
|
|
extern |
Set the swap interval for the current OpenGL context.
Some systems allow specifying -1 for the interval, to enable adaptive vsync. Adaptive vsync works the same as vsync, but if you've already missed the vertical retrace for a given frame, it swaps buffers immediately, which might be less jarring for the user during occasional framerate drops. If an application requests adaptive vsync and the system does not support it, this function will fail and return -1. In such a case, you should probably retry the call with 1 for the interval.
Adaptive vsync is implemented for some glX drivers with GLX_EXT_swap_control_tear, and for some Windows drivers with WGL_EXT_swap_control_tear.
Read more on the Khronos wiki: https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync
- Parameters
-
interval | 0 for immediate updates, 1 for updates synchronized with the vertical retrace, -1 for adaptive vsync. |
- Returns
- 0 on success or -1 if setting the swap interval is not supported; call SDL_GetError() for more information.
- Since
- This function is available since SDL 2.0.0.
- See also
- SDL_GL_GetSwapInterval
Provide a callback that decides if a window region has special properties.
Normally windows are dragged and resized by decorations provided by the system window manager (a title bar, borders, etc), but for some apps, it makes sense to drag them from somewhere else inside the window itself; for example, one might have a borderless window that wants to be draggable from any part, or simulate its own title bar, etc.
This function lets the app provide a callback that designates pieces of a given window as special. This callback is run during event processing if we need to tell the OS to treat a region of the window specially; the use of this callback is known as "hit testing."
Mouse input may not be delivered to your application if it is within a special area; the OS will often apply that input to moving the window or resizing the window and not deliver it to the application.
Specifying NULL for a callback disables hit-testing. Hit-testing is disabled by default.
Platforms that don't support this functionality will return -1 unconditionally, even if you're attempting to disable hit-testing.
Your callback may fire at any time, and its firing does not indicate any specific behavior (for example, on Windows, this certainly might fire when the OS is deciding whether to drag your window, but it fires for lots of other reasons, too, some unrelated to anything you probably care about and when the mouse isn't actually at the location it is testing). Since this can fire at any time, you should try to keep your callback efficient, devoid of allocations, etc.
- Parameters
-
window | the window to set hit-testing on. |
callback | the function to call when doing a hit-test. |
callback_data | an app-defined void pointer passed to callback. |
- Returns
- 0 on success or -1 on error (including unsupported); call SDL_GetError() for more information.
- Since
- This function is available since SDL 2.0.4.
Set a window's keyboard grab mode.
Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or the Meta/Super key. Note that not all system keyboard shortcuts can be captured by applications (one example is Ctrl+Alt+Del on Windows).
This is primarily intended for specialized applications such as VNC clients or VM frontends. Normal games should not use keyboard grab.
When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the window is full-screen to ensure the user is not trapped in your application. If you have a custom keyboard shortcut to exit fullscreen mode, you may suppress this behavior with SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED
.
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.
- Parameters
-
window | The window for which the keyboard grab mode should be set. |
grabbed | This is SDL_TRUE to grab keyboard, and SDL_FALSE to release. |
- Since
- This function is available since SDL 2.0.16.
- See also
- SDL_GetWindowKeyboardGrab
-
SDL_SetWindowMouseGrab
-
SDL_SetWindowGrab