include/SDL_video.h
author Philipp Wiesemann <philipp.wiesemann@arcor.de>
Wed, 15 May 2013 22:00:28 +0200
changeset 7175 45276691c8c8
parent 7014 3e0d048e1c14
child 7188 20bd120bf7e4
permissions -rw-r--r--
Fixed Doxygen warnings.
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 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@3407
    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@1895
    39
/* *INDENT-OFF* */
slouken@0
    40
extern "C" {
slouken@1895
    41
/* *INDENT-ON* */
slouken@0
    42
#endif
slouken@0
    43
slouken@1895
    44
/**
slouken@3407
    45
 *  \brief  The structure that defines a display mode
slouken@3407
    46
 *  
slouken@3407
    47
 *  \sa SDL_GetNumDisplayModes()
slouken@3407
    48
 *  \sa SDL_GetDisplayMode()
slouken@3407
    49
 *  \sa SDL_GetDesktopDisplayMode()
slouken@3407
    50
 *  \sa SDL_GetCurrentDisplayMode()
slouken@3407
    51
 *  \sa SDL_GetClosestDisplayMode()
slouken@3500
    52
 *  \sa SDL_SetWindowDisplayMode()
slouken@3500
    53
 *  \sa SDL_GetWindowDisplayMode()
slouken@1895
    54
 */
slouken@1895
    55
typedef struct
slouken@1895
    56
{
slouken@1895
    57
    Uint32 format;              /**< pixel format */
slouken@1895
    58
    int w;                      /**< width */
slouken@1895
    59
    int h;                      /**< height */
slouken@1895
    60
    int refresh_rate;           /**< refresh rate (or zero for unspecified) */
slouken@1895
    61
    void *driverdata;           /**< driver-specific data, initialize to 0 */
slouken@1895
    62
} SDL_DisplayMode;
slouken@0
    63
slouken@1895
    64
/**
slouken@3407
    65
 *  \brief The type used to identify a window
slouken@3407
    66
 *  
slouken@3407
    67
 *  \sa SDL_CreateWindow()
slouken@3407
    68
 *  \sa SDL_CreateWindowFrom()
slouken@3407
    69
 *  \sa SDL_DestroyWindow()
slouken@3407
    70
 *  \sa SDL_GetWindowData()
slouken@3407
    71
 *  \sa SDL_GetWindowFlags()
slouken@3407
    72
 *  \sa SDL_GetWindowGrab()
slouken@3407
    73
 *  \sa SDL_GetWindowPosition()
slouken@3407
    74
 *  \sa SDL_GetWindowSize()
slouken@3407
    75
 *  \sa SDL_GetWindowTitle()
slouken@3407
    76
 *  \sa SDL_HideWindow()
slouken@3407
    77
 *  \sa SDL_MaximizeWindow()
slouken@3407
    78
 *  \sa SDL_MinimizeWindow()
slouken@3407
    79
 *  \sa SDL_RaiseWindow()
slouken@3407
    80
 *  \sa SDL_RestoreWindow()
slouken@3407
    81
 *  \sa SDL_SetWindowData()
slouken@3407
    82
 *  \sa SDL_SetWindowFullscreen()
slouken@3407
    83
 *  \sa SDL_SetWindowGrab()
slouken@3407
    84
 *  \sa SDL_SetWindowIcon()
slouken@3407
    85
 *  \sa SDL_SetWindowPosition()
slouken@3407
    86
 *  \sa SDL_SetWindowSize()
icculus@6429
    87
 *  \sa SDL_SetWindowBordered()
slouken@3407
    88
 *  \sa SDL_SetWindowTitle()
slouken@3407
    89
 *  \sa SDL_ShowWindow()
slouken@1895
    90
 */
slouken@3685
    91
typedef struct SDL_Window SDL_Window;
slouken@0
    92
slouken@1895
    93
/**
slouken@3407
    94
 *  \brief The flags on a window
slouken@3407
    95
 *  
slouken@3407
    96
 *  \sa SDL_GetWindowFlags()
slouken@1895
    97
 */
slouken@1895
    98
typedef enum
slouken@1895
    99
{
slouken@5380
   100
    SDL_WINDOW_FULLSCREEN = 0x00000001,         /**< fullscreen window */
slouken@1895
   101
    SDL_WINDOW_OPENGL = 0x00000002,             /**< window usable with OpenGL context */
slouken@1895
   102
    SDL_WINDOW_SHOWN = 0x00000004,              /**< window is visible */
slouken@5380
   103
    SDL_WINDOW_HIDDEN = 0x00000008,             /**< window is not visible */
slouken@5380
   104
    SDL_WINDOW_BORDERLESS = 0x00000010,         /**< no window decoration */
slouken@5380
   105
    SDL_WINDOW_RESIZABLE = 0x00000020,          /**< window can be resized */
slouken@5380
   106
    SDL_WINDOW_MINIMIZED = 0x00000040,          /**< window is minimized */
slouken@5380
   107
    SDL_WINDOW_MAXIMIZED = 0x00000080,          /**< window is maximized */
slouken@1895
   108
    SDL_WINDOW_INPUT_GRABBED = 0x00000100,      /**< window has grabbed input focus */
slouken@1895
   109
    SDL_WINDOW_INPUT_FOCUS = 0x00000200,        /**< window has input focus */
slouken@3057
   110
    SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        /**< window has mouse focus */
slouken@6755
   111
	SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
slouken@3057
   112
    SDL_WINDOW_FOREIGN = 0x00000800             /**< window not created by SDL */
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@3407
   141
    SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be 
slouken@3407
   142
                                         redrawn */
slouken@3407
   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 */
slouken@5276
   146
    SDL_WINDOWEVENT_SIZE_CHANGED,   /**< The window size has changed, either as a result of an API call or through the system or user changing the window size. */
slouken@3407
   147
    SDL_WINDOWEVENT_MINIMIZED,      /**< Window has been minimized */
slouken@3407
   148
    SDL_WINDOWEVENT_MAXIMIZED,      /**< Window has been maximized */
slouken@3407
   149
    SDL_WINDOWEVENT_RESTORED,       /**< Window has been restored to normal size
slouken@3407
   150
                                         and position */
slouken@3691
   151
    SDL_WINDOWEVENT_ENTER,          /**< Window has gained mouse focus */
slouken@3691
   152
    SDL_WINDOWEVENT_LEAVE,          /**< Window has lost mouse focus */
slouken@3691
   153
    SDL_WINDOWEVENT_FOCUS_GAINED,   /**< Window has gained keyboard focus */
slouken@3691
   154
    SDL_WINDOWEVENT_FOCUS_LOST,     /**< Window has lost keyboard focus */
slouken@3407
   155
    SDL_WINDOWEVENT_CLOSE           /**< The window manager requests that the 
slouken@3407
   156
                                         window be closed */
slouken@1895
   157
} SDL_WindowEventID;
slouken@1895
   158
slouken@1895
   159
/**
slouken@3407
   160
 *  \brief An opaque handle to an OpenGL context.
slouken@1895
   161
 */
slouken@1895
   162
typedef void *SDL_GLContext;
slouken@1895
   163
slouken@1895
   164
/**
slouken@3407
   165
 *  \brief OpenGL configuration attributes
slouken@0
   166
 */
slouken@1895
   167
typedef enum
slouken@1895
   168
{
slouken@0
   169
    SDL_GL_RED_SIZE,
slouken@0
   170
    SDL_GL_GREEN_SIZE,
slouken@0
   171
    SDL_GL_BLUE_SIZE,
slouken@0
   172
    SDL_GL_ALPHA_SIZE,
slouken@0
   173
    SDL_GL_BUFFER_SIZE,
slouken@0
   174
    SDL_GL_DOUBLEBUFFER,
slouken@0
   175
    SDL_GL_DEPTH_SIZE,
slouken@0
   176
    SDL_GL_STENCIL_SIZE,
slouken@0
   177
    SDL_GL_ACCUM_RED_SIZE,
slouken@0
   178
    SDL_GL_ACCUM_GREEN_SIZE,
slouken@0
   179
    SDL_GL_ACCUM_BLUE_SIZE,
slouken@450
   180
    SDL_GL_ACCUM_ALPHA_SIZE,
slouken@655
   181
    SDL_GL_STEREO,
slouken@656
   182
    SDL_GL_MULTISAMPLEBUFFERS,
slouken@1736
   183
    SDL_GL_MULTISAMPLESAMPLES,
hfutrell@2747
   184
    SDL_GL_ACCELERATED_VISUAL,
slouken@3100
   185
    SDL_GL_RETAINED_BACKING,
slouken@3139
   186
    SDL_GL_CONTEXT_MAJOR_VERSION,
slouken@6296
   187
    SDL_GL_CONTEXT_MINOR_VERSION,
slouken@6370
   188
    SDL_GL_CONTEXT_EGL,
slouken@6296
   189
    SDL_GL_CONTEXT_FLAGS,
slouken@6393
   190
    SDL_GL_CONTEXT_PROFILE_MASK,
slouken@6393
   191
    SDL_GL_SHARE_WITH_CURRENT_CONTEXT
slouken@0
   192
} SDL_GLattr;
slouken@0
   193
slouken@6296
   194
typedef enum
slouken@6296
   195
{
slouken@6296
   196
    SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
slouken@6296
   197
    SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
slouken@6394
   198
    SDL_GL_CONTEXT_PROFILE_ES             = 0x0004
slouken@6296
   199
} SDL_GLprofile;
slouken@6296
   200
slouken@6296
   201
typedef enum
slouken@6296
   202
{
slouken@6296
   203
    SDL_GL_CONTEXT_DEBUG_FLAG              = 0x0001,
slouken@6296
   204
    SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
slouken@6393
   205
    SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG      = 0x0004,
slouken@6393
   206
    SDL_GL_CONTEXT_RESET_ISOLATION_FLAG    = 0x0008
slouken@6296
   207
} SDL_GLcontextFlag;
slouken@6296
   208
slouken@0
   209
slouken@0
   210
/* Function prototypes */
slouken@0
   211
slouken@1895
   212
/**
slouken@3407
   213
 *  \brief Get the number of video drivers compiled into SDL
slouken@3407
   214
 *  
slouken@3407
   215
 *  \sa SDL_GetVideoDriver()
slouken@0
   216
 */
slouken@1895
   217
extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
slouken@1895
   218
slouken@1895
   219
/**
slouken@3407
   220
 *  \brief Get the name of a built in video driver.
slouken@3407
   221
 *  
slouken@3407
   222
 *  \note The video drivers are presented in the order in which they are
slouken@3407
   223
 *        normally checked during initialization.
slouken@3407
   224
 *  
slouken@3407
   225
 *  \sa SDL_GetNumVideoDrivers()
slouken@1895
   226
 */
slouken@1895
   227
extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
slouken@1895
   228
slouken@1895
   229
/**
slouken@3407
   230
 *  \brief Initialize the video subsystem, optionally specifying a video driver.
slouken@3407
   231
 *  
slouken@3407
   232
 *  \param driver_name Initialize a specific driver by name, or NULL for the 
slouken@3407
   233
 *                     default video driver.
slouken@3407
   234
 *  
slouken@3407
   235
 *  \return 0 on success, -1 on error
slouken@3407
   236
 *  
slouken@3407
   237
 *  This function initializes the video subsystem; setting up a connection
slouken@3407
   238
 *  to the window manager, etc, and determines the available display modes
slouken@3407
   239
 *  and pixel formats, but does not initialize a window or graphics mode.
slouken@3407
   240
 *  
slouken@3407
   241
 *  \sa SDL_VideoQuit()
slouken@1895
   242
 */
slouken@5123
   243
extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
slouken@1895
   244
slouken@1895
   245
/**
slouken@3407
   246
 *  \brief Shuts down the video subsystem.
slouken@3407
   247
 *  
slouken@3407
   248
 *  This function closes all windows, and restores the original video mode.
slouken@3407
   249
 *  
slouken@3407
   250
 *  \sa SDL_VideoInit()
slouken@1895
   251
 */
slouken@337
   252
extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
slouken@0
   253
slouken@1895
   254
/**
slouken@3407
   255
 *  \brief Returns the name of the currently initialized video driver.
slouken@3407
   256
 *  
slouken@3407
   257
 *  \return The name of the current video driver or NULL if no driver
slouken@3407
   258
 *          has been initialized
slouken@3407
   259
 *  
slouken@3407
   260
 *  \sa SDL_GetNumVideoDrivers()
slouken@3407
   261
 *  \sa SDL_GetVideoDriver()
slouken@0
   262
 */
slouken@1895
   263
extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
slouken@0
   264
slouken@1895
   265
/**
slouken@3407
   266
 *  \brief Returns the number of available video displays.
slouken@3407
   267
 *  
slouken@3528
   268
 *  \sa SDL_GetDisplayBounds()
slouken@0
   269
 */
slouken@1895
   270
extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
slouken@0
   271
slouken@1895
   272
/**
slouken@6787
   273
 *  \brief Get the name of a display in UTF-8 encoding
slouken@6787
   274
 *  
slouken@6787
   275
 *  \return The name of a display, or NULL for an invalid display index.
slouken@6787
   276
 *  
slouken@6787
   277
 *  \sa SDL_GetNumVideoDisplays()
slouken@6787
   278
 */
slouken@6787
   279
extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
slouken@6787
   280
slouken@6787
   281
/**
slouken@3528
   282
 *  \brief Get the desktop area represented by a display, with the primary
slouken@3528
   283
 *         display located at 0,0
slouken@3528
   284
 *  
slouken@3528
   285
 *  \return 0 on success, or -1 if the index is out of range.
slouken@3528
   286
 *  
slouken@3528
   287
 *  \sa SDL_GetNumVideoDisplays()
slouken@3528
   288
 */
slouken@5244
   289
extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
slouken@3528
   290
slouken@3528
   291
/**
slouken@5244
   292
 *  \brief Returns the number of available display modes.
slouken@3407
   293
 *  
slouken@3407
   294
 *  \sa SDL_GetDisplayMode()
slouken@0
   295
 */
slouken@5244
   296
extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
slouken@0
   297
slouken@1895
   298
/**
slouken@3407
   299
 *  \brief Fill in information about a specific display mode.
slouken@3407
   300
 *  
slouken@3407
   301
 *  \note The display modes are sorted in this priority:
slouken@3407
   302
 *        \li bits per pixel -> more colors to fewer colors
slouken@3407
   303
 *        \li width -> largest to smallest
slouken@3407
   304
 *        \li height -> largest to smallest
slouken@3407
   305
 *        \li refresh rate -> highest to lowest
slouken@3407
   306
 *  
slouken@3407
   307
 *  \sa SDL_GetNumDisplayModes()
slouken@0
   308
 */
slouken@5244
   309
extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
slouken@1967
   310
                                               SDL_DisplayMode * mode);
