1 /* 2 Simple DirectMedia Layer 3 Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org> 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 * \file SDL_video.h 24 * 25 * Header file for SDL video functions. 26 */ 27 28 #ifndef SDL_video_h_ 29 #define SDL_video_h_ 30 31 #include "SDL_stdinc.h" 32 #include "SDL_pixels.h" 33 #include "SDL_rect.h" 34 #include "SDL_surface.h" 35 36 #include "begin_code.h" 37 /* Set up for C function definitions, even when using C++ */ 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /** 43 * \brief The structure that defines a display mode 44 * 45 * \sa SDL_GetNumDisplayModes() 46 * \sa SDL_GetDisplayMode() 47 * \sa SDL_GetDesktopDisplayMode() 48 * \sa SDL_GetCurrentDisplayMode() 49 * \sa SDL_GetClosestDisplayMode() 50 * \sa SDL_SetWindowDisplayMode() 51 * \sa SDL_GetWindowDisplayMode() 52 */ 53 typedef struct 54 { 55 Uint32 format; /**< pixel format */ 56 int w; /**< width, in screen coordinates */ 57 int h; /**< height, in screen coordinates */ 58 int refresh_rate; /**< refresh rate (or zero for unspecified) */ 59 void *driverdata; /**< driver-specific data, initialize to 0 */ 60 } SDL_DisplayMode; 61 62 /** 63 * \brief The type used to identify a window 64 * 65 * \sa SDL_CreateWindow() 66 * \sa SDL_CreateWindowFrom() 67 * \sa SDL_DestroyWindow() 68 * \sa SDL_GetWindowData() 69 * \sa SDL_GetWindowFlags() 70 * \sa SDL_GetWindowGrab() 71 * \sa SDL_GetWindowPosition() 72 * \sa SDL_GetWindowSize() 73 * \sa SDL_GetWindowTitle() 74 * \sa SDL_HideWindow() 75 * \sa SDL_MaximizeWindow() 76 * \sa SDL_MinimizeWindow() 77 * \sa SDL_RaiseWindow() 78 * \sa SDL_RestoreWindow() 79 * \sa SDL_SetWindowData() 80 * \sa SDL_SetWindowFullscreen() 81 * \sa SDL_SetWindowGrab() 82 * \sa SDL_SetWindowIcon() 83 * \sa SDL_SetWindowPosition() 84 * \sa SDL_SetWindowSize() 85 * \sa SDL_SetWindowBordered() 86 * \sa SDL_SetWindowResizable() 87 * \sa SDL_SetWindowTitle() 88 * \sa SDL_ShowWindow() 89 */ 90 typedef struct SDL_Window SDL_Window; 91 92 /** 93 * \brief The flags on a window 94 * 95 * \sa SDL_GetWindowFlags() 96 */ 97 typedef enum 98 { 99 SDL_WINDOW_FULLSCREEN = 0x00000001, /**< fullscreen window */ 100 SDL_WINDOW_OPENGL = 0x00000002, /**< window usable with OpenGL context */ 101 SDL_WINDOW_SHOWN = 0x00000004, /**< window is visible */ 102 SDL_WINDOW_HIDDEN = 0x00000008, /**< window is not visible */ 103 SDL_WINDOW_BORDERLESS = 0x00000010, /**< no window decoration */ 104 SDL_WINDOW_RESIZABLE = 0x00000020, /**< window can be resized */ 105 SDL_WINDOW_MINIMIZED = 0x00000040, /**< window is minimized */ 106 SDL_WINDOW_MAXIMIZED = 0x00000080, /**< window is maximized */ 107 SDL_WINDOW_INPUT_GRABBED = 0x00000100, /**< window has grabbed input focus */ 108 SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */ 109 SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */ 110 SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ), 111 SDL_WINDOW_FOREIGN = 0x00000800, /**< window not created by SDL */ 112 SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000, /**< window should be created in high-DPI mode if supported. 113 On macOS NSHighResolutionCapable must be set true in the 114 application's Info.plist for this to have any effect. */ 115 SDL_WINDOW_MOUSE_CAPTURE = 0x00004000, /**< window has mouse captured (unrelated to INPUT_GRABBED) */ 116 SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000, /**< window should always be above others */ 117 SDL_WINDOW_SKIP_TASKBAR = 0x00010000, /**< window should not be added to the taskbar */ 118 SDL_WINDOW_UTILITY = 0x00020000, /**< window should be treated as a utility window */ 119 SDL_WINDOW_TOOLTIP = 0x00040000, /**< window should be treated as a tooltip */ 120 SDL_WINDOW_POPUP_MENU = 0x00080000, /**< window should be treated as a popup menu */ 121 SDL_WINDOW_VULKAN = 0x10000000 /**< window usable for Vulkan surface */ 122 } SDL_WindowFlags; 123 124 /** 125 * \brief Used to indicate that you don't care what the window position is. 126 */ 127 #define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000u 128 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X)) 129 #define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0) 130 #define SDL_WINDOWPOS_ISUNDEFINED(X) \ 131 (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK) 132 133 /** 134 * \brief Used to indicate that the window position should be centered. 135 */ 136 #define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000u 137 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK|(X)) 138 #define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0) 139 #define SDL_WINDOWPOS_ISCENTERED(X) \ 140 (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK) 141 142 /** 143 * \brief Event subtype for window events 144 */ 145 typedef enum 146 { 147 SDL_WINDOWEVENT_NONE, /**< Never used */ 148 SDL_WINDOWEVENT_SHOWN, /**< Window has been shown */ 149 SDL_WINDOWEVENT_HIDDEN, /**< Window has been hidden */ 150 SDL_WINDOWEVENT_EXPOSED, /**< Window has been exposed and should be 151 redrawn */ 152 SDL_WINDOWEVENT_MOVED, /**< Window has been moved to data1, data2 153 */ 154 SDL_WINDOWEVENT_RESIZED, /**< Window has been resized to data1xdata2 */ 155 SDL_WINDOWEVENT_SIZE_CHANGED, /**< The window size has changed, either as 156 a result of an API call or through the 157 system or user changing the window size. */ 158 SDL_WINDOWEVENT_MINIMIZED, /**< Window has been minimized */ 159 SDL_WINDOWEVENT_MAXIMIZED, /**< Window has been maximized */ 160 SDL_WINDOWEVENT_RESTORED, /**< Window has been restored to normal size 161 and position */ 162 SDL_WINDOWEVENT_ENTER, /**< Window has gained mouse focus */ 163 SDL_WINDOWEVENT_LEAVE, /**< Window has lost mouse focus */ 164 SDL_WINDOWEVENT_FOCUS_GAINED, /**< Window has gained keyboard focus */ 165 SDL_WINDOWEVENT_FOCUS_LOST, /**< Window has lost keyboard focus */ 166 SDL_WINDOWEVENT_CLOSE, /**< The window manager requests that the window be closed */ 167 SDL_WINDOWEVENT_TAKE_FOCUS, /**< Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore) */ 168 SDL_WINDOWEVENT_HIT_TEST /**< Window had a hit test that wasn't SDL_HITTEST_NORMAL. */ 169 } SDL_WindowEventID; 170 171 /** 172 * \brief Event subtype for display events 173 */ 174 typedef enum 175 { 176 SDL_DISPLAYEVENT_NONE, /**< Never used */ 177 SDL_DISPLAYEVENT_ORIENTATION /**< Display orientation has changed to data1 */ 178 } SDL_DisplayEventID; 179 180 typedef enum 181 { 182 SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */ 183 SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */ 184 SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */ 185 SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */ 186 SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */ 187 } SDL_DisplayOrientation; 188 189 /** 190 * \brief An opaque handle to an OpenGL context. 191 */ 192 typedef void *SDL_GLContext; 193 194 /** 195 * \brief OpenGL configuration attributes 196 */ 197 typedef enum 198 { 199 SDL_GL_RED_SIZE, 200 SDL_GL_GREEN_SIZE, 201 SDL_GL_BLUE_SIZE, 202 SDL_GL_ALPHA_SIZE, 203 SDL_GL_BUFFER_SIZE, 204 SDL_GL_DOUBLEBUFFER, 205 SDL_GL_DEPTH_SIZE, 206 SDL_GL_STENCIL_SIZE, 207 SDL_GL_ACCUM_RED_SIZE, 208 SDL_GL_ACCUM_GREEN_SIZE, 209 SDL_GL_ACCUM_BLUE_SIZE, 210 SDL_GL_ACCUM_ALPHA_SIZE, 211 SDL_GL_STEREO, 212 SDL_GL_MULTISAMPLEBUFFERS, 213 SDL_GL_MULTISAMPLESAMPLES, 214 SDL_GL_ACCELERATED_VISUAL, 215 SDL_GL_RETAINED_BACKING, 216 SDL_GL_CONTEXT_MAJOR_VERSION, 217 SDL_GL_CONTEXT_MINOR_VERSION, 218 SDL_GL_CONTEXT_EGL, 219 SDL_GL_CONTEXT_FLAGS, 220 SDL_GL_CONTEXT_PROFILE_MASK, 221 SDL_GL_SHARE_WITH_CURRENT_CONTEXT, 222 SDL_GL_FRAMEBUFFER_SRGB_CAPABLE, 223 SDL_GL_CONTEXT_RELEASE_BEHAVIOR, 224 SDL_GL_CONTEXT_RESET_NOTIFICATION, 225 SDL_GL_CONTEXT_NO_ERROR 226 } SDL_GLattr; 227 228 typedef enum 229 { 230 SDL_GL_CONTEXT_PROFILE_CORE = 0x0001, 231 SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002, 232 SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */ 233 } SDL_GLprofile; 234 235 typedef enum 236 { 237 SDL_GL_CONTEXT_DEBUG_FLAG = 0x0001, 238 SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002, 239 SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG = 0x0004, 240 SDL_GL_CONTEXT_RESET_ISOLATION_FLAG = 0x0008 241 } SDL_GLcontextFlag; 242 243 typedef enum 244 { 245 SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE = 0x0000, 246 SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH = 0x0001 247 } SDL_GLcontextReleaseFlag; 248 249 typedef enum 250 { 251 SDL_GL_CONTEXT_RESET_NO_NOTIFICATION = 0x0000, 252 SDL_GL_CONTEXT_RESET_LOSE_CONTEXT = 0x0001 253 } SDL_GLContextResetNotification; 254 255 /* Function prototypes */ 256 257 /** 258 * \brief Get the number of video drivers compiled into SDL 259 * 260 * \sa SDL_GetVideoDriver() 261 */ 262 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void); 263 264 /** 265 * \brief Get the name of a built in video driver. 266 * 267 * \note The video drivers are presented in the order in which they are 268 * normally checked during initialization. 269 * 270 * \sa SDL_GetNumVideoDrivers() 271 */ 272 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index); 273 274 /** 275 * \brief Initialize the video subsystem, optionally specifying a video driver. 276 * 277 * \param driver_name Initialize a specific driver by name, or NULL for the 278 * default video driver. 279 * 280 * \return 0 on success, -1 on error 281 * 282 * This function initializes the video subsystem; setting up a connection 283 * to the window manager, etc, and determines the available display modes 284 * and pixel formats, but does not initialize a window or graphics mode. 285 * 286 * \sa SDL_VideoQuit() 287 */ 288 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name); 289 290 /** 291 * \brief Shuts down the video subsystem. 292 * 293 * This function closes all windows, and restores the original video mode. 294 * 295 * \sa SDL_VideoInit() 296 */ 297 extern DECLSPEC void SDLCALL SDL_VideoQuit(void); 298 299 /** 300 * \brief Returns the name of the currently initialized video driver. 301 * 302 * \return The name of the current video driver or NULL if no driver 303 * has been initialized 304 * 305 * \sa SDL_GetNumVideoDrivers() 306 * \sa SDL_GetVideoDriver() 307 */ 308 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void); 309 310 /** 311 * \brief Returns the number of available video displays. 312 * 313 * \sa SDL_GetDisplayBounds() 314 */ 315 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void); 316 317 /** 318 * \brief Get the name of a display in UTF-8 encoding 319 * 320 * \return The name of a display, or NULL for an invalid display index. 321 * 322 * \sa SDL_GetNumVideoDisplays() 323 */ 324 extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex); 325 326 /** 327 * \brief Get the desktop area represented by a display, with the primary 328 * display located at 0,0 329 * 330 * \return 0 on success, or -1 if the index is out of range. 331 * 332 * \sa SDL_GetNumVideoDisplays() 333 */ 334 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect); 335 336 /** 337 * \brief Get the usable desktop area represented by a display, with the 338 * primary display located at 0,0 339 * 340 * This is the same area as SDL_GetDisplayBounds() reports, but with portions 341 * reserved by the system removed. For example, on Mac OS X, this subtracts 342 * the area occupied by the menu bar and dock. 343 * 344 * Setting a window to be fullscreen generally bypasses these unusable areas, 345 * so these are good guidelines for the maximum space available to a 346 * non-fullscreen window. 347 * 348 * \return 0 on success, or -1 if the index is out of range. 349 * 350 * \sa SDL_GetDisplayBounds() 351 * \sa SDL_GetNumVideoDisplays() 352 */ 353 extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect * rect); 354 355 /** 356 * \brief Get the dots/pixels-per-inch for a display 357 * 358 * \note Diagonal, horizontal and vertical DPI can all be optionally 359 * returned if the parameter is non-NULL. 360 * 361 * \return 0 on success, or -1 if no DPI information is available or the index is out of range. 362 * 363 * \sa SDL_GetNumVideoDisplays() 364 */ 365 extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, float * hdpi, float * vdpi); 366 367 /** 368 * \brief Get the orientation of a display 369 * 370 * \return The orientation of the display, or SDL_ORIENTATION_UNKNOWN if it isn't available. 371 * 372 * \sa SDL_GetNumVideoDisplays() 373 */ 374 extern DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetDisplayOrientation(int displayIndex); 375 376 /** 377 * \brief Returns the number of available display modes. 378 * 379 * \sa SDL_GetDisplayMode() 380 */ 381 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex); 382 383 /** 384 * \brief Fill in information about a specific display mode. 385 * 386 * \note The display modes are sorted in this priority: 387 * \li bits per pixel -> more colors to fewer colors 388 * \li width -> largest to smallest 389 * \li height -> largest to smallest 390 * \li refresh rate -> highest to lowest 391 * 392 * \sa SDL_GetNumDisplayModes() 393 */ 394 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex, 395 SDL_DisplayMode * mode); 396 397 /** 398 * \brief Fill in information about the desktop display mode. 399 */ 400 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode); 401 402 /** 403 * \brief Fill in information about the current display mode. 404 */ 405 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode); 406 407 408 /** 409 * \brief Get the closest match to the requested display mode. 410 * 411 * \param displayIndex The index of display from which mode should be queried. 412 * \param mode The desired display mode 413 * \param closest A pointer to a display mode to be filled in with the closest 414 * match of the available display modes. 415 * 416 * \return The passed in value \c closest, or NULL if no matching video mode 417 * was available. 418 * 419 * The available display modes are scanned, and \c closest is filled in with the 420 * closest mode matching the requested mode and returned. The mode format and 421 * refresh_rate default to the desktop mode if they are 0. The modes are 422 * scanned with size being first priority, format being second priority, and 423 * finally checking the refresh_rate. If all the available modes are too 424 * small, then NULL is returned. 425 * 426 * \sa SDL_GetNumDisplayModes() 427 * \sa SDL_GetDisplayMode() 428 */ 429 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest); 430 431 /** 432 * \brief Get the display index associated with a window. 433 * 434 * \return the display index of the display containing the center of the 435 * window, or -1 on error. 436 */ 437 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window); 438 439 /** 440 * \brief Set the display mode used when a fullscreen window is visible. 441 * 442 * By default the window's dimensions and the desktop format and refresh rate 443 * are used. 444 * 445 * \param window The window for which the display mode should be set. 446 * \param mode The mode to use, or NULL for the default mode. 447 * 448 * \return 0 on success, or -1 if setting the display mode failed. 449 * 450 * \sa SDL_GetWindowDisplayMode() 451 * \sa SDL_SetWindowFullscreen() 452 */ 453 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window, 454 const SDL_DisplayMode 455 * mode); 456 457 /** 458 * \brief Fill in information about the display mode used when a fullscreen 459 * window is visible. 460 * 461 * \sa SDL_SetWindowDisplayMode() 462 * \sa SDL_SetWindowFullscreen() 463 */ 464 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window, 465 SDL_DisplayMode * mode); 466 467 /** 468 * \brief Get the pixel format associated with the window. 469 */ 470 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window); 471 472 /** 473 * \brief Create a window with the specified position, dimensions, and flags. 474 * 475 * \param title The title of the window, in UTF-8 encoding. 476 * \param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 477 * ::SDL_WINDOWPOS_UNDEFINED. 478 * \param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 479 * ::SDL_WINDOWPOS_UNDEFINED. 480 * \param w The width of the window, in screen coordinates. 481 * \param h The height of the window, in screen coordinates. 482 * \param flags The flags for the window, a mask of any of the following: 483 * ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL, 484 * ::SDL_WINDOW_HIDDEN, ::SDL_WINDOW_BORDERLESS, 485 * ::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED, 486 * ::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_INPUT_GRABBED, 487 * ::SDL_WINDOW_ALLOW_HIGHDPI, ::SDL_WINDOW_VULKAN. 488 * 489 * \return The created window, or NULL if window creation failed. 490 * 491 * If the window is created with the SDL_WINDOW_ALLOW_HIGHDPI flag, its size 492 * in pixels may differ from its size in screen coordinates on platforms with 493 * high-DPI support (e.g. iOS and Mac OS X). Use SDL_GetWindowSize() to query 494 * the client area's size in screen coordinates, and SDL_GL_GetDrawableSize(), 495 * SDL_Vulkan_GetDrawableSize(), or SDL_GetRendererOutputSize() to query the 496 * drawable size in pixels. 497 * 498 * If the window is created with any of the SDL_WINDOW_OPENGL or 499 * SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function 500 * (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the 501 * corresponding UnloadLibrary function is called by SDL_DestroyWindow(). 502 * 503 * If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver, 504 * SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail. 505 * 506 * \note On non-Apple devices, SDL requires you to either not link to the 507 * Vulkan loader or link to a dynamic library version. This limitation 508 * may be removed in a future version of SDL. 509 * 510 * \sa SDL_DestroyWindow() 511 * \sa SDL_GL_LoadLibrary() 512 * \sa SDL_Vulkan_LoadLibrary() 513 */ 514 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title, 515 int x, int y, int w, 516 int h, Uint32 flags); 517 518 /** 519 * \brief Create an SDL window from an existing native window. 520 * 521 * \param data A pointer to driver-dependent window creation data 522 * 523 * \return The created window, or NULL if window creation failed. 524 * 525 * \sa SDL_DestroyWindow() 526 */ 527 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data); 528 529 /** 530 * \brief Get the numeric ID of a window, for logging purposes. 531 */ 532 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window); 533 534 /** 535 * \brief Get a window from a stored ID, or NULL if it doesn't exist. 536 */ 537 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id); 538 539 /** 540 * \brief Get the window flags. 541 */ 542 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window); 543 544 /** 545 * \brief Set the title of a window, in UTF-8 format. 546 * 547 * \sa SDL_GetWindowTitle() 548 */ 549 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window, 550 const char *title); 551 552 /** 553 * \brief Get the title of a window, in UTF-8 format. 554 * 555 * \sa SDL_SetWindowTitle() 556 */ 557 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window); 558 559 /** 560 * \brief Set the icon for a window. 561 * 562 * \param window The window for which the icon should be set. 563 * \param icon The icon for the window. 564 */ 565 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window, 566 SDL_Surface * icon); 567 568 /** 569 * \brief Associate an arbitrary named pointer with a window. 570 * 571 * \param window The window to associate with the pointer. 572 * \param name The name of the pointer. 573 * \param userdata The associated pointer. 574 * 575 * \return The previous value associated with 'name' 576 * 577 * \note The name is case-sensitive. 578 * 579 * \sa SDL_GetWindowData() 580 */ 581 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window, 582 const char *name, 583 void *userdata); 584 585 /** 586 * \brief Retrieve the data pointer associated with a window. 587 * 588 * \param window The window to query. 589 * \param name The name of the pointer. 590 * 591 * \return The value associated with 'name' 592 * 593 * \sa SDL_SetWindowData() 594 */ 595 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window, 596 const char *name); 597 598 /** 599 * \brief Set the position of a window. 600 * 601 * \param window The window to reposition. 602 * \param x The x coordinate of the window in screen coordinates, or 603 * ::SDL_WINDOWPOS_CENTERED or ::SDL_WINDOWPOS_UNDEFINED. 604 * \param y The y coordinate of the window in screen coordinates, or 605 * ::SDL_WINDOWPOS_CENTERED or ::SDL_WINDOWPOS_UNDEFINED. 606 * 607 * \note The window coordinate origin is the upper left of the display. 608 * 609 * \sa SDL_GetWindowPosition() 610 */ 611 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window, 612 int x, int y); 613 614 /** 615 * \brief Get the position of a window. 616 * 617 * \param window The window to query. 618 * \param x Pointer to variable for storing the x position, in screen 619 * coordinates. May be NULL. 620 * \param y Pointer to variable for storing the y position, in screen 621 * coordinates. May be NULL. 622 * 623 * \sa SDL_SetWindowPosition() 624 */ 625 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window, 626 int *x, int *y); 627 628 /** 629 * \brief Set the size of a window's client area. 630 * 631 * \param window The window to resize. 632 * \param w The width of the window, in screen coordinates. Must be >0. 633 * \param h The height of the window, in screen coordinates. Must be >0. 634 * 635 * \note Fullscreen windows automatically match the size of the display mode, 636 * and you should use SDL_SetWindowDisplayMode() to change their size. 637 * 638 * The window size in screen coordinates may differ from the size in pixels, if 639 * the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with 640 * high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or 641 * SDL_GetRendererOutputSize() to get the real client area size in pixels. 642 * 643 * \sa SDL_GetWindowSize() 644 * \sa SDL_SetWindowDisplayMode() 645 */ 646 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w, 647 int h); 648 649 /** 650 * \brief Get the size of a window's client area. 651 * 652 * \param window The window to query. 653 * \param w Pointer to variable for storing the width, in screen 654 * coordinates. May be NULL. 655 * \param h Pointer to variable for storing the height, in screen 656 * coordinates. May be NULL. 657 * 658 * The window size in screen coordinates may differ from the size in pixels, if 659 * the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with 660 * high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or 661 * SDL_GetRendererOutputSize() to get the real client area size in pixels. 662 * 663 * \sa SDL_SetWindowSize() 664 */ 665 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w, 666 int *h); 667 668 /** 669 * \brief Get the size of a window's borders (decorations) around the client area. 670 * 671 * \param window The window to query. 672 * \param top Pointer to variable for storing the size of the top border. NULL is permitted. 673 * \param left Pointer to variable for storing the size of the left border. NULL is permitted. 674 * \param bottom Pointer to variable for storing the size of the bottom border. NULL is permitted. 675 * \param right Pointer to variable for storing the size of the right border. NULL is permitted. 676 * 677 * \return 0 on success, or -1 if getting this information is not supported. 678 * 679 * \note if this function fails (returns -1), the size values will be 680 * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as 681 * if the window in question was borderless. 682 */ 683 extern DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window * window, 684 int *top, int *left, 685 int *bottom, int *right); 686 687 /** 688 * \brief Set the minimum size of a window's client area. 689 * 690 * \param window The window to set a new minimum size. 691 * \param min_w The minimum width of the window, must be >0 692 * \param min_h The minimum height of the window, must be >0 693 * 694 * \note You can't change the minimum size of a fullscreen window, it 695 * automatically matches the size of the display mode. 696 * 697 * \sa SDL_GetWindowMinimumSize() 698 * \sa SDL_SetWindowMaximumSize() 699 */ 700 extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window, 701 int min_w, int min_h); 702 703 /** 704 * \brief Get the minimum size of a window's client area. 705 * 706 * \param window The window to query. 707 * \param w Pointer to variable for storing the minimum width, may be NULL 708 * \param h Pointer to variable for storing the minimum height, may be NULL 709 * 710 * \sa SDL_GetWindowMaximumSize() 711 * \sa SDL_SetWindowMinimumSize() 712 */ 713 extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window, 714 int *w, int *h); 715 716 /** 717 * \brief Set the maximum size of a window's client area. 718 * 719 * \param window The window to set a new maximum size. 720 * \param max_w The maximum width of the window, must be >0 721 * \param max_h The maximum height of the window, must be >0 722 * 723 * \note You can't change the maximum size of a fullscreen window, it 724 * automatically matches the size of the display mode. 725 * 726 * \sa SDL_GetWindowMaximumSize() 727 * \sa SDL_SetWindowMinimumSize() 728 */ 729 extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window, 730 int max_w, int max_h); 731 732 /** 733 * \brief Get the maximum size of a window's client area. 734 * 735 * \param window The window to query. 736 * \param w Pointer to variable for storing the maximum width, may be NULL 737 * \param h Pointer to variable for storing the maximum height, may be NULL 738 * 739 * \sa SDL_GetWindowMinimumSize() 740 * \sa SDL_SetWindowMaximumSize() 741 */ 742 extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window, 743 int *w, int *h); 744 745 /** 746 * \brief Set the border state of a window. 747 * 748 * This will add or remove the window's SDL_WINDOW_BORDERLESS flag and 749 * add or remove the border from the actual window. This is a no-op if the 750 * window's border already matches the requested state. 751 * 752 * \param window The window of which to change the border state. 753 * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border. 754 * 755 * \note You can't change the border state of a fullscreen window. 756 * 757 * \sa SDL_GetWindowFlags() 758 */ 759 extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window, 760 SDL_bool bordered); 761 762 /** 763 * \brief Set the user-resizable state of a window. 764 * 765 * This will add or remove the window's SDL_WINDOW_RESIZABLE flag and 766 * allow/disallow user resizing of the window. This is a no-op if the 767 * window's resizable state already matches the requested state. 768 * 769 * \param window The window of which to change the resizable state. 770 * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow. 771 * 772 * \note You can't change the resizable state of a fullscreen window. 773 * 774 * \sa SDL_GetWindowFlags() 775 */ 776 extern DECLSPEC void SDLCALL SDL_SetWindowResizable(SDL_Window * window, 777 SDL_bool resizable); 778 779 /** 780 * \brief Show a window. 781 * 782 * \sa SDL_HideWindow() 783 */ 784 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window); 785 786 /** 787 * \brief Hide a window. 788 * 789 * \sa SDL_ShowWindow() 790 */ 791 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window); 792 793 /** 794 * \brief Raise a window above other windows and set the input focus. 795 */ 796 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window); 797 798 /** 799 * \brief Make a window as large as possible. 800 * 801 * \sa SDL_RestoreWindow() 802 */ 803 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window); 804 805 /** 806 * \brief Minimize a window to an iconic representation. 807 * 808 * \sa SDL_RestoreWindow() 809 */ 810 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window); 811 812 /** 813 * \brief Restore the size and position of a minimized or maximized window. 814 * 815 * \sa SDL_MaximizeWindow() 816 * \sa SDL_MinimizeWindow() 817 */ 818 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window); 819 820 /** 821 * \brief Set a window's fullscreen state. 822 * 823 * \return 0 on success, or -1 if setting the display mode failed. 824 * 825 * \sa SDL_SetWindowDisplayMode() 826 * \sa SDL_GetWindowDisplayMode() 827 */ 828 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window, 829 Uint32 flags); 830 831 /** 832 * \brief Get the SDL surface associated with the window. 833 * 834 * \return The window's framebuffer surface, or NULL on error. 835 * 836 * A new surface will be created with the optimal format for the window, 837 * if necessary. This surface will be freed when the window is destroyed. 838 * 839 * \note You may not combine this with 3D or the rendering API on this window. 840 * 841 * \sa SDL_UpdateWindowSurface() 842 * \sa SDL_UpdateWindowSurfaceRects() 843 */ 844 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window); 845 846 /** 847 * \brief Copy the window surface to the screen. 848 * 849 * \return 0 on success, or -1 on error. 850 * 851 * \sa SDL_GetWindowSurface() 852 * \sa SDL_UpdateWindowSurfaceRects() 853 */ 854 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window); 855 856 /** 857 * \brief Copy a number of rectangles on the window surface to the screen. 858 * 859 * \return 0 on success, or -1 on error. 860 * 861 * \sa SDL_GetWindowSurface() 862 * \sa SDL_UpdateWindowSurface() 863 */ 864 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window, 865 const SDL_Rect * rects, 866 int numrects); 867 868 /** 869 * \brief Set a window's input grab mode. 870 * 871 * \param window The window for which the input grab mode should be set. 872 * \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input. 873 * 874 * If the caller enables a grab while another window is currently grabbed, 875 * the other window loses its grab in favor of the caller's window. 876 * 877 * \sa SDL_GetWindowGrab() 878 */ 879 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window, 880 SDL_bool grabbed); 881 882 /** 883 * \brief Get a window's input grab mode. 884 * 885 * \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise. 886 * 887 * \sa SDL_SetWindowGrab() 888 */ 889 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window); 890 891 /** 892 * \brief Get the window that currently has an input grab enabled. 893 * 894 * \return This returns the window if input is grabbed, and NULL otherwise. 895 * 896 * \sa SDL_SetWindowGrab() 897 */ 898 extern DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void); 899 900 /** 901 * \brief Set the brightness (gamma correction) for a window. 902 * 903 * \return 0 on success, or -1 if setting the brightness isn't supported. 904 * 905 * \sa SDL_GetWindowBrightness() 906 * \sa SDL_SetWindowGammaRamp() 907 */ 908 extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness); 909 910 /** 911 * \brief Get the brightness (gamma correction) for a window. 912 * 913 * \return The last brightness value passed to SDL_SetWindowBrightness() 914 * 915 * \sa SDL_SetWindowBrightness() 916 */ 917 extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window); 918 919 /** 920 * \brief Set the opacity for a window 921 * 922 * \param window The window which will be made transparent or opaque 923 * \param opacity Opacity (0.0f - transparent, 1.0f - opaque) This will be 924 * clamped internally between 0.0f and 1.0f. 925 * 926 * \return 0 on success, or -1 if setting the opacity isn't supported. 927 * 928 * \sa SDL_GetWindowOpacity() 929 */ 930 extern DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window * window, float opacity); 931 932 /** 933 * \brief Get the opacity of a window. 934 * 935 * If transparency isn't supported on this platform, opacity will be reported 936 * as 1.0f without error. 937 * 938 * \param window The window in question. 939 * \param out_opacity Opacity (0.0f - transparent, 1.0f - opaque) 940 * 941 * \return 0 on success, or -1 on error (invalid window, etc). 942 * 943 * \sa SDL_SetWindowOpacity() 944 */ 945 extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window * window, float * out_opacity); 946 947 /** 948 * \brief Sets the window as a modal for another window (TODO: reconsider this function and/or its name) 949 * 950 * \param modal_window The window that should be modal 951 * \param parent_window The parent window 952 * 953 * \return 0 on success, or -1 otherwise. 954 */ 955 extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window * modal_window, SDL_Window * parent_window); 956 957 /** 958 * \brief Explicitly sets input focus to the window. 959 * 960 * You almost certainly want SDL_RaiseWindow() instead of this function. Use 961 * this with caution, as you might give focus to a window that's completely 962 * obscured by other windows. 963 * 964 * \param window The window that should get the input focus 965 * 966 * \return 0 on success, or -1 otherwise. 967 * \sa SDL_RaiseWindow() 968 */ 969 extern DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window * window); 970 971 /** 972 * \brief Set the gamma ramp for a window. 973 * 974 * \param window The window for which the gamma ramp should be set. 975 * \param red The translation table for the red channel, or NULL. 976 * \param green The translation table for the green channel, or NULL. 977 * \param blue The translation table for the blue channel, or NULL. 978 * 979 * \return 0 on success, or -1 if gamma ramps are unsupported. 980 * 981 * Set the gamma translation table for the red, green, and blue channels 982 * of the video hardware. Each table is an array of 256 16-bit quantities, 983 * representing a mapping between the input and output for that channel. 984 * The input is the index into the array, and the output is the 16-bit 985 * gamma value at that index, scaled to the output color precision. 986 * 987 * \sa SDL_GetWindowGammaRamp() 988 */ 989 extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window, 990 const Uint16 * red, 991 const Uint16 * green, 992 const Uint16 * blue); 993 994 /** 995 * \brief Get the gamma ramp for a window. 996 * 997 * \param window The window from which the gamma ramp should be queried. 998 * \param red A pointer to a 256 element array of 16-bit quantities to hold 999 * the translation table for the red channel, or NULL. 1000 * \param green A pointer to a 256 element array of 16-bit quantities to hold 1001 * the translation table for the green channel, or NULL. 1002 * \param blue A pointer to a 256 element array of 16-bit quantities to hold 1003 * the translation table for the blue channel, or NULL. 1004 * 1005 * \return 0 on success, or -1 if gamma ramps are unsupported. 1006 * 1007 * \sa SDL_SetWindowGammaRamp() 1008 */ 1009 extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window, 1010 Uint16 * red, 1011 Uint16 * green, 1012 Uint16 * blue); 1013 1014 /** 1015 * \brief Possible return values from the SDL_HitTest callback. 1016 * 1017 * \sa SDL_HitTest 1018 */ 1019 typedef enum 1020 { 1021 SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */ 1022 SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */ 1023 SDL_HITTEST_RESIZE_TOPLEFT, 1024 SDL_HITTEST_RESIZE_TOP, 1025 SDL_HITTEST_RESIZE_TOPRIGHT, 1026 SDL_HITTEST_RESIZE_RIGHT, 1027 SDL_HITTEST_RESIZE_BOTTOMRIGHT, 1028 SDL_HITTEST_RESIZE_BOTTOM, 1029 SDL_HITTEST_RESIZE_BOTTOMLEFT, 1030 SDL_HITTEST_RESIZE_LEFT 1031 } SDL_HitTestResult; 1032 1033 /** 1034 * \brief Callback used for hit-testing. 1035 * 1036 * \sa SDL_SetWindowHitTest 1037 */ 1038 typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win, 1039 const SDL_Point *area, 1040 void *data); 1041 1042 /** 1043 * \brief Provide a callback that decides if a window region has special properties. 1044 * 1045 * Normally windows are dragged and resized by decorations provided by the 1046 * system window manager (a title bar, borders, etc), but for some apps, it 1047 * makes sense to drag them from somewhere else inside the window itself; for 1048 * example, one might have a borderless window that wants to be draggable 1049 * from any part, or simulate its own title bar, etc. 1050 * 1051 * This function lets the app provide a callback that designates pieces of 1052 * a given window as special. This callback is run during event processing 1053 * if we need to tell the OS to treat a region of the window specially; the 1054 * use of this callback is known as "hit testing." 1055 * 1056 * Mouse input may not be delivered to your application if it is within 1057 * a special area; the OS will often apply that input to moving the window or 1058 * resizing the window and not deliver it to the application. 1059 * 1060 * Specifying NULL for a callback disables hit-testing. Hit-testing is 1061 * disabled by default. 1062 * 1063 * Platforms that don't support this functionality will return -1 1064 * unconditionally, even if you're attempting to disable hit-testing. 1065 * 1066 * Your callback may fire at any time, and its firing does not indicate any 1067 * specific behavior (for example, on Windows, this certainly might fire 1068 * when the OS is deciding whether to drag your window, but it fires for lots 1069 * of other reasons, too, some unrelated to anything you probably care about 1070 * _and when the mouse isn't actually at the location it is testing_). 1071 * Since this can fire at any time, you should try to keep your callback 1072 * efficient, devoid of allocations, etc. 1073 * 1074 * \param window The window to set hit-testing on. 1075 * \param callback The callback to call when doing a hit-test. 1076 * \param callback_data An app-defined void pointer passed to the callback. 1077 * \return 0 on success, -1 on error (including unsupported). 1078 */ 1079 extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window * window, 1080 SDL_HitTest callback, 1081 void *callback_data); 1082 1083 /** 1084 * \brief Destroy a window. 1085 */ 1086 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window); 1087 1088 1089 /** 1090 * \brief Returns whether the screensaver is currently enabled (default off). 1091 * 1092 * \sa SDL_EnableScreenSaver() 1093 * \sa SDL_DisableScreenSaver() 1094 */ 1095 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void); 1096 1097 /** 1098 * \brief Allow the screen to be blanked by a screensaver 1099 * 1100 * \sa SDL_IsScreenSaverEnabled() 1101 * \sa SDL_DisableScreenSaver() 1102 */ 1103 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void); 1104 1105 /** 1106 * \brief Prevent the screen from being blanked by a screensaver 1107 * 1108 * \sa SDL_IsScreenSaverEnabled() 1109 * \sa SDL_EnableScreenSaver() 1110 */ 1111 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void); 1112 1113 1114 /** 1115 * \name OpenGL support functions 1116 */ 1117 /* @{ */ 1118 1119 /** 1120 * \brief Dynamically load an OpenGL library. 1121 * 1122 * \param path The platform dependent OpenGL library name, or NULL to open the 1123 * default OpenGL library. 1124 * 1125 * \return 0 on success, or -1 if the library couldn't be loaded. 1126 * 1127 * This should be done after initializing the video driver, but before 1128 * creating any OpenGL windows. If no OpenGL library is loaded, the default 1129 * library will be loaded upon creation of the first OpenGL window. 1130 * 1131 * \note If you do this, you need to retrieve all of the GL functions used in 1132 * your program from the dynamic library using SDL_GL_GetProcAddress(). 1133 * 1134 * \sa SDL_GL_GetProcAddress() 1135 * \sa SDL_GL_UnloadLibrary() 1136 */ 1137 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path); 1138 1139 /** 1140 * \brief Get the address of an OpenGL function. 1141 */ 1142 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc); 1143 1144 /** 1145 * \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary(). 1146 * 1147 * \sa SDL_GL_LoadLibrary() 1148 */ 1149 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void); 1150 1151 /** 1152 * \brief Return true if an OpenGL extension is supported for the current 1153 * context. 1154 */ 1155 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char 1156 *extension); 1157 1158 /** 1159 * \brief Reset all previously set OpenGL context attributes to their default values 1160 */ 1161 extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void); 1162 1163 /** 1164 * \brief Set an OpenGL window attribute before window creation. 1165 * 1166 * \return 0 on success, or -1 if the attribute could not be set. 1167 */ 1168 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value); 1169 1170 /** 1171 * \brief Get the actual value for an attribute from the current context. 1172 * 1173 * \return 0 on success, or -1 if the attribute could not be retrieved. 1174 * The integer at \c value will be modified in either case. 1175 */ 1176 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value); 1177 1178 /** 1179 * \brief Create an OpenGL context for use with an OpenGL window, and make it 1180 * current. 1181 * 1182 * \sa SDL_GL_DeleteContext() 1183 */ 1184 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window * 1185 window); 1186 1187 /** 1188 * \brief Set up an OpenGL context for rendering into an OpenGL window. 1189 * 1190 * \note The context must have been created with a compatible window. 1191 */ 1192 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window, 1193 SDL_GLContext context); 1194 1195 /** 1196 * \brief Get the currently active OpenGL window. 1197 */ 1198 extern DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow(void); 1199 1200 /** 1201 * \brief Get the currently active OpenGL context. 1202 */ 1203 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void); 1204 1205 /** 1206 * \brief Get the size of a window's underlying drawable in pixels (for use 1207 * with glViewport). 1208 * 1209 * \param window Window from which the drawable size should be queried 1210 * \param w Pointer to variable for storing the width in pixels, may be NULL 1211 * \param h Pointer to variable for storing the height in pixels, may be NULL 1212 * 1213 * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI 1214 * drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a 1215 * platform with high-DPI support (Apple calls this "Retina"), and not disabled 1216 * by the SDL_HINT_VIDEO_HIGHDPI_DISABLED hint. 1217 * 1218 * \sa SDL_GetWindowSize() 1219 * \sa SDL_CreateWindow() 1220 */ 1221 extern DECLSPEC void SDLCALL SDL_GL_GetDrawableSize(SDL_Window * window, int *w, 1222 int *h); 1223 1224 /** 1225 * \brief Set the swap interval for the current OpenGL context. 1226 * 1227 * \param interval 0 for immediate updates, 1 for updates synchronized with the 1228 * vertical retrace. If the system supports it, you may 1229 * specify -1 to allow late swaps to happen immediately 1230 * instead of waiting for the next retrace. 1231 * 1232 * \return 0 on success, or -1 if setting the swap interval is not supported. 1233 * 1234 * \sa SDL_GL_GetSwapInterval() 1235 */ 1236 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval); 1237 1238 /** 1239 * \brief Get the swap interval for the current OpenGL context. 1240 * 1241 * \return 0 if there is no vertical retrace synchronization, 1 if the buffer 1242 * swap is synchronized with the vertical retrace, and -1 if late 1243 * swaps happen immediately instead of waiting for the next retrace. 1244 * If the system can't determine the swap interval, or there isn't a 1245 * valid current context, this will return 0 as a safe default. 1246 * 1247 * \sa SDL_GL_SetSwapInterval() 1248 */ 1249 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void); 1250 1251 /** 1252 * \brief Swap the OpenGL buffers for a window, if double-buffering is 1253 * supported. 1254 */ 1255 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window); 1256 1257 /** 1258 * \brief Delete an OpenGL context. 1259 * 1260 * \sa SDL_GL_CreateContext() 1261 */ 1262 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context); 1263 1264 /* @} *//* OpenGL support functions */ 1265 1266 1267 /* Ends C function definitions when using C++ */ 1268 #ifdef __cplusplus 1269 } 1270 #endif 1271 #include "close_code.h" 1272 1273 #endif /* SDL_video_h_ */ 1274 1275 /* vi: set ts=4 sw=4 expandtab: */ 1276