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