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