slouken@0
   311
slouken@1895
   312
/**
slouken@5244
   313
 *  \brief Fill in information about the desktop display mode.
slouken@1895
   314
 */
slouken@5244
   315
extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
slouken@1895
   316
slouken@1895
   317
/**
slouken@3407
   318
 *  \brief Fill in information about the current display mode.
slouken@1895
   319
 */
slouken@5244
   320
extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
slouken@1895
   321
slouken@3400
   322
slouken@1895
   323
/**
slouken@3407
   324
 *  \brief Get the closest match to the requested display mode.
slouken@3407
   325
 *  
slouken@3407
   326
 *  \param mode The desired display mode
slouken@3407
   327
 *  \param closest A pointer to a display mode to be filled in with the closest 
slouken@3407
   328
 *                 match of the available display modes.
slouken@3407
   329
 *  
slouken@3407
   330
 *  \return The passed in value \c closest, or NULL if no matching video mode 
slouken@3407
   331
 *          was available.
slouken@3407
   332
 *  
slouken@3407
   333
 *  The available display modes are scanned, and \c closest is filled in with the
slouken@3407
   334
 *  closest mode matching the requested mode and returned.  The mode format and 
slouken@3407
   335
 *  refresh_rate default to the desktop mode if they are 0.  The modes are 
slouken@3407
   336
 *  scanned with size being first priority, format being second priority, and 
slouken@3407
   337
 *  finally checking the refresh_rate.  If all the available modes are too 
slouken@3407
   338
 *  small, then NULL is returned.
slouken@3407
   339
 *  
slouken@3407
   340
 *  \sa SDL_GetNumDisplayModes()
slouken@3407
   341
 *  \sa SDL_GetDisplayMode()
slouken@1895
   342
 */
