4#include <SDL3/SDL_video.h>
5#include "SDL3pp_properties.h"
6#include "SDL3pp_rect.h"
7#include "SDL3pp_surface.h"
70 constexpr explicit operator bool()
const {
return !!
value; }
106 constexpr explicit operator bool()
const {
return !!
value; }
126 SDL_ORIENTATION_UNKNOWN;
139 SDL_ORIENTATION_LANDSCAPE_FLIPPED;
142 SDL_ORIENTATION_PORTRAIT;
145 SDL_ORIENTATION_PORTRAIT_FLIPPED;
182 : m_displayID(displayID)
191 constexpr operator DisplayID()
const {
return m_displayID; }
406 bool include_high_density_modes)
const;
491namespace prop::Global {
506constexpr auto VIDEO_WAYLAND_WL_DISPLAY_POINTER =
507 SDL_PROP_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER;
519 SDL_SYSTEM_THEME_UNKNOWN;
522 SDL_SYSTEM_THEME_LIGHT;
525 SDL_SYSTEM_THEME_DARK;
553 SDL_WINDOW_FULLSCREEN;
568 SDL_WINDOW_BORDERLESS;
571 SDL_WINDOW_RESIZABLE;
574 SDL_WINDOW_MINIMIZED;
577 SDL_WINDOW_MAXIMIZED;
580 SDL_WINDOW_MOUSE_GRABBED;
583 SDL_WINDOW_INPUT_FOCUS;
586 SDL_WINDOW_MOUSE_FOCUS;
600 SDL_WINDOW_MOUSE_RELATIVE_MODE;
603 SDL_WINDOW_ALWAYS_ON_TOP;
621 SDL_WINDOW_KEYBOARD_GRABBED;
630 SDL_WINDOW_TRANSPARENT;
633 SDL_WINDOW_NOT_FOCUSABLE;
649 SDL_FLASH_UNTIL_FOCUSED;
667 SDL_HITTEST_DRAGGABLE;
670 SDL_HITTEST_RESIZE_TOPLEFT;
674 SDL_HITTEST_RESIZE_TOP;
677 SDL_HITTEST_RESIZE_TOPRIGHT;
681 SDL_HITTEST_RESIZE_RIGHT;
685 SDL_HITTEST_RESIZE_BOTTOMRIGHT;
688 SDL_HITTEST_RESIZE_BOTTOM;
691 SDL_HITTEST_RESIZE_BOTTOMLEFT;
695 SDL_HITTEST_RESIZE_LEFT;
749 : m_resource(resource)
854 : m_resource(SDL_CreateWindow(title, size.x, size.y, flags))
933 : m_resource(SDL_CreatePopupWindow(parent,
1070 : m_resource(SDL_CreateWindowWithProperties(props))
1080 std::swap(m_resource, other.m_resource);
1090 auto r = m_resource;
1091 m_resource =
nullptr;
1099 constexpr bool operator==(std::nullptr_t _)
const {
return !m_resource; }
1102 constexpr explicit operator bool()
const {
return !!m_resource; }
1674 void GetSize(
int* w,
int* h)
const;
1783 void GetBordersSize(
int* top,
int* left,
int* bottom,
int* right)
const;
2556 void* cbHandle = Wrapper::Wrap(m_resource, std::move(callback));
2558 [](SDL_Window* win,
const SDL_Point* area,
void* data) {
2559 return Wrapper::Call(data, win,
Point(*area));
2955#define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000u
2967#define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK | (X))
2976#define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
2985#define SDL_WINDOWPOS_ISUNDEFINED(X) \
2986 (((X) & 0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
2996#define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000u
3008#define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK | (X))
3017#define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0)
3026#define SDL_WINDOWPOS_ISCENTERED(X) \
3027 (((X) & 0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
3054 : m_resource(resource)
3090 : m_resource(SDL_GL_CreateContext(window))
3100 std::swap(m_resource, other.m_resource);
3110 auto r = m_resource;
3111 m_resource =
nullptr;
3119 constexpr bool operator==(std::nullptr_t _)
const {
return !m_resource; }
3122 constexpr explicit operator bool()
const {
return !!m_resource; }
3422 SDL_GL_RETAINED_BACKING;
3425 SDL_GL_CONTEXT_MAJOR_VERSION;
3428 SDL_GL_CONTEXT_MINOR_VERSION;
3443 SDL_GL_SHARE_WITH_CURRENT_CONTEXT;
3446 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE;
3460 SDL_GL_CONTEXT_RESET_NOTIFICATION;
3463 SDL_GL_CONTEXT_NO_ERROR;
3477 SDL_GL_CONTEXT_PROFILE_CORE;
3480 SDL_GL_CONTEXT_PROFILE_COMPATIBILITY;
3484 SDL_GL_CONTEXT_PROFILE_ES;
3494 SDL_GL_CONTEXT_DEBUG_FLAG;
3497 SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG;
3500 SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG;
3503 SDL_GL_CONTEXT_RESET_ISOLATION_FLAG;
3514 SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE;
3517 SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH;
3527 SDL_GL_CONTEXT_RESET_NO_NOTIFICATION;
3530 SDL_GL_CONTEXT_RESET_LOSE_CONTEXT;
3566 return SDL_GetVideoDriver(index);
3588 return SDL_GetCurrentVideoDriver();
3615 auto data =
reinterpret_cast<DisplayID*
>(SDL_GetDisplays(&count));
3668 return {
CheckError(SDL_GetDisplayProperties(displayID))};
3676namespace prop::Display {
3678constexpr auto HDR_ENABLED_BOOLEAN = SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN;
3680constexpr auto KMSDRM_PANEL_ORIENTATION_NUMBER =
3681 SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER;
3700 return SDL_GetDisplayName(displayID);
3728 SDL_GetDisplayBounds(displayID, &bounds);
3763 SDL_GetDisplayUsableBounds(displayID, &bounds);
3787 return SDL_GetNaturalDisplayOrientation(displayID);
3810 return SDL_GetCurrentDisplayOrientation(displayID);
3845 return SDL_GetDisplayContentScale(displayID);
3878 auto data =
CheckError(SDL_GetFullscreenDisplayModes(displayID, &count));
3918 bool include_high_density_modes)
3921 CheckError(SDL_GetClosestFullscreenDisplayMode(displayID,
3925 include_high_density_modes,
3933 bool include_high_density_modes)
const
3936 m_displayID, size, refresh_rate, include_high_density_modes);
3960 return *SDL_GetDesktopDisplayMode(displayID);
3989 return *SDL_GetCurrentDisplayMode(displayID);
4013 return SDL_GetDisplayForPoint(&point);
4038 return SDL_GetDisplayForRect(&rect);
4063 return SDL_GetDisplayForWindow(window);
4090 return SDL_GetWindowPixelDensity(window);
4122 return SDL_GetWindowDisplayScale(window);
4165 CheckError(SDL_SetWindowFullscreenMode(window, mode));
4189 return *SDL_GetWindowFullscreenMode(window);
4232 return CheckError(SDL_GetWindowPixelFormat(window));
4253 auto data =
CheckError(SDL_GetWindows(&count));
4348 return Window(std::move(title), size, flags);
4427 return Window(parent, offset, size, flags);
4562namespace prop::Window {
4564constexpr auto CREATE_ALWAYS_ON_TOP_BOOLEAN =
4565 SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN;
4567constexpr auto CREATE_BORDERLESS_BOOLEAN =
4568 SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN;
4570constexpr auto CREATE_CONSTRAIN_POPUP_BOOLEAN =
4571 SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN;
4573constexpr auto CREATE_FOCUSABLE_BOOLEAN =
4574 SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN;
4576constexpr auto CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN =
4577 SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN;
4579constexpr auto CREATE_FLAGS_NUMBER = SDL_PROP_WINDOW_CREATE_FLAGS_NUMBER;
4581constexpr auto CREATE_FULLSCREEN_BOOLEAN =
4582 SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN;
4584constexpr auto CREATE_HEIGHT_NUMBER = SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER;
4586constexpr auto CREATE_HIDDEN_BOOLEAN = SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN;
4588constexpr auto CREATE_HIGH_PIXEL_DENSITY_BOOLEAN =
4589 SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN;
4591constexpr auto CREATE_MAXIMIZED_BOOLEAN =
4592 SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN;
4594constexpr auto CREATE_MENU_BOOLEAN = SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN;
4596constexpr auto CREATE_METAL_BOOLEAN = SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN;
4598constexpr auto CREATE_MINIMIZED_BOOLEAN =
4599 SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN;
4601constexpr auto CREATE_MODAL_BOOLEAN = SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN;
4603constexpr auto CREATE_MOUSE_GRABBED_BOOLEAN =
4604 SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN;
4606constexpr auto CREATE_OPENGL_BOOLEAN = SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN;
4608constexpr auto CREATE_PARENT_POINTER = SDL_PROP_WINDOW_CREATE_PARENT_POINTER;
4610constexpr auto CREATE_RESIZABLE_BOOLEAN =
4611 SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN;
4613constexpr auto CREATE_TITLE_STRING = SDL_PROP_WINDOW_CREATE_TITLE_STRING;
4615constexpr auto CREATE_TRANSPARENT_BOOLEAN =
4616 SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN;
4618constexpr auto CREATE_TOOLTIP_BOOLEAN = SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN;
4620constexpr auto CREATE_UTILITY_BOOLEAN = SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN;
4622constexpr auto CREATE_VULKAN_BOOLEAN = SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN;
4624constexpr auto CREATE_WIDTH_NUMBER = SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER;
4626constexpr auto CREATE_X_NUMBER = SDL_PROP_WINDOW_CREATE_X_NUMBER;
4628constexpr auto CREATE_Y_NUMBER = SDL_PROP_WINDOW_CREATE_Y_NUMBER;
4630constexpr auto CREATE_COCOA_WINDOW_POINTER =
4631 SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER;
4633constexpr auto CREATE_COCOA_VIEW_POINTER =
4634 SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER;
4636constexpr auto CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN =
4637 SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN;
4639constexpr auto CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN =
4640 SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN;
4642constexpr auto CREATE_WAYLAND_WL_SURFACE_POINTER =
4643 SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER;
4645constexpr auto CREATE_WIN32_HWND_POINTER =
4646 SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER;
4648constexpr auto CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER =
4649 SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER;
4651constexpr auto CREATE_X11_WINDOW_NUMBER =
4652 SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER;
4654constexpr auto SHAPE_POINTER = SDL_PROP_WINDOW_SHAPE_POINTER;
4656constexpr auto HDR_ENABLED_BOOLEAN = SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN;
4658constexpr auto SDR_WHITE_LEVEL_FLOAT = SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT;
4660constexpr auto HDR_HEADROOM_FLOAT = SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT;
4662constexpr auto ANDROID_WINDOW_POINTER = SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER;
4664constexpr auto ANDROID_SURFACE_POINTER =
4665 SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER;
4667constexpr auto UIKIT_WINDOW_POINTER = SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER;
4669constexpr auto UIKIT_METAL_VIEW_TAG_NUMBER =
4670 SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER;
4672constexpr auto UIKIT_OPENGL_FRAMEBUFFER_NUMBER =
4673 SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER;
4675constexpr auto UIKIT_OPENGL_RENDERBUFFER_NUMBER =
4676 SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER;
4678constexpr auto UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER =
4679 SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER;
4681constexpr auto KMSDRM_DEVICE_INDEX_NUMBER =
4682 SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER;
4684constexpr auto KMSDRM_DRM_FD_NUMBER = SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER;
4686constexpr auto KMSDRM_GBM_DEVICE_POINTER =
4687 SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER;
4689constexpr auto COCOA_WINDOW_POINTER = SDL_PROP_WINDOW_COCOA_WINDOW_POINTER;
4691constexpr auto COCOA_METAL_VIEW_TAG_NUMBER =
4692 SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER;
4694constexpr auto OPENVR_OVERLAY_ID = SDL_PROP_WINDOW_OPENVR_OVERLAY_ID;
4696constexpr auto VIVANTE_DISPLAY_POINTER =
4697 SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER;
4699constexpr auto VIVANTE_WINDOW_POINTER = SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER;
4701constexpr auto VIVANTE_SURFACE_POINTER =
4702 SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER;
4704constexpr auto WIN32_HWND_POINTER = SDL_PROP_WINDOW_WIN32_HWND_POINTER;
4706constexpr auto WIN32_HDC_POINTER = SDL_PROP_WINDOW_WIN32_HDC_POINTER;
4708constexpr auto WIN32_INSTANCE_POINTER = SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER;
4710constexpr auto WAYLAND_DISPLAY_POINTER =
4711 SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER;
4713constexpr auto WAYLAND_SURFACE_POINTER =
4714 SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER;
4716constexpr auto WAYLAND_VIEWPORT_POINTER =
4717 SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER;
4719constexpr auto WAYLAND_EGL_WINDOW_POINTER =
4720 SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER;
4722constexpr auto WAYLAND_XDG_SURFACE_POINTER =
4723 SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER;
4725constexpr auto WAYLAND_XDG_TOPLEVEL_POINTER =
4726 SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER;
4728constexpr auto WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING =
4729 SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING;
4731constexpr auto WAYLAND_XDG_POPUP_POINTER =
4732 SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER;
4734constexpr auto WAYLAND_XDG_POSITIONER_POINTER =
4735 SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER;
4737constexpr auto X11_DISPLAY_POINTER = SDL_PROP_WINDOW_X11_DISPLAY_POINTER;
4739constexpr auto X11_SCREEN_NUMBER = SDL_PROP_WINDOW_X11_SCREEN_NUMBER;
4741constexpr auto X11_WINDOW_NUMBER = SDL_PROP_WINDOW_X11_WINDOW_NUMBER;
4786 return {SDL_GetWindowFromID(
id)};
4809 return {
CheckError(SDL_GetWindowParent(window))};
4939 return {
CheckError(SDL_GetWindowProperties(window))};
4967 return SDL_GetWindowFlags(window);
4992 CheckError(SDL_SetWindowTitle(window, title));
5015 return SDL_GetWindowTitle(window);
5092 CheckError(SDL_SetWindowPosition(window, p.x, p.y));
5124 CheckError(SDL_GetWindowPosition(window, x, y));
5167 CheckError(SDL_SetWindowSize(window, p.x, p.y));
5225 CheckError(SDL_GetWindowSafeArea(window, &rect));
5276 CheckError(SDL_SetWindowAspectRatio(window, min_aspect, max_aspect));
5304 CheckError(SDL_GetWindowAspectRatio(window, min_aspect, max_aspect));
5352 CheckError(SDL_GetWindowBordersSize(window, top, left, bottom, right));
5382 CheckError(SDL_GetWindowSizeInPixels(window, w, h));
5406 CheckError(SDL_SetWindowMinimumSize(window, p.x, p.y));
5433 CheckError(SDL_GetWindowMinimumSize(window, w, h));
5457 CheckError(SDL_SetWindowMaximumSize(window, p.x, p.y));
5484 CheckError(SDL_GetWindowMaximumSize(window, w, h));
5513 CheckError(SDL_SetWindowBordered(window, bordered));
5542 CheckError(SDL_SetWindowResizable(window, resizable));
5568 CheckError(SDL_SetWindowAlwaysOnTop(window, on_top));
5776 CheckError(SDL_SetWindowFullscreen(window, fullscreen));
5834 return SDL_WindowHasSurface(window);
5904 CheckError(SDL_SetWindowSurfaceVSync(window, vsync));
5933 CheckError(SDL_GetWindowSurfaceVSync(window, &vsync));
6018 CheckError(SDL_DestroyWindowSurface(window));
6055 CheckError(SDL_SetWindowKeyboardGrab(window, grabbed));
6083 CheckError(SDL_SetWindowMouseGrab(window, grabbed));
6105 return SDL_GetWindowKeyboardGrab(window);
6130 return SDL_GetWindowMouseGrab(window);
6175 CheckError(SDL_SetWindowMouseRect(window, &rect));
6200 return SDL_GetWindowMouseRect(window);
6228 CheckError(SDL_SetWindowOpacity(window, opacity));
6254 return SDL_GetWindowOpacity(window);
6295 CheckError(SDL_SetWindowParent(window, parent));
6322 CheckError(SDL_SetWindowModal(window, modal));
6343 CheckError(SDL_SetWindowFocusable(window, focusable));
6373 CheckError(SDL_ShowWindowSystemMenu(window, p.x, p.y));
6424 void* callback_data)
6426 CheckError(SDL_SetWindowHitTest(window, callback, callback_data));
6472 void* cbHandle = Wrapper::Wrap(window, std::move(callback));
6475 [](SDL_Window* win,
const SDL_Point* area,
void* data) {
6476 return Wrapper::Call(data, win,
Point(*area));
6508 CheckError(SDL_SetWindowShape(window, shape));
6529 CheckError(SDL_FlashWindow(window, operation));
6694 return SDL_GL_GetProcAddress(proc);
6716 return SDL_EGL_GetProcAddress(proc);
6753 return SDL_GL_ExtensionSupported(extension);
6790 CheckError(SDL_GL_SetAttribute(attr, value));
6810 CheckError(SDL_GL_GetAttribute(attr, value));
6877 return {
CheckError(SDL_GL_GetCurrentWindow())};
6906 return SDL_EGL_GetCurrentDisplay();
6934 return SDL_EGL_GetWindowSurface(window);
6963 SDL_EGL_SetAttributeCallbacks(platformAttribCallback,
6964 surfaceAttribCallback,
6965 contextAttribCallback,
6999 CheckError(SDL_GL_SetSwapInterval(interval));
7022 CheckError(SDL_GL_GetSwapInterval(interval));
This is a unique ID for a display for the time it is connected to the system, and is never reused for...
Definition: SDL3pp_video.h:172
constexpr Display(DisplayID displayID={})
Wraps Display.
Definition: SDL3pp_video.h:181
An opaque handle to an OpenGL context.
Definition: SDL3pp_video.h:3041
constexpr GLContextRaw release()
Retrieves underlying GLContextRaw and clear this.
Definition: SDL3pp_video.h:3108
constexpr GLContext(const GLContext &other)=default
Copy constructor.
constexpr GLContext()=default
Default ctor.
constexpr auto operator<=>(const GLContext &other) const =default
Comparison.
GLContext(WindowParam window)
Create an OpenGL context for an OpenGL window, and make it current.
Definition: SDL3pp_video.h:3089
constexpr GLContext(GLContext &&other)
Move constructor.
Definition: SDL3pp_video.h:3062
constexpr bool operator==(std::nullptr_t _) const
Comparison.
Definition: SDL3pp_video.h:3119
~GLContext()
Destructor.
Definition: SDL3pp_video.h:3095
constexpr GLContext(const GLContextRaw resource)
Constructs from GLContextParam.
Definition: SDL3pp_video.h:3053
constexpr GLContextRaw get() const
Retrieves underlying GLContextRaw.
Definition: SDL3pp_video.h:3105
GLContext & operator=(GLContext other)
Assignment operator.
Definition: SDL3pp_video.h:3098
Optional-like shim for references.
Definition: SDL3pp_optionalRef.h:20
Base class for SDL memory allocated array wrap.
Definition: SDL3pp_ownPtr.h:44
span-like for empty-derived structs
Definition: SDL3pp_spanRef.h:24
constexpr T * data() const
Retrieves contained data.
Definition: SDL3pp_spanRef.h:75
constexpr size_t size() const
Retrieves contained size.
Definition: SDL3pp_spanRef.h:69
Helpers to use C++ strings parameters.
Definition: SDL3pp_strings.h:43
A collection of pixels used in software blitting.
Definition: SDL3pp_surface.h:195
static constexpr Surface Borrow(SurfaceParam resource)
Safely borrows the from SurfaceParam.
Definition: SDL3pp_surface.h:374
The struct used as an opaque handle to a window.
Definition: SDL3pp_video.h:734
void SetHitTest(HitTest callback, void *callback_data)
Provide a callback that decides if a window region has special properties.
void SetRect(Rect rect)
Request the window's position and size to be set.
Definition: SDL3pp_video.h:1491
constexpr WindowRaw get() const
Retrieves underlying WindowRaw.
Definition: SDL3pp_video.h:1085
constexpr Window(const WindowRaw resource)
Constructs from WindowParam.
Definition: SDL3pp_video.h:748
Point GetSize() const
Get the size of a window's client area.
Definition: SDL3pp_video.h:1648
constexpr WindowRaw release()
Retrieves underlying WindowRaw and clear this.
Definition: SDL3pp_video.h:1088
Window(WindowParam parent, const PointRaw &offset, const PointRaw &size, WindowFlags flags=0)
Create a child popup window of the specified parent window.
Definition: SDL3pp_video.h:929
constexpr Window(Window &&other)
Move constructor.
Definition: SDL3pp_video.h:757
constexpr Window(const Window &other)=delete
Copy constructor.
Window & operator=(Window other)
Assignment operator.
Definition: SDL3pp_video.h:1078
constexpr auto operator<=>(const Window &other) const =default
Comparison.
Point GetPosition() const
Get the position of a window.
Definition: SDL3pp_video.h:1565
Point GetSizeInPixels() const
Get the size of a window's client area, in pixels.
Definition: SDL3pp_video.h:1798
Window(StringParam title, const PointRaw &size, WindowFlags flags=0)
Create a window with the specified dimensions and flags.
Definition: SDL3pp_video.h:853
~Window()
Destructor.
Definition: SDL3pp_video.h:1075
Rect GetRect() const
Get the position and client size of a window.
Definition: SDL3pp_video.h:1510
constexpr bool operator==(std::nullptr_t _) const
Comparison.
Definition: SDL3pp_video.h:1099
void SetHitTest(HitTestCB callback)
Provide a callback that decides if a window region has special properties.
Definition: SDL3pp_video.h:2553
Window(PropertiesParam props)
Create a window with the specified properties.
Definition: SDL3pp_video.h:1069
constexpr Window()=default
Default ctor.
constexpr void CheckError(bool result)
Check and throw if returned value from SDL is an error.
Definition: SDL3pp_error.h:198
void GetTextInputArea(RectRaw *rect, int *cursor)
Get the area used to type Unicode text input.
Definition: SDL3pp_keyboard.h:342
void ClearComposition()
Dismiss the composition window/IME without disabling the subsystem.
Definition: SDL3pp_keyboard.h:332
void StartTextInput()
Start accepting Unicode text input events in a window.
Definition: SDL3pp_keyboard.h:227
bool IsTextInputActive() const
Check whether or not Unicode text input events are enabled for a window.
Definition: SDL3pp_keyboard.h:322
void StopTextInput()
Stop receiving any text input events in a window.
Definition: SDL3pp_keyboard.h:327
bool IsScreenKeyboardShown() const
Check whether the screen keyboard is shown for given window.
Definition: SDL3pp_keyboard.h:365
void SetTextInputArea(const RectRaw &rect, int cursor)
Set the area used to type Unicode text input.
Definition: SDL3pp_keyboard.h:337
bool GetRelativeMouseMode() const
Query whether relative mouse mode is enabled for a window.
Definition: SDL3pp_mouse.h:724
void SetRelativeMouseMode(bool enabled)
Set relative mouse mode for a window.
Definition: SDL3pp_mouse.h:708
void WarpMouse(const FPointRaw &p)
Move the mouse cursor to the given position within the window.
Definition: SDL3pp_mouse.h:654
std::unique_ptr< T, PtrDeleter > OwnPtr
Handle to an owned SDL memory allocated pointer.
Definition: SDL3pp_ownPtr.h:33
SDL_FPoint FPointRaw
Alias to raw representation for FPoint.
Definition: SDL3pp_rect.h:25
SDL_Rect RectRaw
Alias to raw representation for Rect.
Definition: SDL3pp_rect.h:28
SDL_Point PointRaw
Alias to raw representation for Point.
Definition: SDL3pp_rect.h:22
RendererRef GetRenderer() const
Get the renderer associated with a window.
Definition: SDL3pp_render.h:3414
SDL_FunctionPointer FunctionPointer
A generic function pointer.
Definition: SDL3pp_stdinc.h:6203
Uint32 Uint32
An unsigned 32-bit integer type.
Definition: SDL3pp_stdinc.h:325
Uint64 Uint64
An unsigned 64-bit integer type.
Definition: SDL3pp_stdinc.h:363
void DisableScreenSaver()
Prevent the screen from being blanked by a screen saver.
Definition: SDL3pp_video.h:6611
constexpr GLContextFlag GL_CONTEXT_RESET_ISOLATION_FLAG
RESET_ISOLATION_FLAG.
Definition: SDL3pp_video.h:3502
Rect GetBounds() const
Get the desktop area represented by a display.
Definition: SDL3pp_video.h:3732
void SetWindowSurfaceVSync(WindowParam window, int vsync)
Toggle VSync for the window surface.
Definition: SDL3pp_video.h:5902
void GetMaximumSize(int *w, int *h) const
Get the maximum size of a window's client area.
Definition: SDL3pp_video.h:5487
float GetPixelDensity() const
Get the pixel density of a window.
Definition: SDL3pp_video.h:4093
Rect GetWindowSafeArea(WindowParam window)
Get the safe area for this window.
Definition: SDL3pp_video.h:5222
SDL_DisplayOrientation DisplayOrientation
Display orientation values; the way a display is rotated.
Definition: SDL3pp_video.h:123
constexpr GLAttr GL_CONTEXT_RELEASE_BEHAVIOR
sets context the release behavior.
Definition: SDL3pp_video.h:3453
void GetMinimumSize(int *w, int *h) const
Get the minimum size of a window's client area.
Definition: SDL3pp_video.h:5436
void SetFocusable(bool focusable)
Set whether the window may have input focus.
Definition: SDL3pp_video.h:6346
void GL_SetSwapInterval(int interval)
Set the swap interval for the current OpenGL context.
Definition: SDL3pp_video.h:6997
constexpr HitTestResult HITTEST_DRAGGABLE
Region can drag entire window.
Definition: SDL3pp_video.h:666
constexpr HitTestResult HITTEST_RESIZE_BOTTOMLEFT
Region is the resizable bottom-left corner border.
Definition: SDL3pp_video.h:690
SDL_GLAttr GLAttr
An enumeration of OpenGL configuration attributes.
Definition: SDL3pp_video.h:3338
DisplayOrientation GetNaturalDisplayOrientation(DisplayID displayID)
Get the orientation of a display when it is unrotated.
Definition: SDL3pp_video.h:3785
void GL_DestroyContext(GLContextRaw context)
Delete an OpenGL context.
Definition: SDL3pp_video.h:7059
constexpr FlashOperation FLASH_CANCEL
Cancel any window flash state.
Definition: SDL3pp_video.h:642
int GetWindowSurfaceVSync(WindowParam window)
Get VSync for the window surface.
Definition: SDL3pp_video.h:5930
void UpdateSurface()
Copy the window surface to the screen.
Definition: SDL3pp_video.h:5965
OwnArray< DisplayMode * > GetFullscreenModes() const
Get a list of fullscreen display modes available on a display.
Definition: SDL3pp_video.h:3882
constexpr SystemTheme SYSTEM_THEME_LIGHT
Light colored system theme.
Definition: SDL3pp_video.h:521
constexpr WindowFlags WINDOW_MAXIMIZED
window is maximized
Definition: SDL3pp_video.h:576
void EnableScreenSaver()
Allow the screen to be blanked by a screen saver.
Definition: SDL3pp_video.h:6591
void GL_GetSwapInterval(int *interval)
Get the swap interval for the current OpenGL context.
Definition: SDL3pp_video.h:7020
void SetAspectRatio(float min_aspect, float max_aspect)
Request that the aspect ratio of a window's client area be set.
Definition: SDL3pp_video.h:5279
void UpdateWindowSurfaceRects(WindowParam window, SpanRef< const RectRaw > rects)
Copy areas of the window surface to the screen.
Definition: SDL3pp_video.h:5992
void SetMinimumSize(const PointRaw &p)
Set the minimum size of a window's client area.
Definition: SDL3pp_video.h:5409
void SetWindowIcon(WindowParam window, SurfaceParam icon)
Set the icon for a window.
Definition: SDL3pp_video.h:5044
Window CreateWindowWithProperties(PropertiesParam props)
Create a window with the specified properties.
Definition: SDL3pp_video.h:4557
constexpr GLAttr GL_FRAMEBUFFER_SRGB_CAPABLE
requests sRGB capable visual; defaults to 0.
Definition: SDL3pp_video.h:3445
constexpr GLAttr GL_MULTISAMPLESAMPLES
the number of samples used around the current pixel used for multisample anti-aliasing.
Definition: SDL3pp_video.h:3413
constexpr SystemTheme SYSTEM_THEME_DARK
Dark colored system theme.
Definition: SDL3pp_video.h:524
WindowID GetID() const
Get the numeric ID of a window.
Definition: SDL3pp_video.h:4766
float GetDisplayScale() const
Get the content display scale relative to a window's pixel size.
Definition: SDL3pp_video.h:4125
Uint64 WindowFlags
The flags on a window.
Definition: SDL3pp_video.h:550
bool GetWindowMouseGrab(WindowParam window)
Get a window's mouse grab mode.
Definition: SDL3pp_video.h:6128
constexpr WindowFlags WINDOW_UTILITY
window should be treated as a utility window, not showing in the task bar and window list
Definition: SDL3pp_video.h:609
constexpr WindowFlags WINDOW_MOUSE_FOCUS
window has mouse focus
Definition: SDL3pp_video.h:585
constexpr GLAttr GL_STENCIL_SIZE
the minimum number of bits in the stencil buffer; defaults to 0.
Definition: SDL3pp_video.h:3377
void SetWindowPosition(WindowParam window, const PointRaw &p)
Request that the window's position be set.
Definition: SDL3pp_video.h:5090
void Restore()
Request that the size and position of a minimized or maximized window be restored.
Definition: SDL3pp_video.h:5743
void GetWindowPosition(WindowParam window, int *x, int *y)
Get the position of a window.
Definition: SDL3pp_video.h:5122
SDL_Window * WindowRaw
Alias to raw representation for Window.
Definition: SDL3pp_video.h:47
void SetWindowFullscreenMode(WindowParam window, OptionalRef< const DisplayMode > mode)
Set the display mode to use when a window is visible and fullscreen.
Definition: SDL3pp_video.h:4162
WindowRef GetWindowParent(WindowParam window)
Get parent of a window.
Definition: SDL3pp_video.h:4807
PropertiesRef GetProperties() const
Get the properties associated with a display.
Definition: SDL3pp_video.h:3671
Uint32 GLContextReleaseFlag
Possible values to be set for the GL_CONTEXT_RELEASE_BEHAVIOR attribute.
Definition: SDL3pp_video.h:3511
constexpr WindowFlags WINDOW_TRANSPARENT
window with transparent buffer
Definition: SDL3pp_video.h:629
void DestroySurface()
Destroy the surface associated with the window.
Definition: SDL3pp_video.h:6021
DisplayMode GetClosestFullscreenMode(const PointRaw &size, float refresh_rate, bool include_high_density_modes) const
Get the closest match to the requested display mode.
Definition: SDL3pp_video.h:3930
const DisplayMode & GetDesktopDisplayMode(DisplayID displayID)
Get information about the desktop's display mode.
Definition: SDL3pp_video.h:3958
FunctionPointer EGL_GetProcAddress(StringParam proc)
Get an EGL library function by name.
Definition: SDL3pp_video.h:6714
constexpr GLProfile GL_CONTEXT_PROFILE_CORE
OpenGL Core Profile context.
Definition: SDL3pp_video.h:3476
constexpr DisplayOrientation ORIENTATION_UNKNOWN
The display orientation can't be determined.
Definition: SDL3pp_video.h:125
void FlashWindow(WindowParam window, FlashOperation operation)
Request a window to demand attention from the user.
Definition: SDL3pp_video.h:6527
static WindowRef GetGrabbed()
Get the window that currently has an input grab enabled.
Definition: SDL3pp_video.h:6152
void GL_SwapWindow(WindowParam window)
Update a window with OpenGL rendering.
Definition: SDL3pp_video.h:7042
SDL_HitTest HitTest
Callback used for hit-testing.
Definition: SDL3pp_video.h:707
constexpr int WINDOW_SURFACE_VSYNC_ADAPTIVE
Constant to enable adaptive vsync.
Definition: SDL3pp_video.h:5916
void GetWindowAspectRatio(WindowParam window, float *min_aspect, float *max_aspect)
Get the size of a window's client area.
Definition: SDL3pp_video.h:5300
constexpr HitTestResult HITTEST_RESIZE_TOPRIGHT
Region is the resizable top-right corner border.
Definition: SDL3pp_video.h:676
Rect GetDisplayBounds(DisplayID displayID)
Get the desktop area represented by a display.
Definition: SDL3pp_video.h:3725
constexpr GLAttr GL_CONTEXT_MAJOR_VERSION
OpenGL context major version.
Definition: SDL3pp_video.h:3424
constexpr HitTestResult HITTEST_NORMAL
Region is normal. No special properties.
Definition: SDL3pp_video.h:663
void SetPosition(const PointRaw &p)
Request that the window's position be set.
Definition: SDL3pp_video.h:5095
Surface GetSurface()
Get the SDL surface associated with the window.
Definition: SDL3pp_video.h:5874
constexpr GLContextFlag GL_CONTEXT_FORWARD_COMPATIBLE_FLAG
FORWARD_COMPATIBLE_FLAG.
Definition: SDL3pp_video.h:3496
WindowRef GL_GetCurrentWindow()
Get the currently active OpenGL window.
Definition: SDL3pp_video.h:6875
constexpr GLAttr GL_RETAINED_BACKING
not used (deprecated).
Definition: SDL3pp_video.h:3421
Display GetDisplay() const
Get the display associated with a window.
Definition: SDL3pp_video.h:4066
constexpr HitTestResult HITTEST_RESIZE_RIGHT
Region is the resizable right border.
Definition: SDL3pp_video.h:680
float GetContentScale() const
Get the content scale of a display.
Definition: SDL3pp_video.h:3848
float GetOpacity() const
Get the opacity of a window.
Definition: SDL3pp_video.h:6257
constexpr FlashOperation FLASH_BRIEFLY
Flash the window briefly to get attention.
Definition: SDL3pp_video.h:645
void DestroyWindowSurface(WindowParam window)
Destroy the surface associated with the window.
Definition: SDL3pp_video.h:6016
void GL_UnloadLibrary()
Unload the OpenGL library previously loaded by GL_LoadLibrary().
Definition: SDL3pp_video.h:6728
bool GetWindowKeyboardGrab(WindowParam window)
Get a window's keyboard grab mode.
Definition: SDL3pp_video.h:6103
constexpr GLAttr GL_STEREO
whether the output is stereo 3D; defaults to off.
Definition: SDL3pp_video.h:3403
constexpr GLAttr GL_CONTEXT_MINOR_VERSION
OpenGL context minor version.
Definition: SDL3pp_video.h:3427
constexpr GLAttr GL_CONTEXT_PROFILE_MASK
type of GL context (Core, Compatibility, ES).
Definition: SDL3pp_video.h:3440
DisplayOrientation GetCurrentDisplayOrientation(DisplayID displayID)
Get the orientation of a display.
Definition: SDL3pp_video.h:3808
constexpr GLAttr GL_RED_SIZE
the minimum number of bits for the red channel of the color buffer; defaults to 8.
Definition: SDL3pp_video.h:3344
Display GetDisplayForRect(const RectRaw &rect)
Get the display primarily containing a rect.
Definition: SDL3pp_video.h:4036
constexpr WindowFlags WINDOW_MOUSE_GRABBED
window has grabbed mouse input
Definition: SDL3pp_video.h:579
bool ScreenSaverEnabled()
Check whether the screensaver is currently enabled.
Definition: SDL3pp_video.h:6577
Display GetDisplayForPoint(const PointRaw &point)
Get the display containing a point.
Definition: SDL3pp_video.h:4011
constexpr GLAttr GL_GREEN_SIZE
the minimum number of bits for the green channel of the color buffer; defaults to 8.
Definition: SDL3pp_video.h:3350
FunctionPointer GL_GetProcAddress(StringParam proc)
Get an OpenGL function by name.
Definition: SDL3pp_video.h:6692
SDL_EGLAttribArrayCallback EGLAttribArrayCallback
EGL platform attribute initialization callback.
Definition: SDL3pp_video.h:3230
constexpr GLAttr GL_CONTEXT_RESET_NOTIFICATION
set context reset notification.
Definition: SDL3pp_video.h:3459
Window CreateWindow(StringParam title, const PointRaw &size, WindowFlags flags)
Create a window with the specified dimensions and flags.
Definition: SDL3pp_video.h:4344
SDL_DisplayID DisplayID
Alias to raw representation for Display.
Definition: SDL3pp_video.h:41
constexpr GLProfile GL_CONTEXT_PROFILE_COMPATIBILITY
OpenGL Compatibility Profile context.
Definition: SDL3pp_video.h:3479
float GetDisplayContentScale(DisplayID displayID)
Get the content scale of a display.
Definition: SDL3pp_video.h:3843
GLContext GL_CreateContext(WindowParam window)
Create an OpenGL context for an OpenGL window, and make it current.
Definition: SDL3pp_video.h:6835
void SetWindowMinimumSize(WindowParam window, const PointRaw &p)
Set the minimum size of a window's client area.
Definition: SDL3pp_video.h:5404
SDL_DisplayMode DisplayMode
The structure that defines a display mode.
Definition: SDL3pp_video.h:159
void EGL_SetAttributeCallbacks(EGLAttribArrayCallback platformAttribCallback, EGLIntArrayCallback surfaceAttribCallback, EGLIntArrayCallback contextAttribCallback, void *userdata)
Sets the callbacks for defining custom EGLAttrib arrays for EGL initialization.
Definition: SDL3pp_video.h:6957
const DisplayMode & GetCurrentDisplayMode(DisplayID displayID)
Get information about the current display mode.
Definition: SDL3pp_video.h:3987
void Flash(FlashOperation operation)
Request a window to demand attention from the user.
Definition: SDL3pp_video.h:6532
SDL_HitTestResult HitTestResult
Possible return values from the HitTest callback.
Definition: SDL3pp_video.h:661
void SetWindowAspectRatio(WindowParam window, float min_aspect, float max_aspect)
Request that the aspect ratio of a window's client area be set.
Definition: SDL3pp_video.h:5272
constexpr WindowFlags WINDOW_METAL
window usable for Metal view
Definition: SDL3pp_video.h:626
constexpr WindowFlags WINDOW_MINIMIZED
window is minimized
Definition: SDL3pp_video.h:573
constexpr GLAttr GL_ACCUM_ALPHA_SIZE
the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0.
Definition: SDL3pp_video.h:3401
constexpr int WINDOW_SURFACE_VSYNC_DISABLED
Constant to disable vsync.
Definition: SDL3pp_video.h:5913
bool GetMouseGrab() const
Get a window's mouse grab mode.
Definition: SDL3pp_video.h:6133
constexpr DisplayOrientation ORIENTATION_PORTRAIT
The display is in portrait mode.
Definition: SDL3pp_video.h:141
float GetWindowPixelDensity(WindowParam window)
Get the pixel density of a window.
Definition: SDL3pp_video.h:4088
constexpr GLAttr GL_ACCUM_RED_SIZE
the minimum number of bits for the red channel of the accumulation buffer; defaults to 0.
Definition: SDL3pp_video.h:3383
const DisplayMode & GetWindowFullscreenMode(WindowParam window)
Query the display mode to use when a window is visible at fullscreen.
Definition: SDL3pp_video.h:4187
void SetWindowFullscreen(WindowParam window, bool fullscreen)
Request that the window's fullscreen state be changed.
Definition: SDL3pp_video.h:5774
void SetKeyboardGrab(bool grabbed)
Set a window's keyboard grab mode.
Definition: SDL3pp_video.h:6058
SDL_SystemTheme SystemTheme
System theme.
Definition: SDL3pp_video.h:516
void RestoreWindow(WindowParam window)
Request that the size and position of a minimized or maximized window be restored.
Definition: SDL3pp_video.h:5738
constexpr WindowFlags WINDOW_HIGH_PIXEL_DENSITY
window uses high pixel density back buffer if possible
Definition: SDL3pp_video.h:594
constexpr GLAttr GL_CONTEXT_FLAGS
some combination of 0 or more of elements of the GLContextFlag enumeration; defaults to 0.
Definition: SDL3pp_video.h:3434
void SetAlwaysOnTop(bool on_top)
Set the window to always be above the others.
Definition: SDL3pp_video.h:5571
void SetWindowShape(WindowParam window, SurfaceParam shape)
Set the shape of a transparent window.
Definition: SDL3pp_video.h:6506
void SetSize(const PointRaw &p)
Request that the size of a window's client area be set.
Definition: SDL3pp_video.h:5170
constexpr GLProfile GL_CONTEXT_PROFILE_ES
GLX_CONTEXT_ES2_PROFILE_BIT_EXT.
Definition: SDL3pp_video.h:3483
constexpr GLAttr GL_DOUBLEBUFFER
whether the output is single or double buffered; defaults to double buffering on.
Definition: SDL3pp_video.h:3371
float GetWindowDisplayScale(WindowParam window)
Get the content display scale relative to a window's pixel size.
Definition: SDL3pp_video.h:4120
Display GetPrimaryDisplay()
Return the primary display.
Definition: SDL3pp_video.h:3633
SDL_DisplayModeData DisplayModeData
Internal display mode data.
Definition: SDL3pp_video.h:536
constexpr HitTestResult HITTEST_RESIZE_LEFT
Region is the resizable left border.
Definition: SDL3pp_video.h:694
void SetWindowBordered(WindowParam window, bool bordered)
Set the border state of a window.
Definition: SDL3pp_video.h:5511
float GetWindowOpacity(WindowParam window)
Get the opacity of a window.
Definition: SDL3pp_video.h:6252
PixelFormat GetWindowPixelFormat(WindowParam window)
Get the pixel format associated with the window.
Definition: SDL3pp_video.h:4230
void GL_GetAttribute(GLAttr attr, int *value)
Get the actual value for an attribute from the current context.
Definition: SDL3pp_video.h:6808
void Show()
Show a window.
Definition: SDL3pp_video.h:5594
PropertiesRef GetDisplayProperties(DisplayID displayID)
Get the properties associated with a display.
Definition: SDL3pp_video.h:3666
void SetWindowHitTest(WindowParam window, HitTest callback, void *callback_data)
Provide a callback that decides if a window region has special properties.
Definition: SDL3pp_video.h:6422
void Minimize()
Request that the window be minimized to an iconic representation.
Definition: SDL3pp_video.h:5709
void MaximizeWindow(WindowParam window)
Request that the window be made as large as possible.
Definition: SDL3pp_video.h:5671
void GL_SetAttribute(GLAttr attr, int value)
Set an OpenGL window attribute before window creation.
Definition: SDL3pp_video.h:6788
const char * GetCurrentVideoDriver()
Get the name of the currently initialized video driver.
Definition: SDL3pp_video.h:3586
constexpr GLAttr GL_MULTISAMPLEBUFFERS
the number of buffers used for multisample anti-aliasing; defaults to 0.
Definition: SDL3pp_video.h:3407
PropertiesRef GetProperties() const
Get the properties associated with a window.
Definition: SDL3pp_video.h:4942
void ShowSystemMenu(const PointRaw &p)
Display the system-level window menu.
Definition: SDL3pp_video.h:6376
const DisplayMode & GetCurrentMode() const
Get information about the current display mode.
Definition: SDL3pp_video.h:3992
constexpr GLAttr GL_ALPHA_SIZE
the minimum number of bits for the alpha channel of the color buffer; defaults to 8.
Definition: SDL3pp_video.h:3362
constexpr WindowFlags WINDOW_MODAL
window is modal
Definition: SDL3pp_video.h:591
int GetNumVideoDrivers()
Get the number of video drivers compiled into SDL.
Definition: SDL3pp_video.h:3543
std::function< HitTestResult(WindowRaw window, const Point &area)> HitTestCB
Callback used for hit-testing.
Definition: SDL3pp_video.h:722
void SetWindowMouseRect(WindowParam window, const RectRaw &rect)
Confines the cursor to the specified area of a window.
Definition: SDL3pp_video.h:6173
bool GL_ExtensionSupported(StringParam extension)
Check if an OpenGL extension is supported for the current context.
Definition: SDL3pp_video.h:6751
constexpr WindowFlags WINDOW_INPUT_FOCUS
window has input focus
Definition: SDL3pp_video.h:582
int GetSurfaceVSync() const
Get VSync for the window surface.
Definition: SDL3pp_video.h:5937
void SetOpacity(float opacity)
Set the opacity for a window.
Definition: SDL3pp_video.h:6231
constexpr GLAttr GL_ACCUM_GREEN_SIZE
the minimum number of bits for the green channel of the accumulation buffer; defaults to 0.
Definition: SDL3pp_video.h:3389
constexpr GLContextFlag GL_CONTEXT_DEBUG_FLAG
DEBUG_FLAG.
Definition: SDL3pp_video.h:3493
Uint32 GLContextFlag
Possible flags to be set for the GL_CONTEXT_FLAGS attribute.
Definition: SDL3pp_video.h:3491
SDL_WindowID WindowID
This is a unique ID for a window.
Definition: SDL3pp_video.h:489
const char * GetName() const
Get the name of a display in UTF-8 encoding.
Definition: SDL3pp_video.h:3703
void SetWindowResizable(WindowParam window, bool resizable)
Set the user-resizable state of a window.
Definition: SDL3pp_video.h:5540
void SetBordered(bool bordered)
Set the border state of a window.
Definition: SDL3pp_video.h:5516
DisplayOrientation GetNaturalOrientation() const
Get the orientation of a display when it is unrotated.
Definition: SDL3pp_video.h:3790
void ShowWindow(WindowParam window)
Show a window.
Definition: SDL3pp_video.h:5589
void SetTitle(StringParam title)
Set the title of a window.
Definition: SDL3pp_video.h:4995
void SetWindowParent(WindowParam window, WindowParam parent)
Set the window as a child of a parent window.
Definition: SDL3pp_video.h:6293
constexpr HitTestResult HITTEST_RESIZE_TOP
Region is the resizable top border.
Definition: SDL3pp_video.h:673
void ShowWindowSystemMenu(WindowParam window, const PointRaw &p)
Display the system-level window menu.
Definition: SDL3pp_video.h:6371
const char * GetVideoDriver(int index)
Get the name of a built in video driver.
Definition: SDL3pp_video.h:3564
void GetWindowMaximumSize(WindowParam window, int *w, int *h)
Get the maximum size of a window's client area.
Definition: SDL3pp_video.h:5482
EGLSurface EGL_GetWindowSurface(WindowParam window)
Get the EGL surface associated with the window.
Definition: SDL3pp_video.h:6932
void Maximize()
Request that the window be made as large as possible.
Definition: SDL3pp_video.h:5676
SDL_EGLSurface EGLSurface
Opaque type for an EGL surface.
Definition: SDL3pp_video.h:3191
const char * GetDisplayName(DisplayID displayID)
Get the name of a display in UTF-8 encoding.
Definition: SDL3pp_video.h:3698
SDL_FlashOperation FlashOperation
Window flash operation.
Definition: SDL3pp_video.h:640
constexpr WindowFlags WINDOW_VULKAN
window usable for Vulkan surface
Definition: SDL3pp_video.h:623
bool WindowHasSurface(WindowParam window)
Return whether the window has a surface associated with it.
Definition: SDL3pp_video.h:5832
constexpr HitTestResult HITTEST_RESIZE_TOPLEFT
Region is the resizable top-left corner border.
Definition: SDL3pp_video.h:669
constexpr HitTestResult HITTEST_RESIZE_BOTTOMRIGHT
Region is the resizable bottom-right corner border.
Definition: SDL3pp_video.h:684
SDL_EGLConfig EGLConfig
Opaque type for an EGL config.
Definition: SDL3pp_video.h:3184
constexpr SystemTheme SYSTEM_THEME_UNKNOWN
Unknown system theme.
Definition: SDL3pp_video.h:518
constexpr WindowFlags WINDOW_KEYBOARD_GRABBED
window has grabbed keyboard input
Definition: SDL3pp_video.h:620
constexpr GLAttr GL_BLUE_SIZE
the minimum number of bits for the blue channel of the color buffer; defaults to 8.
Definition: SDL3pp_video.h:3356
OwnArray< DisplayMode * > GetFullscreenDisplayModes(DisplayID displayID)
Get a list of fullscreen display modes available on a display.
Definition: SDL3pp_video.h:3875
constexpr GLAttr GL_EGL_PLATFORM
GL_EGL_PLATFORM.
Definition: SDL3pp_video.h:3467
constexpr WindowFlags WINDOW_BORDERLESS
no window decoration
Definition: SDL3pp_video.h:567
const DisplayMode & GetDesktopMode() const
Get information about the desktop's display mode.
Definition: SDL3pp_video.h:3963
void SetWindowFocusable(WindowParam window, bool focusable)
Set whether the window may have input focus.
Definition: SDL3pp_video.h:6341
SDL_EGLDisplay EGLDisplay
Opaque type for an EGL display.
Definition: SDL3pp_video.h:3177
void GetWindowSizeInPixels(WindowParam window, int *w, int *h)
Get the size of a window's client area, in pixels.
Definition: SDL3pp_video.h:5380
constexpr WindowFlags WINDOW_TOOLTIP
window should be treated as a tooltip and does not get mouse or keyboard focus, requires a parent win...
Definition: SDL3pp_video.h:615
Rect GetDisplayUsableBounds(DisplayID displayID)
Get the usable desktop area represented by a display, in screen coordinates.
Definition: SDL3pp_video.h:3760
constexpr WindowFlags WINDOW_MOUSE_CAPTURE
window has mouse captured (unrelated to MOUSE_GRABBED)
Definition: SDL3pp_video.h:597
Window CreatePopupWindow(WindowParam parent, const PointRaw &offset, const PointRaw &size, WindowFlags flags)
Create a child popup window of the specified parent window.
Definition: SDL3pp_video.h:4422
void GetWindowBordersSize(WindowParam window, int *top, int *left, int *bottom, int *right)
Get the size of a window's borders (decorations) around the client area.
Definition: SDL3pp_video.h:5346
WindowRef GetGrabbedWindow()
Get the window that currently has an input grab enabled.
Definition: SDL3pp_video.h:6150
void UpdateWindowSurface(WindowParam window)
Copy the window surface to the screen.
Definition: SDL3pp_video.h:5960
constexpr GLAttr GL_BUFFER_SIZE
the minimum number of bits for frame buffer size; defaults to 0.
Definition: SDL3pp_video.h:3365
constexpr DisplayOrientation ORIENTATION_LANDSCAPE
The display is in landscape mode, with the right side up, relative to portrait mode.
Definition: SDL3pp_video.h:132
constexpr DisplayOrientation ORIENTATION_PORTRAIT_FLIPPED
The display is in portrait mode, upside down.
Definition: SDL3pp_video.h:144
constexpr WindowFlags WINDOW_OPENGL
window usable with OpenGL context
Definition: SDL3pp_video.h:555
bool GetKeyboardGrab() const
Get a window's keyboard grab mode.
Definition: SDL3pp_video.h:6108
constexpr GLAttr GL_CONTEXT_NO_ERROR
GL_CONTEXT_NO_ERROR.
Definition: SDL3pp_video.h:3462
void SetWindowSize(WindowParam window, const PointRaw &p)
Request that the size of a window's client area be set.
Definition: SDL3pp_video.h:5165
const char * GetWindowTitle(WindowParam window)
Get the title of a window.
Definition: SDL3pp_video.h:5013
void SetWindowAlwaysOnTop(WindowParam window, bool on_top)
Set the window to always be above the others.
Definition: SDL3pp_video.h:5566
void GetWindowSize(WindowParam window, int *w, int *h)
Get the size of a window's client area.
Definition: SDL3pp_video.h:5195
static OwnArray< DisplayID > GetAll()
Get a list of currently connected displays.
Definition: SDL3pp_video.h:3619
SDL_EGLint EGLint
An EGL integer attribute, used when creating an EGL surface.
Definition: SDL3pp_video.h:3205
WindowFlags GetWindowFlags(WindowParam window)
Get the window flags.
Definition: SDL3pp_video.h:4965
constexpr GLContextFlag GL_CONTEXT_ROBUST_ACCESS_FLAG
ROBUST_ACCESS_FLAG.
Definition: SDL3pp_video.h:3499
constexpr DisplayOrientation ORIENTATION_LANDSCAPE_FLIPPED
The display is in landscape mode, with the left side up, relative to portrait mode.
Definition: SDL3pp_video.h:138
Surface GetWindowSurface(WindowParam window)
Get the SDL surface associated with the window.
Definition: SDL3pp_video.h:5869
const char * GetTitle() const
Get the title of a window.
Definition: SDL3pp_video.h:5018
constexpr WindowFlags WINDOW_MOUSE_RELATIVE_MODE
window has relative mode enabled
Definition: SDL3pp_video.h:599
constexpr WindowFlags WINDOW_OCCLUDED
window is occluded
Definition: SDL3pp_video.h:558
constexpr FlashOperation FLASH_UNTIL_FOCUSED
Flash the window until it gets focus.
Definition: SDL3pp_video.h:648
static Display GetForPoint(const PointRaw &point)
Get the display containing a point.
Definition: SDL3pp_video.h:4016
void SetWindowOpacity(WindowParam window, float opacity)
Set the opacity for a window.
Definition: SDL3pp_video.h:6226
SDL_GLContext GLContextRaw
Alias to raw representation for GLContext.
Definition: SDL3pp_video.h:83
Uint32 GLProfile
Possible values to be set for the GL_CONTEXT_PROFILE_MASK attribute.
Definition: SDL3pp_video.h:3474
void SetMouseRect(const RectRaw &rect)
Confines the cursor to the specified area of a window.
Definition: SDL3pp_video.h:6178
void SetWindowModal(WindowParam window, bool modal)
Toggle the state of the window as modal.
Definition: SDL3pp_video.h:6320
void Destroy()
Destroy a window.
Definition: SDL3pp_video.h:6559
SystemTheme GetSystemTheme()
Get the current system theme.
Definition: SDL3pp_video.h:3600
static Display GetForRect(const RectRaw &rect)
Get the display primarily containing a rect.
Definition: SDL3pp_video.h:4041
DisplayOrientation GetCurrentOrientation() const
Get the orientation of a display.
Definition: SDL3pp_video.h:3813
OwnPtr< void > GetICCProfile() const
Get the raw ICC profile data for the screen the window is currently on.
Definition: SDL3pp_video.h:4214
static WindowRef FromID(WindowID id)
Get a window from a stored ID.
Definition: SDL3pp_video.h:4789
PropertiesRef GetWindowProperties(WindowParam window)
Get the properties associated with a window.
Definition: SDL3pp_video.h:4937
void GetAspectRatio(float *min_aspect, float *max_aspect) const
Get the size of a window's client area.
Definition: SDL3pp_video.h:5307
void GetWindowMinimumSize(WindowParam window, int *w, int *h)
Get the minimum size of a window's client area.
Definition: SDL3pp_video.h:5431
constexpr WindowFlags WINDOW_NOT_FOCUSABLE
window should not be focusable
Definition: SDL3pp_video.h:632
void SetWindowKeyboardGrab(WindowParam window, bool grabbed)
Set a window's keyboard grab mode.
Definition: SDL3pp_video.h:6053
constexpr GLContextResetNotification GL_CONTEXT_RESET_NO_NOTIFICATION
NO_NOTIFICATION.
Definition: SDL3pp_video.h:3526
constexpr GLAttr GL_FLOATBUFFERS
GL_FLOATBUFFERS.
Definition: SDL3pp_video.h:3465
void GL_MakeCurrent(WindowParam window, GLContext context)
Set up an OpenGL context for rendering into an OpenGL window.
Definition: SDL3pp_video.h:6855
void Raise()
Request that a window be raised above other windows and gain the input focus.
Definition: SDL3pp_video.h:5638
void SetMaximumSize(const PointRaw &p)
Set the maximum size of a window's client area.
Definition: SDL3pp_video.h:5460
GLContext GL_GetCurrentContext()
Get the currently active OpenGL context.
Definition: SDL3pp_video.h:6892
constexpr WindowFlags WINDOW_RESIZABLE
window can be resized
Definition: SDL3pp_video.h:570
OwnArray< WindowRef > GetWindows()
Get a list of valid windows.
Definition: SDL3pp_video.h:4250
PixelFormat GetPixelFormat() const
Get the pixel format associated with the window.
Definition: SDL3pp_video.h:4235
constexpr WindowFlags WINDOW_POPUP_MENU
window should be treated as a popup menu, requires a parent window
Definition: SDL3pp_video.h:618
void Hide()
Hide a window.
Definition: SDL3pp_video.h:5614
void SetParent(WindowParam parent)
Set the window as a child of a parent window.
Definition: SDL3pp_video.h:6298
constexpr GLContextResetNotification GL_CONTEXT_RESET_LOSE_CONTEXT
LOSE_CONTEXT.
Definition: SDL3pp_video.h:3529
Display GetDisplayForWindow(WindowParam window)
Get the display associated with a window.
Definition: SDL3pp_video.h:4061
void SetModal(bool modal)
Toggle the state of the window as modal.
Definition: SDL3pp_video.h:6325
void GL_ResetAttributes()
Reset all previously set OpenGL context attributes to their default values.
Definition: SDL3pp_video.h:6766
Uint32 GLContextResetNotification
Possible values to be set GL_CONTEXT_RESET_NOTIFICATION attribute.
Definition: SDL3pp_video.h:3524
void Destroy()
Delete an OpenGL context.
Definition: SDL3pp_video.h:7064
constexpr WindowFlags WINDOW_EXTERNAL
window not created by SDL
Definition: SDL3pp_video.h:588
Rect GetSafeArea() const
Get the safe area for this window.
Definition: SDL3pp_video.h:5229
void SetWindowMaximumSize(WindowParam window, const PointRaw &p)
Set the maximum size of a window's client area.
Definition: SDL3pp_video.h:5455
WindowFlags GetFlags() const
Get the window flags.
Definition: SDL3pp_video.h:4970
void SyncWindow(WindowParam window)
Block until any pending window state is finalized.
Definition: SDL3pp_video.h:5812
OwnArray< DisplayID > GetDisplays()
Get a list of currently connected displays.
Definition: SDL3pp_video.h:3612
const RectRaw * GetMouseRect() const
Get the mouse confinement rectangle of a window.
Definition: SDL3pp_video.h:6203
constexpr WindowFlags WINDOW_ALWAYS_ON_TOP
window should always be above others
Definition: SDL3pp_video.h:602
std::function< SDL_EGLAttrib *()> EGLAttribArrayCB
EGL platform attribute initialization callback.
Definition: SDL3pp_video.h:3256
const DisplayMode & GetFullscreenMode() const
Query the display mode to use when a window is visible at fullscreen.
Definition: SDL3pp_video.h:4192
constexpr WindowFlags WINDOW_HIDDEN
window is neither mapped onto the desktop nor shown in the taskbar/dock/window list; Window....
Definition: SDL3pp_video.h:565
constexpr GLAttr GL_SHARE_WITH_CURRENT_CONTEXT
OpenGL context sharing; defaults to 0.
Definition: SDL3pp_video.h:3442
void SetWindowTitle(WindowParam window, StringParam title)
Set the title of a window.
Definition: SDL3pp_video.h:4990
void Sync()
Block until any pending window state is finalized.
Definition: SDL3pp_video.h:5817
WindowID GetWindowID(WindowParam window)
Get the numeric ID of a window.
Definition: SDL3pp_video.h:4761
EGLConfig EGL_GetCurrentConfig()
Get the currently active EGL config.
Definition: SDL3pp_video.h:6919
void HideWindow(WindowParam window)
Hide a window.
Definition: SDL3pp_video.h:5609
static Display GetPrimary()
Return the primary display.
Definition: SDL3pp_video.h:3638
constexpr HitTestResult HITTEST_RESIZE_BOTTOM
Region is the resizable bottom border.
Definition: SDL3pp_video.h:687
OwnPtr< void > GetWindowICCProfile(WindowParam window)
Get the raw ICC profile data for the screen the window is currently on.
Definition: SDL3pp_video.h:4208
void RaiseWindow(WindowParam window)
Request that a window be raised above other windows and gain the input focus.
Definition: SDL3pp_video.h:5633
bool HasSurface() const
Return whether the window has a surface associated with it.
Definition: SDL3pp_video.h:5837
Rect GetUsableBounds() const
Get the usable desktop area represented by a display, in screen coordinates.
Definition: SDL3pp_video.h:3767
void SetResizable(bool resizable)
Set the user-resizable state of a window.
Definition: SDL3pp_video.h:5545
void DestroyWindow(WindowRaw window)
Destroy a window.
Definition: SDL3pp_video.h:6557
constexpr GLAttr GL_ACCUM_BLUE_SIZE
the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0.
Definition: SDL3pp_video.h:3395
const RectRaw * GetWindowMouseRect(WindowParam window)
Get the mouse confinement rectangle of a window.
Definition: SDL3pp_video.h:6198
WindowRef GetWindowFromID(WindowID id)
Get a window from a stored ID.
Definition: SDL3pp_video.h:4784
void GetBordersSize(int *top, int *left, int *bottom, int *right) const
Get the size of a window's borders (decorations) around the client area.
Definition: SDL3pp_video.h:5355
constexpr WindowFlags WINDOW_FULLSCREEN
window is in fullscreen mode
Definition: SDL3pp_video.h:552
void UpdateSurfaceRects(SpanRef< const RectRaw > rects)
Copy areas of the window surface to the screen.
Definition: SDL3pp_video.h:5998
constexpr GLContextReleaseFlag GL_CONTEXT_RELEASE_BEHAVIOR_NONE
BEHAVIOR_NONE.
Definition: SDL3pp_video.h:3513
void SetShape(SurfaceParam shape)
Set the shape of a transparent window.
Definition: SDL3pp_video.h:6511
WindowRef GetParent() const
Get parent of a window.
Definition: SDL3pp_video.h:4812
SDL_EGLAttrib EGLAttrib
An EGL attribute, used when creating an EGL context.
Definition: SDL3pp_video.h:3198
void GL_LoadLibrary(StringParam path)
Dynamically load an OpenGL library.
Definition: SDL3pp_video.h:6634
void SetFullscreen(bool fullscreen)
Request that the window's fullscreen state be changed.
Definition: SDL3pp_video.h:5779
void MakeCurrent(WindowParam window)
Set up an OpenGL context for rendering into an OpenGL window.
Definition: SDL3pp_video.h:6860
void SetFullscreenMode(OptionalRef< const DisplayMode > mode)
Set the display mode to use when a window is visible and fullscreen.
Definition: SDL3pp_video.h:4168
constexpr GLAttr GL_DEPTH_SIZE
the minimum number of bits in the depth buffer; defaults to 16.
Definition: SDL3pp_video.h:3374
void SetIcon(SurfaceParam icon)
Set the icon for a window.
Definition: SDL3pp_video.h:5049
std::function< SDL_EGLint *(SDL_EGLDisplay, SDL_EGLConfig)> EGLIntArrayCB
EGL surface/context attribute initialization callback types.
Definition: SDL3pp_video.h:3319
DisplayMode GetClosestFullscreenDisplayMode(DisplayID displayID, const PointRaw &size, float refresh_rate, bool include_high_density_modes)
Get the closest match to the requested display mode.
Definition: SDL3pp_video.h:3914
EGLDisplay EGL_GetCurrentDisplay()
Get the currently active EGL display.
Definition: SDL3pp_video.h:6904
void SetMouseGrab(bool grabbed)
Set a window's mouse grab mode.
Definition: SDL3pp_video.h:6086
void MinimizeWindow(WindowParam window)
Request that the window be minimized to an iconic representation.
Definition: SDL3pp_video.h:5704
constexpr GLContextReleaseFlag GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH
BEHAVIOR_FLUSH.
Definition: SDL3pp_video.h:3516
void SetSurfaceVSync(int vsync)
Toggle VSync for the window surface.
Definition: SDL3pp_video.h:5907
constexpr GLAttr GL_ACCELERATED_VISUAL
set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow ei...
Definition: SDL3pp_video.h:3419
void SetWindowMouseGrab(WindowParam window, bool grabbed)
Set a window's mouse grab mode.
Definition: SDL3pp_video.h:6081
SDL_EGLIntArrayCallback EGLIntArrayCallback
EGL surface/context attribute initialization callback types.
Definition: SDL3pp_video.h:3287
Main include header for the SDL3pp library.
Safely wrap GLContext for non owning parameters.
Definition: SDL3pp_video.h:90
GLContextRaw value
parameter's GLContextRaw
Definition: SDL3pp_video.h:91
constexpr GLContextParam(GLContextRaw value)
Constructs from GLContextRaw.
Definition: SDL3pp_video.h:94
constexpr auto operator<=>(const GLContextParam &other) const =default
Comparison.
constexpr GLContextParam(std::nullptr_t _=nullptr)
Constructs null/invalid.
Definition: SDL3pp_video.h:100
RAII owning version GLContext.
Definition: SDL3pp_video.h:3157
constexpr GLContextScoped(GLContext &&other)
Move constructor.
Definition: SDL3pp_video.h:3163
~GLContextScoped()
Destructor.
Definition: SDL3pp_video.h:3169
Store callbacks by key.
Definition: SDL3pp_callbackWrapper.h:222
The structure that defines a point (using integers).
Definition: SDL3pp_rect.h:80
Safely wrap Properties for non owning parameters.
Definition: SDL3pp_properties.h:52
Semi-safe reference for Properties.
Definition: SDL3pp_properties.h:569
A rectangle, with the origin at the upper left (using integers).
Definition: SDL3pp_rect.h:836
constexpr Point GetTopLeft() const
Get top left corner of the rect.
Definition: SDL3pp_rect.h:1085
constexpr Point GetSize() const
Get size of the rect.
Definition: SDL3pp_rect.h:1117
Semi-safe reference for Renderer.
Definition: SDL3pp_render.h:2090
Safely wrap Surface for non owning parameters.
Definition: SDL3pp_surface.h:46
Safely wrap Window for non owning parameters.
Definition: SDL3pp_video.h:54
constexpr WindowParam(WindowRaw value)
Constructs from WindowRaw.
Definition: SDL3pp_video.h:58
constexpr auto operator<=>(const WindowParam &other) const =default
Comparison.
WindowRaw value
parameter's WindowRaw
Definition: SDL3pp_video.h:55
constexpr WindowParam(std::nullptr_t _=nullptr)
Constructs null/invalid.
Definition: SDL3pp_video.h:64
Semi-safe reference for Window.
Definition: SDL3pp_video.h:2922
~WindowRef()
Destructor.
Definition: SDL3pp_video.h:2942
WindowRef(WindowParam resource)
Constructs from WindowParam.
Definition: SDL3pp_video.h:2930
WindowRef(const WindowRef &other)
Copy constructor.
Definition: SDL3pp_video.h:2936