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