slouken@5244
   343
extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
slouken@1895
   344
slouken@1895
   345
/**
slouken@5246
   346
 *  \brief Get the display index associated with a window.
slouken@5246
   347
 *  
slouken@5246
   348
 *  \return the display index of the display containing the center of the
slouken@5246
   349
 *          window, or -1 on error.
slouken@5246
   350
 */
slouken@6786
   351
extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window);
slouken@5246
   352
slouken@5246
   353
/**
slouken@5244
   354
 *  \brief Set the display mode used when a fullscreen window is visible.
slouken@5244
   355
 *
slouken@5244
   356
 *  By default the window's dimensions and the desktop format and refresh rate
slouken@5244
   357
 *  are used.
slouken@3407
   358
 *  
slouken@3500
   359
 *  \param mode The mode to use, or NULL for the default mode.
slouken@3407
   360
 *  
slouken@3407
   361
 *  \return 0 on success, or -1 if setting the display mode failed.
slouken@3407
   362
 *  
slouken@3522
   363
 *  \sa SDL_GetWindowDisplayMode()
slouken@3407
   364
 *  \sa SDL_SetWindowFullscreen()
slouken@0
   365
 */
slouken@3685
   366
extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
slouken@3500
   367
                                                     const SDL_DisplayMode
