Atlas - SDL_video.h
Home / ext / SDL / include / SDL3 Lines: 2 | Size: 142479 bytes [Download] [Show on GitHub] [Search similar files] [Raw] [Raw (proxy)][FILE BEGIN]1/* 2 Simple DirectMedia Layer 3 Copyright (C) 1997-2026 Sam Lantinga <[email protected]> 4 5 This software is provided 'as-is', without any express or implied 6 warranty. In no event will the authors be held liable for any damages 7 arising from the use of this software. 8 9 Permission is granted to anyone to use this software for any purpose, 10 including commercial applications, and to alter it and redistribute it 11 freely, subject to the following restrictions: 12 13 1. The origin of this software must not be misrepresented; you must not 14 claim that you wrote the original software. If you use this software 15 in a product, an acknowledgment in the product documentation would be 16 appreciated but is not required. 17 2. Altered source versions must be plainly marked as such, and must not be 18 misrepresented as being the original software. 19 3. This notice may not be removed or altered from any source distribution. 20*/ 21 22/** 23 * # CategoryVideo 24 * 25 * SDL's video subsystem is largely interested in abstracting window 26 * management from the underlying operating system. You can create windows, 27 * manage them in various ways, set them fullscreen, and get events when 28 * interesting things happen with them, such as the mouse or keyboard 29 * interacting with a window. 30 * 31 * The video subsystem is also interested in abstracting away some 32 * platform-specific differences in OpenGL: context creation, swapping 33 * buffers, etc. This may be crucial to your app, but also you are not 34 * required to use OpenGL at all. In fact, SDL can provide rendering to those 35 * windows as well, either with an easy-to-use 36 * [2D API](https://wiki.libsdl.org/SDL3/CategoryRender) 37 * or with a more-powerful 38 * [GPU API](https://wiki.libsdl.org/SDL3/CategoryGPU) 39 * . Of course, it can simply get out of your way and give you the window 40 * handles you need to use Vulkan, Direct3D, Metal, or whatever else you like 41 * directly, too. 42 * 43 * The video subsystem covers a lot of functionality, out of necessity, so it 44 * is worth perusing the list of functions just to see what's available, but 45 * most apps can get by with simply creating a window and listening for 46 * events, so start with SDL_CreateWindow() and SDL_PollEvent(). 47 */ 48 49#ifndef SDL_video_h_ 50#define SDL_video_h_ 51 52#include <SDL3/SDL_stdinc.h> 53#include <SDL3/SDL_error.h> 54#include <SDL3/SDL_pixels.h> 55#include <SDL3/SDL_properties.h> 56#include <SDL3/SDL_rect.h> 57#include <SDL3/SDL_surface.h> 58 59#include <SDL3/SDL_begin_code.h> 60/* Set up for C function definitions, even when using C++ */ 61#ifdef __cplusplus 62extern "C" { 63#endif 64 65/** 66 * This is a unique ID for a display for the time it is connected to the 67 * system, and is never reused for the lifetime of the application. 68 * 69 * If the display is disconnected and reconnected, it will get a new ID. 70 * 71 * The value 0 is an invalid ID. 72 * 73 * \since This datatype is available since SDL 3.2.0. 74 */ 75typedef Uint32 SDL_DisplayID; 76 77/** 78 * This is a unique ID for a window. 79 * 80 * The value 0 is an invalid ID. 81 * 82 * \since This datatype is available since SDL 3.2.0. 83 */ 84typedef Uint32 SDL_WindowID; 85 86/* Global video properties... */ 87 88/** 89 * The pointer to the global `wl_display` object used by the Wayland video 90 * backend. 91 * 92 * Can be set before the video subsystem is initialized to import an external 93 * `wl_display` object from an application or toolkit for use in SDL, or read 94 * after initialization to export the `wl_display` used by the Wayland video 95 * backend. Setting this property after the video subsystem has been 96 * initialized has no effect, and reading it when the video subsystem is 97 * uninitialized will either return the user provided value, if one was set 98 * prior to initialization, or NULL. See docs/README-wayland.md for more 99 * information. 100 * 101 * \since This macro is available since SDL 3.2.0. 102 */ 103#define SDL_PROP_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER "SDL.video.wayland.wl_display" 104 105/** 106 * System theme. 107 * 108 * \since This enum is available since SDL 3.2.0. 109 */ 110typedef enum SDL_SystemTheme 111{ 112 SDL_SYSTEM_THEME_UNKNOWN, /**< Unknown system theme */ 113 SDL_SYSTEM_THEME_LIGHT, /**< Light colored system theme */ 114 SDL_SYSTEM_THEME_DARK /**< Dark colored system theme */ 115} SDL_SystemTheme; 116 117/** 118 * Internal display mode data. 119 * 120 * This lives as a field in SDL_DisplayMode, as opaque data. 121 * 122 * \since This struct is available since SDL 3.2.0. 123 * 124 * \sa SDL_DisplayMode 125 */ 126typedef struct SDL_DisplayModeData SDL_DisplayModeData; 127 128/** 129 * The structure that defines a display mode. 130 * 131 * \since This struct is available since SDL 3.2.0. 132 * 133 * \sa SDL_GetFullscreenDisplayModes 134 * \sa SDL_GetDesktopDisplayMode 135 * \sa SDL_GetCurrentDisplayMode 136 * \sa SDL_SetWindowFullscreenMode 137 * \sa SDL_GetWindowFullscreenMode 138 */ 139typedef struct SDL_DisplayMode 140{ 141 SDL_DisplayID displayID; /**< the display this mode is associated with */ 142 SDL_PixelFormat format; /**< pixel format */ 143 int w; /**< width */ 144 int h; /**< height */ 145 float pixel_density; /**< scale converting size to pixels (e.g. a 1920x1080 mode with 2.0 scale would have 3840x2160 pixels) */ 146 float refresh_rate; /**< refresh rate (or 0.0f for unspecified) */ 147 int refresh_rate_numerator; /**< precise refresh rate numerator (or 0 for unspecified) */ 148 int refresh_rate_denominator; /**< precise refresh rate denominator */ 149 150 SDL_DisplayModeData *internal; /**< Private */ 151 152} SDL_DisplayMode; 153 154/** 155 * Display orientation values; the way a display is rotated. 156 * 157 * \since This enum is available since SDL 3.2.0. 158 */ 159typedef enum SDL_DisplayOrientation 160{ 161 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */ 162 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */ 163 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */ 164 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */ 165 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */ 166} SDL_DisplayOrientation; 167 168/** 169 * The struct used as an opaque handle to a window. 170 * 171 * \since This struct is available since SDL 3.2.0. 172 * 173 * \sa SDL_CreateWindow 174 */ 175typedef struct SDL_Window SDL_Window; 176 177/** 178 * The flags on a window. 179 * 180 * These cover a lot of true/false, or on/off, window state. Some of it is 181 * immutable after being set through SDL_CreateWindow(), some of it can be 182 * changed on existing windows by the app, and some of it might be altered by 183 * the user or system outside of the app's control. 184 * 185 * When creating windows with `SDL_WINDOW_RESIZABLE`, SDL will constrain 186 * resizable windows to the dimensions recommended by the compositor to fit it 187 * within the usable desktop space, although some compositors will do this 188 * automatically without intervention as well. Use `SDL_SetWindowResizable` 189 * after creation instead if you wish to create a window with a specific size. 190 * 191 * \since This datatype is available since SDL 3.2.0. 192 * 193 * \sa SDL_GetWindowFlags 194 */ 195typedef Uint64 SDL_WindowFlags; 196 197#define SDL_WINDOW_FULLSCREEN SDL_UINT64_C(0x0000000000000001) /**< window is in fullscreen mode */ 198#define SDL_WINDOW_OPENGL SDL_UINT64_C(0x0000000000000002) /**< window usable with OpenGL context */ 199#define SDL_WINDOW_OCCLUDED SDL_UINT64_C(0x0000000000000004) /**< window is occluded */ 200#define SDL_WINDOW_HIDDEN SDL_UINT64_C(0x0000000000000008) /**< window is neither mapped onto the desktop nor shown in the taskbar/dock/window list; SDL_ShowWindow() is required for it to become visible */ 201#define SDL_WINDOW_BORDERLESS SDL_UINT64_C(0x0000000000000010) /**< no window decoration */ 202#define SDL_WINDOW_RESIZABLE SDL_UINT64_C(0x0000000000000020) /**< window can be resized */ 203#define SDL_WINDOW_MINIMIZED SDL_UINT64_C(0x0000000000000040) /**< window is minimized */ 204#define SDL_WINDOW_MAXIMIZED SDL_UINT64_C(0x0000000000000080) /**< window is maximized */ 205#define SDL_WINDOW_MOUSE_GRABBED SDL_UINT64_C(0x0000000000000100) /**< window has grabbed mouse input */ 206#define SDL_WINDOW_INPUT_FOCUS SDL_UINT64_C(0x0000000000000200) /**< window has input focus */ 207#define SDL_WINDOW_MOUSE_FOCUS SDL_UINT64_C(0x0000000000000400) /**< window has mouse focus */ 208#define SDL_WINDOW_EXTERNAL SDL_UINT64_C(0x0000000000000800) /**< window not created by SDL */ 209#define SDL_WINDOW_MODAL SDL_UINT64_C(0x0000000000001000) /**< window is modal */ 210#define SDL_WINDOW_HIGH_PIXEL_DENSITY SDL_UINT64_C(0x0000000000002000) /**< window uses high pixel density back buffer if possible */ 211#define SDL_WINDOW_MOUSE_CAPTURE SDL_UINT64_C(0x0000000000004000) /**< window has mouse captured (unrelated to MOUSE_GRABBED) */ 212#define SDL_WINDOW_MOUSE_RELATIVE_MODE SDL_UINT64_C(0x0000000000008000) /**< window has relative mode enabled */ 213#define SDL_WINDOW_ALWAYS_ON_TOP SDL_UINT64_C(0x0000000000010000) /**< window should always be above others */ 214#define SDL_WINDOW_UTILITY SDL_UINT64_C(0x0000000000020000) /**< window should be treated as a utility window, not showing in the task bar and window list */ 215#define SDL_WINDOW_TOOLTIP SDL_UINT64_C(0x0000000000040000) /**< window should be treated as a tooltip and does not get mouse or keyboard focus, requires a parent window */ 216#define SDL_WINDOW_POPUP_MENU SDL_UINT64_C(0x0000000000080000) /**< window should be treated as a popup menu, requires a parent window */ 217#define SDL_WINDOW_KEYBOARD_GRABBED SDL_UINT64_C(0x0000000000100000) /**< window has grabbed keyboard input */ 218#define SDL_WINDOW_FILL_DOCUMENT SDL_UINT64_C(0x0000000000200000) /**< window is in fill-document mode (Emscripten only), since SDL 3.4.0 */ 219#define SDL_WINDOW_VULKAN SDL_UINT64_C(0x0000000010000000) /**< window usable for Vulkan surface */ 220#define SDL_WINDOW_METAL SDL_UINT64_C(0x0000000020000000) /**< window usable for Metal view */ 221#define SDL_WINDOW_TRANSPARENT SDL_UINT64_C(0x0000000040000000) /**< window with transparent buffer */ 222#define SDL_WINDOW_NOT_FOCUSABLE SDL_UINT64_C(0x0000000080000000) /**< window should not be focusable */ 223 224 225/** 226 * A magic value used with SDL_WINDOWPOS_UNDEFINED. 227 * 228 * Generally this macro isn't used directly, but rather through 229 * SDL_WINDOWPOS_UNDEFINED or SDL_WINDOWPOS_UNDEFINED_DISPLAY. 230 * 231 * \since This macro is available since SDL 3.2.0. 232 * 233 * \sa SDL_SetWindowPosition 234 */ 235#define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000u 236 237/** 238 * Used to indicate that you don't care what the window position is. 239 * 240 * If you _really_ don't care, SDL_WINDOWPOS_UNDEFINED is the same, but always 241 * uses the primary display instead of specifying one. 242 * 243 * \param X the SDL_DisplayID of the display to use. 244 * 245 * \since This macro is available since SDL 3.2.0. 246 * 247 * \sa SDL_SetWindowPosition 248 */ 249#define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X)) 250 251/** 252 * Used to indicate that you don't care what the window position/display is. 253 * 254 * This always uses the primary display. 255 * 256 * \since This macro is available since SDL 3.2.0. 257 * 258 * \sa SDL_SetWindowPosition 259 */ 260#define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0) 261 262/** 263 * A macro to test if the window position is marked as "undefined." 264 * 265 * \param X the window position value. 266 * 267 * \since This macro is available since SDL 3.2.0. 268 * 269 * \sa SDL_SetWindowPosition 270 */ 271#define SDL_WINDOWPOS_ISUNDEFINED(X) (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK) 272 273/** 274 * A magic value used with SDL_WINDOWPOS_CENTERED. 275 * 276 * Generally this macro isn't used directly, but rather through 277 * SDL_WINDOWPOS_CENTERED or SDL_WINDOWPOS_CENTERED_DISPLAY. 278 * 279 * \since This macro is available since SDL 3.2.0. 280 * 281 * \sa SDL_SetWindowPosition 282 */ 283#define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000u 284 285/** 286 * Used to indicate that the window position should be centered. 287 * 288 * SDL_WINDOWPOS_CENTERED is the same, but always uses the primary display 289 * instead of specifying one. 290 * 291 * \param X the SDL_DisplayID of the display to use. 292 * 293 * \since This macro is available since SDL 3.2.0. 294 * 295 * \sa SDL_SetWindowPosition 296 */ 297#define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK|(X)) 298 299/** 300 * Used to indicate that the window position should be centered. 301 * 302 * This always uses the primary display. 303 * 304 * \since This macro is available since SDL 3.2.0. 305 * 306 * \sa SDL_SetWindowPosition 307 */ 308#define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0) 309 310/** 311 * A macro to test if the window position is marked as "centered." 312 * 313 * \param X the window position value. 314 * 315 * \since This macro is available since SDL 3.2.0. 316 * 317 * \sa SDL_GetWindowPosition 318 */ 319#define SDL_WINDOWPOS_ISCENTERED(X) \ 320 (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK) 321 322 323/** 324 * Window flash operation. 325 * 326 * \since This enum is available since SDL 3.2.0. 327 */ 328typedef enum SDL_FlashOperation 329{ 330 SDL_FLASH_CANCEL, /**< Cancel any window flash state */ 331 SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */ 332 SDL_FLASH_UNTIL_FOCUSED /**< Flash the window until it gets focus */ 333} SDL_FlashOperation; 334 335/** 336 * Window progress state 337 * 338 * \since This enum is available since SDL 3.2.8. 339 */ 340typedef enum SDL_ProgressState 341{ 342 SDL_PROGRESS_STATE_INVALID = -1, /**< An invalid progress state indicating an error; check SDL_GetError() */ 343 SDL_PROGRESS_STATE_NONE, /**< No progress bar is shown */ 344 SDL_PROGRESS_STATE_INDETERMINATE, /**< The progress bar is shown in a indeterminate state */ 345 SDL_PROGRESS_STATE_NORMAL, /**< The progress bar is shown in a normal state */ 346 SDL_PROGRESS_STATE_PAUSED, /**< The progress bar is shown in a paused state */ 347 SDL_PROGRESS_STATE_ERROR /**< The progress bar is shown in a state indicating the application had an error */ 348} SDL_ProgressState; 349 350/** 351 * An opaque handle to an OpenGL context. 352 * 353 * \since This datatype is available since SDL 3.2.0. 354 * 355 * \sa SDL_GL_CreateContext 356 * \sa SDL_GL_SetAttribute 357 * \sa SDL_GL_MakeCurrent 358 * \sa SDL_GL_DestroyContext 359 */ 360typedef struct SDL_GLContextState *SDL_GLContext; 361 362/** 363 * Opaque type for an EGL display. 364 * 365 * \since This datatype is available since SDL 3.2.0. 366 */ 367typedef void *SDL_EGLDisplay; 368 369/** 370 * Opaque type for an EGL config. 371 * 372 * \since This datatype is available since SDL 3.2.0. 373 */ 374typedef void *SDL_EGLConfig; 375 376/** 377 * Opaque type for an EGL surface. 378 * 379 * \since This datatype is available since SDL 3.2.0. 380 */ 381typedef void *SDL_EGLSurface; 382 383/** 384 * An EGL attribute, used when creating an EGL context. 385 * 386 * \since This datatype is available since SDL 3.2.0. 387 */ 388typedef intptr_t SDL_EGLAttrib; 389 390/** 391 * An EGL integer attribute, used when creating an EGL surface. 392 * 393 * \since This datatype is available since SDL 3.2.0. 394 */ 395typedef int SDL_EGLint; 396 397/** 398 * EGL platform attribute initialization callback. 399 * 400 * This is called when SDL is attempting to create an EGL context, to let the 401 * app add extra attributes to its eglGetPlatformDisplay() call. 402 * 403 * The callback should return a pointer to an EGL attribute array terminated 404 * with `EGL_NONE`. If this function returns NULL, the SDL_CreateWindow 405 * process will fail gracefully. 406 * 407 * The returned pointer should be allocated with SDL_malloc() and will be 408 * passed to SDL_free(). 409 * 410 * The arrays returned by each callback will be appended to the existing 411 * attribute arrays defined by SDL. 412 * 413 * \param userdata an app-controlled pointer that is passed to the callback. 414 * \returns a newly-allocated array of attributes, terminated with `EGL_NONE`. 415 * 416 * \since This datatype is available since SDL 3.2.0. 417 * 418 * \sa SDL_EGL_SetAttributeCallbacks 419 */ 420typedef SDL_EGLAttrib *(SDLCALL *SDL_EGLAttribArrayCallback)(void *userdata); 421 422/** 423 * EGL surface/context attribute initialization callback types. 424 * 425 * This is called when SDL is attempting to create an EGL surface, to let the 426 * app add extra attributes to its eglCreateWindowSurface() or 427 * eglCreateContext calls. 428 * 429 * For convenience, the EGLDisplay and EGLConfig to use are provided to the 430 * callback. 431 * 432 * The callback should return a pointer to an EGL attribute array terminated 433 * with `EGL_NONE`. If this function returns NULL, the SDL_CreateWindow 434 * process will fail gracefully. 435 * 436 * The returned pointer should be allocated with SDL_malloc() and will be 437 * passed to SDL_free(). 438 * 439 * The arrays returned by each callback will be appended to the existing 440 * attribute arrays defined by SDL. 441 * 442 * \param userdata an app-controlled pointer that is passed to the callback. 443 * \param display the EGL display to be used. 444 * \param config the EGL config to be used. 445 * \returns a newly-allocated array of attributes, terminated with `EGL_NONE`. 446 * 447 * \since This datatype is available since SDL 3.2.0. 448 * 449 * \sa SDL_EGL_SetAttributeCallbacks 450 */ 451typedef SDL_EGLint *(SDLCALL *SDL_EGLIntArrayCallback)(void *userdata, SDL_EGLDisplay display, SDL_EGLConfig config); 452 453/** 454 * An enumeration of OpenGL configuration attributes. 455 * 456 * While you can set most OpenGL attributes normally, the attributes listed 457 * above must be known before SDL creates the window that will be used with 458 * the OpenGL context. These attributes are set and read with 459 * SDL_GL_SetAttribute() and SDL_GL_GetAttribute(). 460 * 461 * In some cases, these attributes are minimum requests; the GL does not 462 * promise to give you exactly what you asked for. It's possible to ask for a 463 * 16-bit depth buffer and get a 24-bit one instead, for example, or to ask 464 * for no stencil buffer and still have one available. Context creation should 465 * fail if the GL can't provide your requested attributes at a minimum, but 466 * you should check to see exactly what you got. 467 * 468 * \since This enum is available since SDL 3.2.0. 469 */ 470typedef enum SDL_GLAttr 471{ 472 SDL_GL_RED_SIZE, /**< the minimum number of bits for the red channel of the color buffer; defaults to 8. */ 473 SDL_GL_GREEN_SIZE, /**< the minimum number of bits for the green channel of the color buffer; defaults to 8. */ 474 SDL_GL_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the color buffer; defaults to 8. */ 475 SDL_GL_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the color buffer; defaults to 8. */ 476 SDL_GL_BUFFER_SIZE, /**< the minimum number of bits for frame buffer size; defaults to 0. */ 477 SDL_GL_DOUBLEBUFFER, /**< whether the output is single or double buffered; defaults to double buffering on. */ 478 SDL_GL_DEPTH_SIZE, /**< the minimum number of bits in the depth buffer; defaults to 16. */ 479 SDL_GL_STENCIL_SIZE, /**< the minimum number of bits in the stencil buffer; defaults to 0. */ 480 SDL_GL_ACCUM_RED_SIZE, /**< the minimum number of bits for the red channel of the accumulation buffer; defaults to 0. */ 481 SDL_GL_ACCUM_GREEN_SIZE, /**< the minimum number of bits for the green channel of the accumulation buffer; defaults to 0. */ 482 SDL_GL_ACCUM_BLUE_SIZE, /**< the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0. */ 483 SDL_GL_ACCUM_ALPHA_SIZE, /**< the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0. */ 484 SDL_GL_STEREO, /**< whether the output is stereo 3D; defaults to off. */ 485 SDL_GL_MULTISAMPLEBUFFERS, /**< the number of buffers used for multisample anti-aliasing; defaults to 0. */ 486 SDL_GL_MULTISAMPLESAMPLES, /**< the number of samples used around the current pixel used for multisample anti-aliasing. */ 487 SDL_GL_ACCELERATED_VISUAL, /**< set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either. */ 488 SDL_GL_RETAINED_BACKING, /**< not used (deprecated). */ 489 SDL_GL_CONTEXT_MAJOR_VERSION, /**< OpenGL context major version. */ 490 SDL_GL_CONTEXT_MINOR_VERSION, /**< OpenGL context minor version. */ 491 SDL_GL_CONTEXT_FLAGS, /**< some combination of 0 or more of elements of the SDL_GLContextFlag enumeration; defaults to 0. */ 492 SDL_GL_CONTEXT_PROFILE_MASK, /**< type of GL context (Core, Compatibility, ES). See SDL_GLProfile; default value depends on platform. */ 493 SDL_GL_SHARE_WITH_CURRENT_CONTEXT, /**< OpenGL context sharing; defaults to 0. */ 494 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, /**< requests sRGB capable visual; defaults to 0. */ 495 SDL_GL_CONTEXT_RELEASE_BEHAVIOR, /**< sets context the release behavior. See SDL_GLContextReleaseFlag; defaults to FLUSH. */ 496 SDL_GL_CONTEXT_RESET_NOTIFICATION, /**< set context reset notification. See SDL_GLContextResetNotification; defaults to NO_NOTIFICATION. */ 497 SDL_GL_CONTEXT_NO_ERROR, 498 SDL_GL_FLOATBUFFERS, 499 SDL_GL_EGL_PLATFORM 500} SDL_GLAttr; 501 502/** 503 * Possible values to be set for the SDL_GL_CONTEXT_PROFILE_MASK attribute. 504 * 505 * \since This datatype is available since SDL 3.2.0. 506 */ 507typedef Uint32 SDL_GLProfile; 508 509#define SDL_GL_CONTEXT_PROFILE_CORE 0x0001 /**< OpenGL Core Profile context */ 510#define SDL_GL_CONTEXT_PROFILE_COMPATIBILITY 0x0002 /**< OpenGL Compatibility Profile context */ 511#define SDL_GL_CONTEXT_PROFILE_ES 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */ 512 513 514/** 515 * Possible flags to be set for the SDL_GL_CONTEXT_FLAGS attribute. 516 * 517 * \since This datatype is available since SDL 3.2.0. 518 */ 519typedef Uint32 SDL_GLContextFlag; 520 521#define SDL_GL_CONTEXT_DEBUG_FLAG 0x0001 522#define SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG 0x0002 523#define SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG 0x0004 524#define SDL_GL_CONTEXT_RESET_ISOLATION_FLAG 0x0008 525 526 527/** 528 * Possible values to be set for the SDL_GL_CONTEXT_RELEASE_BEHAVIOR 529 * attribute. 530 * 531 * \since This datatype is available since SDL 3.2.0. 532 */ 533typedef Uint32 SDL_GLContextReleaseFlag; 534 535#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE 0x0000 536#define SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH 0x0001 537 538 539/** 540 * Possible values to be set SDL_GL_CONTEXT_RESET_NOTIFICATION attribute. 541 * 542 * \since This datatype is available since SDL 3.2.0. 543 */ 544typedef Uint32 SDL_GLContextResetNotification; 545 546#define SDL_GL_CONTEXT_RESET_NO_NOTIFICATION 0x0000 547#define SDL_GL_CONTEXT_RESET_LOSE_CONTEXT 0x0001 548 549 550/* Function prototypes */ 551 552/** 553 * Get the number of video drivers compiled into SDL. 554 * 555 * \returns the number of built in video drivers. 556 * 557 * \threadsafety This function should only be called on the main thread. 558 * 559 * \since This function is available since SDL 3.2.0. 560 * 561 * \sa SDL_GetVideoDriver 562 */ 563extern SDL_DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void); 564 565/** 566 * Get the name of a built in video driver. 567 * 568 * The video drivers are presented in the order in which they are normally 569 * checked during initialization. 570 * 571 * The names of drivers are all simple, low-ASCII identifiers, like "cocoa", 572 * "x11" or "windows". These never have Unicode characters, and are not meant 573 * to be proper names. 574 * 575 * \param index the index of a video driver. 576 * \returns the name of the video driver with the given **index**, or NULL if 577 * index is out of bounds. 578 * 579 * \threadsafety This function should only be called on the main thread. 580 * 581 * \since This function is available since SDL 3.2.0. 582 * 583 * \sa SDL_GetNumVideoDrivers 584 */ 585extern SDL_DECLSPEC const char * SDLCALL SDL_GetVideoDriver(int index); 586 587/** 588 * Get the name of the currently initialized video driver. 589 * 590 * The names of drivers are all simple, low-ASCII identifiers, like "cocoa", 591 * "x11" or "windows". These never have Unicode characters, and are not meant 592 * to be proper names. 593 * 594 * \returns the name of the current video driver or NULL if no driver has been 595 * initialized. 596 * 597 * \threadsafety This function should only be called on the main thread. 598 * 599 * \since This function is available since SDL 3.2.0. 600 * 601 * \sa SDL_GetNumVideoDrivers 602 * \sa SDL_GetVideoDriver 603 */ 604extern SDL_DECLSPEC const char * SDLCALL SDL_GetCurrentVideoDriver(void); 605 606/** 607 * Get the current system theme. 608 * 609 * \returns the current system theme, light, dark, or unknown. 610 * 611 * \threadsafety This function should only be called on the main thread. 612 * 613 * \since This function is available since SDL 3.2.0. 614 */ 615extern SDL_DECLSPEC SDL_SystemTheme SDLCALL SDL_GetSystemTheme(void); 616 617/** 618 * Get a list of currently connected displays. 619 * 620 * \param count a pointer filled in with the number of displays returned, may 621 * be NULL. 622 * \returns a 0 terminated array of display instance IDs or NULL on failure; 623 * call SDL_GetError() for more information. This should be freed 624 * with SDL_free() when it is no longer needed. 625 * 626 * \threadsafety This function should only be called on the main thread. 627 * 628 * \since This function is available since SDL 3.2.0. 629 */ 630extern SDL_DECLSPEC SDL_DisplayID * SDLCALL SDL_GetDisplays(int *count); 631 632/** 633 * Return the primary display. 634 * 635 * \returns the instance ID of the primary display on success or 0 on failure; 636 * call SDL_GetError() for more information. 637 * 638 * \threadsafety This function should only be called on the main thread. 639 * 640 * \since This function is available since SDL 3.2.0. 641 * 642 * \sa SDL_GetDisplays 643 */ 644extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetPrimaryDisplay(void); 645 646/** 647 * Get the properties associated with a display. 648 * 649 * The following read-only properties are provided by SDL: 650 * 651 * - `SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN`: true if the display has HDR 652 * headroom above the SDR white point. This is for informational and 653 * diagnostic purposes only, as not all platforms provide this information 654 * at the display level. 655 * 656 * On KMS/DRM: 657 * 658 * - `SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER`: the "panel 659 * orientation" property for the display in degrees of clockwise rotation. 660 * Note that this is provided only as a hint, and the application is 661 * responsible for any coordinate transformations needed to conform to the 662 * requested display orientation. 663 * 664 * On Wayland: 665 * 666 * - `SDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER`: the wl_output associated 667 * with the display 668 * 669 * On Windows: 670 * 671 * - `SDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER`: the monitor handle 672 * (HMONITOR) associated with the display 673 * 674 * \param displayID the instance ID of the display to query. 675 * \returns a valid property ID on success or 0 on failure; call 676 * SDL_GetError() for more information. 677 * 678 * \threadsafety This function should only be called on the main thread. 679 * 680 * \since This function is available since SDL 3.2.0. 681 */ 682extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetDisplayProperties(SDL_DisplayID displayID); 683 684#define SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN "SDL.display.HDR_enabled" 685#define SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER "SDL.display.KMSDRM.panel_orientation" 686#define SDL_PROP_DISPLAY_WAYLAND_WL_OUTPUT_POINTER "SDL.display.wayland.wl_output" 687#define SDL_PROP_DISPLAY_WINDOWS_HMONITOR_POINTER "SDL.display.windows.hmonitor" 688 689/** 690 * Get the name of a display in UTF-8 encoding. 691 * 692 * \param displayID the instance ID of the display to query. 693 * \returns the name of a display or NULL on failure; call SDL_GetError() for 694 * more information. 695 * 696 * \threadsafety This function should only be called on the main thread. 697 * 698 * \since This function is available since SDL 3.2.0. 699 * 700 * \sa SDL_GetDisplays 701 */ 702extern SDL_DECLSPEC const char * SDLCALL SDL_GetDisplayName(SDL_DisplayID displayID); 703 704/** 705 * Get the desktop area represented by a display. 706 * 707 * The primary display is often located at (0,0), but may be placed at a 708 * different location depending on monitor layout. 709 * 710 * \param displayID the instance ID of the display to query. 711 * \param rect the SDL_Rect structure filled in with the display bounds. 712 * \returns true on success or false on failure; call SDL_GetError() for more 713 * information. 714 * 715 * \threadsafety This function should only be called on the main thread. 716 * 717 * \since This function is available since SDL 3.2.0. 718 * 719 * \sa SDL_GetDisplayUsableBounds 720 * \sa SDL_GetDisplays 721 */ 722extern SDL_DECLSPEC bool SDLCALL SDL_GetDisplayBounds(SDL_DisplayID displayID, SDL_Rect *rect); 723 724/** 725 * Get the usable desktop area represented by a display, in screen 726 * coordinates. 727 * 728 * This is the same area as SDL_GetDisplayBounds() reports, but with portions 729 * reserved by the system removed. For example, on Apple's macOS, this 730 * subtracts the area occupied by the menu bar and dock. 731 * 732 * Setting a window to be fullscreen generally bypasses these unusable areas, 733 * so these are good guidelines for the maximum space available to a 734 * non-fullscreen window. 735 * 736 * \param displayID the instance ID of the display to query. 737 * \param rect the SDL_Rect structure filled in with the display bounds. 738 * \returns true on success or false on failure; call SDL_GetError() for more 739 * information. 740 * 741 * \threadsafety This function should only be called on the main thread. 742 * 743 * \since This function is available since SDL 3.2.0. 744 * 745 * \sa SDL_GetDisplayBounds 746 * \sa SDL_GetDisplays 747 */ 748extern SDL_DECLSPEC bool SDLCALL SDL_GetDisplayUsableBounds(SDL_DisplayID displayID, SDL_Rect *rect); 749 750/** 751 * Get the orientation of a display when it is unrotated. 752 * 753 * \param displayID the instance ID of the display to query. 754 * \returns the SDL_DisplayOrientation enum value of the display, or 755 * `SDL_ORIENTATION_UNKNOWN` if it isn't available. 756 * 757 * \threadsafety This function should only be called on the main thread. 758 * 759 * \since This function is available since SDL 3.2.0. 760 * 761 * \sa SDL_GetDisplays 762 */ 763extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetNaturalDisplayOrientation(SDL_DisplayID displayID); 764 765/** 766 * Get the orientation of a display. 767 * 768 * \param displayID the instance ID of the display to query. 769 * \returns the SDL_DisplayOrientation enum value of the display, or 770 * `SDL_ORIENTATION_UNKNOWN` if it isn't available. 771 * 772 * \threadsafety This function should only be called on the main thread. 773 * 774 * \since This function is available since SDL 3.2.0. 775 * 776 * \sa SDL_GetDisplays 777 */ 778extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetCurrentDisplayOrientation(SDL_DisplayID displayID); 779 780/** 781 * Get the content scale of a display. 782 * 783 * The content scale is the expected scale for content based on the DPI 784 * settings of the display. For example, a 4K display might have a 2.0 (200%) 785 * display scale, which means that the user expects UI elements to be twice as 786 * big on this display, to aid in readability. 787 * 788 * After window creation, SDL_GetWindowDisplayScale() should be used to query 789 * the content scale factor for individual windows instead of querying the 790 * display for a window and calling this function, as the per-window content 791 * scale factor may differ from the base value of the display it is on, 792 * particularly on high-DPI and/or multi-monitor desktop configurations. 793 * 794 * \param displayID the instance ID of the display to query. 795 * \returns the content scale of the display, or 0.0f on failure; call 796 * SDL_GetError() for more information. 797 * 798 * \threadsafety This function should only be called on the main thread. 799 * 800 * \since This function is available since SDL 3.2.0. 801 * 802 * \sa SDL_GetWindowDisplayScale 803 * \sa SDL_GetDisplays 804 */ 805extern SDL_DECLSPEC float SDLCALL SDL_GetDisplayContentScale(SDL_DisplayID displayID); 806 807/** 808 * Get a list of fullscreen display modes available on a display. 809 * 810 * The display modes are sorted in this priority: 811 * 812 * - w -> largest to smallest 813 * - h -> largest to smallest 814 * - bits per pixel -> more colors to fewer colors 815 * - packed pixel layout -> largest to smallest 816 * - refresh rate -> highest to lowest 817 * - pixel density -> lowest to highest 818 * 819 * \param displayID the instance ID of the display to query. 820 * \param count a pointer filled in with the number of display modes returned, 821 * may be NULL. 822 * \returns a NULL terminated array of display mode pointers or NULL on 823 * failure; call SDL_GetError() for more information. This is a 824 * single allocation that should be freed with SDL_free() when it is 825 * no longer needed. 826 * 827 * \threadsafety This function should only be called on the main thread. 828 * 829 * \since This function is available since SDL 3.2.0. 830 * 831 * \sa SDL_GetDisplays 832 */ 833extern SDL_DECLSPEC SDL_DisplayMode ** SDLCALL SDL_GetFullscreenDisplayModes(SDL_DisplayID displayID, int *count); 834 835/** 836 * Get the closest match to the requested display mode. 837 * 838 * The available display modes are scanned and `closest` is filled in with the 839 * closest mode matching the requested mode and returned. The mode format and 840 * refresh rate default to the desktop mode if they are set to 0. The modes 841 * are scanned with size being first priority, format being second priority, 842 * and finally checking the refresh rate. If all the available modes are too 843 * small, then false is returned. 844 * 845 * \param displayID the instance ID of the display to query. 846 * \param w the width in pixels of the desired display mode. 847 * \param h the height in pixels of the desired display mode. 848 * \param refresh_rate the refresh rate of the desired display mode, or 0.0f 849 * for the desktop refresh rate. 850 * \param include_high_density_modes boolean to include high density modes in 851 * the search. 852 * \param closest a pointer filled in with the closest display mode equal to 853 * or larger than the desired mode. 854 * \returns true on success or false on failure; call SDL_GetError() for more 855 * information. 856 * 857 * \threadsafety This function should only be called on the main thread. 858 * 859 * \since This function is available since SDL 3.2.0. 860 * 861 * \sa SDL_GetDisplays 862 * \sa SDL_GetFullscreenDisplayModes 863 */ 864extern SDL_DECLSPEC bool SDLCALL SDL_GetClosestFullscreenDisplayMode(SDL_DisplayID displayID, int w, int h, float refresh_rate, bool include_high_density_modes, SDL_DisplayMode *closest); 865 866/** 867 * Get information about the desktop's display mode. 868 * 869 * There's a difference between this function and SDL_GetCurrentDisplayMode() 870 * when SDL runs fullscreen and has changed the resolution. In that case this 871 * function will return the previous native display mode, and not the current 872 * display mode. 873 * 874 * \param displayID the instance ID of the display to query. 875 * \returns a pointer to the desktop display mode or NULL on failure; call 876 * SDL_GetError() for more information. 877 * 878 * \threadsafety This function should only be called on the main thread. 879 * 880 * \since This function is available since SDL 3.2.0. 881 * 882 * \sa SDL_GetCurrentDisplayMode 883 * \sa SDL_GetDisplays 884 */ 885extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayID displayID); 886 887/** 888 * Get information about the current display mode. 889 * 890 * There's a difference between this function and SDL_GetDesktopDisplayMode() 891 * when SDL runs fullscreen and has changed the resolution. In that case this 892 * function will return the current display mode, and not the previous native 893 * display mode. 894 * 895 * \param displayID the instance ID of the display to query. 896 * \returns a pointer to the desktop display mode or NULL on failure; call 897 * SDL_GetError() for more information. 898 * 899 * \threadsafety This function should only be called on the main thread. 900 * 901 * \since This function is available since SDL 3.2.0. 902 * 903 * \sa SDL_GetDesktopDisplayMode 904 * \sa SDL_GetDisplays 905 */ 906extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayID displayID); 907 908/** 909 * Get the display containing a point. 910 * 911 * \param point the point to query. 912 * \returns the instance ID of the display containing the point or 0 on 913 * failure; call SDL_GetError() for more information. 914 * 915 * \threadsafety This function should only be called on the main thread. 916 * 917 * \since This function is available since SDL 3.2.0. 918 * 919 * \sa SDL_GetDisplayBounds 920 * \sa SDL_GetDisplays 921 */ 922extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForPoint(const SDL_Point *point); 923 924/** 925 * Get the display primarily containing a rect. 926 * 927 * \param rect the rect to query. 928 * \returns the instance ID of the display entirely containing the rect or 929 * closest to the center of the rect on success or 0 on failure; call 930 * SDL_GetError() for more information. 931 * 932 * \threadsafety This function should only be called on the main thread. 933 * 934 * \since This function is available since SDL 3.2.0. 935 * 936 * \sa SDL_GetDisplayBounds 937 * \sa SDL_GetDisplays 938 */ 939extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForRect(const SDL_Rect *rect); 940 941/** 942 * Get the display associated with a window. 943 * 944 * \param window the window to query. 945 * \returns the instance ID of the display containing the center of the window 946 * on success or 0 on failure; call SDL_GetError() for more 947 * information. 948 * 949 * \threadsafety This function should only be called on the main thread. 950 * 951 * \since This function is available since SDL 3.2.0. 952 * 953 * \sa SDL_GetDisplayBounds 954 * \sa SDL_GetDisplays 955 */ 956extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForWindow(SDL_Window *window); 957 958/** 959 * Get the pixel density of a window. 960 * 961 * This is a ratio of pixel size to window size. For example, if the window is 962 * 1920x1080 and it has a high density back buffer of 3840x2160 pixels, it 963 * would have a pixel density of 2.0. 964 * 965 * \param window the window to query. 966 * \returns the pixel density or 0.0f on failure; call SDL_GetError() for more 967 * information. 968 * 969 * \threadsafety This function should only be called on the main thread. 970 * 971 * \since This function is available since SDL 3.2.0. 972 * 973 * \sa SDL_GetWindowDisplayScale 974 */ 975extern SDL_DECLSPEC float SDLCALL SDL_GetWindowPixelDensity(SDL_Window *window); 976 977/** 978 * Get the content display scale relative to a window's pixel size. 979 * 980 * This is a combination of the window pixel density and the display content 981 * scale, and is the expected scale for displaying content in this window. For 982 * example, if a 3840x2160 window had a display scale of 2.0, the user expects 983 * the content to take twice as many pixels and be the same physical size as 984 * if it were being displayed in a 1920x1080 window with a display scale of 985 * 1.0. 986 * 987 * Conceptually this value corresponds to the scale display setting, and is 988 * updated when that setting is changed, or the window moves to a display with 989 * a different scale setting. 990 * 991 * \param window the window to query. 992 * \returns the display scale, or 0.0f on failure; call SDL_GetError() for 993 * more information. 994 * 995 * \threadsafety This function should only be called on the main thread. 996 * 997 * \since This function is available since SDL 3.2.0. 998 */ 999extern SDL_DECLSPEC float SDLCALL SDL_GetWindowDisplayScale(SDL_Window *window); 1000 1001/** 1002 * Set the display mode to use when a window is visible and fullscreen. 1003 * 1004 * This only affects the display mode used when the window is fullscreen. To 1005 * change the window size when the window is not fullscreen, use 1006 * SDL_SetWindowSize(). 1007 * 1008 * If the window is currently in the fullscreen state, this request is 1009 * asynchronous on some windowing systems and the new mode dimensions may not 1010 * be applied immediately upon the return of this function. If an immediate 1011 * change is required, call SDL_SyncWindow() to block until the changes have 1012 * taken effect. 1013 * 1014 * When the new mode takes effect, an SDL_EVENT_WINDOW_RESIZED and/or an 1015 * SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event will be emitted with the new mode 1016 * dimensions. 1017 * 1018 * \param window the window to affect. 1019 * \param mode a pointer to the display mode to use, which can be NULL for 1020 * borderless fullscreen desktop mode, or one of the fullscreen 1021 * modes returned by SDL_GetFullscreenDisplayModes() to set an 1022 * exclusive fullscreen mode. 1023 * \returns true on success or false on failure; call SDL_GetError() for more 1024 * information. 1025 * 1026 * \threadsafety This function should only be called on the main thread. 1027 * 1028 * \since This function is available since SDL 3.2.0. 1029 * 1030 * \sa SDL_GetWindowFullscreenMode 1031 * \sa SDL_SetWindowFullscreen 1032 * \sa SDL_SyncWindow 1033 */ 1034extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFullscreenMode(SDL_Window *window, const SDL_DisplayMode *mode); 1035 1036/** 1037 * Query the display mode to use when a window is visible at fullscreen. 1038 * 1039 * \param window the window to query. 1040 * \returns a pointer to the exclusive fullscreen mode to use or NULL for 1041 * borderless fullscreen desktop mode. 1042 * 1043 * \threadsafety This function should only be called on the main thread. 1044 * 1045 * \since This function is available since SDL 3.2.0. 1046 * 1047 * \sa SDL_SetWindowFullscreenMode 1048 * \sa SDL_SetWindowFullscreen 1049 */ 1050extern SDL_DECLSPEC const SDL_DisplayMode * SDLCALL SDL_GetWindowFullscreenMode(SDL_Window *window); 1051 1052/** 1053 * Get the raw ICC profile data for the screen the window is currently on. 1054 * 1055 * \param window the window to query. 1056 * \param size the size of the ICC profile. 1057 * \returns the raw ICC profile data on success or NULL on failure; call 1058 * SDL_GetError() for more information. This should be freed with 1059 * SDL_free() when it is no longer needed. 1060 * 1061 * \threadsafety This function should only be called on the main thread. 1062 * 1063 * \since This function is available since SDL 3.2.0. 1064 */ 1065extern SDL_DECLSPEC void * SDLCALL SDL_GetWindowICCProfile(SDL_Window *window, size_t *size); 1066 1067/** 1068 * Get the pixel format associated with the window. 1069 * 1070 * \param window the window to query. 1071 * \returns the pixel format of the window on success or 1072 * SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more 1073 * information. 1074 * 1075 * \threadsafety This function should only be called on the main thread. 1076 * 1077 * \since This function is available since SDL 3.2.0. 1078 */ 1079extern SDL_DECLSPEC SDL_PixelFormat SDLCALL SDL_GetWindowPixelFormat(SDL_Window *window); 1080 1081/** 1082 * Get a list of valid windows. 1083 * 1084 * \param count a pointer filled in with the number of windows returned, may 1085 * be NULL. 1086 * \returns a NULL terminated array of SDL_Window pointers or NULL on failure; 1087 * call SDL_GetError() for more information. This is a single 1088 * allocation that should be freed with SDL_free() when it is no 1089 * longer needed. 1090 * 1091 * \threadsafety This function should only be called on the main thread. 1092 * 1093 * \since This function is available since SDL 3.2.0. 1094 */ 1095extern SDL_DECLSPEC SDL_Window ** SDLCALL SDL_GetWindows(int *count); 1096 1097/** 1098 * Create a window with the specified dimensions and flags. 1099 * 1100 * The window size is a request and may be different than expected based on 1101 * the desktop layout and window manager policies. Your application should be 1102 * prepared to handle a window of any size. 1103 * 1104 * `flags` may be any of the following OR'd together: 1105 * 1106 * - `SDL_WINDOW_FULLSCREEN`: fullscreen window at desktop resolution 1107 * - `SDL_WINDOW_OPENGL`: window usable with an OpenGL context 1108 * - `SDL_WINDOW_HIDDEN`: window is not visible 1109 * - `SDL_WINDOW_BORDERLESS`: no window decoration 1110 * - `SDL_WINDOW_RESIZABLE`: window can be resized 1111 * - `SDL_WINDOW_MINIMIZED`: window is minimized 1112 * - `SDL_WINDOW_MAXIMIZED`: window is maximized 1113 * - `SDL_WINDOW_MOUSE_GRABBED`: window has grabbed mouse focus 1114 * - `SDL_WINDOW_INPUT_FOCUS`: window has input focus 1115 * - `SDL_WINDOW_MOUSE_FOCUS`: window has mouse focus 1116 * - `SDL_WINDOW_EXTERNAL`: window not created by SDL 1117 * - `SDL_WINDOW_MODAL`: window is modal 1118 * - `SDL_WINDOW_HIGH_PIXEL_DENSITY`: window uses high pixel density back 1119 * buffer if possible 1120 * - `SDL_WINDOW_MOUSE_CAPTURE`: window has mouse captured (unrelated to 1121 * MOUSE_GRABBED) 1122 * - `SDL_WINDOW_ALWAYS_ON_TOP`: window should always be above others 1123 * - `SDL_WINDOW_UTILITY`: window should be treated as a utility window, not 1124 * showing in the task bar and window list 1125 * - `SDL_WINDOW_TOOLTIP`: window should be treated as a tooltip and does not 1126 * get mouse or keyboard focus, requires a parent window 1127 * - `SDL_WINDOW_POPUP_MENU`: window should be treated as a popup menu, 1128 * requires a parent window 1129 * - `SDL_WINDOW_KEYBOARD_GRABBED`: window has grabbed keyboard input 1130 * - `SDL_WINDOW_VULKAN`: window usable with a Vulkan instance 1131 * - `SDL_WINDOW_METAL`: window usable with a Metal instance 1132 * - `SDL_WINDOW_TRANSPARENT`: window with transparent buffer 1133 * - `SDL_WINDOW_NOT_FOCUSABLE`: window should not be focusable 1134 * 1135 * The SDL_Window will be shown if SDL_WINDOW_HIDDEN is not set. If hidden at 1136 * creation time, SDL_ShowWindow() can be used to show it later. 1137 * 1138 * On Apple's macOS, you **must** set the NSHighResolutionCapable Info.plist 1139 * property to YES, otherwise you will not receive a High-DPI OpenGL canvas. 1140 * 1141 * The window pixel size may differ from its window coordinate size if the 1142 * window is on a high pixel density display. Use SDL_GetWindowSize() to query 1143 * the client area's size in window coordinates, and 1144 * SDL_GetWindowSizeInPixels() or SDL_GetRenderOutputSize() to query the 1145 * drawable size in pixels. Note that the drawable size can vary after the 1146 * window is created and should be queried again if you get an 1147 * SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event. 1148 * 1149 * If the window is created with any of the SDL_WINDOW_OPENGL or 1150 * SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function 1151 * (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the 1152 * corresponding UnloadLibrary function is called by SDL_DestroyWindow(). 1153 * 1154 * If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver, 1155 * SDL_CreateWindow() will fail, because SDL_Vulkan_LoadLibrary() will fail. 1156 * 1157 * If SDL_WINDOW_METAL is specified on an OS that does not support Metal, 1158 * SDL_CreateWindow() will fail. 1159 * 1160 * If you intend to use this window with an SDL_Renderer, you should use 1161 * SDL_CreateWindowAndRenderer() instead of this function, to avoid window 1162 * flicker. 1163 * 1164 * On non-Apple devices, SDL requires you to either not link to the Vulkan 1165 * loader or link to a dynamic library version. This limitation may be removed 1166 * in a future version of SDL. 1167 * 1168 * \param title the title of the window, in UTF-8 encoding. 1169 * \param w the width of the window. 1170 * \param h the height of the window. 1171 * \param flags 0, or one or more SDL_WindowFlags OR'd together. 1172 * \returns the window that was created or NULL on failure; call 1173 * SDL_GetError() for more information. 1174 * 1175 * \threadsafety This function should only be called on the main thread. 1176 * 1177 * \since This function is available since SDL 3.2.0. 1178 * 1179 * \sa SDL_CreateWindowAndRenderer 1180 * \sa SDL_CreatePopupWindow 1181 * \sa SDL_CreateWindowWithProperties 1182 * \sa SDL_DestroyWindow 1183 */ 1184extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title, int w, int h, SDL_WindowFlags flags); 1185 1186/** 1187 * Create a child popup window of the specified parent window. 1188 * 1189 * The window size is a request and may be different than expected based on 1190 * the desktop layout and window manager policies. Your application should be 1191 * prepared to handle a window of any size. 1192 * 1193 * The flags parameter **must** contain at least one of the following: 1194 * 1195 * - `SDL_WINDOW_TOOLTIP`: The popup window is a tooltip and will not pass any 1196 * input events. 1197 * - `SDL_WINDOW_POPUP_MENU`: The popup window is a popup menu. The topmost 1198 * popup menu will implicitly gain the keyboard focus. 1199 * 1200 * The following flags are not relevant to popup window creation and will be 1201 * ignored: 1202 * 1203 * - `SDL_WINDOW_MINIMIZED` 1204 * - `SDL_WINDOW_MAXIMIZED` 1205 * - `SDL_WINDOW_FULLSCREEN` 1206 * - `SDL_WINDOW_BORDERLESS` 1207 * 1208 * The following flags are incompatible with popup window creation and will 1209 * cause it to fail: 1210 * 1211 * - `SDL_WINDOW_UTILITY` 1212 * - `SDL_WINDOW_MODAL` 1213 * 1214 * The parent parameter **must** be non-null and a valid window. The parent of 1215 * a popup window can be either a regular, toplevel window, or another popup 1216 * window. 1217 * 1218 * Popup windows cannot be minimized, maximized, made fullscreen, raised, 1219 * flash, be made a modal window, be the parent of a toplevel window, or grab 1220 * the mouse and/or keyboard. Attempts to do so will fail. 1221 * 1222 * Popup windows implicitly do not have a border/decorations and do not appear 1223 * on the taskbar/dock or in lists of windows such as alt-tab menus. 1224 * 1225 * By default, popup window positions will automatically be constrained to 1226 * keep the entire window within display bounds. This can be overridden with 1227 * the `SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN` property. 1228 * 1229 * By default, popup menus will automatically grab keyboard focus from the 1230 * parent when shown. This behavior can be overridden by setting the 1231 * `SDL_WINDOW_NOT_FOCUSABLE` flag, setting the 1232 * `SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN` property to false, or toggling 1233 * it after creation via the `SDL_SetWindowFocusable()` function. 1234 * 1235 * If a parent window is hidden or destroyed, any child popup windows will be 1236 * recursively hidden or destroyed as well. Child popup windows not explicitly 1237 * hidden will be restored when the parent is shown. 1238 * 1239 * \param parent the parent of the window, must not be NULL. 1240 * \param offset_x the x position of the popup window relative to the origin 1241 * of the parent. 1242 * \param offset_y the y position of the popup window relative to the origin 1243 * of the parent window. 1244 * \param w the width of the window. 1245 * \param h the height of the window. 1246 * \param flags SDL_WINDOW_TOOLTIP or SDL_WINDOW_POPUP_MENU, and zero or more 1247 * additional SDL_WindowFlags OR'd together. 1248 * \returns the window that was created or NULL on failure; call 1249 * SDL_GetError() for more information. 1250 * 1251 * \threadsafety This function should only be called on the main thread. 1252 * 1253 * \since This function is available since SDL 3.2.0. 1254 * 1255 * \sa SDL_CreateWindow 1256 * \sa SDL_CreateWindowWithProperties 1257 * \sa SDL_DestroyWindow 1258 * \sa SDL_GetWindowParent 1259 */ 1260extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreatePopupWindow(SDL_Window *parent, int offset_x, int offset_y, int w, int h, SDL_WindowFlags flags); 1261 1262/** 1263 * Create a window with the specified properties. 1264 * 1265 * The window size is a request and may be different than expected based on 1266 * the desktop layout and window manager policies. Your application should be 1267 * prepared to handle a window of any size. 1268 * 1269 * These are the supported properties: 1270 * 1271 * - `SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN`: true if the window should 1272 * be always on top 1273 * - `SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN`: true if the window has no 1274 * window decoration 1275 * - `SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN`: true if the "tooltip" 1276 * and "menu" window types should be automatically constrained to be 1277 * entirely within display bounds (default), false if no constraints on the 1278 * position are desired. 1279 * - `SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN`: true if the 1280 * window will be used with an externally managed graphics context. 1281 * - `SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN`: true if the window should 1282 * accept keyboard input (defaults true) 1283 * - `SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN`: true if the window should 1284 * start in fullscreen mode at desktop resolution 1285 * - `SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER`: the height of the window 1286 * - `SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN`: true if the window should start 1287 * hidden 1288 * - `SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN`: true if the window 1289 * uses a high pixel density buffer if possible 1290 * - `SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN`: true if the window should 1291 * start maximized 1292 * - `SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN`: true if the window is a popup menu 1293 * - `SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN`: true if the window will be used 1294 * with Metal rendering 1295 * - `SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN`: true if the window should 1296 * start minimized 1297 * - `SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN`: true if the window is modal to 1298 * its parent 1299 * - `SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN`: true if the window starts 1300 * with grabbed mouse focus 1301 * - `SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN`: true if the window will be used 1302 * with OpenGL rendering 1303 * - `SDL_PROP_WINDOW_CREATE_PARENT_POINTER`: an SDL_Window that will be the 1304 * parent of this window, required for windows with the "tooltip", "menu", 1305 * and "modal" properties 1306 * - `SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN`: true if the window should be 1307 * resizable 1308 * - `SDL_PROP_WINDOW_CREATE_TITLE_STRING`: the title of the window, in UTF-8 1309 * encoding 1310 * - `SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN`: true if the window show 1311 * transparent in the areas with alpha of 0 1312 * - `SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN`: true if the window is a tooltip 1313 * - `SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN`: true if the window is a utility 1314 * window, not showing in the task bar and window list 1315 * - `SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN`: true if the window will be used 1316 * with Vulkan rendering 1317 * - `SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER`: the width of the window 1318 * - `SDL_PROP_WINDOW_CREATE_X_NUMBER`: the x position of the window, or 1319 * `SDL_WINDOWPOS_CENTERED`, defaults to `SDL_WINDOWPOS_UNDEFINED`. This is 1320 * relative to the parent for windows with the "tooltip" or "menu" property 1321 * set. 1322 * - `SDL_PROP_WINDOW_CREATE_Y_NUMBER`: the y position of the window, or 1323 * `SDL_WINDOWPOS_CENTERED`, defaults to `SDL_WINDOWPOS_UNDEFINED`. This is 1324 * relative to the parent for windows with the "tooltip" or "menu" property 1325 * set. 1326 * 1327 * These are additional supported properties on macOS: 1328 * 1329 * - `SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER`: the 1330 * `(__unsafe_unretained)` NSWindow associated with the window, if you want 1331 * to wrap an existing window. 1332 * - `SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER`: the `(__unsafe_unretained)` 1333 * NSView associated with the window, defaults to `[window contentView]` 1334 * 1335 * These are additional supported properties on iOS, tvOS, and visionOS: 1336 * 1337 * - `SDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER`: the `(__unsafe_unretained)` 1338 * UIWindowScene associated with the window, defaults to the active window 1339 * scene. 1340 * 1341 * These are additional supported properties on Wayland: 1342 * 1343 * - `SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN` - true if 1344 * the application wants to use the Wayland surface for a custom role and 1345 * does not want it attached to an XDG toplevel window. See 1346 * [README-wayland](README-wayland) for more information on using custom 1347 * surfaces. 1348 * - `SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN` - true if the 1349 * application wants an associated `wl_egl_window` object to be created and 1350 * attached to the window, even if the window does not have the OpenGL 1351 * property or `SDL_WINDOW_OPENGL` flag set. 1352 * - `SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER` - the wl_surface 1353 * associated with the window, if you want to wrap an existing window. See 1354 * [README-wayland](README-wayland) for more information. 1355 * 1356 * These are additional supported properties on Windows: 1357 * 1358 * - `SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER`: the HWND associated with the 1359 * window, if you want to wrap an existing window. 1360 * - `SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER`: optional, 1361 * another window to share pixel format with, useful for OpenGL windows 1362 * 1363 * These are additional supported properties with X11: 1364 * 1365 * - `SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER`: the X11 Window associated 1366 * with the window, if you want to wrap an existing window. 1367 * 1368 * The window is implicitly shown if the "hidden" property is not set. 1369 * 1370 * These are additional supported properties with Emscripten: 1371 * 1372 * - `SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING`: the id given to the 1373 * canvas element. This should start with a '#' sign 1374 * - `SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING`: override the 1375 * binding element for keyboard inputs for this canvas. The variable can be 1376 * one of: 1377 * - "#window": the javascript window object (default) 1378 * - "#document": the javascript document object 1379 * - "#screen": the javascript window.screen object 1380 * - "#canvas": the WebGL canvas element 1381 * - "#none": Don't bind anything at all 1382 * - any other string without a leading # sign applies to the element on the 1383 * page with that ID. Windows with the "tooltip" and "menu" properties are 1384 * popup windows and have the behaviors and guidelines outlined in 1385 * SDL_CreatePopupWindow(). 1386 * 1387 * If this window is being created to be used with an SDL_Renderer, you should 1388 * not add a graphics API specific property 1389 * (`SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN`, etc), as SDL will handle that 1390 * internally when it chooses a renderer. However, SDL might need to recreate 1391 * your window at that point, which may cause the window to appear briefly, 1392 * and then flicker as it is recreated. The correct approach to this is to 1393 * create the window with the `SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN` property 1394 * set to true, then create the renderer, then show the window with 1395 * SDL_ShowWindow(). 1396 * 1397 * \param props the properties to use. 1398 * \returns the window that was created or NULL on failure; call 1399 * SDL_GetError() for more information. 1400 * 1401 * \threadsafety This function should only be called on the main thread. 1402 * 1403 * \since This function is available since SDL 3.2.0. 1404 * 1405 * \sa SDL_CreateProperties 1406 * \sa SDL_CreateWindow 1407 * \sa SDL_DestroyWindow 1408 */ 1409extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowWithProperties(SDL_PropertiesID props); 1410 1411#define SDL_PROP_WINDOW_CREATE_ALWAYS_ON_TOP_BOOLEAN "SDL.window.create.always_on_top" 1412#define SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN "SDL.window.create.borderless" 1413#define SDL_PROP_WINDOW_CREATE_CONSTRAIN_POPUP_BOOLEAN "SDL.window.create.constrain_popup" 1414#define SDL_PROP_WINDOW_CREATE_FOCUSABLE_BOOLEAN "SDL.window.create.focusable" 1415#define SDL_PROP_WINDOW_CREATE_EXTERNAL_GRAPHICS_CONTEXT_BOOLEAN "SDL.window.create.external_graphics_context" 1416#define SDL_PROP_WINDOW_CREATE_FLAGS_NUMBER "SDL.window.create.flags" 1417#define SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN "SDL.window.create.fullscreen" 1418#define SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER "SDL.window.create.height" 1419#define SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN "SDL.window.create.hidden" 1420#define SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN "SDL.window.create.high_pixel_density" 1421#define SDL_PROP_WINDOW_CREATE_MAXIMIZED_BOOLEAN "SDL.window.create.maximized" 1422#define SDL_PROP_WINDOW_CREATE_MENU_BOOLEAN "SDL.window.create.menu" 1423#define SDL_PROP_WINDOW_CREATE_METAL_BOOLEAN "SDL.window.create.metal" 1424#define SDL_PROP_WINDOW_CREATE_MINIMIZED_BOOLEAN "SDL.window.create.minimized" 1425#define SDL_PROP_WINDOW_CREATE_MODAL_BOOLEAN "SDL.window.create.modal" 1426#define SDL_PROP_WINDOW_CREATE_MOUSE_GRABBED_BOOLEAN "SDL.window.create.mouse_grabbed" 1427#define SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN "SDL.window.create.opengl" 1428#define SDL_PROP_WINDOW_CREATE_PARENT_POINTER "SDL.window.create.parent" 1429#define SDL_PROP_WINDOW_CREATE_RESIZABLE_BOOLEAN "SDL.window.create.resizable" 1430#define SDL_PROP_WINDOW_CREATE_TITLE_STRING "SDL.window.create.title" 1431#define SDL_PROP_WINDOW_CREATE_TRANSPARENT_BOOLEAN "SDL.window.create.transparent" 1432#define SDL_PROP_WINDOW_CREATE_TOOLTIP_BOOLEAN "SDL.window.create.tooltip" 1433#define SDL_PROP_WINDOW_CREATE_UTILITY_BOOLEAN "SDL.window.create.utility" 1434#define SDL_PROP_WINDOW_CREATE_VULKAN_BOOLEAN "SDL.window.create.vulkan" 1435#define SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER "SDL.window.create.width" 1436#define SDL_PROP_WINDOW_CREATE_X_NUMBER "SDL.window.create.x" 1437#define SDL_PROP_WINDOW_CREATE_Y_NUMBER "SDL.window.create.y" 1438#define SDL_PROP_WINDOW_CREATE_COCOA_WINDOW_POINTER "SDL.window.create.cocoa.window" 1439#define SDL_PROP_WINDOW_CREATE_COCOA_VIEW_POINTER "SDL.window.create.cocoa.view" 1440#define SDL_PROP_WINDOW_CREATE_WINDOWSCENE_POINTER "SDL.window.create.uikit.windowscene" 1441#define SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN "SDL.window.create.wayland.surface_role_custom" 1442#define SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN "SDL.window.create.wayland.create_egl_window" 1443#define SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER "SDL.window.create.wayland.wl_surface" 1444#define SDL_PROP_WINDOW_CREATE_WIN32_HWND_POINTER "SDL.window.create.win32.hwnd" 1445#define SDL_PROP_WINDOW_CREATE_WIN32_PIXEL_FORMAT_HWND_POINTER "SDL.window.create.win32.pixel_format_hwnd" 1446#define SDL_PROP_WINDOW_CREATE_X11_WINDOW_NUMBER "SDL.window.create.x11.window" 1447#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_CANVAS_ID_STRING "SDL.window.create.emscripten.canvas_id" 1448#define SDL_PROP_WINDOW_CREATE_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING "SDL.window.create.emscripten.keyboard_element" 1449 1450/** 1451 * Get the numeric ID of a window. 1452 * 1453 * The numeric ID is what SDL_WindowEvent references, and is necessary to map 1454 * these events to specific SDL_Window objects. 1455 * 1456 * \param window the window to query. 1457 * \returns the ID of the window on success or 0 on failure; call 1458 * SDL_GetError() for more information. 1459 * 1460 * \threadsafety This function should only be called on the main thread. 1461 * 1462 * \since This function is available since SDL 3.2.0. 1463 * 1464 * \sa SDL_GetWindowFromID 1465 */ 1466extern SDL_DECLSPEC SDL_WindowID SDLCALL SDL_GetWindowID(SDL_Window *window); 1467 1468/** 1469 * Get a window from a stored ID. 1470 * 1471 * The numeric ID is what SDL_WindowEvent references, and is necessary to map 1472 * these events to specific SDL_Window objects. 1473 * 1474 * \param id the ID of the window. 1475 * \returns the window associated with `id` or NULL if it doesn't exist; call 1476 * SDL_GetError() for more information. 1477 * 1478 * \threadsafety This function should only be called on the main thread. 1479 * 1480 * \since This function is available since SDL 3.2.0. 1481 * 1482 * \sa SDL_GetWindowID 1483 */ 1484extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(SDL_WindowID id); 1485 1486/** 1487 * Get parent of a window. 1488 * 1489 * \param window the window to query. 1490 * \returns the parent of the window on success or NULL if the window has no 1491 * parent. 1492 * 1493 * \threadsafety This function should only be called on the main thread. 1494 * 1495 * \since This function is available since SDL 3.2.0. 1496 * 1497 * \sa SDL_CreatePopupWindow 1498 */ 1499extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetWindowParent(SDL_Window *window); 1500 1501/** 1502 * Get the properties associated with a window. 1503 * 1504 * The following read-only properties are provided by SDL: 1505 * 1506 * - `SDL_PROP_WINDOW_SHAPE_POINTER`: the surface associated with a shaped 1507 * window 1508 * - `SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN`: true if the window has HDR 1509 * headroom above the SDR white point. This property can change dynamically 1510 * when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent. 1511 * - `SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT`: the value of SDR white in the 1512 * SDL_COLORSPACE_SRGB_LINEAR colorspace. On Windows this corresponds to the 1513 * SDR white level in scRGB colorspace, and on Apple platforms this is 1514 * always 1.0 for EDR content. This property can change dynamically when 1515 * SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent. 1516 * - `SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT`: the additional high dynamic range 1517 * that can be displayed, in terms of the SDR white point. When HDR is not 1518 * enabled, this will be 1.0. This property can change dynamically when 1519 * SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent. 1520 * 1521 * On Android: 1522 * 1523 * - `SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER`: the ANativeWindow associated 1524 * with the window 1525 * - `SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER`: the EGLSurface associated with 1526 * the window 1527 * 1528 * On iOS: 1529 * 1530 * - `SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER`: the `(__unsafe_unretained)` 1531 * UIWindow associated with the window 1532 * - `SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER`: the NSInteger tag 1533 * associated with metal views on the window 1534 * - `SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER`: the OpenGL view's 1535 * framebuffer object. It must be bound when rendering to the screen using 1536 * OpenGL. 1537 * - `SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER`: the OpenGL view's 1538 * renderbuffer object. It must be bound when SDL_GL_SwapWindow is called. 1539 * - `SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER`: the OpenGL 1540 * view's resolve framebuffer, when MSAA is used. 1541 * 1542 * On KMS/DRM: 1543 * 1544 * - `SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER`: the device index associated 1545 * with the window (e.g. the X in /dev/dri/cardX) 1546 * - `SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER`: the DRM FD associated with the 1547 * window 1548 * - `SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER`: the GBM device associated 1549 * with the window 1550 * 1551 * On macOS: 1552 * 1553 * - `SDL_PROP_WINDOW_COCOA_WINDOW_POINTER`: the `(__unsafe_unretained)` 1554 * NSWindow associated with the window 1555 * - `SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER`: the NSInteger tag 1556 * associated with metal views on the window 1557 * 1558 * On OpenVR: 1559 * 1560 * - `SDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER`: the OpenVR Overlay Handle ID 1561 * for the associated overlay window. 1562 * 1563 * On QNX: 1564 * 1565 * - `SDL_PROP_WINDOW_QNX_WINDOW_POINTER`: the screen_window_t associated with 1566 * the window. 1567 * - `SDL_PROP_WINDOW_QNX_SURFACE_POINTER`: the EGLSurface associated with the 1568 * window 1569 * 1570 * On Vivante: 1571 * 1572 * - `SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER`: the EGLNativeDisplayType 1573 * associated with the window 1574 * - `SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER`: the EGLNativeWindowType 1575 * associated with the window 1576 * - `SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER`: the EGLSurface associated with 1577 * the window 1578 * 1579 * On Windows: 1580 * 1581 * - `SDL_PROP_WINDOW_WIN32_HWND_POINTER`: the HWND associated with the window 1582 * - `SDL_PROP_WINDOW_WIN32_HDC_POINTER`: the HDC associated with the window 1583 * - `SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER`: the HINSTANCE associated with 1584 * the window 1585 * 1586 * On Wayland: 1587 * 1588 * Note: The `xdg_*` window objects do not internally persist across window 1589 * show/hide calls. They will be null if the window is hidden and must be 1590 * queried each time it is shown. 1591 * 1592 * - `SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER`: the wl_display associated with 1593 * the window 1594 * - `SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER`: the wl_surface associated with 1595 * the window 1596 * - `SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER`: the wp_viewport associated 1597 * with the window 1598 * - `SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER`: the wl_egl_window 1599 * associated with the window 1600 * - `SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER`: the xdg_surface associated 1601 * with the window 1602 * - `SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER`: the xdg_toplevel role 1603 * associated with the window 1604 * - 'SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING': the export 1605 * handle associated with the window 1606 * - `SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER`: the xdg_popup role 1607 * associated with the window 1608 * - `SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER`: the xdg_positioner 1609 * associated with the window, in popup mode 1610 * 1611 * On X11: 1612 * 1613 * - `SDL_PROP_WINDOW_X11_DISPLAY_POINTER`: the X11 Display associated with 1614 * the window 1615 * - `SDL_PROP_WINDOW_X11_SCREEN_NUMBER`: the screen number associated with 1616 * the window 1617 * - `SDL_PROP_WINDOW_X11_WINDOW_NUMBER`: the X11 Window associated with the 1618 * window 1619 * 1620 * On Emscripten: 1621 * 1622 * - `SDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING`: the id the canvas element 1623 * will have 1624 * - `SDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING`: the keyboard 1625 * element that associates keyboard events to this window 1626 * 1627 * \param window the window to query. 1628 * \returns a valid property ID on success or 0 on failure; call 1629 * SDL_GetError() for more information. 1630 * 1631 * \threadsafety This function should only be called on the main thread. 1632 * 1633 * \since This function is available since SDL 3.2.0. 1634 */ 1635extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetWindowProperties(SDL_Window *window); 1636 1637#define SDL_PROP_WINDOW_SHAPE_POINTER "SDL.window.shape" 1638#define SDL_PROP_WINDOW_HDR_ENABLED_BOOLEAN "SDL.window.HDR_enabled" 1639#define SDL_PROP_WINDOW_SDR_WHITE_LEVEL_FLOAT "SDL.window.SDR_white_level" 1640#define SDL_PROP_WINDOW_HDR_HEADROOM_FLOAT "SDL.window.HDR_headroom" 1641#define SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER "SDL.window.android.window" 1642#define SDL_PROP_WINDOW_ANDROID_SURFACE_POINTER "SDL.window.android.surface" 1643#define SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER "SDL.window.uikit.window" 1644#define SDL_PROP_WINDOW_UIKIT_METAL_VIEW_TAG_NUMBER "SDL.window.uikit.metal_view_tag" 1645#define SDL_PROP_WINDOW_UIKIT_OPENGL_FRAMEBUFFER_NUMBER "SDL.window.uikit.opengl.framebuffer" 1646#define SDL_PROP_WINDOW_UIKIT_OPENGL_RENDERBUFFER_NUMBER "SDL.window.uikit.opengl.renderbuffer" 1647#define SDL_PROP_WINDOW_UIKIT_OPENGL_RESOLVE_FRAMEBUFFER_NUMBER "SDL.window.uikit.opengl.resolve_framebuffer" 1648#define SDL_PROP_WINDOW_KMSDRM_DEVICE_INDEX_NUMBER "SDL.window.kmsdrm.dev_index" 1649#define SDL_PROP_WINDOW_KMSDRM_DRM_FD_NUMBER "SDL.window.kmsdrm.drm_fd" 1650#define SDL_PROP_WINDOW_KMSDRM_GBM_DEVICE_POINTER "SDL.window.kmsdrm.gbm_dev" 1651#define SDL_PROP_WINDOW_COCOA_WINDOW_POINTER "SDL.window.cocoa.window" 1652#define SDL_PROP_WINDOW_COCOA_METAL_VIEW_TAG_NUMBER "SDL.window.cocoa.metal_view_tag" 1653#define SDL_PROP_WINDOW_OPENVR_OVERLAY_ID_NUMBER "SDL.window.openvr.overlay_id" 1654#define SDL_PROP_WINDOW_QNX_WINDOW_POINTER "SDL.window.qnx.window" 1655#define SDL_PROP_WINDOW_QNX_SURFACE_POINTER "SDL.window.qnx.surface" 1656#define SDL_PROP_WINDOW_VIVANTE_DISPLAY_POINTER "SDL.window.vivante.display" 1657#define SDL_PROP_WINDOW_VIVANTE_WINDOW_POINTER "SDL.window.vivante.window" 1658#define SDL_PROP_WINDOW_VIVANTE_SURFACE_POINTER "SDL.window.vivante.surface" 1659#define SDL_PROP_WINDOW_WIN32_HWND_POINTER "SDL.window.win32.hwnd" 1660#define SDL_PROP_WINDOW_WIN32_HDC_POINTER "SDL.window.win32.hdc" 1661#define SDL_PROP_WINDOW_WIN32_INSTANCE_POINTER "SDL.window.win32.instance" 1662#define SDL_PROP_WINDOW_WAYLAND_DISPLAY_POINTER "SDL.window.wayland.display" 1663#define SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER "SDL.window.wayland.surface" 1664#define SDL_PROP_WINDOW_WAYLAND_VIEWPORT_POINTER "SDL.window.wayland.viewport" 1665#define SDL_PROP_WINDOW_WAYLAND_EGL_WINDOW_POINTER "SDL.window.wayland.egl_window" 1666#define SDL_PROP_WINDOW_WAYLAND_XDG_SURFACE_POINTER "SDL.window.wayland.xdg_surface" 1667#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER "SDL.window.wayland.xdg_toplevel" 1668#define SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_EXPORT_HANDLE_STRING "SDL.window.wayland.xdg_toplevel_export_handle" 1669#define SDL_PROP_WINDOW_WAYLAND_XDG_POPUP_POINTER "SDL.window.wayland.xdg_popup" 1670#define SDL_PROP_WINDOW_WAYLAND_XDG_POSITIONER_POINTER "SDL.window.wayland.xdg_positioner" 1671#define SDL_PROP_WINDOW_X11_DISPLAY_POINTER "SDL.window.x11.display" 1672#define SDL_PROP_WINDOW_X11_SCREEN_NUMBER "SDL.window.x11.screen" 1673#define SDL_PROP_WINDOW_X11_WINDOW_NUMBER "SDL.window.x11.window" 1674#define SDL_PROP_WINDOW_EMSCRIPTEN_CANVAS_ID_STRING "SDL.window.emscripten.canvas_id" 1675#define SDL_PROP_WINDOW_EMSCRIPTEN_KEYBOARD_ELEMENT_STRING "SDL.window.emscripten.keyboard_element" 1676 1677/** 1678 * Get the window flags. 1679 * 1680 * \param window the window to query. 1681 * \returns a mask of the SDL_WindowFlags associated with `window`. 1682 * 1683 * \threadsafety This function should only be called on the main thread. 1684 * 1685 * \since This function is available since SDL 3.2.0. 1686 * 1687 * \sa SDL_CreateWindow 1688 * \sa SDL_HideWindow 1689 * \sa SDL_MaximizeWindow 1690 * \sa SDL_MinimizeWindow 1691 * \sa SDL_SetWindowFullscreen 1692 * \sa SDL_SetWindowMouseGrab 1693 * \sa SDL_SetWindowFillDocument 1694 * \sa SDL_ShowWindow 1695 */ 1696extern SDL_DECLSPEC SDL_WindowFlags SDLCALL SDL_GetWindowFlags(SDL_Window *window); 1697 1698/** 1699 * Set the title of a window. 1700 * 1701 * This string is expected to be in UTF-8 encoding. 1702 * 1703 * \param window the window to change. 1704 * \param title the desired window title in UTF-8 format. 1705 * \returns true on success or false on failure; call SDL_GetError() for more 1706 * information. 1707 * 1708 * \threadsafety This function should only be called on the main thread. 1709 * 1710 * \since This function is available since SDL 3.2.0. 1711 * 1712 * \sa SDL_GetWindowTitle 1713 */ 1714extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowTitle(SDL_Window *window, const char *title); 1715 1716/** 1717 * Get the title of a window. 1718 * 1719 * \param window the window to query. 1720 * \returns the title of the window in UTF-8 format or "" if there is no 1721 * title. 1722 * 1723 * \threadsafety This function should only be called on the main thread. 1724 * 1725 * \since This function is available since SDL 3.2.0. 1726 * 1727 * \sa SDL_SetWindowTitle 1728 */ 1729extern SDL_DECLSPEC const char * SDLCALL SDL_GetWindowTitle(SDL_Window *window); 1730 1731/** 1732 * Set the icon for a window. 1733 * 1734 * If this function is passed a surface with alternate representations added 1735 * using SDL_AddSurfaceAlternateImage(), the surface will be interpreted as 1736 * the content to be used for 100% display scale, and the alternate 1737 * representations will be used for high DPI situations. For example, if the 1738 * original surface is 32x32, then on a 2x macOS display or 200% display scale 1739 * on Windows, a 64x64 version of the image will be used, if available. If a 1740 * matching version of the image isn't available, the closest larger size 1741 * image will be downscaled to the appropriate size and be used instead, if 1742 * available. Otherwise, the closest smaller image will be upscaled and be 1743 * used instead. 1744 * 1745 * \param window the window to change. 1746 * \param icon an SDL_Surface structure containing the icon for the window. 1747 * \returns true on success or false on failure; call SDL_GetError() for more 1748 * information. 1749 * 1750 * \threadsafety This function should only be called on the main thread. 1751 * 1752 * \since This function is available since SDL 3.2.0. 1753 * 1754 * \sa SDL_AddSurfaceAlternateImage 1755 */ 1756extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon); 1757 1758/** 1759 * Request that the window's position be set. 1760 * 1761 * If the window is in an exclusive fullscreen or maximized state, this 1762 * request has no effect. 1763 * 1764 * This can be used to reposition fullscreen-desktop windows onto a different 1765 * display, however, as exclusive fullscreen windows are locked to a specific 1766 * display, they can only be repositioned programmatically via 1767 * SDL_SetWindowFullscreenMode(). 1768 * 1769 * On some windowing systems this request is asynchronous and the new 1770 * coordinates may not have have been applied immediately upon the return of 1771 * this function. If an immediate change is required, call SDL_SyncWindow() to 1772 * block until the changes have taken effect. 1773 * 1774 * When the window position changes, an SDL_EVENT_WINDOW_MOVED event will be 1775 * emitted with the window's new coordinates. Note that the new coordinates 1776 * may not match the exact coordinates requested, as some windowing systems 1777 * can restrict the position of the window in certain scenarios (e.g. 1778 * constraining the position so the window is always within desktop bounds). 1779 * Additionally, as this is just a request, it can be denied by the windowing 1780 * system. 1781 * 1782 * \param window the window to reposition. 1783 * \param x the x coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or 1784 * `SDL_WINDOWPOS_UNDEFINED`. 1785 * \param y the y coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or 1786 * `SDL_WINDOWPOS_UNDEFINED`. 1787 * \returns true on success or false on failure; call SDL_GetError() for more 1788 * information. 1789 * 1790 * \threadsafety This function should only be called on the main thread. 1791 * 1792 * \since This function is available since SDL 3.2.0. 1793 * 1794 * \sa SDL_GetWindowPosition 1795 * \sa SDL_SyncWindow 1796 */ 1797extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowPosition(SDL_Window *window, int x, int y); 1798 1799/** 1800 * Get the position of a window. 1801 * 1802 * This is the current position of the window as last reported by the 1803 * windowing system. 1804 * 1805 * If you do not need the value for one of the positions a NULL may be passed 1806 * in the `x` or `y` parameter. 1807 * 1808 * \param window the window to query. 1809 * \param x a pointer filled in with the x position of the window, may be 1810 * NULL. 1811 * \param y a pointer filled in with the y position of the window, may be 1812 * NULL. 1813 * \returns true on success or false on failure; call SDL_GetError() for more 1814 * information. 1815 * 1816 * \threadsafety This function should only be called on the main thread. 1817 * 1818 * \since This function is available since SDL 3.2.0. 1819 * 1820 * \sa SDL_SetWindowPosition 1821 */ 1822extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowPosition(SDL_Window *window, int *x, int *y); 1823 1824/** 1825 * Request that the size of a window's client area be set. 1826 * 1827 * If the window is in a fullscreen or maximized state, this request has no 1828 * effect. 1829 * 1830 * To change the exclusive fullscreen mode of a window, use 1831 * SDL_SetWindowFullscreenMode(). 1832 * 1833 * On some windowing systems, this request is asynchronous and the new window 1834 * size may not have have been applied immediately upon the return of this 1835 * function. If an immediate change is required, call SDL_SyncWindow() to 1836 * block until the changes have taken effect. 1837 * 1838 * When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will be 1839 * emitted with the new window dimensions. Note that the new dimensions may 1840 * not match the exact size requested, as some windowing systems can restrict 1841 * the window size in certain scenarios (e.g. constraining the size of the 1842 * content area to remain within the usable desktop bounds). Additionally, as 1843 * this is just a request, it can be denied by the windowing system. 1844 * 1845 * \param window the window to change. 1846 * \param w the width of the window, must be > 0. 1847 * \param h the height of the window, must be > 0. 1848 * \returns true on success or false on failure; call SDL_GetError() for more 1849 * information. 1850 * 1851 * \threadsafety This function should only be called on the main thread. 1852 * 1853 * \since This function is available since SDL 3.2.0. 1854 * 1855 * \sa SDL_GetWindowSize 1856 * \sa SDL_SetWindowFullscreenMode 1857 * \sa SDL_SyncWindow 1858 */ 1859extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSize(SDL_Window *window, int w, int h); 1860 1861/** 1862 * Get the size of a window's client area. 1863 * 1864 * The window pixel size may differ from its window coordinate size if the 1865 * window is on a high pixel density display. Use SDL_GetWindowSizeInPixels() 1866 * or SDL_GetRenderOutputSize() to get the real client area size in pixels. 1867 * 1868 * \param window the window to query the width and height from. 1869 * \param w a pointer filled in with the width of the window, may be NULL. 1870 * \param h a pointer filled in with the height of the window, may be NULL. 1871 * \returns true on success or false on failure; call SDL_GetError() for more 1872 * information. 1873 * 1874 * \threadsafety This function should only be called on the main thread. 1875 * 1876 * \since This function is available since SDL 3.2.0. 1877 * 1878 * \sa SDL_GetRenderOutputSize 1879 * \sa SDL_GetWindowSizeInPixels 1880 * \sa SDL_SetWindowSize 1881 * \sa SDL_EVENT_WINDOW_RESIZED 1882 */ 1883extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSize(SDL_Window *window, int *w, int *h); 1884 1885/** 1886 * Get the safe area for this window. 1887 * 1888 * Some devices have portions of the screen which are partially obscured or 1889 * not interactive, possibly due to on-screen controls, curved edges, camera 1890 * notches, TV overscan, etc. This function provides the area of the window 1891 * which is safe to have interactable content. You should continue rendering 1892 * into the rest of the window, but it should not contain visually important 1893 * or interactable content. 1894 * 1895 * \param window the window to query. 1896 * \param rect a pointer filled in with the client area that is safe for 1897 * interactive content. 1898 * \returns true on success or false on failure; call SDL_GetError() for more 1899 * information. 1900 * 1901 * \threadsafety This function should only be called on the main thread. 1902 * 1903 * \since This function is available since SDL 3.2.0. 1904 */ 1905extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSafeArea(SDL_Window *window, SDL_Rect *rect); 1906 1907/** 1908 * Request that the aspect ratio of a window's client area be set. 1909 * 1910 * The aspect ratio is the ratio of width divided by height, e.g. 2560x1600 1911 * would be 1.6. Larger aspect ratios are wider and smaller aspect ratios are 1912 * narrower. 1913 * 1914 * If, at the time of this request, the window in a fixed-size state, such as 1915 * maximized or fullscreen, the request will be deferred until the window 1916 * exits this state and becomes resizable again. 1917 * 1918 * On some windowing systems, this request is asynchronous and the new window 1919 * aspect ratio may not have have been applied immediately upon the return of 1920 * this function. If an immediate change is required, call SDL_SyncWindow() to 1921 * block until the changes have taken effect. 1922 * 1923 * When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will be 1924 * emitted with the new window dimensions. Note that the new dimensions may 1925 * not match the exact aspect ratio requested, as some windowing systems can 1926 * restrict the window size in certain scenarios (e.g. constraining the size 1927 * of the content area to remain within the usable desktop bounds). 1928 * Additionally, as this is just a request, it can be denied by the windowing 1929 * system. 1930 * 1931 * \param window the window to change. 1932 * \param min_aspect the minimum aspect ratio of the window, or 0.0f for no 1933 * limit. 1934 * \param max_aspect the maximum aspect ratio of the window, or 0.0f for no 1935 * limit. 1936 * \returns true on success or false on failure; call SDL_GetError() for more 1937 * information. 1938 * 1939 * \threadsafety This function should only be called on the main thread. 1940 * 1941 * \since This function is available since SDL 3.2.0. 1942 * 1943 * \sa SDL_GetWindowAspectRatio 1944 * \sa SDL_SyncWindow 1945 */ 1946extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAspectRatio(SDL_Window *window, float min_aspect, float max_aspect); 1947 1948/** 1949 * Get the aspect ratio of a window's client area. 1950 * 1951 * \param window the window to query the width and height from. 1952 * \param min_aspect a pointer filled in with the minimum aspect ratio of the 1953 * window, may be NULL. 1954 * \param max_aspect a pointer filled in with the maximum aspect ratio of the 1955 * window, may be NULL. 1956 * \returns true on success or false on failure; call SDL_GetError() for more 1957 * information. 1958 * 1959 * \threadsafety This function should only be called on the main thread. 1960 * 1961 * \since This function is available since SDL 3.2.0. 1962 * 1963 * \sa SDL_SetWindowAspectRatio 1964 */ 1965extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowAspectRatio(SDL_Window *window, float *min_aspect, float *max_aspect); 1966 1967/** 1968 * Get the size of a window's borders (decorations) around the client area. 1969 * 1970 * Note: If this function fails (returns false), the size values will be 1971 * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the 1972 * window in question was borderless. 1973 * 1974 * Note: This function may fail on systems where the window has not yet been 1975 * decorated by the display server (for example, immediately after calling 1976 * SDL_CreateWindow). It is recommended that you wait at least until the 1977 * window has been presented and composited, so that the window system has a 1978 * chance to decorate the window and provide the border dimensions to SDL. 1979 * 1980 * This function also returns false if getting the information is not 1981 * supported. 1982 * 1983 * \param window the window to query the size values of the border 1984 * (decorations) from. 1985 * \param top pointer to variable for storing the size of the top border; NULL 1986 * is permitted. 1987 * \param left pointer to variable for storing the size of the left border; 1988 * NULL is permitted. 1989 * \param bottom pointer to variable for storing the size of the bottom 1990 * border; NULL is permitted. 1991 * \param right pointer to variable for storing the size of the right border; 1992 * NULL is permitted. 1993 * \returns true on success or false on failure; call SDL_GetError() for more 1994 * information. 1995 * 1996 * \threadsafety This function should only be called on the main thread. 1997 * 1998 * \since This function is available since SDL 3.2.0. 1999 * 2000 * \sa SDL_GetWindowSize 2001 */ 2002extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right); 2003 2004/** 2005 * Get the size of a window's client area, in pixels. 2006 * 2007 * \param window the window from which the drawable size should be queried. 2008 * \param w a pointer to variable for storing the width in pixels, may be 2009 * NULL. 2010 * \param h a pointer to variable for storing the height in pixels, may be 2011 * NULL. 2012 * \returns true on success or false on failure; call SDL_GetError() for more 2013 * information. 2014 * 2015 * \threadsafety This function should only be called on the main thread. 2016 * 2017 * \since This function is available since SDL 3.2.0. 2018 * 2019 * \sa SDL_CreateWindow 2020 * \sa SDL_GetWindowSize 2021 */ 2022extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSizeInPixels(SDL_Window *window, int *w, int *h); 2023 2024/** 2025 * Set the minimum size of a window's client area. 2026 * 2027 * \param window the window to change. 2028 * \param min_w the minimum width of the window, or 0 for no limit. 2029 * \param min_h the minimum height of the window, or 0 for no limit. 2030 * \returns true on success or false on failure; call SDL_GetError() for more 2031 * information. 2032 * 2033 * \threadsafety This function should only be called on the main thread. 2034 * 2035 * \since This function is available since SDL 3.2.0. 2036 * 2037 * \sa SDL_GetWindowMinimumSize 2038 * \sa SDL_SetWindowMaximumSize 2039 */ 2040extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window, int min_w, int min_h); 2041 2042/** 2043 * Get the minimum size of a window's client area. 2044 * 2045 * \param window the window to query. 2046 * \param w a pointer filled in with the minimum width of the window, may be 2047 * NULL. 2048 * \param h a pointer filled in with the minimum height of the window, may be 2049 * NULL. 2050 * \returns true on success or false on failure; call SDL_GetError() for more 2051 * information. 2052 * 2053 * \threadsafety This function should only be called on the main thread. 2054 * 2055 * \since This function is available since SDL 3.2.0. 2056 * 2057 * \sa SDL_GetWindowMaximumSize 2058 * \sa SDL_SetWindowMinimumSize 2059 */ 2060extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window, int *w, int *h); 2061 2062/** 2063 * Set the maximum size of a window's client area. 2064 * 2065 * \param window the window to change. 2066 * \param max_w the maximum width of the window, or 0 for no limit. 2067 * \param max_h the maximum height of the window, or 0 for no limit. 2068 * \returns true on success or false on failure; call SDL_GetError() for more 2069 * information. 2070 * 2071 * \threadsafety This function should only be called on the main thread. 2072 * 2073 * \since This function is available since SDL 3.2.0. 2074 * 2075 * \sa SDL_GetWindowMaximumSize 2076 * \sa SDL_SetWindowMinimumSize 2077 */ 2078extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window, int max_w, int max_h); 2079 2080/** 2081 * Get the maximum size of a window's client area. 2082 * 2083 * \param window the window to query. 2084 * \param w a pointer filled in with the maximum width of the window, may be 2085 * NULL. 2086 * \param h a pointer filled in with the maximum height of the window, may be 2087 * NULL. 2088 * \returns true on success or false on failure; call SDL_GetError() for more 2089 * information. 2090 * 2091 * \threadsafety This function should only be called on the main thread. 2092 * 2093 * \since This function is available since SDL 3.2.0. 2094 * 2095 * \sa SDL_GetWindowMinimumSize 2096 * \sa SDL_SetWindowMaximumSize 2097 */ 2098extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window, int *w, int *h); 2099 2100/** 2101 * Set the border state of a window. 2102 * 2103 * This will add or remove the window's `SDL_WINDOW_BORDERLESS` flag and add 2104 * or remove the border from the actual window. This is a no-op if the 2105 * window's border already matches the requested state. 2106 * 2107 * You can't change the border state of a fullscreen window. 2108 * 2109 * \param window the window of which to change the border state. 2110 * \param bordered false to remove border, true to add border. 2111 * \returns true on success or false on failure; call SDL_GetError() for more 2112 * information. 2113 * 2114 * \threadsafety This function should only be called on the main thread. 2115 * 2116 * \since This function is available since SDL 3.2.0. 2117 * 2118 * \sa SDL_GetWindowFlags 2119 */ 2120extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowBordered(SDL_Window *window, bool bordered); 2121 2122/** 2123 * Set the user-resizable state of a window. 2124 * 2125 * This will add or remove the window's `SDL_WINDOW_RESIZABLE` flag and 2126 * allow/disallow user resizing of the window. This is a no-op if the window's 2127 * resizable state already matches the requested state. 2128 * 2129 * You can't change the resizable state of a fullscreen window. 2130 * 2131 * \param window the window of which to change the resizable state. 2132 * \param resizable true to allow resizing, false to disallow. 2133 * \returns true on success or false on failure; call SDL_GetError() for more 2134 * information. 2135 * 2136 * \threadsafety This function should only be called on the main thread. 2137 * 2138 * \since This function is available since SDL 3.2.0. 2139 * 2140 * \sa SDL_GetWindowFlags 2141 */ 2142extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowResizable(SDL_Window *window, bool resizable); 2143 2144/** 2145 * Set the window to always be above the others. 2146 * 2147 * This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP` flag. This 2148 * will bring the window to the front and keep the window above the rest. 2149 * 2150 * \param window the window of which to change the always on top state. 2151 * \param on_top true to set the window always on top, false to disable. 2152 * \returns true on success or false on failure; call SDL_GetError() for more 2153 * information. 2154 * 2155 * \threadsafety This function should only be called on the main thread. 2156 * 2157 * \since This function is available since SDL 3.2.0. 2158 * 2159 * \sa SDL_GetWindowFlags 2160 */ 2161extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window *window, bool on_top); 2162 2163/** 2164 * Set the window to fill the current document space (Emscripten only). 2165 * 2166 * This will add or remove the window's `SDL_WINDOW_FILL_DOCUMENT` flag. 2167 * 2168 * Currently this flag only applies to the Emscripten target. 2169 * 2170 * When enabled, the canvas element fills the entire document. Resize events 2171 * will be generated as the browser window is resized, as that will adjust the 2172 * canvas size as well. The canvas will cover anything else on the page, 2173 * including any controls provided by Emscripten in its generated HTML file 2174 * (in fact, any elements on the page that aren't the canvas will be moved 2175 * into a hidden `div` element). 2176 * 2177 * Often times this is desirable for a browser-based game, but it means 2178 * several things that we expect of an SDL window on other platforms might not 2179 * work as expected, such as minimum window sizes and aspect ratios. 2180 * 2181 * \param window the window of which to change the fill-document state. 2182 * \param fill true to set the window to fill the document, false to disable. 2183 * \returns true on success or false on failure; call SDL_GetError() for more 2184 * information. 2185 * 2186 * \threadsafety This function should only be called on the main thread. 2187 * 2188 * \since This function is available since SDL 3.4.0. 2189 * 2190 * \sa SDL_GetWindowFlags 2191 */ 2192extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFillDocument(SDL_Window *window, bool fill); 2193 2194/** 2195 * Show a window. 2196 * 2197 * \param window the window to show. 2198 * \returns true on success or false on failure; call SDL_GetError() for more 2199 * information. 2200 * 2201 * \threadsafety This function should only be called on the main thread. 2202 * 2203 * \since This function is available since SDL 3.2.0. 2204 * 2205 * \sa SDL_HideWindow 2206 * \sa SDL_RaiseWindow 2207 */ 2208extern SDL_DECLSPEC bool SDLCALL SDL_ShowWindow(SDL_Window *window); 2209 2210/** 2211 * Hide a window. 2212 * 2213 * \param window the window to hide. 2214 * \returns true on success or false on failure; call SDL_GetError() for more 2215 * information. 2216 * 2217 * \threadsafety This function should only be called on the main thread. 2218 * 2219 * \since This function is available since SDL 3.2.0. 2220 * 2221 * \sa SDL_ShowWindow 2222 * \sa SDL_WINDOW_HIDDEN 2223 */ 2224extern SDL_DECLSPEC bool SDLCALL SDL_HideWindow(SDL_Window *window); 2225 2226/** 2227 * Request that a window be raised above other windows and gain the input 2228 * focus. 2229 * 2230 * The result of this request is subject to desktop window manager policy, 2231 * particularly if raising the requested window would result in stealing focus 2232 * from another application. If the window is successfully raised and gains 2233 * input focus, an SDL_EVENT_WINDOW_FOCUS_GAINED event will be emitted, and 2234 * the window will have the SDL_WINDOW_INPUT_FOCUS flag set. 2235 * 2236 * \param window the window to raise. 2237 * \returns true on success or false on failure; call SDL_GetError() for more 2238 * information. 2239 * 2240 * \threadsafety This function should only be called on the main thread. 2241 * 2242 * \since This function is available since SDL 3.2.0. 2243 */ 2244extern SDL_DECLSPEC bool SDLCALL SDL_RaiseWindow(SDL_Window *window); 2245 2246/** 2247 * Request that the window be made as large as possible. 2248 * 2249 * Non-resizable windows can't be maximized. The window must have the 2250 * SDL_WINDOW_RESIZABLE flag set, or this will have no effect. 2251 * 2252 * On some windowing systems this request is asynchronous and the new window 2253 * state may not have have been applied immediately upon the return of this 2254 * function. If an immediate change is required, call SDL_SyncWindow() to 2255 * block until the changes have taken effect. 2256 * 2257 * When the window state changes, an SDL_EVENT_WINDOW_MAXIMIZED event will be 2258 * emitted. Note that, as this is just a request, the windowing system can 2259 * deny the state change. 2260 * 2261 * When maximizing a window, whether the constraints set via 2262 * SDL_SetWindowMaximumSize() are honored depends on the policy of the window 2263 * manager. Win32 and macOS enforce the constraints when maximizing, while X11 2264 * and Wayland window managers may vary. 2265 * 2266 * \param window the window to maximize. 2267 * \returns true on success or false on failure; call SDL_GetError() for more 2268 * information. 2269 * 2270 * \threadsafety This function should only be called on the main thread. 2271 * 2272 * \since This function is available since SDL 3.2.0. 2273 * 2274 * \sa SDL_MinimizeWindow 2275 * \sa SDL_RestoreWindow 2276 * \sa SDL_SyncWindow 2277 */ 2278extern SDL_DECLSPEC bool SDLCALL SDL_MaximizeWindow(SDL_Window *window); 2279 2280/** 2281 * Request that the window be minimized to an iconic representation. 2282 * 2283 * If the window is in a fullscreen state, this request has no direct effect. 2284 * It may alter the state the window is returned to when leaving fullscreen. 2285 * 2286 * On some windowing systems this request is asynchronous and the new window 2287 * state may not have been applied immediately upon the return of this 2288 * function. If an immediate change is required, call SDL_SyncWindow() to 2289 * block until the changes have taken effect. 2290 * 2291 * When the window state changes, an SDL_EVENT_WINDOW_MINIMIZED event will be 2292 * emitted. Note that, as this is just a request, the windowing system can 2293 * deny the state change. 2294 * 2295 * \param window the window to minimize. 2296 * \returns true on success or false on failure; call SDL_GetError() for more 2297 * information. 2298 * 2299 * \threadsafety This function should only be called on the main thread. 2300 * 2301 * \since This function is available since SDL 3.2.0. 2302 * 2303 * \sa SDL_MaximizeWindow 2304 * \sa SDL_RestoreWindow 2305 * \sa SDL_SyncWindow 2306 */ 2307extern SDL_DECLSPEC bool SDLCALL SDL_MinimizeWindow(SDL_Window *window); 2308 2309/** 2310 * Request that the size and position of a minimized or maximized window be 2311 * restored. 2312 * 2313 * If the window is in a fullscreen state, this request has no direct effect. 2314 * It may alter the state the window is returned to when leaving fullscreen. 2315 * 2316 * On some windowing systems this request is asynchronous and the new window 2317 * state may not have have been applied immediately upon the return of this 2318 * function. If an immediate change is required, call SDL_SyncWindow() to 2319 * block until the changes have taken effect. 2320 * 2321 * When the window state changes, an SDL_EVENT_WINDOW_RESTORED event will be 2322 * emitted. Note that, as this is just a request, the windowing system can 2323 * deny the state change. 2324 * 2325 * \param window the window to restore. 2326 * \returns true on success or false on failure; call SDL_GetError() for more 2327 * information. 2328 * 2329 * \threadsafety This function should only be called on the main thread. 2330 * 2331 * \since This function is available since SDL 3.2.0. 2332 * 2333 * \sa SDL_MaximizeWindow 2334 * \sa SDL_MinimizeWindow 2335 * \sa SDL_SyncWindow 2336 */ 2337extern SDL_DECLSPEC bool SDLCALL SDL_RestoreWindow(SDL_Window *window); 2338 2339/** 2340 * Request that the window's fullscreen state be changed. 2341 * 2342 * By default a window in fullscreen state uses borderless fullscreen desktop 2343 * mode, but a specific exclusive display mode can be set using 2344 * SDL_SetWindowFullscreenMode(). 2345 * 2346 * On some windowing systems this request is asynchronous and the new 2347 * fullscreen state may not have have been applied immediately upon the return 2348 * of this function. If an immediate change is required, call SDL_SyncWindow() 2349 * to block until the changes have taken effect. 2350 * 2351 * When the window state changes, an SDL_EVENT_WINDOW_ENTER_FULLSCREEN or 2352 * SDL_EVENT_WINDOW_LEAVE_FULLSCREEN event will be emitted. Note that, as this 2353 * is just a request, it can be denied by the windowing system. 2354 * 2355 * \param window the window to change. 2356 * \param fullscreen true for fullscreen mode, false for windowed mode. 2357 * \returns true on success or false on failure; call SDL_GetError() for more 2358 * information. 2359 * 2360 * \threadsafety This function should only be called on the main thread. 2361 * 2362 * \since This function is available since SDL 3.2.0. 2363 * 2364 * \sa SDL_GetWindowFullscreenMode 2365 * \sa SDL_SetWindowFullscreenMode 2366 * \sa SDL_SyncWindow 2367 * \sa SDL_WINDOW_FULLSCREEN 2368 */ 2369extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, bool fullscreen); 2370 2371/** 2372 * Block until any pending window state is finalized. 2373 * 2374 * On asynchronous windowing systems, this acts as a synchronization barrier 2375 * for pending window state. It will attempt to wait until any pending window 2376 * state has been applied and is guaranteed to return within finite time. Note 2377 * that for how long it can potentially block depends on the underlying window 2378 * system, as window state changes may involve somewhat lengthy animations 2379 * that must complete before the window is in its final requested state. 2380 * 2381 * On windowing systems where changes are immediate, this does nothing. 2382 * 2383 * \param window the window for which to wait for the pending state to be 2384 * applied. 2385 * \returns true on success or false if the operation timed out before the 2386 * window was in the requested state. 2387 * 2388 * \threadsafety This function should only be called on the main thread. 2389 * 2390 * \since This function is available since SDL 3.2.0. 2391 * 2392 * \sa SDL_SetWindowSize 2393 * \sa SDL_SetWindowPosition 2394 * \sa SDL_SetWindowFullscreen 2395 * \sa SDL_MinimizeWindow 2396 * \sa SDL_MaximizeWindow 2397 * \sa SDL_RestoreWindow 2398 * \sa SDL_HINT_VIDEO_SYNC_WINDOW_OPERATIONS 2399 */ 2400extern SDL_DECLSPEC bool SDLCALL SDL_SyncWindow(SDL_Window *window); 2401 2402/** 2403 * Return whether the window has a surface associated with it. 2404 * 2405 * \param window the window to query. 2406 * \returns true if there is a surface associated with the window, or false 2407 * otherwise. 2408 * 2409 * \threadsafety This function should only be called on the main thread. 2410 * 2411 * \since This function is available since SDL 3.2.0. 2412 * 2413 * \sa SDL_GetWindowSurface 2414 */ 2415extern SDL_DECLSPEC bool SDLCALL SDL_WindowHasSurface(SDL_Window *window); 2416 2417/** 2418 * Get the SDL surface associated with the window. 2419 * 2420 * A new surface will be created with the optimal format for the window, if 2421 * necessary. This surface will be freed when the window is destroyed. Do not 2422 * free this surface. 2423 * 2424 * This surface will be invalidated if the window is resized. After resizing a 2425 * window this function must be called again to return a valid surface. 2426 * 2427 * You may not combine this with 3D or the rendering API on this window. 2428 * 2429 * This function is affected by `SDL_HINT_FRAMEBUFFER_ACCELERATION`. 2430 * 2431 * \param window the window to query. 2432 * \returns the surface associated with the window, or NULL on failure; call 2433 * SDL_GetError() for more information. 2434 * 2435 * \threadsafety This function should only be called on the main thread. 2436 * 2437 * \since This function is available since SDL 3.2.0. 2438 * 2439 * \sa SDL_DestroyWindowSurface 2440 * \sa SDL_WindowHasSurface 2441 * \sa SDL_UpdateWindowSurface 2442 * \sa SDL_UpdateWindowSurfaceRects 2443 */ 2444extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window *window); 2445 2446/** 2447 * Toggle VSync for the window surface. 2448 * 2449 * When a window surface is created, vsync defaults to 2450 * SDL_WINDOW_SURFACE_VSYNC_DISABLED. 2451 * 2452 * The `vsync` parameter can be 1 to synchronize present with every vertical 2453 * refresh, 2 to synchronize present with every second vertical refresh, etc., 2454 * SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync), 2455 * or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is 2456 * supported by every driver, so you should check the return value to see 2457 * whether the requested setting is supported. 2458 * 2459 * \param window the window. 2460 * \param vsync the vertical refresh sync interval. 2461 * \returns true on success or false on failure; call SDL_GetError() for more 2462 * information. 2463 * 2464 * \threadsafety This function should only be called on the main thread. 2465 * 2466 * \since This function is available since SDL 3.2.0. 2467 * 2468 * \sa SDL_GetWindowSurfaceVSync 2469 */ 2470extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSurfaceVSync(SDL_Window *window, int vsync); 2471 2472#define SDL_WINDOW_SURFACE_VSYNC_DISABLED 0 2473#define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE (-1) 2474 2475/** 2476 * Get VSync for the window surface. 2477 * 2478 * \param window the window to query. 2479 * \param vsync an int filled with the current vertical refresh sync interval. 2480 * See SDL_SetWindowSurfaceVSync() for the meaning of the value. 2481 * \returns true on success or false on failure; call SDL_GetError() for more 2482 * information. 2483 * 2484 * \threadsafety This function should only be called on the main thread. 2485 * 2486 * \since This function is available since SDL 3.2.0. 2487 * 2488 * \sa SDL_SetWindowSurfaceVSync 2489 */ 2490extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSurfaceVSync(SDL_Window *window, int *vsync); 2491 2492/** 2493 * Copy the window surface to the screen. 2494 * 2495 * This is the function you use to reflect any changes to the surface on the 2496 * screen. 2497 * 2498 * This function is equivalent to the SDL 1.2 API SDL_Flip(). 2499 * 2500 * \param window the window to update. 2501 * \returns true on success or false on failure; call SDL_GetError() for more 2502 * information. 2503 * 2504 * \threadsafety This function should only be called on the main thread. 2505 * 2506 * \since This function is available since SDL 3.2.0. 2507 * 2508 * \sa SDL_GetWindowSurface 2509 * \sa SDL_UpdateWindowSurfaceRects 2510 */ 2511extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurface(SDL_Window *window); 2512 2513/** 2514 * Copy areas of the window surface to the screen. 2515 * 2516 * This is the function you use to reflect changes to portions of the surface 2517 * on the screen. 2518 * 2519 * This function is equivalent to the SDL 1.2 API SDL_UpdateRects(). 2520 * 2521 * Note that this function will update _at least_ the rectangles specified, 2522 * but this is only intended as an optimization; in practice, this might 2523 * update more of the screen (or all of the screen!), depending on what method 2524 * SDL uses to send pixels to the system. 2525 * 2526 * \param window the window to update. 2527 * \param rects an array of SDL_Rect structures representing areas of the 2528 * surface to copy, in pixels. 2529 * \param numrects the number of rectangles. 2530 * \returns true on success or false on failure; call SDL_GetError() for more 2531 * information. 2532 * 2533 * \threadsafety This function should only be called on the main thread. 2534 * 2535 * \since This function is available since SDL 3.2.0. 2536 * 2537 * \sa SDL_GetWindowSurface 2538 * \sa SDL_UpdateWindowSurface 2539 */ 2540extern SDL_DECLSPEC bool SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects); 2541 2542/** 2543 * Destroy the surface associated with the window. 2544 * 2545 * \param window the window to update. 2546 * \returns true on success or false on failure; call SDL_GetError() for more 2547 * information. 2548 * 2549 * \threadsafety This function should only be called on the main thread. 2550 * 2551 * \since This function is available since SDL 3.2.0. 2552 * 2553 * \sa SDL_GetWindowSurface 2554 * \sa SDL_WindowHasSurface 2555 */ 2556extern SDL_DECLSPEC bool SDLCALL SDL_DestroyWindowSurface(SDL_Window *window); 2557 2558/** 2559 * Set a window's keyboard grab mode. 2560 * 2561 * Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or 2562 * the Meta/Super key. Note that not all system keyboard shortcuts can be 2563 * captured by applications (one example is Ctrl+Alt+Del on Windows). 2564 * 2565 * This is primarily intended for specialized applications such as VNC clients 2566 * or VM frontends. Normal games should not use keyboard grab. 2567 * 2568 * When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the 2569 * window is full-screen to ensure the user is not trapped in your 2570 * application. If you have a custom keyboard shortcut to exit fullscreen 2571 * mode, you may suppress this behavior with 2572 * `SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED`. 2573 * 2574 * If the caller enables a grab while another window is currently grabbed, the 2575 * other window loses its grab in favor of the caller's window. 2576 * 2577 * \param window the window for which the keyboard grab mode should be set. 2578 * \param grabbed this is true to grab keyboard, and false to release. 2579 * \returns true on success or false on failure; call SDL_GetError() for more 2580 * information. 2581 * 2582 * \threadsafety This function should only be called on the main thread. 2583 * 2584 * \since This function is available since SDL 3.2.0. 2585 * 2586 * \sa SDL_GetWindowKeyboardGrab 2587 * \sa SDL_SetWindowMouseGrab 2588 */ 2589extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window *window, bool grabbed); 2590 2591/** 2592 * Set a window's mouse grab mode. 2593 * 2594 * Mouse grab confines the mouse cursor to the window. 2595 * 2596 * \param window the window for which the mouse grab mode should be set. 2597 * \param grabbed this is true to grab mouse, and false to release. 2598 * \returns true on success or false on failure; call SDL_GetError() for more 2599 * information. 2600 * 2601 * \threadsafety This function should only be called on the main thread. 2602 * 2603 * \since This function is available since SDL 3.2.0. 2604 * 2605 * \sa SDL_GetWindowMouseRect 2606 * \sa SDL_SetWindowMouseRect 2607 * \sa SDL_SetWindowKeyboardGrab 2608 */ 2609extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMouseGrab(SDL_Window *window, bool grabbed); 2610 2611/** 2612 * Get a window's keyboard grab mode. 2613 * 2614 * \param window the window to query. 2615 * \returns true if keyboard is grabbed, and false otherwise. 2616 * 2617 * \threadsafety This function should only be called on the main thread. 2618 * 2619 * \since This function is available since SDL 3.2.0. 2620 * 2621 * \sa SDL_SetWindowKeyboardGrab 2622 */ 2623extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window *window); 2624 2625/** 2626 * Get a window's mouse grab mode. 2627 * 2628 * \param window the window to query. 2629 * \returns true if mouse is grabbed, and false otherwise. 2630 * 2631 * \threadsafety This function should only be called on the main thread. 2632 * 2633 * \since This function is available since SDL 3.2.0. 2634 * 2635 * \sa SDL_GetWindowMouseRect 2636 * \sa SDL_SetWindowMouseRect 2637 * \sa SDL_SetWindowMouseGrab 2638 * \sa SDL_SetWindowKeyboardGrab 2639 */ 2640extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowMouseGrab(SDL_Window *window); 2641 2642/** 2643 * Get the window that currently has an input grab enabled. 2644 * 2645 * \returns the window if input is grabbed or NULL otherwise. 2646 * 2647 * \threadsafety This function should only be called on the main thread. 2648 * 2649 * \since This function is available since SDL 3.2.0. 2650 * 2651 * \sa SDL_SetWindowMouseGrab 2652 * \sa SDL_SetWindowKeyboardGrab 2653 */ 2654extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void); 2655 2656/** 2657 * Confines the cursor to the specified area of a window. 2658 * 2659 * Note that this does NOT grab the cursor, it only defines the area a cursor 2660 * is restricted to when the window has mouse focus. 2661 * 2662 * \param window the window that will be associated with the barrier. 2663 * \param rect a rectangle area in window-relative coordinates. If NULL the 2664 * barrier for the specified window will be destroyed. 2665 * \returns true on success or false on failure; call SDL_GetError() for more 2666 * information. 2667 * 2668 * \threadsafety This function should only be called on the main thread. 2669 * 2670 * \since This function is available since SDL 3.2.0. 2671 * 2672 * \sa SDL_GetWindowMouseRect 2673 * \sa SDL_GetWindowMouseGrab 2674 * \sa SDL_SetWindowMouseGrab 2675 */ 2676extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect); 2677 2678/** 2679 * Get the mouse confinement rectangle of a window. 2680 * 2681 * \param window the window to query. 2682 * \returns a pointer to the mouse confinement rectangle of a window, or NULL 2683 * if there isn't one. 2684 * 2685 * \threadsafety This function should only be called on the main thread. 2686 * 2687 * \since This function is available since SDL 3.2.0. 2688 * 2689 * \sa SDL_SetWindowMouseRect 2690 * \sa SDL_GetWindowMouseGrab 2691 * \sa SDL_SetWindowMouseGrab 2692 */ 2693extern SDL_DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window *window); 2694 2695/** 2696 * Set the opacity for a window. 2697 * 2698 * The parameter `opacity` will be clamped internally between 0.0f 2699 * (transparent) and 1.0f (opaque). 2700 * 2701 * This function also returns false if setting the opacity isn't supported. 2702 * 2703 * \param window the window which will be made transparent or opaque. 2704 * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque). 2705 * \returns true on success or false on failure; call SDL_GetError() for more 2706 * information. 2707 * 2708 * \threadsafety This function should only be called on the main thread. 2709 * 2710 * \since This function is available since SDL 3.2.0. 2711 * 2712 * \sa SDL_GetWindowOpacity 2713 */ 2714extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowOpacity(SDL_Window *window, float opacity); 2715 2716/** 2717 * Get the opacity of a window. 2718 * 2719 * If transparency isn't supported on this platform, opacity will be returned 2720 * as 1.0f without error. 2721 * 2722 * \param window the window to get the current opacity value from. 2723 * \returns the opacity, (0.0f - transparent, 1.0f - opaque), or -1.0f on 2724 * failure; call SDL_GetError() for more information. 2725 * 2726 * \threadsafety This function should only be called on the main thread. 2727 * 2728 * \since This function is available since SDL 3.2.0. 2729 * 2730 * \sa SDL_SetWindowOpacity 2731 */ 2732extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window); 2733 2734/** 2735 * Set the window as a child of a parent window. 2736 * 2737 * If the window is already the child of an existing window, it will be 2738 * reparented to the new owner. Setting the parent window to NULL unparents 2739 * the window and removes child window status. 2740 * 2741 * If a parent window is hidden or destroyed, the operation will be 2742 * recursively applied to child windows. Child windows hidden with the parent 2743 * that did not have their hidden status explicitly set will be restored when 2744 * the parent is shown. 2745 * 2746 * Attempting to set the parent of a window that is currently in the modal 2747 * state will fail. Use SDL_SetWindowModal() to cancel the modal status before 2748 * attempting to change the parent. 2749 * 2750 * Popup windows cannot change parents and attempts to do so will fail. 2751 * 2752 * Setting a parent window that is currently the sibling or descendent of the 2753 * child window results in undefined behavior. 2754 * 2755 * \param window the window that should become the child of a parent. 2756 * \param parent the new parent window for the child window. 2757 * \returns true on success or false on failure; call SDL_GetError() for more 2758 * information. 2759 * 2760 * \threadsafety This function should only be called on the main thread. 2761 * 2762 * \since This function is available since SDL 3.2.0. 2763 * 2764 * \sa SDL_SetWindowModal 2765 */ 2766extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowParent(SDL_Window *window, SDL_Window *parent); 2767 2768/** 2769 * Toggle the state of the window as modal. 2770 * 2771 * To enable modal status on a window, the window must currently be the child 2772 * window of a parent, or toggling modal status on will fail. 2773 * 2774 * \param window the window on which to set the modal state. 2775 * \param modal true to toggle modal status on, false to toggle it off. 2776 * \returns true on success or false on failure; call SDL_GetError() for more 2777 * information. 2778 * 2779 * \threadsafety This function should only be called on the main thread. 2780 * 2781 * \since This function is available since SDL 3.2.0. 2782 * 2783 * \sa SDL_SetWindowParent 2784 * \sa SDL_WINDOW_MODAL 2785 */ 2786extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowModal(SDL_Window *window, bool modal); 2787 2788/** 2789 * Set whether the window may have input focus. 2790 * 2791 * \param window the window to set focusable state. 2792 * \param focusable true to allow input focus, false to not allow input focus. 2793 * \returns true on success or false on failure; call SDL_GetError() for more 2794 * information. 2795 * 2796 * \threadsafety This function should only be called on the main thread. 2797 * 2798 * \since This function is available since SDL 3.2.0. 2799 */ 2800extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowFocusable(SDL_Window *window, bool focusable); 2801 2802 2803/** 2804 * Display the system-level window menu. 2805 * 2806 * This default window menu is provided by the system and on some platforms 2807 * provides functionality for setting or changing privileged state on the 2808 * window, such as moving it between workspaces or displays, or toggling the 2809 * always-on-top property. 2810 * 2811 * On platforms or desktops where this is unsupported, this function does 2812 * nothing. 2813 * 2814 * \param window the window for which the menu will be displayed. 2815 * \param x the x coordinate of the menu, relative to the origin (top-left) of 2816 * the client area. 2817 * \param y the y coordinate of the menu, relative to the origin (top-left) of 2818 * the client area. 2819 * \returns true on success or false on failure; call SDL_GetError() for more 2820 * information. 2821 * 2822 * \threadsafety This function should only be called on the main thread. 2823 * 2824 * \since This function is available since SDL 3.2.0. 2825 */ 2826extern SDL_DECLSPEC bool SDLCALL SDL_ShowWindowSystemMenu(SDL_Window *window, int x, int y); 2827 2828/** 2829 * Possible return values from the SDL_HitTest callback. 2830 * 2831 * \threadsafety This function should only be called on the main thread. 2832 * 2833 * \since This enum is available since SDL 3.2.0. 2834 * 2835 * \sa SDL_HitTest 2836 */ 2837typedef enum SDL_HitTestResult 2838{ 2839 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */ 2840 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */ 2841 SDL_HITTEST_RESIZE_TOPLEFT, /**< Region is the resizable top-left corner border. */ 2842 SDL_HITTEST_RESIZE_TOP, /**< Region is the resizable top border. */ 2843 SDL_HITTEST_RESIZE_TOPRIGHT, /**< Region is the resizable top-right corner border. */ 2844 SDL_HITTEST_RESIZE_RIGHT, /**< Region is the resizable right border. */ 2845 SDL_HITTEST_RESIZE_BOTTOMRIGHT, /**< Region is the resizable bottom-right corner border. */ 2846 SDL_HITTEST_RESIZE_BOTTOM, /**< Region is the resizable bottom border. */ 2847 SDL_HITTEST_RESIZE_BOTTOMLEFT, /**< Region is the resizable bottom-left corner border. */ 2848 SDL_HITTEST_RESIZE_LEFT /**< Region is the resizable left border. */ 2849} SDL_HitTestResult; 2850 2851/** 2852 * Callback used for hit-testing. 2853 * 2854 * \param win the SDL_Window where hit-testing was set on. 2855 * \param area an SDL_Point which should be hit-tested. 2856 * \param data what was passed as `callback_data` to SDL_SetWindowHitTest(). 2857 * \returns an SDL_HitTestResult value. 2858 * 2859 * \sa SDL_SetWindowHitTest 2860 */ 2861typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win, 2862 const SDL_Point *area, 2863 void *data); 2864 2865/** 2866 * Provide a callback that decides if a window region has special properties. 2867 * 2868 * Normally windows are dragged and resized by decorations provided by the 2869 * system window manager (a title bar, borders, etc), but for some apps, it 2870 * makes sense to drag them from somewhere else inside the window itself; for 2871 * example, one might have a borderless window that wants to be draggable from 2872 * any part, or simulate its own title bar, etc. 2873 * 2874 * This function lets the app provide a callback that designates pieces of a 2875 * given window as special. This callback is run during event processing if we 2876 * need to tell the OS to treat a region of the window specially; the use of 2877 * this callback is known as "hit testing." 2878 * 2879 * Mouse input may not be delivered to your application if it is within a 2880 * special area; the OS will often apply that input to moving the window or 2881 * resizing the window and not deliver it to the application. 2882 * 2883 * Specifying NULL for a callback disables hit-testing. Hit-testing is 2884 * disabled by default. 2885 * 2886 * Platforms that don't support this functionality will return false 2887 * unconditionally, even if you're attempting to disable hit-testing. 2888 * 2889 * Your callback may fire at any time, and its firing does not indicate any 2890 * specific behavior (for example, on Windows, this certainly might fire when 2891 * the OS is deciding whether to drag your window, but it fires for lots of 2892 * other reasons, too, some unrelated to anything you probably care about _and 2893 * when the mouse isn't actually at the location it is testing_). Since this 2894 * can fire at any time, you should try to keep your callback efficient, 2895 * devoid of allocations, etc. 2896 * 2897 * \param window the window to set hit-testing on. 2898 * \param callback the function to call when doing a hit-test. 2899 * \param callback_data an app-defined void pointer passed to **callback**. 2900 * \returns true on success or false on failure; call SDL_GetError() for more 2901 * information. 2902 * 2903 * \threadsafety This function should only be called on the main thread. 2904 * 2905 * \since This function is available since SDL 3.2.0. 2906 */ 2907extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data); 2908 2909/** 2910 * Set the shape of a transparent window. 2911 * 2912 * This sets the alpha channel of a transparent window and any fully 2913 * transparent areas are also transparent to mouse clicks. If you are using 2914 * something besides the SDL render API, then you are responsible for drawing 2915 * the alpha channel of the window to match the shape alpha channel to get 2916 * consistent cross-platform results. 2917 * 2918 * The shape is copied inside this function, so you can free it afterwards. If 2919 * your shape surface changes, you should call SDL_SetWindowShape() again to 2920 * update the window. This is an expensive operation, so should be done 2921 * sparingly. 2922 * 2923 * The window must have been created with the SDL_WINDOW_TRANSPARENT flag. 2924 * 2925 * \param window the window. 2926 * \param shape the surface representing the shape of the window, or NULL to 2927 * remove any current shape. 2928 * \returns true on success or false on failure; call SDL_GetError() for more 2929 * information. 2930 * 2931 * \threadsafety This function should only be called on the main thread. 2932 * 2933 * \since This function is available since SDL 3.2.0. 2934 */ 2935extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surface *shape); 2936 2937/** 2938 * Request a window to demand attention from the user. 2939 * 2940 * \param window the window to be flashed. 2941 * \param operation the operation to perform. 2942 * \returns true on success or false on failure; call SDL_GetError() for more 2943 * information. 2944 * 2945 * \threadsafety This function should only be called on the main thread. 2946 * 2947 * \since This function is available since SDL 3.2.0. 2948 */ 2949extern SDL_DECLSPEC bool SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation); 2950 2951/** 2952 * Sets the state of the progress bar for the given window’s taskbar icon. 2953 * 2954 * \param window the window whose progress state is to be modified. 2955 * \param state the progress state. `SDL_PROGRESS_STATE_NONE` stops displaying 2956 * the progress bar. 2957 * \returns true on success or false on failure; call SDL_GetError() for more 2958 * information. 2959 * 2960 * \threadsafety This function should only be called on the main thread. 2961 * 2962 * \since This function is available since SDL 3.4.0. 2963 */ 2964extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowProgressState(SDL_Window *window, SDL_ProgressState state); 2965 2966/** 2967 * Get the state of the progress bar for the given window’s taskbar icon. 2968 * 2969 * \param window the window to get the current progress state from. 2970 * \returns the progress state, or `SDL_PROGRESS_STATE_INVALID` on failure; 2971 * call SDL_GetError() for more information. 2972 * 2973 * \threadsafety This function should only be called on the main thread. 2974 * 2975 * \since This function is available since SDL 3.4.0. 2976 */ 2977extern SDL_DECLSPEC SDL_ProgressState SDLCALL SDL_GetWindowProgressState(SDL_Window *window); 2978 2979/** 2980 * Sets the value of the progress bar for the given window’s taskbar icon. 2981 * 2982 * \param window the window whose progress value is to be modified. 2983 * \param value the progress value in the range of [0.0f - 1.0f]. If the value 2984 * is outside the valid range, it gets clamped. 2985 * \returns true on success or false on failure; call SDL_GetError() for more 2986 * information. 2987 * 2988 * \threadsafety This function should only be called on the main thread. 2989 * 2990 * \since This function is available since SDL 3.4.0. 2991 */ 2992extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowProgressValue(SDL_Window *window, float value); 2993 2994/** 2995 * Get the value of the progress bar for the given window’s taskbar icon. 2996 * 2997 * \param window the window to get the current progress value from. 2998 * \returns the progress value in the range of [0.0f - 1.0f], or -1.0f on 2999 * failure; call SDL_GetError() for more information. 3000 * 3001 * \threadsafety This function should only be called on the main thread. 3002 * 3003 * \since This function is available since SDL 3.4.0. 3004 */ 3005extern SDL_DECLSPEC float SDLCALL SDL_GetWindowProgressValue(SDL_Window *window); 3006 3007/** 3008 * Destroy a window. 3009 * 3010 * Any child windows owned by the window will be recursively destroyed as 3011 * well. 3012 * 3013 * Note that on some platforms, the visible window may not actually be removed 3014 * from the screen until the SDL event loop is pumped again, even though the 3015 * SDL_Window is no longer valid after this call. 3016 * 3017 * \param window the window to destroy. 3018 * 3019 * \threadsafety This function should only be called on the main thread. 3020 * 3021 * \since This function is available since SDL 3.2.0. 3022 * 3023 * \sa SDL_CreatePopupWindow 3024 * \sa SDL_CreateWindow 3025 * \sa SDL_CreateWindowWithProperties 3026 */ 3027extern SDL_DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window *window); 3028 3029 3030/** 3031 * Check whether the screensaver is currently enabled. 3032 * 3033 * The screensaver is disabled by default. 3034 * 3035 * The default can also be changed using `SDL_HINT_VIDEO_ALLOW_SCREENSAVER`. 3036 * 3037 * \returns true if the screensaver is enabled, false if it is disabled. 3038 * 3039 * \threadsafety This function should only be called on the main thread. 3040 * 3041 * \since This function is available since SDL 3.2.0. 3042 * 3043 * \sa SDL_DisableScreenSaver 3044 * \sa SDL_EnableScreenSaver 3045 */ 3046extern SDL_DECLSPEC bool SDLCALL SDL_ScreenSaverEnabled(void); 3047 3048/** 3049 * Allow the screen to be blanked by a screen saver. 3050 * 3051 * \returns true on success or false on failure; call SDL_GetError() for more 3052 * information. 3053 * 3054 * \threadsafety This function should only be called on the main thread. 3055 * 3056 * \since This function is available since SDL 3.2.0. 3057 * 3058 * \sa SDL_DisableScreenSaver 3059 * \sa SDL_ScreenSaverEnabled 3060 */ 3061extern SDL_DECLSPEC bool SDLCALL SDL_EnableScreenSaver(void); 3062 3063/** 3064 * Prevent the screen from being blanked by a screen saver. 3065 * 3066 * If you disable the screensaver, it is automatically re-enabled when SDL 3067 * quits. 3068 * 3069 * The screensaver is disabled by default, but this may by changed by 3070 * SDL_HINT_VIDEO_ALLOW_SCREENSAVER. 3071 * 3072 * \returns true on success or false on failure; call SDL_GetError() for more 3073 * information. 3074 * 3075 * \threadsafety This function should only be called on the main thread. 3076 * 3077 * \since This function is available since SDL 3.2.0. 3078 * 3079 * \sa SDL_EnableScreenSaver 3080 * \sa SDL_ScreenSaverEnabled 3081 */ 3082extern SDL_DECLSPEC bool SDLCALL SDL_DisableScreenSaver(void); 3083 3084 3085/** 3086 * \name OpenGL support functions 3087 */ 3088/* @{ */ 3089 3090/** 3091 * Dynamically load an OpenGL library. 3092 * 3093 * This should be done after initializing the video driver, but before 3094 * creating any OpenGL windows. If no OpenGL library is loaded, the default 3095 * library will be loaded upon creation of the first OpenGL window. 3096 * 3097 * If you do this, you need to retrieve all of the GL functions used in your 3098 * program from the dynamic library using SDL_GL_GetProcAddress(). 3099 * 3100 * \param path the platform dependent OpenGL library name, or NULL to open the 3101 * default OpenGL library. 3102 * \returns true on success or false on failure; call SDL_GetError() for more 3103 * information. 3104 * 3105 * \threadsafety This function should only be called on the main thread. 3106 * 3107 * \since This function is available since SDL 3.2.0. 3108 * 3109 * \sa SDL_GL_GetProcAddress 3110 * \sa SDL_GL_UnloadLibrary 3111 */ 3112extern SDL_DECLSPEC bool SDLCALL SDL_GL_LoadLibrary(const char *path); 3113 3114/** 3115 * Get an OpenGL function by name. 3116 * 3117 * If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all 3118 * GL functions must be retrieved this way. Usually this is used to retrieve 3119 * function pointers to OpenGL extensions. 3120 * 3121 * There are some quirks to looking up OpenGL functions that require some 3122 * extra care from the application. If you code carefully, you can handle 3123 * these quirks without any platform-specific code, though: 3124 * 3125 * - On Windows, function pointers are specific to the current GL context; 3126 * this means you need to have created a GL context and made it current 3127 * before calling SDL_GL_GetProcAddress(). If you recreate your context or 3128 * create a second context, you should assume that any existing function 3129 * pointers aren't valid to use with it. This is (currently) a 3130 * Windows-specific limitation, and in practice lots of drivers don't suffer 3131 * this limitation, but it is still the way the wgl API is documented to 3132 * work and you should expect crashes if you don't respect it. Store a copy 3133 * of the function pointers that comes and goes with context lifespan. 3134 * - On X11, function pointers returned by this function are valid for any 3135 * context, and can even be looked up before a context is created at all. 3136 * This means that, for at least some common OpenGL implementations, if you 3137 * look up a function that doesn't exist, you'll get a non-NULL result that 3138 * is _NOT_ safe to call. You must always make sure the function is actually 3139 * available for a given GL context before calling it, by checking for the 3140 * existence of the appropriate extension with SDL_GL_ExtensionSupported(), 3141 * or verifying that the version of OpenGL you're using offers the function 3142 * as core functionality. 3143 * - Some OpenGL drivers, on all platforms, *will* return NULL if a function 3144 * isn't supported, but you can't count on this behavior. Check for 3145 * extensions you use, and if you get a NULL anyway, act as if that 3146 * extension wasn't available. This is probably a bug in the driver, but you 3147 * can code defensively for this scenario anyhow. 3148 * - Just because you're on Linux/Unix, don't assume you'll be using X11. 3149 * Next-gen display servers are waiting to replace it, and may or may not 3150 * make the same promises about function pointers. 3151 * - OpenGL function pointers must be declared `APIENTRY` as in the example 3152 * code. This will ensure the proper calling convention is followed on 3153 * platforms where this matters (Win32) thereby avoiding stack corruption. 3154 * 3155 * \param proc the name of an OpenGL function. 3156 * \returns a pointer to the named OpenGL function. The returned pointer 3157 * should be cast to the appropriate function signature. 3158 * 3159 * \threadsafety This function should only be called on the main thread. 3160 * 3161 * \since This function is available since SDL 3.2.0. 3162 * 3163 * \sa SDL_GL_ExtensionSupported 3164 * \sa SDL_GL_LoadLibrary 3165 * \sa SDL_GL_UnloadLibrary 3166 */ 3167extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_GL_GetProcAddress(const char *proc); 3168 3169/** 3170 * Get an EGL library function by name. 3171 * 3172 * If an EGL library is loaded, this function allows applications to get entry 3173 * points for EGL functions. This is useful to provide to an EGL API and 3174 * extension loader. 3175 * 3176 * \param proc the name of an EGL function. 3177 * \returns a pointer to the named EGL function. The returned pointer should 3178 * be cast to the appropriate function signature. 3179 * 3180 * \threadsafety This function should only be called on the main thread. 3181 * 3182 * \since This function is available since SDL 3.2.0. 3183 * 3184 * \sa SDL_EGL_GetCurrentDisplay 3185 */ 3186extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_EGL_GetProcAddress(const char *proc); 3187 3188/** 3189 * Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary(). 3190 * 3191 * \threadsafety This function should only be called on the main thread. 3192 * 3193 * \since This function is available since SDL 3.2.0. 3194 * 3195 * \sa SDL_GL_LoadLibrary 3196 */ 3197extern SDL_DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void); 3198 3199/** 3200 * Check if an OpenGL extension is supported for the current context. 3201 * 3202 * This function operates on the current GL context; you must have created a 3203 * context and it must be current before calling this function. Do not assume 3204 * that all contexts you create will have the same set of extensions 3205 * available, or that recreating an existing context will offer the same 3206 * extensions again. 3207 * 3208 * While it's probably not a massive overhead, this function is not an O(1) 3209 * operation. Check the extensions you care about after creating the GL 3210 * context and save that information somewhere instead of calling the function 3211 * every time you need to know. 3212 * 3213 * \param extension the name of the extension to check. 3214 * \returns true if the extension is supported, false otherwise. 3215 * 3216 * \threadsafety This function should only be called on the main thread. 3217 * 3218 * \since This function is available since SDL 3.2.0. 3219 */ 3220extern SDL_DECLSPEC bool SDLCALL SDL_GL_ExtensionSupported(const char *extension); 3221 3222/** 3223 * Reset all previously set OpenGL context attributes to their default values. 3224 * 3225 * \threadsafety This function should only be called on the main thread. 3226 * 3227 * \since This function is available since SDL 3.2.0. 3228 * 3229 * \sa SDL_GL_GetAttribute 3230 * \sa SDL_GL_SetAttribute 3231 */ 3232extern SDL_DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void); 3233 3234/** 3235 * Set an OpenGL window attribute before window creation. 3236 * 3237 * This function sets the OpenGL attribute `attr` to `value`. The requested 3238 * attributes should be set before creating an OpenGL window. You should use 3239 * SDL_GL_GetAttribute() to check the values after creating the OpenGL 3240 * context, since the values obtained can differ from the requested ones. 3241 * 3242 * \param attr an enum value specifying the OpenGL attribute to set. 3243 * \param value the desired value for the attribute. 3244 * \returns true on success or false on failure; call SDL_GetError() for more 3245 * information. 3246 * 3247 * \threadsafety This function should only be called on the main thread. 3248 * 3249 * \since This function is available since SDL 3.2.0. 3250 * 3251 * \sa SDL_GL_CreateContext 3252 * \sa SDL_GL_GetAttribute 3253 * \sa SDL_GL_ResetAttributes 3254 */ 3255extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetAttribute(SDL_GLAttr attr, int value); 3256 3257/** 3258 * Get the actual value for an attribute from the current context. 3259 * 3260 * \param attr an SDL_GLAttr enum value specifying the OpenGL attribute to 3261 * get. 3262 * \param value a pointer filled in with the current value of `attr`. 3263 * \returns true on success or false on failure; call SDL_GetError() for more 3264 * information. 3265 * 3266 * \threadsafety This function should only be called on the main thread. 3267 * 3268 * \since This function is available since SDL 3.2.0. 3269 * 3270 * \sa SDL_GL_ResetAttributes 3271 * \sa SDL_GL_SetAttribute 3272 */ 3273extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetAttribute(SDL_GLAttr attr, int *value); 3274 3275/** 3276 * Create an OpenGL context for an OpenGL window, and make it current. 3277 * 3278 * The OpenGL context will be created with the current states set through 3279 * SDL_GL_SetAttribute(). 3280 * 3281 * The SDL_Window specified must have been created with the SDL_WINDOW_OPENGL 3282 * flag, or context creation will fail. 3283 * 3284 * Windows users new to OpenGL should note that, for historical reasons, GL 3285 * functions added after OpenGL version 1.1 are not available by default. 3286 * Those functions must be loaded at run-time, either with an OpenGL 3287 * extension-handling library or with SDL_GL_GetProcAddress() and its related 3288 * functions. 3289 * 3290 * SDL_GLContext is opaque to the application. 3291 * 3292 * \param window the window to associate with the context. 3293 * \returns the OpenGL context associated with `window` or NULL on failure; 3294 * call SDL_GetError() for more information. 3295 * 3296 * \threadsafety This function should only be called on the main thread. 3297 * 3298 * \since This function is available since SDL 3.2.0. 3299 * 3300 * \sa SDL_GL_DestroyContext 3301 * \sa SDL_GL_MakeCurrent 3302 */ 3303extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *window); 3304 3305/** 3306 * Set up an OpenGL context for rendering into an OpenGL window. 3307 * 3308 * The context must have been created with a compatible window. 3309 * 3310 * \param window the window to associate with the context. 3311 * \param context the OpenGL context to associate with the window. 3312 * \returns true on success or false on failure; call SDL_GetError() for more 3313 * information. 3314 * 3315 * \threadsafety This function should only be called on the main thread. 3316 * 3317 * \since This function is available since SDL 3.2.0. 3318 * 3319 * \sa SDL_GL_CreateContext 3320 */ 3321extern SDL_DECLSPEC bool SDLCALL SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext context); 3322 3323/** 3324 * Get the currently active OpenGL window. 3325 * 3326 * \returns the currently active OpenGL window on success or NULL on failure; 3327 * call SDL_GetError() for more information. 3328 * 3329 * \threadsafety This function should only be called on the main thread. 3330 * 3331 * \since This function is available since SDL 3.2.0. 3332 */ 3333extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GL_GetCurrentWindow(void); 3334 3335/** 3336 * Get the currently active OpenGL context. 3337 * 3338 * \returns the currently active OpenGL context or NULL on failure; call 3339 * SDL_GetError() for more information. 3340 * 3341 * \threadsafety This function should only be called on the main thread. 3342 * 3343 * \since This function is available since SDL 3.2.0. 3344 * 3345 * \sa SDL_GL_MakeCurrent 3346 */ 3347extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void); 3348 3349/** 3350 * Get the currently active EGL display. 3351 * 3352 * \returns the currently active EGL display or NULL on failure; call 3353 * SDL_GetError() for more information. 3354 * 3355 * \threadsafety This function should only be called on the main thread. 3356 * 3357 * \since This function is available since SDL 3.2.0. 3358 */ 3359extern SDL_DECLSPEC SDL_EGLDisplay SDLCALL SDL_EGL_GetCurrentDisplay(void); 3360 3361/** 3362 * Get the currently active EGL config. 3363 * 3364 * \returns the currently active EGL config or NULL on failure; call 3365 * SDL_GetError() for more information. 3366 * 3367 * \threadsafety This function should only be called on the main thread. 3368 * 3369 * \since This function is available since SDL 3.2.0. 3370 */ 3371extern SDL_DECLSPEC SDL_EGLConfig SDLCALL SDL_EGL_GetCurrentConfig(void); 3372 3373/** 3374 * Get the EGL surface associated with the window. 3375 * 3376 * \param window the window to query. 3377 * \returns the EGLSurface pointer associated with the window, or NULL on 3378 * failure. 3379 * 3380 * \threadsafety This function should only be called on the main thread. 3381 * 3382 * \since This function is available since SDL 3.2.0. 3383 */ 3384extern SDL_DECLSPEC SDL_EGLSurface SDLCALL SDL_EGL_GetWindowSurface(SDL_Window *window); 3385 3386/** 3387 * Sets the callbacks for defining custom EGLAttrib arrays for EGL 3388 * initialization. 3389 * 3390 * Callbacks that aren't needed can be set to NULL. 3391 * 3392 * NOTE: These callback pointers will be reset after SDL_GL_ResetAttributes. 3393 * 3394 * \param platformAttribCallback callback for attributes to pass to 3395 * eglGetPlatformDisplay. May be NULL. 3396 * \param surfaceAttribCallback callback for attributes to pass to 3397 * eglCreateSurface. May be NULL. 3398 * \param contextAttribCallback callback for attributes to pass to 3399 * eglCreateContext. May be NULL. 3400 * \param userdata a pointer that is passed to the callbacks. 3401 * 3402 * \threadsafety This function should only be called on the main thread. 3403 * 3404 * \since This function is available since SDL 3.2.0. 3405 */ 3406extern SDL_DECLSPEC void SDLCALL SDL_EGL_SetAttributeCallbacks(SDL_EGLAttribArrayCallback platformAttribCallback, 3407 SDL_EGLIntArrayCallback surfaceAttribCallback, 3408 SDL_EGLIntArrayCallback contextAttribCallback, void *userdata); 3409 3410/** 3411 * Set the swap interval for the current OpenGL context. 3412 * 3413 * Some systems allow specifying -1 for the interval, to enable adaptive 3414 * vsync. Adaptive vsync works the same as vsync, but if you've already missed 3415 * the vertical retrace for a given frame, it swaps buffers immediately, which 3416 * might be less jarring for the user during occasional framerate drops. If an 3417 * application requests adaptive vsync and the system does not support it, 3418 * this function will fail and return false. In such a case, you should 3419 * probably retry the call with 1 for the interval. 3420 * 3421 * Adaptive vsync is implemented for some glX drivers with 3422 * GLX_EXT_swap_control_tear, and for some Windows drivers with 3423 * WGL_EXT_swap_control_tear. 3424 * 3425 * Read more on the Khronos wiki: 3426 * https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync 3427 * 3428 * \param interval 0 for immediate updates, 1 for updates synchronized with 3429 * the vertical retrace, -1 for adaptive vsync. 3430 * \returns true on success or false on failure; call SDL_GetError() for more 3431 * information. 3432 * 3433 * \threadsafety This function should only be called on the main thread. 3434 * 3435 * \since This function is available since SDL 3.2.0. 3436 * 3437 * \sa SDL_GL_GetSwapInterval 3438 */ 3439extern SDL_DECLSPEC bool SDLCALL SDL_GL_SetSwapInterval(int interval); 3440 3441/** 3442 * Get the swap interval for the current OpenGL context. 3443 * 3444 * If the system can't determine the swap interval, or there isn't a valid 3445 * current context, this function will set *interval to 0 as a safe default. 3446 * 3447 * \param interval output interval value. 0 if there is no vertical retrace 3448 * synchronization, 1 if the buffer swap is synchronized with 3449 * the vertical retrace, and -1 if late swaps happen 3450 * immediately instead of waiting for the next retrace. 3451 * \returns true on success or false on failure; call SDL_GetError() for more 3452 * information. 3453 * 3454 * \threadsafety This function should only be called on the main thread. 3455 * 3456 * \since This function is available since SDL 3.2.0. 3457 * 3458 * \sa SDL_GL_SetSwapInterval 3459 */ 3460extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetSwapInterval(int *interval); 3461 3462/** 3463 * Update a window with OpenGL rendering. 3464 * 3465 * This is used with double-buffered OpenGL contexts, which are the default. 3466 * 3467 * On macOS, make sure you bind 0 to the draw framebuffer before swapping the 3468 * window, otherwise nothing will happen. If you aren't using 3469 * glBindFramebuffer(), this is the default and you won't have to do anything 3470 * extra. 3471 * 3472 * \param window the window to change. 3473 * \returns true on success or false on failure; call SDL_GetError() for more 3474 * information. 3475 * 3476 * \threadsafety This function should only be called on the main thread. 3477 * 3478 * \since This function is available since SDL 3.2.0. 3479 */ 3480extern SDL_DECLSPEC bool SDLCALL SDL_GL_SwapWindow(SDL_Window *window); 3481 3482/** 3483 * Delete an OpenGL context. 3484 * 3485 * \param context the OpenGL context to be deleted. 3486 * \returns true on success or false on failure; call SDL_GetError() for more 3487 * information. 3488 * 3489 * \threadsafety This function should only be called on the main thread. 3490 * 3491 * \since This function is available since SDL 3.2.0. 3492 * 3493 * \sa SDL_GL_CreateContext 3494 */ 3495extern SDL_DECLSPEC bool SDLCALL SDL_GL_DestroyContext(SDL_GLContext context); 3496 3497/* @} *//* OpenGL support functions */ 3498 3499 3500/* Ends C function definitions when using C++ */ 3501#ifdef __cplusplus 3502} 3503#endif 3504#include <SDL3/SDL_close_code.h> 3505 3506#endif /* SDL_video_h_ */ 3507[FILE END](C) 2025 0x4248 (C) 2025 4248 Media and 4248 Systems, All part of 0x4248 See LICENCE files for more information. Not all files are by 0x4248 always check Licencing.