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 noexcept {
return m_displayID; }
438 bool include_high_density_modes)
const;
490namespace 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;
559 SDL_WINDOW_FULLSCREEN;
574 SDL_WINDOW_BORDERLESS;
577 SDL_WINDOW_RESIZABLE;
580 SDL_WINDOW_MINIMIZED;
583 SDL_WINDOW_MAXIMIZED;
586 SDL_WINDOW_MOUSE_GRABBED;
589 SDL_WINDOW_INPUT_FOCUS;
592 SDL_WINDOW_MOUSE_FOCUS;
606 SDL_WINDOW_MOUSE_RELATIVE_MODE;
609 SDL_WINDOW_ALWAYS_ON_TOP;
627 SDL_WINDOW_KEYBOARD_GRABBED;
629#if SDL_VERSION_ATLEAST(3, 4, 0)
643 SDL_WINDOW_TRANSPARENT;
646 SDL_WINDOW_NOT_FOCUSABLE;
662 SDL_FLASH_UNTIL_FOCUSED;
680 SDL_HITTEST_DRAGGABLE;
683 SDL_HITTEST_RESIZE_TOPLEFT;
687 SDL_HITTEST_RESIZE_TOP;
690 SDL_HITTEST_RESIZE_TOPRIGHT;
694 SDL_HITTEST_RESIZE_RIGHT;
698 SDL_HITTEST_RESIZE_BOTTOMRIGHT;
701 SDL_HITTEST_RESIZE_BOTTOM;
704 SDL_HITTEST_RESIZE_BOTTOMLEFT;
708 SDL_HITTEST_RESIZE_LEFT;
746#if SDL_VERSION_ATLEAST(3, 4, 0)
759 SDL_PROGRESS_STATE_NONE;
763 SDL_PROGRESS_STATE_INDETERMINATE;
767 SDL_PROGRESS_STATE_NORMAL;
770 SDL_PROGRESS_STATE_PAUSED;
794 constexpr Window(std::nullptr_t =
nullptr) noexcept
807 : m_resource(resource)
935 : m_resource(SDL_CreateWindow(title, size.x, size.y, flags))
1014 : m_resource(SDL_CreatePopupWindow(parent,
1168 : m_resource(SDL_CreateWindowWithProperties(props))
1178 std::swap(m_resource, other.m_resource);
1193 auto r = m_resource;
1194 m_resource =
nullptr;
1202 constexpr explicit operator bool() const noexcept {
return !!m_resource; }
1205 constexpr operator WindowParam() const noexcept {
return {m_resource}; }
1756 void GetSize(
int* w,
int* h)
const;
1913 void GetBordersSize(
int* top,
int* left,
int* bottom,
int* right)
const;
2074#if SDL_VERSION_ATLEAST(3, 4, 0)
2794#if SDL_VERSION_ATLEAST(3, 4, 0)
3229 return SDL_WINDOWPOS_UNDEFINED_DISPLAY(X);
3254 return SDL_WINDOWPOS_ISUNDEFINED(X);
3283 return SDL_WINDOWPOS_CENTERED_DISPLAY(X);
3308 return SDL_WINDOWPOS_ISCENTERED(X);
3340 : m_resource(resource)
3382 : m_resource(SDL_GL_CreateContext(window))
3392 std::swap(m_resource, other.m_resource);
3405 auto r = m_resource;
3406 m_resource =
nullptr;
3414 constexpr explicit operator bool() const noexcept {
return !!m_resource; }
3651 SDL_GL_RETAINED_BACKING;
3654 SDL_GL_CONTEXT_MAJOR_VERSION;
3657 SDL_GL_CONTEXT_MINOR_VERSION;
3672 SDL_GL_SHARE_WITH_CURRENT_CONTEXT;
3691 SDL_GL_CONTEXT_RESET_NOTIFICATION;
3694 SDL_GL_CONTEXT_NO_ERROR;
3708 SDL_GL_CONTEXT_PROFILE_CORE;
3711 SDL_GL_CONTEXT_PROFILE_COMPATIBILITY;
3715 SDL_GL_CONTEXT_PROFILE_ES;
3725 SDL_GL_CONTEXT_DEBUG_FLAG;
3728 SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG;
3731 SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG;
3734 SDL_GL_CONTEXT_RESET_ISOLATION_FLAG;
3744 SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE;
3747 SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH;
3757 SDL_GL_CONTEXT_RESET_NO_NOTIFICATION;
3760 SDL_GL_CONTEXT_RESET_LOSE_CONTEXT;
3797 return SDL_GetVideoDriver(index);
3819 return SDL_GetCurrentVideoDriver();
3846 auto data =
reinterpret_cast<DisplayID*
>(SDL_GetDisplays(&count));
3908 return {
CheckError(SDL_GetDisplayProperties(displayID))};
3916namespace prop::Display {
3918constexpr auto HDR_ENABLED_BOOLEAN = SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN;
3920constexpr auto KMSDRM_PANEL_ORIENTATION_NUMBER =
3921 SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER;
3923#if SDL_VERSION_ATLEAST(3, 4, 0)
3925constexpr auto WAYLAND_WL_OUTPUT_POINTER =
3926 SDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER;
3928constexpr auto WINDOWS_HMONITOR_POINTER =
3929 SDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER;
3950 return SDL_GetDisplayName(displayID);
3978 SDL_GetDisplayBounds(displayID, &bounds);
4012 SDL_GetDisplayUsableBounds(displayID, &bounds);
4036 return SDL_GetNaturalDisplayOrientation(displayID);
4059 return SDL_GetCurrentDisplayOrientation(displayID);
4094 return SDL_GetDisplayContentScale(displayID);
4127 auto data =
CheckError(SDL_GetFullscreenDisplayModes(displayID, &count));
4166 bool include_high_density_modes)
4169 CheckError(SDL_GetClosestFullscreenDisplayMode(displayID,
4173 include_high_density_modes,
4181 bool include_high_density_modes)
const
4184 m_displayID, size, refresh_rate, include_high_density_modes);
4208 return *SDL_GetDesktopDisplayMode(displayID);
4237 return *SDL_GetCurrentDisplayMode(displayID);
4261 return SDL_GetDisplayForPoint(&point);
4286 return CheckError(SDL_GetDisplayForRect(&rect));
4311 return CheckError(SDL_GetDisplayForWindow(window));
4338 return SDL_GetWindowPixelDensity(window);
4369 return SDL_GetWindowDisplayScale(window);
4411 CheckError(SDL_SetWindowFullscreenMode(window, mode));
4435 return *SDL_GetWindowFullscreenMode(window);
4478 return CheckError(SDL_GetWindowPixelFormat(window));
4499 auto data =
CheckError(SDL_GetWindows(&count));
4591 return Window(std::move(title), size, flags);
4670 return Window(parent, offset, size, flags);
4822namespace prop::Window {
4824constexpr auto CREATE_ALWAYS_ON_TOP_BOOLEAN =
4825 SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN;
4827constexpr auto CREATE_BORDERLESS_BOOLEAN =
4828 SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN;
4830#if SDL_VERSION_ATLEAST(3, 2, 18)
4832constexpr auto CREATE_CONSTRAIN_POPUP_BOOLEAN =
4833 SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN;
4837constexpr auto CREATE_FOCUSABLE_BOOLEAN =
4838 SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN;
4840constexpr auto CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN =
4841 SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN;
4843constexpr auto CREATE_FLAGS_NUMBER = SDL_PROP_WINDOW_CREATE_FLAGS_NUMBER;
4845constexpr auto CREATE_FULLSCREEN_BOOLEAN =
4846 SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN;
4848constexpr auto CREATE_HEIGHT_NUMBER = SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER;
4850constexpr auto CREATE_HIDDEN_BOOLEAN = SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN;
4852constexpr auto CREATE_HIGH_PIXEL_DENSITY_BOOLEAN =
4853 SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN;
4855constexpr auto CREATE_MAXIMIZED_BOOLEAN =
4856 SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN;
4858constexpr auto CREATE_MENU_BOOLEAN = SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN;
4860constexpr auto CREATE_METAL_BOOLEAN = SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN;
4862constexpr auto CREATE_MINIMIZED_BOOLEAN =
4863 SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN;
4865constexpr auto CREATE_MODAL_BOOLEAN = SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN;
4867constexpr auto CREATE_MOUSE_GRABBED_BOOLEAN =
4868 SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN;
4870constexpr auto CREATE_OPENGL_BOOLEAN = SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN;
4872constexpr auto CREATE_PARENT_POINTER = SDL_PROP_WINDOW_CREATE_PARENT_POINTER;
4874constexpr auto CREATE_RESIZABLE_BOOLEAN =
4875 SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN;
4877constexpr auto CREATE_TITLE_STRING = SDL_PROP_WINDOW_CREATE_TITLE_STRING;
4879constexpr auto CREATE_TRANSPARENT_BOOLEAN =
4880 SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN;
4882constexpr auto CREATE_TOOLTIP_BOOLEAN = SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN;
4884constexpr auto CREATE_UTILITY_BOOLEAN = SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN;
4886constexpr auto CREATE_VULKAN_BOOLEAN = SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN;
4888constexpr auto CREATE_WIDTH_NUMBER = SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER;
4890constexpr auto CREATE_X_NUMBER = SDL_PROP_WINDOW_CREATE_X_NUMBER;
4892constexpr auto CREATE_Y_NUMBER = SDL_PROP_WINDOW_CREATE_Y_NUMBER;
4894constexpr auto CREATE_COCOA_WINDOW_POINTER =
4895 SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER;
4897constexpr auto CREATE_COCOA_VIEW_POINTER =
4898 SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER;
4900#if SDL_VERSION_ATLEAST(3, 4, 0)
4902constexpr auto CREATE_WINDOWSCENE_POINTER =
4903 SDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER;
4907constexpr auto CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN =
4908 SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN;
4910constexpr auto CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN =
4911 SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN;
4913constexpr auto CREATE_WAYLAND_WL_SURFACE_POINTER =
4914 SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER;
4916constexpr auto CREATE_WIN32_HWND_POINTER =
4917 SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER;
4919constexpr auto CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER =
4920 SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER;
4922constexpr auto CREATE_X11_WINDOW_NUMBER =
4923 SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER;
4925#if SDL_VERSION_ATLEAST(3, 4, 0)
4927constexpr auto CREATE_EMSCRIPTEN_CANVAS_ID_STRING =
4928 SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING;
4930constexpr auto CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING =
4931 SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING;
4935constexpr auto SHAPE_POINTER = SDL_PROP_WINDOW_SHAPE_POINTER;
4937constexpr auto HDR_ENABLED_BOOLEAN = SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN;
4939constexpr auto SDR_WHITE_LEVEL_FLOAT = SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT;
4941constexpr auto HDR_HEADROOM_FLOAT = SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT;
4943constexpr auto ANDROID_WINDOW_POINTER = SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER;
4945constexpr auto ANDROID_SURFACE_POINTER =
4946 SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER;
4948constexpr auto UIKIT_WINDOW_POINTER = SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER;
4950constexpr auto UIKIT_METAL_VIEW_TAG_NUMBER =
4951 SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER;
4953constexpr auto UIKIT_OPENGL_FRAMEBUFFER_NUMBER =
4954 SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER;
4956constexpr auto UIKIT_OPENGL_RENDERBUFFER_NUMBER =
4957 SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER;
4959constexpr auto UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER =
4960 SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER;
4962constexpr auto KMSDRM_DEVICE_INDEX_NUMBER =
4963 SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER;
4965constexpr auto KMSDRM_DRM_FD_NUMBER = SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER;
4967constexpr auto KMSDRM_GBM_DEVICE_POINTER =
4968 SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER;
4970constexpr auto COCOA_WINDOW_POINTER = SDL_PROP_WINDOW_COCOA_WINDOW_POINTER;
4972constexpr auto COCOA_METAL_VIEW_TAG_NUMBER =
4973 SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER;
4975#if SDL_VERSION_ATLEAST(3, 4, 0)
4977constexpr auto OPENVR_OVERLAY_ID_NUMBER =
4978 SDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER;
4982constexpr auto OPENVR_OVERLAY_ID_NUMBER = SDL_PROP_WINDOW_OPENVR_OVERLAY_ID;
4986constexpr auto VIVANTE_DISPLAY_POINTER =
4987 SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER;
4989constexpr auto VIVANTE_WINDOW_POINTER = SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER;
4991constexpr auto VIVANTE_SURFACE_POINTER =
4992 SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER;
4994constexpr auto WIN32_HWND_POINTER = SDL_PROP_WINDOW_WIN32_HWND_POINTER;
4996constexpr auto WIN32_HDC_POINTER = SDL_PROP_WINDOW_WIN32_HDC_POINTER;
4998constexpr auto WIN32_INSTANCE_POINTER = SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER;
5000constexpr auto WAYLAND_DISPLAY_POINTER =
5001 SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER;
5003constexpr auto WAYLAND_SURFACE_POINTER =
5004 SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER;
5006constexpr auto WAYLAND_VIEWPORT_POINTER =
5007 SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER;
5009constexpr auto WAYLAND_EGL_WINDOW_POINTER =
5010 SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER;
5012constexpr auto WAYLAND_XDG_SURFACE_POINTER =
5013 SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER;
5015constexpr auto WAYLAND_XDG_TOPLEVEL_POINTER =
5016 SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER;
5018constexpr auto WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING =
5019 SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING;
5021constexpr auto WAYLAND_XDG_POPUP_POINTER =
5022 SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER;
5024constexpr auto WAYLAND_XDG_POSITIONER_POINTER =
5025 SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER;
5027constexpr auto X11_DISPLAY_POINTER = SDL_PROP_WINDOW_X11_DISPLAY_POINTER;
5029constexpr auto X11_SCREEN_NUMBER = SDL_PROP_WINDOW_X11_SCREEN_NUMBER;
5031constexpr auto X11_WINDOW_NUMBER = SDL_PROP_WINDOW_X11_WINDOW_NUMBER;
5033#if SDL_VERSION_ATLEAST(3, 4, 0)
5035constexpr auto EMSCRIPTEN_CANVAS_ID_STRING =
5036 SDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING;
5038constexpr auto EMSCRIPTEN_KEYBOARD_ELEMENT_STRING =
5039 SDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING;
5086 return {SDL_GetWindowFromID(
id)};
5109 return {
CheckError(SDL_GetWindowParent(window))};
5243 return {
CheckError(SDL_GetWindowProperties(window))};
5272 return SDL_GetWindowFlags(window);
5297 CheckError(SDL_SetWindowTitle(window, title));
5319 return SDL_GetWindowTitle(window);
5397 CheckError(SDL_SetWindowPosition(window, p.x, p.y));
5429 CheckError(SDL_GetWindowPosition(window, x, y));
5503 CheckError(SDL_SetWindowSize(window, size.x, size.y));
5632 CheckError(SDL_GetWindowSafeArea(window, &rect));
5682 CheckError(SDL_SetWindowAspectRatio(window, min_aspect, max_aspect));
5710 CheckError(SDL_GetWindowAspectRatio(window, min_aspect, max_aspect));
5757 CheckError(SDL_GetWindowBordersSize(window, top, left, bottom, right));
5787 CheckError(SDL_GetWindowSizeInPixels(window, w, h));
5838 CheckError(SDL_SetWindowMinimumSize(window, p.x, p.y));
5865 CheckError(SDL_GetWindowMinimumSize(window, w, h));
5889 CheckError(SDL_SetWindowMaximumSize(window, p.x, p.y));
5916 CheckError(SDL_GetWindowMaximumSize(window, w, h));
5945 CheckError(SDL_SetWindowBordered(window, bordered));
5974 CheckError(SDL_SetWindowResizable(window, resizable));
6000 CheckError(SDL_SetWindowAlwaysOnTop(window, on_top));
6008#if SDL_VERSION_ATLEAST(3, 4, 0)
6040 CheckError(SDL_SetWindowFillDocument(window, fill));
6249 CheckError(SDL_SetWindowFullscreen(window, fullscreen));
6307 return SDL_WindowHasSurface(window);
6377 CheckError(SDL_SetWindowSurfaceVSync(window, vsync));
6406 CheckError(SDL_GetWindowSurfaceVSync(window, &vsync));
6491 CheckError(SDL_DestroyWindowSurface(window));
6527 CheckError(SDL_SetWindowKeyboardGrab(window, grabbed));
6554 CheckError(SDL_SetWindowMouseGrab(window, grabbed));
6576 return SDL_GetWindowKeyboardGrab(window);
6601 return SDL_GetWindowMouseGrab(window);
6646 CheckError(SDL_SetWindowMouseRect(window, &rect));
6671 return SDL_GetWindowMouseRect(window);
6699 CheckError(SDL_SetWindowOpacity(window, opacity));
6725 return SDL_GetWindowOpacity(window);
6766 CheckError(SDL_SetWindowParent(window, parent));
6793 CheckError(SDL_SetWindowModal(window, modal));
6814 CheckError(SDL_SetWindowFocusable(window, focusable));
6844 CheckError(SDL_ShowWindowSystemMenu(window, p.x, p.y));
6895 void* callback_data)
6897 CheckError(SDL_SetWindowHitTest(window, callback, callback_data));
6981 CheckError(SDL_SetWindowShape(window, shape));
7002 CheckError(SDL_FlashWindow(window, operation));
7010#if SDL_VERSION_ATLEAST(3, 4, 0)
7026 CheckError(SDL_SetWindowProgressState(window, state));
7047 return SDL_GetWindowProgressState(window);
7069 CheckError(SDL_SetWindowProgressValue(window, value));
7090 return SDL_GetWindowProgressValue(window);
7256 return SDL_GL_GetProcAddress(proc);
7278 return SDL_EGL_GetProcAddress(proc);
7314 return SDL_GL_ExtensionSupported(extension);
7351 CheckError(SDL_GL_SetAttribute(attr, value));
7370 CheckError(SDL_GL_GetAttribute(attr, value));
7451 return {
CheckError(SDL_GL_GetCurrentWindow())};
7480 return SDL_EGL_GetCurrentDisplay();
7508 return SDL_EGL_GetWindowSurface(window);
7542 SDL_EGL_SetAttributeCallbacks(platformAttribCallback,
7543 surfaceAttribCallback,
7544 contextAttribCallback,
7578 CheckError(SDL_GL_SetSwapInterval(interval));
7601 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={}) noexcept
Wraps Display.
Definition: SDL3pp_video.h:181
An opaque handle to an OpenGL context.
Definition: SDL3pp_video.h:3324
constexpr auto operator<=>(const GLContext &other) const noexcept=default
Comparison.
constexpr GLContextRaw get() const noexcept
Retrieves underlying GLContextRaw.
Definition: SDL3pp_video.h:3400
constexpr GLContext(const GLContext &other) noexcept=default
Copy constructor.
constexpr GLContext & operator=(const GLContext &other) noexcept=default
Assignment operator.
GLContext(WindowParam window)
Create an OpenGL context for an OpenGL window, and make it current.
Definition: SDL3pp_video.h:3381
~GLContext()
Destructor.
Definition: SDL3pp_video.h:3387
constexpr GLContext(GLContext &&other) noexcept
Move constructor.
Definition: SDL3pp_video.h:3348
constexpr GLContextRaw release() noexcept
Retrieves underlying GLContextRaw and clear this.
Definition: SDL3pp_video.h:3403
constexpr GLContext & operator=(GLContext &&other) noexcept
Assignment operator.
Definition: SDL3pp_video.h:3390
constexpr GLContext(std::nullptr_t=nullptr) noexcept
Default ctor.
Definition: SDL3pp_video.h:3329
constexpr GLContext(const GLContextRaw resource) noexcept
Constructs from GLContextParam.
Definition: SDL3pp_video.h:3339
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:227
static constexpr Surface Borrow(SurfaceParam resource)
Safely borrows the from SurfaceParam.
Definition: SDL3pp_surface.h:411
The struct used as an opaque handle to a window.
Definition: SDL3pp_video.h:789
constexpr Window & operator=(Window &&other) noexcept
Assignment operator.
Definition: SDL3pp_video.h:1176
constexpr Window & operator=(const Window &other) noexcept=default
Assignment operator.
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:1010
constexpr auto operator<=>(const Window &other) const noexcept=default
Comparison.
constexpr WindowRaw get() const noexcept
Retrieves underlying WindowRaw.
Definition: SDL3pp_video.h:1188
constexpr Window(const WindowRaw resource) noexcept
Constructs from WindowParam.
Definition: SDL3pp_video.h:806
Window(StringParam title, const PointRaw &size, WindowFlags flags=0)
Create a window with the specified dimensions and flags.
Definition: SDL3pp_video.h:934
~Window()
Destructor.
Definition: SDL3pp_video.h:1173
constexpr WindowRaw release() noexcept
Retrieves underlying WindowRaw and clear this.
Definition: SDL3pp_video.h:1191
constexpr Window(std::nullptr_t=nullptr) noexcept
Default ctor.
Definition: SDL3pp_video.h:794
Window(PropertiesParam props)
Create a window with the specified properties.
Definition: SDL3pp_video.h:1167
constexpr Window(const Window &other) noexcept=default
Copy constructor.
constexpr Window(Window &&other) noexcept
Move constructor.
Definition: SDL3pp_video.h:817
constexpr void CheckError(bool result)
Check and throw if returned value from SDL is an error.
Definition: SDL3pp_error.h:197
void GetTextInputArea(RectRaw *rect, int *cursor)
Get the area used to type Unicode text input.
Definition: SDL3pp_keyboard.h:341
void ClearComposition()
Dismiss the composition window/IME without disabling the subsystem.
Definition: SDL3pp_keyboard.h:331
void StartTextInput()
Start accepting Unicode text input events in a window.
Definition: SDL3pp_keyboard.h:226
bool IsTextInputActive() const
Check whether or not Unicode text input events are enabled for a window.
Definition: SDL3pp_keyboard.h:321
void StopTextInput()
Stop receiving any text input events in a window.
Definition: SDL3pp_keyboard.h:326
bool IsScreenKeyboardShown() const
Check whether the screen keyboard is shown for given window.
Definition: SDL3pp_keyboard.h:364
void SetTextInputArea(const RectRaw &rect, int cursor)
Set the area used to type Unicode text input.
Definition: SDL3pp_keyboard.h:336
bool GetRelativeMouseMode() const
Query whether relative mouse mode is enabled for a window.
Definition: SDL3pp_mouse.h:843
void SetRelativeMouseMode(bool enabled)
Set relative mouse mode for a window.
Definition: SDL3pp_mouse.h:838
void WarpMouse(const FPointRaw &p)
Move the mouse cursor to the given position within the window.
Definition: SDL3pp_mouse.h:764
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:28
SDL_Rect RectRaw
Alias to raw representation for Rect.
Definition: SDL3pp_rect.h:34
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:4326
::Uint32 Uint32
An unsigned 32-bit integer type.
Definition: SDL3pp_stdinc.h:341
::Uint64 Uint64
An unsigned 64-bit integer type.
Definition: SDL3pp_stdinc.h:371
void(SDLCALL *)() FunctionPointer
A generic function pointer.
Definition: SDL3pp_stdinc.h:6388
void SetProgressState(ProgressState state)
Sets the state of the progress bar for the given window’s taskbar icon.
Definition: SDL3pp_video.h:7029
void DisableScreenSaver()
Prevent the screen from being blanked by a screen saver.
Definition: SDL3pp_video.h:7173
constexpr GLContextFlag GL_CONTEXT_RESET_ISOLATION_FLAG
RESET_ISOLATION_FLAG.
Definition: SDL3pp_video.h:3733
Rect GetBounds() const
Get the desktop area represented by a display.
Definition: SDL3pp_video.h:3982
void SetWindowSurfaceVSync(WindowParam window, int vsync)
Toggle VSync for the window surface.
Definition: SDL3pp_video.h:6375
void GetMaximumSize(int *w, int *h) const
Get the maximum size of a window's client area.
Definition: SDL3pp_video.h:5919
float GetPixelDensity() const
Get the pixel density of a window.
Definition: SDL3pp_video.h:4341
void SetHitTest(HitTest callback, void *callback_data)
Provide a callback that decides if a window region has special properties.
Definition: SDL3pp_video.h:6945
Rect GetWindowSafeArea(WindowParam window)
Get the safe area for this window.
Definition: SDL3pp_video.h:5629
constexpr int WINDOWPOS_CENTERED
Used to indicate that the window position should be centered.
Definition: SDL3pp_video.h:3295
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:3684
void GetMinimumSize(int *w, int *h) const
Get the minimum size of a window's client area.
Definition: SDL3pp_video.h:5868
Rect GetWindowRect(WindowParam window)
Get the position and client size of a window.
Definition: SDL3pp_video.h:5605
void SetFocusable(bool focusable)
Set whether the window may have input focus.
Definition: SDL3pp_video.h:6817
void GL_SetSwapInterval(int interval)
Set the swap interval for the current OpenGL context.
Definition: SDL3pp_video.h:7576
constexpr HitTestResult HITTEST_DRAGGABLE
Region can drag entire window.
Definition: SDL3pp_video.h:679
constexpr HitTestResult HITTEST_RESIZE_BOTTOMLEFT
Region is the resizable bottom-left corner border.
Definition: SDL3pp_video.h:703
SDL_GLAttr GLAttr
An enumeration of OpenGL configuration attributes.
Definition: SDL3pp_video.h:3567
DisplayOrientation GetNaturalDisplayOrientation(DisplayID displayID)
Get the orientation of a display when it is unrotated.
Definition: SDL3pp_video.h:4034
void GL_DestroyContext(GLContextRaw context)
Delete an OpenGL context.
Definition: SDL3pp_video.h:7640
constexpr FlashOperation FLASH_CANCEL
Cancel any window flash state.
Definition: SDL3pp_video.h:655
int GetWindowSurfaceVSync(WindowParam window)
Get VSync for the window surface.
Definition: SDL3pp_video.h:6403
DisplayMode GetClosestFullscreenDisplayMode(Display 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:4162
void UpdateSurface()
Copy the window surface to the screen.
Definition: SDL3pp_video.h:6438
OwnArray< DisplayMode * > GetFullscreenModes() const
Get a list of fullscreen display modes available on a display.
Definition: SDL3pp_video.h:4131
constexpr bool WINDOWPOS_ISUNDEFINED(int X)
A macro to test if the window position is marked as "undefined.".
Definition: SDL3pp_video.h:3252
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:582
void EnableScreenSaver()
Allow the screen to be blanked by a screen saver.
Definition: SDL3pp_video.h:7153
void SetRect(Rect rect)
Request the window's position and size to be set.
Definition: SDL3pp_video.h:5589
void GL_GetSwapInterval(int *interval)
Get the swap interval for the current OpenGL context.
Definition: SDL3pp_video.h:7599
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:5685
void UpdateWindowSurfaceRects(WindowParam window, SpanRef< const RectRaw > rects)
Copy areas of the window surface to the screen.
Definition: SDL3pp_video.h:6465
void SetMinimumSize(const PointRaw &p)
Set the minimum size of a window's client area.
Definition: SDL3pp_video.h:5841
void SetWindowIcon(WindowParam window, SurfaceParam icon)
Set the icon for a window.
Definition: SDL3pp_video.h:5350
Window CreateWindowWithProperties(PropertiesParam props)
Create a window with the specified properties.
Definition: SDL3pp_video.h:4817
constexpr GLAttr GL_FRAMEBUFFER_SRGB_CAPABLE
requests sRGB-capable visual if 1.
Definition: SDL3pp_video.h:3678
constexpr GLAttr GL_MULTISAMPLESAMPLES
the number of samples used around the current pixel used for multisample anti-aliasing.
Definition: SDL3pp_video.h:3642
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:5066
float GetDisplayScale() const
Get the content display scale relative to a window's pixel size.
Definition: SDL3pp_video.h:4372
Uint64 WindowFlags
The flags on a window.
Definition: SDL3pp_video.h:556
bool GetWindowMouseGrab(WindowParam window)
Get a window's mouse grab mode.
Definition: SDL3pp_video.h:6599
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:615
constexpr WindowFlags WINDOW_MOUSE_FOCUS
window has mouse focus
Definition: SDL3pp_video.h:591
constexpr GLAttr GL_STENCIL_SIZE
the minimum number of bits in the stencil buffer; defaults to 0.
Definition: SDL3pp_video.h:3606
void SetWindowPosition(WindowParam window, const PointRaw &p)
Request that the window's position be set.
Definition: SDL3pp_video.h:5395
void Restore()
Request that the size and position of a minimized or maximized window be restored.
Definition: SDL3pp_video.h:6216
void GetWindowPosition(WindowParam window, int *x, int *y)
Get the position of a window.
Definition: SDL3pp_video.h:5427
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:4408
WindowRef GetWindowParent(WindowParam window)
Get parent of a window.
Definition: SDL3pp_video.h:5107
EGLSurface GetEGLSurface()
Get the EGL surface associated with the window.
Definition: SDL3pp_video.h:7511
void SetWindowSize(WindowParam window, const PointRaw &size)
Request that the size of a window's client area be set.
Definition: SDL3pp_video.h:5501
PropertiesRef GetProperties() const
Get the properties associated with a display.
Definition: SDL3pp_video.h:3911
Uint32 GLContextReleaseFlag
Possible values to be set for the GL_CONTEXT_RELEASE_BEHAVIOR attribute.
Definition: SDL3pp_video.h:3741
constexpr WindowFlags WINDOW_TRANSPARENT
window with transparent buffer
Definition: SDL3pp_video.h:642
void DestroySurface()
Destroy the surface associated with the window.
Definition: SDL3pp_video.h:6494
Point GetSize() const
Get the size of a window's client area.
Definition: SDL3pp_video.h:5569
SDL_ProgressState ProgressState
Window progress state.
Definition: SDL3pp_video.h:753
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:4178
const DisplayMode & GetDesktopDisplayMode(DisplayID displayID)
Get information about the desktop's display mode.
Definition: SDL3pp_video.h:4206
FunctionPointer EGL_GetProcAddress(StringParam proc)
Get an EGL library function by name.
Definition: SDL3pp_video.h:7276
constexpr GLProfile GL_CONTEXT_PROFILE_CORE
OpenGL Core Profile context.
Definition: SDL3pp_video.h:3707
constexpr DisplayOrientation ORIENTATION_UNKNOWN
The display orientation can't be determined.
Definition: SDL3pp_video.h:125
constexpr int WINDOWPOS_UNDEFINED_MASK
A magic value used with WINDOWPOS_UNDEFINED.
Definition: SDL3pp_video.h:3213
void FlashWindow(WindowParam window, FlashOperation operation)
Request a window to demand attention from the user.
Definition: SDL3pp_video.h:7000
static WindowRef GetGrabbed()
Get the window that currently has an input grab enabled.
Definition: SDL3pp_video.h:6623
void GL_SwapWindow(WindowParam window)
Update a window with OpenGL rendering.
Definition: SDL3pp_video.h:7621
constexpr int WINDOW_SURFACE_VSYNC_ADAPTIVE
Constant to enable adaptive vsync.
Definition: SDL3pp_video.h:6389
void GetWindowAspectRatio(WindowParam window, float *min_aspect, float *max_aspect)
Get the aspect ratio of a window's client area.
Definition: SDL3pp_video.h:5706
constexpr HitTestResult HITTEST_RESIZE_TOPRIGHT
Region is the resizable top-right corner border.
Definition: SDL3pp_video.h:689
constexpr GLAttr GL_CONTEXT_MAJOR_VERSION
OpenGL context major version.
Definition: SDL3pp_video.h:3653
constexpr HitTestResult HITTEST_NORMAL
Region is normal. No special properties.
Definition: SDL3pp_video.h:676
void GL_Swap()
Update a window with OpenGL rendering.
Definition: SDL3pp_video.h:7626
void SetPosition(const PointRaw &p)
Request that the window's position be set.
Definition: SDL3pp_video.h:5400
constexpr ProgressState PROGRESS_STATE_PAUSED
The progress bar is shown in a paused state.
Definition: SDL3pp_video.h:769
Surface GetSurface()
Get the SDL surface associated with the window.
Definition: SDL3pp_video.h:6347
constexpr GLContextFlag GL_CONTEXT_FORWARD_COMPATIBLE_FLAG
FORWARD_COMPATIBLE_FLAG.
Definition: SDL3pp_video.h:3727
constexpr int WINDOWPOS_UNDEFINED_DISPLAY(int X)
Used to indicate that you don't care what the window position is.
Definition: SDL3pp_video.h:3227
WindowRef GL_GetCurrentWindow()
Get the currently active OpenGL window.
Definition: SDL3pp_video.h:7449
constexpr GLAttr GL_RETAINED_BACKING
not used (deprecated).
Definition: SDL3pp_video.h:3650
Rect GetDisplayUsableBounds(Display displayID)
Get the usable desktop area represented by a display, in screen coordinates.
Definition: SDL3pp_video.h:4009
Display GetDisplay() const
Get the display associated with a window.
Definition: SDL3pp_video.h:4314
constexpr HitTestResult HITTEST_RESIZE_RIGHT
Region is the resizable right border.
Definition: SDL3pp_video.h:693
float GetContentScale() const
Get the content scale of a display.
Definition: SDL3pp_video.h:4097
float GetOpacity() const
Get the opacity of a window.
Definition: SDL3pp_video.h:6728
constexpr FlashOperation FLASH_BRIEFLY
Flash the window briefly to get attention.
Definition: SDL3pp_video.h:658
void DestroyWindowSurface(WindowParam window)
Destroy the surface associated with the window.
Definition: SDL3pp_video.h:6489
void SetFillDocument(bool fill)
Set the window to fill the current document space (Emscripten only).
Definition: SDL3pp_video.h:6043
void GL_UnloadLibrary()
Unload the OpenGL library previously loaded by GL_LoadLibrary().
Definition: SDL3pp_video.h:7290
bool GetWindowKeyboardGrab(WindowParam window)
Get a window's keyboard grab mode.
Definition: SDL3pp_video.h:6574
constexpr GLAttr GL_STEREO
whether the output is stereo 3D; defaults to off.
Definition: SDL3pp_video.h:3632
constexpr GLAttr GL_CONTEXT_MINOR_VERSION
OpenGL context minor version.
Definition: SDL3pp_video.h:3656
constexpr GLAttr GL_CONTEXT_PROFILE_MASK
type of GL context (Core, Compatibility, ES).
Definition: SDL3pp_video.h:3669
DisplayOrientation GetCurrentDisplayOrientation(DisplayID displayID)
Get the orientation of a display.
Definition: SDL3pp_video.h:4057
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:3573
Display GetDisplayForRect(const RectRaw &rect)
Get the display primarily containing a rect.
Definition: SDL3pp_video.h:4284
constexpr WindowFlags WINDOW_MOUSE_GRABBED
window has grabbed mouse input
Definition: SDL3pp_video.h:585
bool ScreenSaverEnabled()
Check whether the screensaver is currently enabled.
Definition: SDL3pp_video.h:7139
EGLint *(SDLCALL *)(void *userdata, EGLDisplay display, EGLConfig config) EGLIntArrayCallback
EGL surface/context attribute initialization callback types.
Definition: SDL3pp_video.h:3548
Display GetDisplayForPoint(const PointRaw &point)
Get the display containing a point.
Definition: SDL3pp_video.h:4259
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:3579
FunctionPointer GL_GetProcAddress(StringParam proc)
Get an OpenGL function by name.
Definition: SDL3pp_video.h:7254
constexpr GLAttr GL_CONTEXT_RESET_NOTIFICATION
set context reset notification.
Definition: SDL3pp_video.h:3690
Window CreateWindow(StringParam title, const PointRaw &size, WindowFlags flags)
Create a window with the specified dimensions and flags.
Definition: SDL3pp_video.h:4587
SDL_DisplayID DisplayID
Alias to raw representation for Display.
Definition: SDL3pp_video.h:38
constexpr GLProfile GL_CONTEXT_PROFILE_COMPATIBILITY
OpenGL Compatibility Profile context.
Definition: SDL3pp_video.h:3710
float GetDisplayContentScale(DisplayID displayID)
Get the content scale of a display.
Definition: SDL3pp_video.h:4092
GLContext GL_CreateContext(WindowParam window)
Create an OpenGL context for an OpenGL window, and make it current.
Definition: SDL3pp_video.h:7401
void SetWindowMinimumSize(WindowParam window, const PointRaw &p)
Set the minimum size of a window's client area.
Definition: SDL3pp_video.h:5836
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:7536
GLContext CreateGLContext()
Create an OpenGL context for an OpenGL window, and make it current.
Definition: SDL3pp_video.h:7406
const DisplayMode & GetCurrentDisplayMode(DisplayID displayID)
Get information about the current display mode.
Definition: SDL3pp_video.h:4235
void Flash(FlashOperation operation)
Request a window to demand attention from the user.
Definition: SDL3pp_video.h:7005
SDL_HitTestResult HitTestResult
Possible return values from the HitTest callback.
Definition: SDL3pp_video.h:674
Rect GetDisplayBounds(Display displayID)
Get the desktop area represented by a display.
Definition: SDL3pp_video.h:3975
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:5678
constexpr WindowFlags WINDOW_METAL
window usable for Metal view
Definition: SDL3pp_video.h:639
constexpr WindowFlags WINDOW_MINIMIZED
window is minimized
Definition: SDL3pp_video.h:579
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:3630
constexpr int WINDOW_SURFACE_VSYNC_DISABLED
Constant to disable vsync.
Definition: SDL3pp_video.h:6386
bool GetMouseGrab() const
Get a window's mouse grab mode.
Definition: SDL3pp_video.h:6604
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:4336
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:3612
OwnArray< DisplayMode * > GetFullscreenDisplayModes(Display displayID)
Get a list of fullscreen display modes available on a display.
Definition: SDL3pp_video.h:4124
const DisplayMode & GetWindowFullscreenMode(WindowParam window)
Query the display mode to use when a window is visible at fullscreen.
Definition: SDL3pp_video.h:4433
void SetWindowFullscreen(WindowParam window, bool fullscreen)
Request that the window's fullscreen state be changed.
Definition: SDL3pp_video.h:6247
void SetKeyboardGrab(bool grabbed)
Set a window's keyboard grab mode.
Definition: SDL3pp_video.h:6530
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:6211
ProgressState GetProgressState()
Get the state of the progress bar for the given window’s taskbar icon.
Definition: SDL3pp_video.h:7050
constexpr WindowFlags WINDOW_HIGH_PIXEL_DENSITY
window uses high pixel density back buffer if possible
Definition: SDL3pp_video.h:600
float GetProgressValue()
Get the value of the progress bar for the given window’s taskbar icon.
Definition: SDL3pp_video.h:7093
constexpr ProgressState PROGRESS_STATE_INVALID
An invalid progress state indicating an error; check GetError()
Definition: SDL3pp_video.h:756
constexpr GLAttr GL_CONTEXT_FLAGS
some combination of 0 or more of elements of the GLContextFlag enumeration; defaults to 0.
Definition: SDL3pp_video.h:3663
void SetAlwaysOnTop(bool on_top)
Set the window to always be above the others.
Definition: SDL3pp_video.h:6003
void SetWindowShape(WindowParam window, SurfaceParam shape)
Set the shape of a transparent window.
Definition: SDL3pp_video.h:6979
constexpr GLProfile GL_CONTEXT_PROFILE_ES
GLX_CONTEXT_ES2_PROFILE_BIT_EXT.
Definition: SDL3pp_video.h:3714
constexpr GLAttr GL_DOUBLEBUFFER
whether the output is single or double buffered; defaults to double buffering on.
Definition: SDL3pp_video.h:3600
float GetWindowDisplayScale(WindowParam window)
Get the content display scale relative to a window's pixel size.
Definition: SDL3pp_video.h:4367
Display GetPrimaryDisplay()
Return the primary display.
Definition: SDL3pp_video.h:3863
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:707
Point GetPosition() const
Get the position of a window.
Definition: SDL3pp_video.h:5463
void SetWindowBordered(WindowParam window, bool bordered)
Set the border state of a window.
Definition: SDL3pp_video.h:5943
float GetWindowOpacity(WindowParam window)
Get the opacity of a window.
Definition: SDL3pp_video.h:6723
PixelFormat GetWindowPixelFormat(WindowParam window)
Get the pixel format associated with the window.
Definition: SDL3pp_video.h:4476
void GL_GetAttribute(GLAttr attr, int *value)
Get the actual value for an attribute from the current context.
Definition: SDL3pp_video.h:7368
void Show()
Show a window.
Definition: SDL3pp_video.h:6068
HitTestResult(SDLCALL *)(WindowRaw win, const PointRaw *area, void *data) HitTest
Callback used for hit-testing.
Definition: SDL3pp_video.h:722
void MakeCurrent(GLContext context)
Set up an OpenGL context for rendering into an OpenGL window.
Definition: SDL3pp_video.h:7428
PropertiesRef GetDisplayProperties(DisplayID displayID)
Get the properties associated with a display.
Definition: SDL3pp_video.h:3906
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:6893
void Minimize()
Request that the window be minimized to an iconic representation.
Definition: SDL3pp_video.h:6182
void MaximizeWindow(WindowParam window)
Request that the window be made as large as possible.
Definition: SDL3pp_video.h:6144
constexpr WindowFlags WINDOW_FILL_DOCUMENT
window is in fill-document mode (Emscripten only), since SDL 3.4.0
Definition: SDL3pp_video.h:632
void GL_SetAttribute(GLAttr attr, int value)
Set an OpenGL window attribute before window creation.
Definition: SDL3pp_video.h:7349
void SetSize(const PointRaw &size)
Request that the size of a window's client area be set.
Definition: SDL3pp_video.h:5506
const char * GetCurrentVideoDriver()
Get the name of the currently initialized video driver.
Definition: SDL3pp_video.h:3817
Point GetSizeInPixels() const
Get the size of a window's client area, in pixels.
Definition: SDL3pp_video.h:5817
constexpr GLAttr GL_MULTISAMPLEBUFFERS
the number of buffers used for multisample anti-aliasing; defaults to 0.
Definition: SDL3pp_video.h:3636
PropertiesRef GetProperties() const
Get the properties associated with a window.
Definition: SDL3pp_video.h:5246
void ShowSystemMenu(const PointRaw &p)
Display the system-level window menu.
Definition: SDL3pp_video.h:6847
const DisplayMode & GetCurrentMode() const
Get information about the current display mode.
Definition: SDL3pp_video.h:4240
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:3591
constexpr WindowFlags WINDOW_MODAL
window is modal
Definition: SDL3pp_video.h:597
int GetNumVideoDrivers()
Get the number of video drivers compiled into SDL.
Definition: SDL3pp_video.h:3773
void SetWindowMouseRect(WindowParam window, const RectRaw &rect)
Confines the cursor to the specified area of a window.
Definition: SDL3pp_video.h:6644
bool GL_ExtensionSupported(StringParam extension)
Check if an OpenGL extension is supported for the current context.
Definition: SDL3pp_video.h:7312
constexpr WindowFlags WINDOW_INPUT_FOCUS
window has input focus
Definition: SDL3pp_video.h:588
void SetWindowRect(WindowParam window, Rect rect)
Request the window's position and size to be set.
Definition: SDL3pp_video.h:5583
int GetSurfaceVSync() const
Get VSync for the window surface.
Definition: SDL3pp_video.h:6410
void SetOpacity(float opacity)
Set the opacity for a window.
Definition: SDL3pp_video.h:6702
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:3618
constexpr GLContextFlag GL_CONTEXT_DEBUG_FLAG
DEBUG_FLAG.
Definition: SDL3pp_video.h:3724
Uint32 GLContextFlag
Possible flags to be set for the GL_CONTEXT_FLAGS attribute.
Definition: SDL3pp_video.h:3722
SDL_WindowID WindowID
This is a unique ID for a window.
Definition: SDL3pp_video.h:488
const char * GetName() const
Get the name of a display in UTF-8 encoding.
Definition: SDL3pp_video.h:3953
void SetWindowResizable(WindowParam window, bool resizable)
Set the user-resizable state of a window.
Definition: SDL3pp_video.h:5972
float GetWindowProgressValue(WindowParam window)
Get the value of the progress bar for the given window’s taskbar icon.
Definition: SDL3pp_video.h:7088
void SetBordered(bool bordered)
Set the border state of a window.
Definition: SDL3pp_video.h:5948
DisplayOrientation GetNaturalOrientation() const
Get the orientation of a display when it is unrotated.
Definition: SDL3pp_video.h:4039
void ShowWindow(WindowParam window)
Show a window.
Definition: SDL3pp_video.h:6063
void SetTitle(StringParam title)
Set the title of a window.
Definition: SDL3pp_video.h:5300
void SetWindowParent(WindowParam window, WindowParam parent)
Set the window as a child of a parent window.
Definition: SDL3pp_video.h:6764
constexpr HitTestResult HITTEST_RESIZE_TOP
Region is the resizable top border.
Definition: SDL3pp_video.h:686
void ShowWindowSystemMenu(WindowParam window, const PointRaw &p)
Display the system-level window menu.
Definition: SDL3pp_video.h:6842
const char * GetVideoDriver(int index)
Get the name of a built in video driver.
Definition: SDL3pp_video.h:3795
void GetWindowMaximumSize(WindowParam window, int *w, int *h)
Get the maximum size of a window's client area.
Definition: SDL3pp_video.h:5914
EGLSurface EGL_GetWindowSurface(WindowParam window)
Get the EGL surface associated with the window.
Definition: SDL3pp_video.h:7506
constexpr int WINDOWPOS_CENTERED_DISPLAY(int X)
Used to indicate that the window position should be centered.
Definition: SDL3pp_video.h:3281
void Maximize()
Request that the window be made as large as possible.
Definition: SDL3pp_video.h:6149
SDL_EGLSurface EGLSurface
Opaque type for an EGL surface.
Definition: SDL3pp_video.h:744
const char * GetDisplayName(DisplayID displayID)
Get the name of a display in UTF-8 encoding.
Definition: SDL3pp_video.h:3948
SDL_FlashOperation FlashOperation
Window flash operation.
Definition: SDL3pp_video.h:653
constexpr WindowFlags WINDOW_VULKAN
window usable for Vulkan surface
Definition: SDL3pp_video.h:636
Rect GetRect() const
Get the position and client size of a window.
Definition: SDL3pp_video.h:5610
ProgressState GetWindowProgressState(WindowParam window)
Get the state of the progress bar for the given window’s taskbar icon.
Definition: SDL3pp_video.h:7045
bool WindowHasSurface(WindowParam window)
Return whether the window has a surface associated with it.
Definition: SDL3pp_video.h:6305
constexpr HitTestResult HITTEST_RESIZE_TOPLEFT
Region is the resizable top-left corner border.
Definition: SDL3pp_video.h:682
constexpr HitTestResult HITTEST_RESIZE_BOTTOMRIGHT
Region is the resizable bottom-right corner border.
Definition: SDL3pp_video.h:697
SDL_EGLConfig EGLConfig
Opaque type for an EGL config.
Definition: SDL3pp_video.h:3476
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:626
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:3585
constexpr GLAttr GL_EGL_PLATFORM
GL_EGL_PLATFORM.
Definition: SDL3pp_video.h:3698
constexpr WindowFlags WINDOW_BORDERLESS
no window decoration
Definition: SDL3pp_video.h:573
const DisplayMode & GetDesktopMode() const
Get information about the desktop's display mode.
Definition: SDL3pp_video.h:4211
void SetWindowFocusable(WindowParam window, bool focusable)
Set whether the window may have input focus.
Definition: SDL3pp_video.h:6812
SDL_EGLDisplay EGLDisplay
Opaque type for an EGL display.
Definition: SDL3pp_video.h:3469
void GetWindowSizeInPixels(WindowParam window, int *w, int *h)
Get the size of a window's client area, in pixels.
Definition: SDL3pp_video.h:5785
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:621
constexpr WindowFlags WINDOW_MOUSE_CAPTURE
window has mouse captured (unrelated to MOUSE_GRABBED)
Definition: SDL3pp_video.h:603
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:4665
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:5751
WindowRef GetGrabbedWindow()
Get the window that currently has an input grab enabled.
Definition: SDL3pp_video.h:6621
void UpdateWindowSurface(WindowParam window)
Copy the window surface to the screen.
Definition: SDL3pp_video.h:6433
constexpr GLAttr GL_BUFFER_SIZE
the minimum number of bits for frame buffer size; defaults to 0.
Definition: SDL3pp_video.h:3594
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:561
bool GetKeyboardGrab() const
Get a window's keyboard grab mode.
Definition: SDL3pp_video.h:6579
constexpr ProgressState PROGRESS_STATE_NONE
No progress bar is shown.
Definition: SDL3pp_video.h:758
constexpr GLAttr GL_CONTEXT_NO_ERROR
GL_CONTEXT_NO_ERROR.
Definition: SDL3pp_video.h:3693
const char * GetWindowTitle(WindowParam window)
Get the title of a window.
Definition: SDL3pp_video.h:5317
void SetWindowAlwaysOnTop(WindowParam window, bool on_top)
Set the window to always be above the others.
Definition: SDL3pp_video.h:5998
void GetWindowSize(WindowParam window, int *w, int *h)
Get the size of a window's client area.
Definition: SDL3pp_video.h:5532
SDL_EGLint EGLint
An EGL integer attribute, used when creating an EGL surface.
Definition: SDL3pp_video.h:3490
WindowFlags GetWindowFlags(WindowParam window)
Get the window flags.
Definition: SDL3pp_video.h:5270
constexpr GLContextFlag GL_CONTEXT_ROBUST_ACCESS_FLAG
ROBUST_ACCESS_FLAG.
Definition: SDL3pp_video.h:3730
void SetWindowProgressValue(WindowParam window, float value)
Sets the value of the progress bar for the given window’s taskbar icon.
Definition: SDL3pp_video.h:7067
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:6342
constexpr int WINDOWPOS_UNDEFINED
Used to indicate that you don't care what the window position/display is.
Definition: SDL3pp_video.h:3241
const char * GetTitle() const
Get the title of a window.
Definition: SDL3pp_video.h:5322
constexpr WindowFlags WINDOW_MOUSE_RELATIVE_MODE
window has relative mode enabled
Definition: SDL3pp_video.h:605
constexpr ProgressState PROGRESS_STATE_NORMAL
The progress bar is shown in a normal state.
Definition: SDL3pp_video.h:766
constexpr WindowFlags WINDOW_OCCLUDED
window is occluded
Definition: SDL3pp_video.h:564
constexpr FlashOperation FLASH_UNTIL_FOCUSED
Flash the window until it gets focus.
Definition: SDL3pp_video.h:661
static Display GetForPoint(const PointRaw &point)
Get the display containing a point.
Definition: SDL3pp_video.h:4264
void SetWindowOpacity(WindowParam window, float opacity)
Set the opacity for a window.
Definition: SDL3pp_video.h:6697
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:3705
void SetMouseRect(const RectRaw &rect)
Confines the cursor to the specified area of a window.
Definition: SDL3pp_video.h:6649
void SetWindowFillDocument(WindowParam window, bool fill)
Set the window to fill the current document space (Emscripten only).
Definition: SDL3pp_video.h:6038
void SetWindowModal(WindowParam window, bool modal)
Toggle the state of the window as modal.
Definition: SDL3pp_video.h:6791
void Destroy()
Destroy a window.
Definition: SDL3pp_video.h:7121
SystemTheme GetSystemTheme()
Get the current system theme.
Definition: SDL3pp_video.h:3831
static Display GetForRect(const RectRaw &rect)
Get the display primarily containing a rect.
Definition: SDL3pp_video.h:4289
DisplayOrientation GetCurrentOrientation() const
Get the orientation of a display.
Definition: SDL3pp_video.h:4062
OwnPtr< void > GetICCProfile() const
Get the raw ICC profile data for the screen the window is currently on.
Definition: SDL3pp_video.h:4460
static WindowRef FromID(WindowID id)
Get a window from a stored ID.
Definition: SDL3pp_video.h:5089
PropertiesRef GetWindowProperties(WindowParam window)
Get the properties associated with a window.
Definition: SDL3pp_video.h:5241
void GetAspectRatio(float *min_aspect, float *max_aspect) const
Get the aspect ratio of a window's client area.
Definition: SDL3pp_video.h:5713
void GetWindowMinimumSize(WindowParam window, int *w, int *h)
Get the minimum size of a window's client area.
Definition: SDL3pp_video.h:5863
constexpr WindowFlags WINDOW_NOT_FOCUSABLE
window should not be focusable
Definition: SDL3pp_video.h:645
constexpr ProgressState PROGRESS_STATE_ERROR
The progress bar is shown in a state indicating the application had an error.
Definition: SDL3pp_video.h:775
void SetWindowKeyboardGrab(WindowParam window, bool grabbed)
Set a window's keyboard grab mode.
Definition: SDL3pp_video.h:6525
constexpr GLContextResetNotification GL_CONTEXT_RESET_NO_NOTIFICATION
NO_NOTIFICATION.
Definition: SDL3pp_video.h:3756
constexpr GLAttr GL_FLOATBUFFERS
GL_FLOATBUFFERS.
Definition: SDL3pp_video.h:3696
void GL_MakeCurrent(WindowParam window, GLContext context)
Set up an OpenGL context for rendering into an OpenGL window.
Definition: SDL3pp_video.h:7423
void Raise()
Request that a window be raised above other windows and gain the input focus.
Definition: SDL3pp_video.h:6111
void SetMaximumSize(const PointRaw &p)
Set the maximum size of a window's client area.
Definition: SDL3pp_video.h:5892
GLContext GL_GetCurrentContext()
Get the currently active OpenGL context.
Definition: SDL3pp_video.h:7466
constexpr WindowFlags WINDOW_RESIZABLE
window can be resized
Definition: SDL3pp_video.h:576
OwnArray< WindowRef > GetWindows()
Get a list of valid windows.
Definition: SDL3pp_video.h:4496
PixelFormat GetPixelFormat() const
Get the pixel format associated with the window.
Definition: SDL3pp_video.h:4481
constexpr WindowFlags WINDOW_POPUP_MENU
window should be treated as a popup menu, requires a parent window
Definition: SDL3pp_video.h:624
void Hide()
Hide a window.
Definition: SDL3pp_video.h:6088
void SetParent(WindowParam parent)
Set the window as a child of a parent window.
Definition: SDL3pp_video.h:6769
constexpr GLContextResetNotification GL_CONTEXT_RESET_LOSE_CONTEXT
LOSE_CONTEXT.
Definition: SDL3pp_video.h:3759
Display GetDisplayForWindow(WindowParam window)
Get the display associated with a window.
Definition: SDL3pp_video.h:4309
void SetModal(bool modal)
Toggle the state of the window as modal.
Definition: SDL3pp_video.h:6796
void GL_ResetAttributes()
Reset all previously set OpenGL context attributes to their default values.
Definition: SDL3pp_video.h:7327
Uint32 GLContextResetNotification
Possible values to be set GL_CONTEXT_RESET_NOTIFICATION attribute.
Definition: SDL3pp_video.h:3754
void Destroy()
Delete an OpenGL context.
Definition: SDL3pp_video.h:7645
constexpr WindowFlags WINDOW_EXTERNAL
window not created by SDL
Definition: SDL3pp_video.h:594
Rect GetSafeArea() const
Get the safe area for this window.
Definition: SDL3pp_video.h:5636
void SetWindowMaximumSize(WindowParam window, const PointRaw &p)
Set the maximum size of a window's client area.
Definition: SDL3pp_video.h:5887
WindowFlags GetFlags() const
Get the window flags.
Definition: SDL3pp_video.h:5275
void SyncWindow(WindowParam window)
Block until any pending window state is finalized.
Definition: SDL3pp_video.h:6285
OwnArray< DisplayID > GetDisplays()
Get a list of currently connected displays.
Definition: SDL3pp_video.h:3843
const RectRaw * GetMouseRect() const
Get the mouse confinement rectangle of a window.
Definition: SDL3pp_video.h:6674
constexpr WindowFlags WINDOW_ALWAYS_ON_TOP
window should always be above others
Definition: SDL3pp_video.h:608
const DisplayMode & GetFullscreenMode() const
Query the display mode to use when a window is visible at fullscreen.
Definition: SDL3pp_video.h:4438
constexpr WindowFlags WINDOW_HIDDEN
window is neither mapped onto the desktop nor shown in the taskbar/dock/window list; Window....
Definition: SDL3pp_video.h:571
constexpr GLAttr GL_SHARE_WITH_CURRENT_CONTEXT
OpenGL context sharing; defaults to 0.
Definition: SDL3pp_video.h:3671
void SetWindowTitle(WindowParam window, StringParam title)
Set the title of a window.
Definition: SDL3pp_video.h:5295
void Sync()
Block until any pending window state is finalized.
Definition: SDL3pp_video.h:6290
WindowID GetWindowID(WindowParam window)
Get the numeric ID of a window.
Definition: SDL3pp_video.h:5061
EGLConfig EGL_GetCurrentConfig()
Get the currently active EGL config.
Definition: SDL3pp_video.h:7493
void HideWindow(WindowParam window)
Hide a window.
Definition: SDL3pp_video.h:6083
static Display GetPrimary()
Return the primary display.
Definition: SDL3pp_video.h:3868
constexpr HitTestResult HITTEST_RESIZE_BOTTOM
Region is the resizable bottom border.
Definition: SDL3pp_video.h:700
OwnPtr< void > GetWindowICCProfile(WindowParam window)
Get the raw ICC profile data for the screen the window is currently on.
Definition: SDL3pp_video.h:4454
void RaiseWindow(WindowParam window)
Request that a window be raised above other windows and gain the input focus.
Definition: SDL3pp_video.h:6106
bool HasSurface() const
Return whether the window has a surface associated with it.
Definition: SDL3pp_video.h:6310
Rect GetUsableBounds() const
Get the usable desktop area represented by a display, in screen coordinates.
Definition: SDL3pp_video.h:4016
void SetResizable(bool resizable)
Set the user-resizable state of a window.
Definition: SDL3pp_video.h:5977
void DestroyWindow(WindowRaw window)
Destroy a window.
Definition: SDL3pp_video.h:7119
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:3624
const RectRaw * GetWindowMouseRect(WindowParam window)
Get the mouse confinement rectangle of a window.
Definition: SDL3pp_video.h:6669
WindowRef GetWindowFromID(WindowID id)
Get a window from a stored ID.
Definition: SDL3pp_video.h:5084
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:5760
constexpr WindowFlags WINDOW_FULLSCREEN
window is in fullscreen mode
Definition: SDL3pp_video.h:558
void UpdateSurfaceRects(SpanRef< const RectRaw > rects)
Copy areas of the window surface to the screen.
Definition: SDL3pp_video.h:6471
constexpr GLContextReleaseFlag GL_CONTEXT_RELEASE_BEHAVIOR_NONE
BEHAVIOR_NONE.
Definition: SDL3pp_video.h:3743
void SetShape(SurfaceParam shape)
Set the shape of a transparent window.
Definition: SDL3pp_video.h:6984
WindowRef GetParent() const
Get parent of a window.
Definition: SDL3pp_video.h:5112
SDL_EGLAttrib EGLAttrib
An EGL attribute, used when creating an EGL context.
Definition: SDL3pp_video.h:3483
void GL_LoadLibrary(StringParam path)
Dynamically load an OpenGL library.
Definition: SDL3pp_video.h:7196
void SetFullscreen(bool fullscreen)
Request that the window's fullscreen state be changed.
Definition: SDL3pp_video.h:6252
void MakeCurrent(WindowParam window)
Set up an OpenGL context for rendering into an OpenGL window.
Definition: SDL3pp_video.h:7433
void SetFullscreenMode(OptionalRef< const DisplayMode > mode)
Set the display mode to use when a window is visible and fullscreen.
Definition: SDL3pp_video.h:4414
constexpr GLAttr GL_DEPTH_SIZE
the minimum number of bits in the depth buffer; defaults to 16.
Definition: SDL3pp_video.h:3603
void SetWindowProgressState(WindowParam window, ProgressState state)
Sets the state of the progress bar for the given window’s taskbar icon.
Definition: SDL3pp_video.h:7024
void SetIcon(SurfaceParam icon)
Set the icon for a window.
Definition: SDL3pp_video.h:5355
constexpr int WINDOWPOS_CENTERED_MASK
A magic value used with WINDOWPOS_CENTERED.
Definition: SDL3pp_video.h:3267
EGLDisplay EGL_GetCurrentDisplay()
Get the currently active EGL display.
Definition: SDL3pp_video.h:7478
void SetProgressValue(float value)
Sets the value of the progress bar for the given window’s taskbar icon.
Definition: SDL3pp_video.h:7072
constexpr ProgressState PROGRESS_STATE_INDETERMINATE
The progress bar is shown in a indeterminate state.
Definition: SDL3pp_video.h:762
void SetMouseGrab(bool grabbed)
Set a window's mouse grab mode.
Definition: SDL3pp_video.h:6557
void MinimizeWindow(WindowParam window)
Request that the window be minimized to an iconic representation.
Definition: SDL3pp_video.h:6177
constexpr GLContextReleaseFlag GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH
BEHAVIOR_FLUSH.
Definition: SDL3pp_video.h:3746
void SetSurfaceVSync(int vsync)
Toggle VSync for the window surface.
Definition: SDL3pp_video.h:6380
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:3648
void SetWindowMouseGrab(WindowParam window, bool grabbed)
Set a window's mouse grab mode.
Definition: SDL3pp_video.h:6552
EGLAttrib *(SDLCALL *)(void *userdata) EGLAttribArrayCallback
EGL platform attribute initialization callback.
Definition: SDL3pp_video.h:3515
constexpr bool WINDOWPOS_ISCENTERED(int X)
A macro to test if the window position is marked as "centered.".
Definition: SDL3pp_video.h:3306
Main include header for the SDL3pp library.
Safely wrap GLContext for non owning parameters.
Definition: SDL3pp_video.h:90
constexpr GLContextParam(std::nullptr_t=nullptr)
Constructs null/invalid.
Definition: SDL3pp_video.h:100
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.
RAII owning version GLContext.
Definition: SDL3pp_video.h:3449
constexpr GLContextScoped(GLContext &&other) noexcept
Move constructor.
Definition: SDL3pp_video.h:3455
~GLContextScoped()
Destructor.
Definition: SDL3pp_video.h:3461
Definition: SDL3pp_callbackWrapper.h:197
The structure that defines a point (using integers).
Definition: SDL3pp_rect.h:83
Safely wrap Properties for non owning parameters.
Definition: SDL3pp_properties.h:53
Semi-safe reference for Properties.
Definition: SDL3pp_properties.h:716
A rectangle, with the origin at the upper left (using integers).
Definition: SDL3pp_rect.h:845
constexpr Point GetTopLeft() const
Get top left corner of the rect.
Definition: SDL3pp_rect.h:1094
constexpr Point GetSize() const
Get size of the rect.
Definition: SDL3pp_rect.h:1126
Semi-safe reference for Renderer.
Definition: SDL3pp_render.h:2419
Safely wrap Surface for non owning parameters.
Definition: SDL3pp_surface.h:53
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:3169
~WindowRef()
Destructor.
Definition: SDL3pp_video.h:3200
constexpr WindowRef(const WindowRef &other) noexcept=default
Copy constructor.
WindowRef(WindowRaw resource) noexcept
Constructs from WindowParam.
Definition: SDL3pp_video.h:3191
WindowRef(WindowParam resource) noexcept
Constructs from WindowParam.
Definition: SDL3pp_video.h:3179