slouken@1895
   368
                                                         * mode);
slouken@0
   369
slouken@1895
   370
/**
slouken@3407
   371
 *  \brief Fill in information about the display mode used when a fullscreen
slouken@5244
   372
 *         window is visible.
slouken@3522
   373
 *
slouken@3522
   374
 *  \sa SDL_SetWindowDisplayMode()
slouken@3522
   375
 *  \sa SDL_SetWindowFullscreen()
slouken@0
   376
 */
slouken@3685
   377
extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
slouken@3500
   378
                                                     SDL_DisplayMode * mode);
slouken@0
   379
slouken@1895
   380
/**
slouken@5154
   381
 *  \brief Get the pixel format associated with the window.
slouken@5154
   382
 */
slouken@5154
   383
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
slouken@5154
   384
slouken@5154
   385
/**
slouken@3407
   386
 *  \brief Create a window with the specified position, dimensions, and flags.
slouken@3407
   387
 *  
slouken@3407
   388
 *  \param title The title of the window, in UTF-8 encoding.
slouken@3407
   389
 *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 
slouken@3407
   390
 *               ::SDL_WINDOWPOS_UNDEFINED.
slouken@3407
   391
 *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 
slouken@3407
   392
 *               ::SDL_WINDOWPOS_UNDEFINED.
slouken@3407
   393
 *  \param w     The width of the window.
slouken@3407
   394
 *  \param h     The height of the window.
slouken@3407
   395
 *  \param flags The flags for the window, a mask of any of the following: 
slouken@3407
   396
 *               ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL, 
slouken@3407
   397
 *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_BORDERLESS, 
slouken@3407
   398
 *               ::SDL_WINDOW_RESIZABLE,  ::SDL_WINDOW_MAXIMIZED, 
slouken@3407
   399
 *               ::SDL_WINDOW_MINIMIZED,  ::SDL_WINDOW_INPUT_GRABBED.
slouken@3407
   400
 *  
slouken@3407
   401
 *  \return The id of the window created, or zero if window creation failed.
slouken@3407
   402
 *  
slouken@3407
   403
 *  \sa SDL_DestroyWindow()
slouken@0
   404
 */
slouken@3685
   405
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
slouken@1895
   406
                                                      int x, int y, int w,
slouken@1895
   407
                                                      int h, Uint32 flags);
slouken@0
   408
slouken@1895
   409
/**
slouken@3493
   410
 *  \brief Create an SDL window from an existing native window.
slouken@3407
   411
 *  
slouken@3407
   412
 *  \param data A pointer to driver-dependent window creation data
slouken@3407
   413
 *  
slouken@3407
   414
 *  \return The id of the window created, or zero if window creation failed.
slouken@3407
   415
 *  
slouken@3407
   416
 *  \sa SDL_DestroyWindow()
slouken@0
   417
 */
slouken@3685
   418
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
slouken@3685
   419
slouken@3685
   420
/**
slouken@4883
   421
 *  \brief Get the numeric ID of a window, for logging purposes.
slouken@3685
   422
 */
slouken@3685
   423
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
slouken@3685
   424
slouken@3685
   425
/**
slouken@3685
   426
 *  \brief Get a window from a stored ID, or NULL if it doesn't exist.
slouken@3685
   427
 */
slouken@3685
   428
extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
slouken@1895
   429
slouken@1895
   430
/**
slouken@3407
   431
 *  \brief Get the window flags.
slouken@1895
   432
 */
slouken@3685
   433
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
slouken@1895
   434
slouken@1895
   435
/**
slouken@4883
   436
 *  \brief Set the title of a window, in UTF-8 format.
slouken@3407
   437
 *  
slouken@3407
   438
 *  \sa SDL_GetWindowTitle()
slouken@1895
   439
 */
slouken@3685
   440
extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
slouken@1895
   441
                                                const char *title);
slouken@1895
   442
slouken@1895
   443
/**
slouken@4883
   444
 *  \brief Get the title of a window, in UTF-8 format.
slouken@3407
   445
 *  
slouken@3407
   446
 *  \sa SDL_SetWindowTitle()
slouken@1895
   447
 */
slouken@3685
   448
extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
slouken@1895
   449
slouken@1895
   450
/**
slouken@4887
   451
 *  \brief Set the icon for a window.
slouken@3407
   452
 *  
slouken@4887
   453
 *  \param icon The icon for the window.
slouken@1895
   454
 */
slouken@3685
   455
extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
slouken@2990
   456
                                               SDL_Surface * icon);
slouken@1895
   457
slouken@1895
   458
/**
slouken@5165
   459
 *  \brief Associate an arbitrary named pointer with a window.
slouken@3407
   460
 *  
slouken@5165
   461
 *  \param window   The window to associate with the pointer.
slouken@5165
   462
 *  \param name     The name of the pointer.
slouken@5165
   463
 *  \param userdata The associated pointer.
slouken@5165
   464
 *
slouken@5165
   465
 *  \return The previous value associated with 'name'
slouken@5165
   466
 *
slouken@5165
   467
 *  \note The name is case-sensitive.
slouken@5165
   468
 *
slouken@3407
   469
 *  \sa SDL_GetWindowData()
slouken@1895
   470
 */
slouken@5165
   471
extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
slouken@5165
   472
                                                const char *name,
slouken@5165
   473
                                                void *userdata);
slouken@1895
   474
slouken@1895
   475
/**
slouken@4883
   476
 *  \brief Retrieve the data pointer associated with a window.
slouken@3407
   477
 *  
slouken@5165
   478
 *  \param window   The window to query.
slouken@5165
   479
 *  \param name     The name of the pointer.
slouken@5165
   480
 *
slouken@5165
   481
 *  \return The value associated with 'name'
slouken@5165
   482
 *  
slouken@3407
   483
 *  \sa SDL_SetWindowData()
slouken@1895
   484
 */
slouken@5165
   485
extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
slouken@5165
   486
                                                const char *name);
slouken@1895
   487
slouken@1895
   488
/**
slouken@4883
   489
 *  \brief Set the position of a window.
slouken@3407
   490
 *  
slouken@5165
   491
 *  \param window   The window to reposition.
slouken@3407
   492
 *  \param x        The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
slouken@3407
   493
                    ::SDL_WINDOWPOS_UNDEFINED.
slouken@3407
   494
 *  \param y        The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
slouken@3407
   495
                    ::SDL_WINDOWPOS_UNDEFINED.
slouken@3407
   496
 *  
slouken@3407
   497
 *  \note The window coordinate origin is the upper left of the display.
slouken@3407
   498
 *  
slouken@3407
   499
 *  \sa SDL_GetWindowPosition()
slouken@1895
   500
 */
slouken@3685
   501
extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
slouken@1895
   502
                                                   int x, int y);
slouken@1895
   503
slouken@1895
   504
/**
slouken@4883
   505
 *  \brief Get the position of a window.
slouken@3407
   506
 *  
philipp@7175
   507
 *  \param window   The window to query.
aschiffler@6984
   508
 *  \param x        Pointer to variable for storing the x position, may be NULL
aschiffler@6984
   509
 *  \param y        Pointer to variable for storing the y position, may be NULL
aschiffler@6984
   510
 *
slouken@3407
   511
 *  \sa SDL_SetWindowPosition()
slouken@1895
   512
 */
slouken@3685
   513
extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
slouken@1895
   514
                                                   int *x, int *y);
slouken@1895
   515
slouken@1895
   516
/**
slouken@4883
   517
 *  \brief Set the size of a window's client area.
slouken@3407
   518
 *  
philipp@7175
   519
 *  \param window   The window to resize.
aschiffler@6984
   520
 *  \param w        The width of the window, must be >0
aschiffler@6984
   521
 *  \param h        The height of the window, must be >0
aschiffler@6984
   522
 *
slouken@3407
   523
 *  \note You can't change the size of a fullscreen window, it automatically
slouken@3407
   524
 *        matches the size of the display mode.
slouken@3407
   525
 *  
slouken@3407
   526
 *  \sa SDL_GetWindowSize()
slouken@1895
   527
 */
slouken@3685
   528
extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
slouken@1895
   529
                                               int h);
slouken@1895
   530
slouken@1895
   531
/**
slouken@4883
   532
 *  \brief Get the size of a window's client area.
slouken@3407
   533
 *  
philipp@7175
   534
 *  \param window   The window to query.
aschiffler@6984
   535
 *  \param w        Pointer to variable for storing the width, may be NULL
aschiffler@6984
   536
 *  \param h        Pointer to variable for storing the height, may be NULL
aschiffler@6984
   537
 *  
slouken@3407
   538
 *  \sa SDL_SetWindowSize()
slouken@1895
   539
 */
slouken@3685
   540
extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
slouken@1895
   541
                                               int *h);
stopiccot@6681
   542
    
stopiccot@6681
   543
/**
stopiccot@6681
   544
 *  \brief Set the minimum size of a window's client area.
aschiffler@6984
   545
 *  
philipp@7175
   546
 *  \param window    The window to set a new minimum size.
aschiffler@6984
   547
 *  \param min_w     The minimum width of the window, must be >0
aschiffler@6984
   548
 *  \param min_h     The minimum height of the window, must be >0
stopiccot@6681
   549
 *
stopiccot@6681
   550
 *  \note You can't change the minimum size of a fullscreen window, it
stopiccot@6681
   551
 *        automatically matches the size of the display mode.
stopiccot@6681
   552
 *
stopiccot@6681
   553
 *  \sa SDL_GetWindowMinimumSize()
slouken@6788
   554
 *  \sa SDL_SetWindowMaximumSize()
stopiccot@6681
   555
 */
stopiccot@6681
   556
extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window,
stopiccot@6681
   557
                                                      int min_w, int min_h);
stopiccot@6681
   558
    
stopiccot@6681
   559
/**
stopiccot@6681
   560
 *  \brief Get the minimum size of a window's client area.
aschiffler@6984
   561
 *  
philipp@7175
   562
 *  \param window   The window to query.
aschiffler@6984
   563
 *  \param w        Pointer to variable for storing the minimum width, may be NULL
aschiffler@6984
   564
 *  \param h        Pointer to variable for storing the minimum height, may be NULL
aschiffler@6984
   565
 *  
slouken@6788
   566
 *  \sa SDL_GetWindowMaximumSize()
stopiccot@6681
   567
 *  \sa SDL_SetWindowMinimumSize()
stopiccot@6681
   568
 */
stopiccot@6681
   569
extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window,
stopiccot@6681
   570
                                                      int *w, int *h);
slouken@1895
   571
slouken@1895
   572
/**
slouken@6788
   573
 *  \brief Set the maximum size of a window's client area.
slouken@6788
   574
 *
philipp@7175
   575
 *  \param window    The window to set a new maximum size.
aschiffler@6984
   576
 *  \param max_w     The maximum width of the window, must be >0
aschiffler@6984
   577
 *  \param max_h     The maximum height of the window, must be >0
aschiffler@6984
   578
 *
slouken@6788
   579
 *  \note You can't change the maximum size of a fullscreen window, it
slouken@6788
   580
 *        automatically matches the size of the display mode.
slouken@6788
   581
 *
slouken@6788
   582
 *  \sa SDL_GetWindowMaximumSize()
slouken@6788
   583
 *  \sa SDL_SetWindowMinimumSize()
slouken@6788
   584
 */
slouken@6788
   585
extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window,
slouken@6788
   586
                                                      int max_w, int max_h);
slouken@6788
   587
    
slouken@6788
   588
/**
slouken@6788
   589
 *  \brief Get the maximum size of a window's client area.
aschiffler@6984
   590
 *  
philipp@7175
   591
 *  \param window   The window to query.
aschiffler@6984
   592
 *  \param w        Pointer to variable for storing the maximum width, may be NULL
aschiffler@6984
   593
 *  \param h        Pointer to variable for storing the maximum height, may be NULL
slouken@6788
   594
 *
slouken@6788
   595
 *  \sa SDL_GetWindowMinimumSize()
slouken@6788
   596
 *  \sa SDL_SetWindowMaximumSize()
slouken@6788
   597
 */
slouken@6788
   598
extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window,
slouken@6788
   599
                                                      int *w, int *h);
slouken@6788
   600
slouken@6788
   601
/**
icculus@6422
   602
 *  \brief Set the border state of a window.
icculus@6422
   603
 *
icculus@6422
   604
 *  This will add or remove the window's SDL_WINDOW_BORDERLESS flag and
icculus@6422
   605
 *  add or remove the border from the actual window. This is a no-op if the
icculus@6422
   606
 *  window's border already matches the requested state.
icculus@6422
   607
 *
icculus@6422
   608
 *  \param window The window of which to change the border state.
icculus@6422
   609
 *  \param bordered SDL_FALSE to remove border, SDL_TRUE to add border.
icculus@6422
   610
 *
icculus@6422
   611
 *  \note You can't change the border state of a fullscreen window.
icculus@6422
   612
 *  
icculus@6422
   613
 *  \sa SDL_GetWindowFlags()
icculus@6422
   614
 */
icculus@6422
   615
extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window,
icculus@6422
   616
                                                   SDL_bool bordered);
icculus@6422
   617
icculus@6422
   618
/**
slouken@4883
   619
 *  \brief Show a window.
slouken@3407
   620
 *  
slouken@3407
   621
 *  \sa SDL_HideWindow()
slouken@1895
   622
 */
slouken@3685
   623
extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
slouken@1895
   624
slouken@1895
   625
/**
slouken@4883
   626
 *  \brief Hide a window.
slouken@3407
   627
 *  
slouken@3407
   628
 *  \sa SDL_ShowWindow()
slouken@1895
   629
 */
slouken@3685
   630
extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
slouken@1895
   631
slouken@1895
   632
/**
slouken@4883
   633
 *  \brief Raise a window above other windows and set the input focus.
slouken@1895
   634
 */
slouken@3685
   635
extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
slouken@1895
   636
slouken@1895
   637
/**
slouken@4883
   638
 *  \brief Make a window as large as possible.
slouken@3407
   639
 *  
slouken@3407
   640
 *  \sa SDL_RestoreWindow()
slouken@1895
   641
 */
slouken@3685
   642
extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
slouken@1895
   643
slouken@1895
   644
/**
slouken@4883
   645
 *  \brief Minimize a window to an iconic representation.
slouken@3407
   646
 *  
slouken@3407
   647
 *  \sa SDL_RestoreWindow()
slouken@1895
   648
 */
slouken@3685
   649
extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
slouken@1895
   650
slouken@1895
   651
/**
slouken@3407
   652
 *  \brief Restore the size and position of a minimized or maximized window.
slouken@3407
   653
 *  
slouken@3407
   654
 *  \sa SDL_MaximizeWindow()
slouken@3407
   655
 *  \sa SDL_MinimizeWindow()
slouken@1895
   656
 */
slouken@3685
   657
extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
slouken@1895
   658
slouken@1895
   659
/**
slouken@4883
   660
 *  \brief Set a window's fullscreen state.
slouken@3407
   661
 *  
slouken@3407
   662
 *  \return 0 on success, or -1 if setting the display mode failed.
slouken@3407
   663
 *  
slouken@3522
   664
 *  \sa SDL_SetWindowDisplayMode()
slouken@3522
   665
 *  \sa SDL_GetWindowDisplayMode()
slouken@1895
   666
 */
slouken@3685
   667
extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
slouken@6755
   668
                                                    Uint32 flags);
slouken@1895
   669
slouken@1895
   670
/**
slouken@5546
   671
 *  \brief Get the SDL surface associated with the window.
slouken@5166
   672
 *
slouken@5546
   673
 *  \return The window's framebuffer surface, or NULL on error. 
slouken@5546
   674
 *
slouken@5546
   675
 *  A new surface will be created with the optimal format for the window,
slouken@5546
   676
 *  if necessary. This surface will be freed when the window is destroyed.
slouken@5166
   677
 *
slouken@5166
   678
 *  \note You may not combine this with 3D or the rendering API on this window.
slouken@5166
   679
 *
slouken@5166
   680
 *  \sa SDL_UpdateWindowSurface()
slouken@5166
   681
 *  \sa SDL_UpdateWindowSurfaceRects()
slouken@5166
   682
 */
slouken@5166
   683
extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
slouken@5166
   684
slouken@5166
   685
/**
slouken@5166
   686
 *  \brief Copy the window surface to the screen.
slouken@5166
   687
 *
slouken@5166
   688
 *  \return 0 on success, or -1 on error.
slouken@5166
   689
 *
slouken@5166
   690
 *  \sa SDL_GetWindowSurface()
slouken@5166
   691
 *  \sa SDL_UpdateWindowSurfaceRects()
slouken@5166
   692
 */
slouken@5166
   693
extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
slouken@5166
   694
slouken@5166
   695
/**
slouken@5166
   696
 *  \brief Copy a number of rectangles on the window surface to the screen.
slouken@5166
   697
 *
slouken@5166
   698
 *  \return 0 on success, or -1 on error.
slouken@5166
   699
 *
slouken@5166
   700
 *  \sa SDL_GetWindowSurface()
slouken@5166
   701
 *  \sa SDL_UpdateWindowSurfaceRect()
slouken@5166
   702
 */
slouken@5166
   703
extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
slouken@7014
   704
                                                         const SDL_Rect * rects,
slouken@5297
   705
                                                         int numrects);
slouken@5166
   706
slouken@5166
   707
/**
slouken@4883
   708
 *  \brief Set a window's input grab mode.
slouken@3407
   709
 *  
slouken@5403
   710
 *  \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
slouken@3407
   711
 *  
slouken@3407
   712
 *  \sa SDL_GetWindowGrab()
slouken@1895
   713
 */
slouken@3685
   714
extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
slouken@5403
   715
                                               SDL_bool grabbed);
slouken@1895
   716
slouken@1895
   717
/**
slouken@4883
   718
 *  \brief Get a window's input grab mode.
slouken@3407
   719
 *  
slouken@5403
   720
 *  \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.
slouken@3407
   721
 *  
slouken@3407
   722
 *  \sa SDL_SetWindowGrab()
slouken@1895
   723
 */
slouken@5403
   724
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
slouken@1895
   725
slouken@1895
   726
/**
slouken@5466
   727
 *  \brief Set the brightness (gamma correction) for a window.
slouken@5466
   728
 *  
slouken@5466
   729
 *  \return 0 on success, or -1 if setting the brightness isn't supported.
slouken@5466
   730
 *  
slouken@5466
   731
 *  \sa SDL_GetWindowBrightness()
slouken@5466
   732
 *  \sa SDL_SetWindowGammaRamp()
slouken@5466
   733
 */
slouken@5466
   734
extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
slouken@5466
   735
slouken@5466
   736
/**
slouken@5466
   737
 *  \brief Get the brightness (gamma correction) for a window.
slouken@5466
   738
 *  
slouken@5466
   739
 *  \return The last brightness value passed to SDL_SetWindowBrightness()
slouken@5466
   740
 *  
slouken@5466
   741
 *  \sa SDL_SetWindowBrightness()
slouken@5466
   742
 */
slouken@5466
   743
extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
slouken@5466
   744
slouken@5466
   745
/**
slouken@5466
   746
 *  \brief Set the gamma ramp for a window.
slouken@5466
   747
 *  
slouken@5466
   748
 *  \param red The translation table for the red channel, or NULL.
slouken@5466
   749
 *  \param green The translation table for the green channel, or NULL.
slouken@5466
   750
 *  \param blue The translation table for the blue channel, or NULL.
slouken@5466
   751
 *  
slouken@5466
   752
 *  \return 0 on success, or -1 if gamma ramps are unsupported.
slouken@5466
   753
 *  
slouken@5466
   754
 *  Set the gamma translation table for the red, green, and blue channels
slouken@5466
   755
 *  of the video hardware.  Each table is an array of 256 16-bit quantities,
slouken@5466
   756
 *  representing a mapping between the input and output for that channel.
slouken@5466
   757
 *  The input is the index into the array, and the output is the 16-bit
slouken@5466
   758
 *  gamma value at that index, scaled to the output color precision.
slouken@5466
   759
 *
slouken@5504
   760
 *  \sa SDL_GetWindowGammaRamp()
slouken@5466
   761
 */
slouken@5466
   762
extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
slouken@5466
   763
                                                   const Uint16 * red,
slouken@5466
   764
                                                   const Uint16 * green,
slouken@5466
   765
                                                   const Uint16 * blue);
slouken@5466
   766
slouken@5466
   767
/**
slouken@5466
   768
 *  \brief Get the gamma ramp for a window.
slouken@5466
   769
 *  
slouken@5466
   770
 *  \param red   A pointer to a 256 element array of 16-bit quantities to hold 
slouken@5466
   771
 *               the translation table for the red channel, or NULL.
slouken@5466
   772
 *  \param green A pointer to a 256 element array of 16-bit quantities to hold 
slouken@5466
   773
 *               the translation table for the green channel, or NULL.
slouken@5466
   774
 *  \param blue  A pointer to a 256 element array of 16-bit quantities to hold 
slouken@5466
   775
 *               the translation table for the blue channel, or NULL.
slouken@5466
   776
 *   
slouken@5466
   777
 *  \return 0 on success, or -1 if gamma ramps are unsupported.
slouken@5466
   778
 *  
slouken@5466
   779
 *  \sa SDL_SetWindowGammaRamp()
slouken@5466
   780
 */
slouken@5466
   781
extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
slouken@5466
   782
                                                   Uint16 * red,
slouken@5466
   783
                                                   Uint16 * green,
slouken@5466
   784
                                                   Uint16 * blue);
slouken@5466
   785
slouken@5466
   786
/**
slouken@3407
   787
 *  \brief Destroy a window.
slouken@1895
   788
 */
slouken@3685
   789
extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
slouken@1895
   790
slouken@0
   791
slouken@3025
   792
/**
slouken@4875
   793
 *  \brief Returns whether the screensaver is currently enabled (default on).
slouken@3407
   794
 *  
slouken@3407
   795
 *  \sa SDL_EnableScreenSaver()
slouken@3407
   796
 *  \sa SDL_DisableScreenSaver()
slouken@3025
   797
 */
couriersud@3033
   798
extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
slouken@3025
   799
slouken@3025
   800
/**
slouken@3407
   801
 *  \brief Allow the screen to be blanked by a screensaver
slouken@3407
   802
 *  
slouken@3407
   803
 *  \sa SDL_IsScreenSaverEnabled()
slouken@3407
   804
 *  \sa SDL_DisableScreenSaver()
slouken@3025
   805
 */
couriersud@3033
   806
extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
slouken@3025
   807
slouken@3025
   808
/**
slouken@3407
   809
 *  \brief Prevent the screen from being blanked by a screensaver
slouken@3407
   810
 *  
slouken@3407
   811
 *  \sa SDL_IsScreenSaverEnabled()
slouken@3407
   812
 *  \sa SDL_EnableScreenSaver()
slouken@3025
   813
 */
couriersud@3033
   814
extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
slouken@3025
   815
slouken@0
   816
slouken@3407
   817
/**
slouken@3407
   818
 *  \name OpenGL support functions
slouken@3407
   819
 */
slouken@3407
   820
/*@{*/
slouken@0
   821
slouken@1895
   822
/**
slouken@3407
   823
 *  \brief Dynamically load an OpenGL library.
slouken@3407
   824
 *  
slouken@3407
   825
 *  \param path The platform dependent OpenGL library name, or NULL to open the 
slouken@3407
   826
 *              default OpenGL library.
slouken@3407
   827
 *  
slouken@3407
   828
 *  \return 0 on success, or -1 if the library couldn't be loaded.
slouken@3407
   829
 *  
slouken@3407
   830
 *  This should be done after initializing the video driver, but before
slouken@3407
   831
 *  creating any OpenGL windows.  If no OpenGL library is loaded, the default
slouken@3407
   832
 *  library will be loaded upon creation of the first OpenGL window.
slouken@3407
   833
 *  
slouken@3407
   834
 *  \note If you do this, you need to retrieve all of the GL functions used in
slouken@3407
   835
 *        your program from the dynamic library using SDL_GL_GetProcAddress().
slouken@3407
   836
 *  
slouken@3407
   837
 *  \sa SDL_GL_GetProcAddress()
slouken@3407
   838
 *  \sa SDL_GL_UnloadLibrary()
slouken@0
   839
 */
slouken@337
   840
extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
slouken@0
   841
slouken@1895
   842
/**
slouken@3407
   843
 *  \brief Get the address of an OpenGL function.
slouken@0
   844
 */
slouken@1895
   845
extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
slouken@0
   846
slouken@1895
   847
/**
slouken@3407
   848
 *  \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
slouken@3407
   849
 *  
slouken@3407
   850
 *  \sa SDL_GL_LoadLibrary()
slouken@3057
   851
 */
slouken@3057
   852
extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
slouken@3057
   853
slouken@3057
   854
/**
slouken@3407
   855
 *  \brief Return true if an OpenGL extension is supported for the current 
slouken@3407
   856
 *         context.
slouken@1926
   857
 */
slouken@1926
   858
extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
slouken@1926
   859
                                                           *extension);
slouken@1926
   860
slouken@1926
   861
/**
slouken@3407
   862
 *  \brief Set an OpenGL window attribute before window creation.
slouken@0
   863
 */
slouken@337
   864
extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
slouken@0
   865
slouken@1895
   866
/**
slouken@3407
   867
 *  \brief Get the actual value for an attribute from the current context.
slouken@0
   868
 */
slouken@1936
   869
extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
slouken@0
   870
slouken@1895
   871
/**
slouken@3407
   872
 *  \brief Create an OpenGL context for use with an OpenGL window, and make it 
slouken@3407
   873
 *         current.
slouken@3407
   874
 *  
slouken@3407
   875
 *  \sa SDL_GL_DeleteContext()
slouken@1895
   876
 */
slouken@3685
   877
extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
slouken@3685
   878
                                                           window);
slouken@1895
   879
slouken@1895
   880
/**
slouken@3407
   881
 *  \brief Set up an OpenGL context for rendering into an OpenGL window.
slouken@3407
   882
 *  
slouken@3407
   883
 *  \note The context must have been created with a compatible window.
slouken@1895
   884
 */
slouken@3685
   885
extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
slouken@1895
   886
                                               SDL_GLContext context);
slouken@1895
   887
slouken@1895
   888
/**
slouken@3407
   889
 *  \brief Set the swap interval for the current OpenGL context.
slouken@3407
   890
 *  
slouken@3407
   891
 *  \param interval 0 for immediate updates, 1 for updates synchronized with the
icculus@6382
   892
 *                  vertical retrace. If the system supports it, you may
icculus@6382
   893
 *                  specify -1 to allow late swaps to happen immediately
icculus@6382
   894
 *                  instead of waiting for the next retrace.
slouken@3407
   895
 *  
slouken@3407
   896
 *  \return 0 on success, or -1 if setting the swap interval is not supported.
slouken@3407
   897
 *  
slouken@3407
   898
 *  \sa SDL_GL_GetSwapInterval()
slouken@1895
   899
 */
slouken@1895
   900
extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
slouken@1895
   901
slouken@1895
   902
/**
slouken@3407
   903
 *  \brief Get the swap interval for the current OpenGL context.
slouken@3407
   904
 *  
slouken@3407
   905
 *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer 
icculus@6382
   906
 *          swap is synchronized with the vertical retrace, and -1 if late
icculus@6382
   907
 *          swaps happen immediately instead of waiting for the next retrace.
icculus@6382
   908
 *          If the system can't determine the swap interval, or there isn't a
icculus@6382
   909
 *          valid current context, this will return 0 as a safe default.
slouken@3407
   910
 *  
slouken@3407
   911
 *  \sa SDL_GL_SetSwapInterval()
slouken@1895
   912
 */
slouken@1895
   913
extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
slouken@1895
   914
slouken@1895
   915
/**
slouken@4883
   916
 * \brief Swap the OpenGL buffers for a window, if double-buffering is 
slouken@3407
   917
 *        supported.
slouken@0
   918
 */
slouken@3685
   919
extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
slouken@0
   920
slouken@1895
   921
/**
slouken@3407
   922
 *  \brief Delete an OpenGL context.
slouken@3407
   923
 *  
slouken@3407
   924
 *  \sa SDL_GL_CreateContext()
slouken@0
   925
 */
slouken@1895
   926
extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
slouken@0
   927
slouken@3407
   928
/*@}*//*OpenGL support functions*/
slouken@3407
   929
slouken@0
   930
slouken@0
   931
/* Ends C function definitions when using C++ */
slouken@0
   932
#ifdef __cplusplus
slouken@1895
   933
/* *INDENT-OFF* */
slouken@0
   934
}
slouken@1895
   935
/* *INDENT-ON* */
slouken@0
   936
#endif
slouken@0
   937
#include "close_code.h"
slouken@0
   938
slouken@0
   939
#endif /* _SDL_video_h */
slouken@1895
   940
slouken@1895
   941
/* vi: set ts=4 sw=4 expandtab: */