include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 12 Feb 2011 12:04:00 -0800
changeset 5272 3c94c559f5c2
parent 5262 b530ef003506
child 5276 8e421890cdb8
permissions -rw-r--r--
changeset: 5272:cb08ef104ac4
tag: tip
user: Martin Decky <martin@decky.cz>
date: Sat Feb 12 20:53:06 2011 +0100
summary: improve header files compatibility with SDL 1.2 applications (namely QEMU)
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@5262
     3
    Copyright (C) 1997-2011 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@251
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@1895
    23
/**
slouken@3407
    24
 *  \file SDL_video.h
slouken@3407
    25
 *  
slouken@3407
    26
 *  Header file for SDL video functions.
slouken@1895
    27
 */
slouken@0
    28
slouken@0
    29
#ifndef _SDL_video_h
slouken@0
    30
#define _SDL_video_h
slouken@0
    31
slouken@1356
    32
#include "SDL_stdinc.h"
slouken@1895
    33
#include "SDL_pixels.h"
slouken@2275
    34
#include "SDL_rect.h"
slouken@2275
    35
#include "SDL_surface.h"
slouken@0
    36
slouken@0
    37
#include "begin_code.h"
slouken@0
    38
/* Set up for C function definitions, even when using C++ */
slouken@0
    39
#ifdef __cplusplus
slouken@1895
    40
/* *INDENT-OFF* */
slouken@0
    41
extern "C" {
slouken@1895
    42
/* *INDENT-ON* */
slouken@0
    43
#endif
slouken@0
    44
slouken@1895
    45
/**
slouken@3407
    46
 *  \brief  The structure that defines a display mode
slouken@3407
    47
 *  
slouken@3407
    48
 *  \sa SDL_GetNumDisplayModes()
slouken@3407
    49
 *  \sa SDL_GetDisplayMode()
slouken@3407
    50
 *  \sa SDL_GetDesktopDisplayMode()
slouken@3407
    51
 *  \sa SDL_GetCurrentDisplayMode()
slouken@3407
    52
 *  \sa SDL_GetClosestDisplayMode()
slouken@3500
    53
 *  \sa SDL_SetWindowDisplayMode()
slouken@3500
    54
 *  \sa SDL_GetWindowDisplayMode()
slouken@1895
    55
 */
slouken@1895
    56
typedef struct
slouken@1895
    57
{
slouken@1895
    58
    Uint32 format;              /**< pixel format */
slouken@1895
    59
    int w;                      /**< width */
slouken@1895
    60
    int h;                      /**< height */
slouken@1895
    61
    int refresh_rate;           /**< refresh rate (or zero for unspecified) */
slouken@1895
    62
    void *driverdata;           /**< driver-specific data, initialize to 0 */
slouken@1895
    63
} SDL_DisplayMode;
slouken@0
    64
slouken@1895
    65
/**
slouken@3407
    66
 *  \brief The type used to identify a window
slouken@3407
    67
 *  
slouken@3407
    68
 *  \sa SDL_CreateWindow()
slouken@3407
    69
 *  \sa SDL_CreateWindowFrom()
slouken@3407
    70
 *  \sa SDL_DestroyWindow()
slouken@3407
    71
 *  \sa SDL_GetWindowData()
slouken@3407
    72
 *  \sa SDL_GetWindowFlags()
slouken@3407
    73
 *  \sa SDL_GetWindowGrab()
slouken@3407
    74
 *  \sa SDL_GetWindowPosition()
slouken@3407
    75
 *  \sa SDL_GetWindowSize()
slouken@3407
    76
 *  \sa SDL_GetWindowTitle()
slouken@3407
    77
 *  \sa SDL_HideWindow()
slouken@3407
    78
 *  \sa SDL_MaximizeWindow()
slouken@3407
    79
 *  \sa SDL_MinimizeWindow()
slouken@3407
    80
 *  \sa SDL_RaiseWindow()
slouken@3407
    81
 *  \sa SDL_RestoreWindow()
slouken@3407
    82
 *  \sa SDL_SetWindowData()
slouken@3407
    83
 *  \sa SDL_SetWindowFullscreen()
slouken@3407
    84
 *  \sa SDL_SetWindowGrab()
slouken@3407
    85
 *  \sa SDL_SetWindowIcon()
slouken@3407
    86
 *  \sa SDL_SetWindowPosition()
slouken@3407
    87
 *  \sa SDL_SetWindowSize()
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@1895
   100
    SDL_WINDOW_FULLSCREEN = 0x00000001,         /**< fullscreen window, implies borderless */
slouken@1895
   101
    SDL_WINDOW_OPENGL = 0x00000002,             /**< window usable with OpenGL context */
slouken@1895
   102
    SDL_WINDOW_SHOWN = 0x00000004,              /**< window is visible */
slouken@1895
   103
    SDL_WINDOW_BORDERLESS = 0x00000008,         /**< no window decoration */
slouken@1895
   104
    SDL_WINDOW_RESIZABLE = 0x00000010,          /**< window can be resized */
slouken@3523
   105
    SDL_WINDOW_MINIMIZED = 0x00000020,          /**< window is minimized */
slouken@3523
   106
    SDL_WINDOW_MAXIMIZED = 0x00000040,          /**< window is maximized */
slouken@1895
   107
    SDL_WINDOW_INPUT_GRABBED = 0x00000100,      /**< window has grabbed input focus */
slouken@1895
   108
    SDL_WINDOW_INPUT_FOCUS = 0x00000200,        /**< window has input focus */
slouken@3057
   109
    SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        /**< window has mouse focus */
slouken@3057
   110
    SDL_WINDOW_FOREIGN = 0x00000800             /**< window not created by SDL */
slouken@1895
   111
} SDL_WindowFlags;
slouken@0
   112
slouken@1895
   113
/**
slouken@3407
   114
 *  \brief Used to indicate that you don't care what the window position is.
slouken@1895
   115
 */
slouken@5246
   116
#define SDL_WINDOWPOS_UNDEFINED_MASK    0x1FFF0000
slouken@5246
   117
#define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)  (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
slouken@5246
   118
#define SDL_WINDOWPOS_UNDEFINED         SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
slouken@5246
   119
#define SDL_WINDOWPOS_ISUNDEFINED(X)    \
slouken@5246
   120
            (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
slouken@3407
   121
slouken@1895
   122
/**
slouken@3407
   123
 *  \brief Used to indicate that the window position should be centered.
slouken@1895
   124
 */
slouken@5246
   125
#define SDL_WINDOWPOS_CENTERED_MASK    0x2FFF0000
slouken@5246
   126
#define SDL_WINDOWPOS_CENTERED_DISPLAY(X)  (SDL_WINDOWPOS_CENTERED_MASK|(X))
slouken@5246
   127
#define SDL_WINDOWPOS_CENTERED         SDL_WINDOWPOS_CENTERED_DISPLAY(0)
slouken@5246
   128
#define SDL_WINDOWPOS_ISCENTERED(X)    \
slouken@5246
   129
            (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
slouken@1895
   130
slouken@1895
   131
/**
slouken@3407
   132
 *  \brief Event subtype for window events
slouken@1895
   133
 */
slouken@1895
   134
typedef enum
slouken@1895
   135
{
slouken@3407
   136
    SDL_WINDOWEVENT_NONE,           /**< Never used */
slouken@3407
   137
    SDL_WINDOWEVENT_SHOWN,          /**< Window has been shown */
slouken@3407
   138
    SDL_WINDOWEVENT_HIDDEN,         /**< Window has been hidden */
slouken@3407
   139
    SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be 
slouken@3407
   140
                                         redrawn */
slouken@3407
   141
    SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2 
slouken@3407
   142
                                     */
slouken@3407
   143
    SDL_WINDOWEVENT_RESIZED,        /**< Window size changed to data1xdata2 */
slouken@3407
   144
    SDL_WINDOWEVENT_MINIMIZED,      /**< Window has been minimized */
slouken@3407
   145
    SDL_WINDOWEVENT_MAXIMIZED,      /**< Window has been maximized */
slouken@3407
   146
    SDL_WINDOWEVENT_RESTORED,       /**< Window has been restored to normal size
slouken@3407
   147
                                         and position */
slouken@3691
   148
    SDL_WINDOWEVENT_ENTER,          /**< Window has gained mouse focus */
slouken@3691
   149
    SDL_WINDOWEVENT_LEAVE,          /**< Window has lost mouse focus */
slouken@3691
   150
    SDL_WINDOWEVENT_FOCUS_GAINED,   /**< Window has gained keyboard focus */
slouken@3691
   151
    SDL_WINDOWEVENT_FOCUS_LOST,     /**< Window has lost keyboard focus */
slouken@3407
   152
    SDL_WINDOWEVENT_CLOSE           /**< The window manager requests that the 
slouken@3407
   153
                                         window be closed */
slouken@1895
   154
} SDL_WindowEventID;
slouken@1895
   155
slouken@1895
   156
/**
slouken@3407
   157
 *  \brief An opaque handle to an OpenGL context.
slouken@1895
   158
 */
slouken@1895
   159
typedef void *SDL_GLContext;
slouken@1895
   160
slouken@1895
   161
/**
slouken@3407
   162
 *  \brief OpenGL configuration attributes
slouken@0
   163
 */
slouken@1895
   164
typedef enum
slouken@1895
   165
{
slouken@0
   166
    SDL_GL_RED_SIZE,
slouken@0
   167
    SDL_GL_GREEN_SIZE,
slouken@0
   168
    SDL_GL_BLUE_SIZE,
slouken@0
   169
    SDL_GL_ALPHA_SIZE,
slouken@0
   170
    SDL_GL_BUFFER_SIZE,
slouken@0
   171
    SDL_GL_DOUBLEBUFFER,
slouken@0
   172
    SDL_GL_DEPTH_SIZE,
slouken@0
   173
    SDL_GL_STENCIL_SIZE,
slouken@0
   174
    SDL_GL_ACCUM_RED_SIZE,
slouken@0
   175
    SDL_GL_ACCUM_GREEN_SIZE,
slouken@0
   176
    SDL_GL_ACCUM_BLUE_SIZE,
slouken@450
   177
    SDL_GL_ACCUM_ALPHA_SIZE,
slouken@655
   178
    SDL_GL_STEREO,
slouken@656
   179
    SDL_GL_MULTISAMPLEBUFFERS,
slouken@1736
   180
    SDL_GL_MULTISAMPLESAMPLES,
hfutrell@2747
   181
    SDL_GL_ACCELERATED_VISUAL,
slouken@3100
   182
    SDL_GL_RETAINED_BACKING,
slouken@3139
   183
    SDL_GL_CONTEXT_MAJOR_VERSION,
slouken@3139
   184
    SDL_GL_CONTEXT_MINOR_VERSION
slouken@0
   185
} SDL_GLattr;
slouken@0
   186
slouken@0
   187
slouken@0
   188
/* Function prototypes */
slouken@0
   189
slouken@1895
   190
/**
slouken@3407
   191
 *  \brief Get the number of video drivers compiled into SDL
slouken@3407
   192
 *  
slouken@3407
   193
 *  \sa SDL_GetVideoDriver()
slouken@0
   194
 */
slouken@1895
   195
extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
slouken@1895
   196
slouken@1895
   197
/**
slouken@3407
   198
 *  \brief Get the name of a built in video driver.
slouken@3407
   199
 *  
slouken@3407
   200
 *  \note The video drivers are presented in the order in which they are
slouken@3407
   201
 *        normally checked during initialization.
slouken@3407
   202
 *  
slouken@3407
   203
 *  \sa SDL_GetNumVideoDrivers()
slouken@1895
   204
 */
slouken@1895
   205
extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
slouken@1895
   206
slouken@1895
   207
/**
slouken@3407
   208
 *  \brief Initialize the video subsystem, optionally specifying a video driver.
slouken@3407
   209
 *  
slouken@3407
   210
 *  \param driver_name Initialize a specific driver by name, or NULL for the 
slouken@3407
   211
 *                     default video driver.
slouken@3407
   212
 *  
slouken@3407
   213
 *  \return 0 on success, -1 on error
slouken@3407
   214
 *  
slouken@3407
   215
 *  This function initializes the video subsystem; setting up a connection
slouken@3407
   216
 *  to the window manager, etc, and determines the available display modes
slouken@3407
   217
 *  and pixel formats, but does not initialize a window or graphics mode.
slouken@3407
   218
 *  
slouken@3407
   219
 *  \sa SDL_VideoQuit()
slouken@1895
   220
 */
slouken@5123
   221
extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
slouken@1895
   222
slouken@1895
   223
/**
slouken@3407
   224
 *  \brief Shuts down the video subsystem.
slouken@3407
   225
 *  
slouken@3407
   226
 *  This function closes all windows, and restores the original video mode.
slouken@3407
   227
 *  
slouken@3407
   228
 *  \sa SDL_VideoInit()
slouken@1895
   229
 */
slouken@337
   230
extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
slouken@0
   231
slouken@1895
   232
/**
slouken@3407
   233
 *  \brief Returns the name of the currently initialized video driver.
slouken@3407
   234
 *  
slouken@3407
   235
 *  \return The name of the current video driver or NULL if no driver
slouken@3407
   236
 *          has been initialized
slouken@3407
   237
 *  
slouken@3407
   238
 *  \sa SDL_GetNumVideoDrivers()
slouken@3407
   239
 *  \sa SDL_GetVideoDriver()
slouken@0
   240
 */
slouken@1895
   241
extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
slouken@0
   242
slouken@1895
   243
/**
slouken@3407
   244
 *  \brief Returns the number of available video displays.
slouken@3407
   245
 *  
slouken@3528
   246
 *  \sa SDL_GetDisplayBounds()
slouken@0
   247
 */
slouken@1895
   248
extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
slouken@0
   249
slouken@1895
   250
/**
slouken@3528
   251
 *  \brief Get the desktop area represented by a display, with the primary
slouken@3528
   252
 *         display located at 0,0
slouken@3528
   253
 *  
slouken@3528
   254
 *  \return 0 on success, or -1 if the index is out of range.
slouken@3528
   255
 *  
slouken@3528
   256
 *  \sa SDL_GetNumVideoDisplays()
slouken@3528
   257
 */
slouken@5244
   258
extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
slouken@3528
   259
slouken@3528
   260
/**
slouken@5244
   261
 *  \brief Returns the number of available display modes.
slouken@3407
   262
 *  
slouken@3407
   263
 *  \sa SDL_GetDisplayMode()
slouken@0
   264
 */
slouken@5244
   265
extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
slouken@0
   266
slouken@1895
   267
/**
slouken@3407
   268
 *  \brief Fill in information about a specific display mode.
slouken@3407
   269
 *  
slouken@3407
   270
 *  \note The display modes are sorted in this priority:
slouken@3407
   271
 *        \li bits per pixel -> more colors to fewer colors
slouken@3407
   272
 *        \li width -> largest to smallest
slouken@3407
   273
 *        \li height -> largest to smallest
slouken@3407
   274
 *        \li refresh rate -> highest to lowest
slouken@3407
   275
 *  
slouken@3407
   276
 *  \sa SDL_GetNumDisplayModes()
slouken@0
   277
 */
slouken@5244
   278
extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
slouken@1967
   279
                                               SDL_DisplayMode * mode);
slouken@0
   280
slouken@1895
   281
/**
slouken@5244
   282
 *  \brief Fill in information about the desktop display mode.
slouken@1895
   283
 */
slouken@5244
   284
extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
slouken@1895
   285
slouken@1895
   286
/**
slouken@3407
   287
 *  \brief Fill in information about the current display mode.
slouken@1895
   288
 */
slouken@5244
   289
extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
slouken@1895
   290
slouken@3400
   291
slouken@1895
   292
/**
slouken@3407
   293
 *  \brief Get the closest match to the requested display mode.
slouken@3407
   294
 *  
slouken@3407
   295
 *  \param mode The desired display mode
slouken@3407
   296
 *  \param closest A pointer to a display mode to be filled in with the closest 
slouken@3407
   297
 *                 match of the available display modes.
slouken@3407
   298
 *  
slouken@3407
   299
 *  \return The passed in value \c closest, or NULL if no matching video mode 
slouken@3407
   300
 *          was available.
slouken@3407
   301
 *  
slouken@3407
   302
 *  The available display modes are scanned, and \c closest is filled in with the
slouken@3407
   303
 *  closest mode matching the requested mode and returned.  The mode format and 
slouken@3407
   304
 *  refresh_rate default to the desktop mode if they are 0.  The modes are 
slouken@3407
   305
 *  scanned with size being first priority, format being second priority, and 
slouken@3407
   306
 *  finally checking the refresh_rate.  If all the available modes are too 
slouken@3407
   307
 *  small, then NULL is returned.
slouken@3407
   308
 *  
slouken@3407
   309
 *  \sa SDL_GetNumDisplayModes()
slouken@3407
   310
 *  \sa SDL_GetDisplayMode()
slouken@1895
   311
 */
slouken@5244
   312
extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
slouken@1895
   313
slouken@1895
   314
/**
slouken@5246
   315
 *  \brief Get the display index associated with a window.
slouken@5246
   316
 *  
slouken@5246
   317
 *  \return the display index of the display containing the center of the
slouken@5246
   318
 *          window, or -1 on error.
slouken@5246
   319
 */
slouken@5246
   320
extern DECLSPEC int SDLCALL SDL_GetWindowDisplay(SDL_Window * window);
slouken@5246
   321
slouken@5246
   322
/**
slouken@5244
   323
 *  \brief Set the display mode used when a fullscreen window is visible.
slouken@5244
   324
 *
slouken@5244
   325
 *  By default the window's dimensions and the desktop format and refresh rate
slouken@5244
   326
 *  are used.
slouken@3407
   327
 *  
slouken@3500
   328
 *  \param mode The mode to use, or NULL for the default mode.
slouken@3407
   329
 *  
slouken@3407
   330
 *  \return 0 on success, or -1 if setting the display mode failed.
slouken@3407
   331
 *  
slouken@3522
   332
 *  \sa SDL_GetWindowDisplayMode()
slouken@3407
   333
 *  \sa SDL_SetWindowFullscreen()
slouken@0
   334
 */
slouken@3685
   335
extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
slouken@3500
   336
                                                     const SDL_DisplayMode
slouken@1895
   337
                                                         * mode);
slouken@0
   338
slouken@1895
   339
/**
slouken@3407
   340
 *  \brief Fill in information about the display mode used when a fullscreen
slouken@5244
   341
 *         window is visible.
slouken@3522
   342
 *
slouken@3522
   343
 *  \sa SDL_SetWindowDisplayMode()
slouken@3522
   344
 *  \sa SDL_SetWindowFullscreen()
slouken@0
   345
 */
slouken@3685
   346
extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
slouken@3500
   347
                                                     SDL_DisplayMode * mode);
slouken@0
   348
slouken@1895
   349
/**
slouken@5154
   350
 *  \brief Get the pixel format associated with the window.
slouken@5154
   351
 */
slouken@5154
   352
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
slouken@5154
   353
slouken@5154
   354
/**
slouken@3407
   355
 *  \brief Create a window with the specified position, dimensions, and flags.
slouken@3407
   356
 *  
slouken@3407
   357
 *  \param title The title of the window, in UTF-8 encoding.
slouken@3407
   358
 *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 
slouken@3407
   359
 *               ::SDL_WINDOWPOS_UNDEFINED.
slouken@3407
   360
 *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 
slouken@3407
   361
 *               ::SDL_WINDOWPOS_UNDEFINED.
slouken@3407
   362
 *  \param w     The width of the window.
slouken@3407
   363
 *  \param h     The height of the window.
slouken@3407
   364
 *  \param flags The flags for the window, a mask of any of the following: 
slouken@3407
   365
 *               ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL, 
slouken@3407
   366
 *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_BORDERLESS, 
slouken@3407
   367
 *               ::SDL_WINDOW_RESIZABLE,  ::SDL_WINDOW_MAXIMIZED, 
slouken@3407
   368
 *               ::SDL_WINDOW_MINIMIZED,  ::SDL_WINDOW_INPUT_GRABBED.
slouken@3407
   369
 *  
slouken@3407
   370
 *  \return The id of the window created, or zero if window creation failed.
slouken@3407
   371
 *  
slouken@3407
   372
 *  \sa SDL_DestroyWindow()
slouken@0
   373
 */
slouken@3685
   374
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
slouken@1895
   375
                                                      int x, int y, int w,
slouken@1895
   376
                                                      int h, Uint32 flags);
slouken@0
   377
slouken@1895
   378
/**
slouken@3493
   379
 *  \brief Create an SDL window from an existing native window.
slouken@3407
   380
 *  
slouken@3407
   381
 *  \param data A pointer to driver-dependent window creation data
slouken@3407
   382
 *  
slouken@3407
   383
 *  \return The id of the window created, or zero if window creation failed.
slouken@3407
   384
 *  
slouken@3407
   385
 *  \sa SDL_DestroyWindow()
slouken@0
   386
 */
slouken@3685
   387
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
slouken@3685
   388
slouken@3685
   389
/**
slouken@4883
   390
 *  \brief Get the numeric ID of a window, for logging purposes.
slouken@3685
   391
 */
slouken@3685
   392
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
slouken@3685
   393
slouken@3685
   394
/**
slouken@3685
   395
 *  \brief Get a window from a stored ID, or NULL if it doesn't exist.
slouken@3685
   396
 */
slouken@3685
   397
extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
slouken@1895
   398
slouken@1895
   399
/**
slouken@3407
   400
 *  \brief Get the window flags.
slouken@1895
   401
 */
slouken@3685
   402
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
slouken@1895
   403
slouken@1895
   404
/**
slouken@4883
   405
 *  \brief Set the title of a window, in UTF-8 format.
slouken@3407
   406
 *  
slouken@3407
   407
 *  \sa SDL_GetWindowTitle()
slouken@1895
   408
 */
slouken@3685
   409
extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
slouken@1895
   410
                                                const char *title);
slouken@1895
   411
slouken@1895
   412
/**
slouken@4883
   413
 *  \brief Get the title of a window, in UTF-8 format.
slouken@3407
   414
 *  
slouken@3407
   415
 *  \sa SDL_SetWindowTitle()
slouken@1895
   416
 */
slouken@3685
   417
extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
slouken@1895
   418
slouken@1895
   419
/**
slouken@4887
   420
 *  \brief Set the icon for a window.
slouken@3407
   421
 *  
slouken@4887
   422
 *  \param icon The icon for the window.
slouken@1895
   423
 */
slouken@3685
   424
extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
slouken@2990
   425
                                               SDL_Surface * icon);
slouken@1895
   426
slouken@1895
   427
/**
slouken@5165
   428
 *  \brief Associate an arbitrary named pointer with a window.
slouken@3407
   429
 *  
slouken@5165
   430
 *  \param window   The window to associate with the pointer.
slouken@5165
   431
 *  \param name     The name of the pointer.
slouken@5165
   432
 *  \param userdata The associated pointer.
slouken@5165
   433
 *
slouken@5165
   434
 *  \return The previous value associated with 'name'
slouken@5165
   435
 *
slouken@5165
   436
 *  \note The name is case-sensitive.
slouken@5165
   437
 *
slouken@3407
   438
 *  \sa SDL_GetWindowData()
slouken@1895
   439
 */
slouken@5165
   440
extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
slouken@5165
   441
                                                const char *name,
slouken@5165
   442
                                                void *userdata);
slouken@1895
   443
slouken@1895
   444
/**
slouken@4883
   445
 *  \brief Retrieve the data pointer associated with a window.
slouken@3407
   446
 *  
slouken@5165
   447
 *  \param window   The window to query.
slouken@5165
   448
 *  \param name     The name of the pointer.
slouken@5165
   449
 *
slouken@5165
   450
 *  \return The value associated with 'name'
slouken@5165
   451
 *  
slouken@3407
   452
 *  \sa SDL_SetWindowData()
slouken@1895
   453
 */
slouken@5165
   454
extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
slouken@5165
   455
                                                const char *name);
slouken@1895
   456
slouken@1895
   457
/**
slouken@4883
   458
 *  \brief Set the position of a window.
slouken@3407
   459
 *  
slouken@5165
   460
 *  \param window   The window to reposition.
slouken@3407
   461
 *  \param x        The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
slouken@3407
   462
                    ::SDL_WINDOWPOS_UNDEFINED.
slouken@3407
   463
 *  \param y        The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
slouken@3407
   464
                    ::SDL_WINDOWPOS_UNDEFINED.
slouken@3407
   465
 *  
slouken@3407
   466
 *  \note The window coordinate origin is the upper left of the display.
slouken@3407
   467
 *  
slouken@3407
   468
 *  \sa SDL_GetWindowPosition()
slouken@1895
   469
 */
slouken@3685
   470
extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
slouken@1895
   471
                                                   int x, int y);
slouken@1895
   472
slouken@1895
   473
/**
slouken@4883
   474
 *  \brief Get the position of a window.
slouken@3407
   475
 *  
slouken@3407
   476
 *  \sa SDL_SetWindowPosition()
slouken@1895
   477
 */
slouken@3685
   478
extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
slouken@1895
   479
                                                   int *x, int *y);
slouken@1895
   480
slouken@1895
   481
/**
slouken@4883
   482
 *  \brief Set the size of a window's client area.
slouken@3407
   483
 *  
slouken@3407
   484
 *  \note You can't change the size of a fullscreen window, it automatically
slouken@3407
   485
 *        matches the size of the display mode.
slouken@3407
   486
 *  
slouken@3407
   487
 *  \sa SDL_GetWindowSize()
slouken@1895
   488
 */
slouken@3685
   489
extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
slouken@1895
   490
                                               int h);
slouken@1895
   491
slouken@1895
   492
/**
slouken@4883
   493
 *  \brief Get the size of a window's client area.
slouken@3407
   494
 *  
slouken@3407
   495
 *  \sa SDL_SetWindowSize()
slouken@1895
   496
 */
slouken@3685
   497
extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
slouken@1895
   498
                                               int *h);
slouken@1895
   499
slouken@1895
   500
/**
slouken@4883
   501
 *  \brief Show a window.
slouken@3407
   502
 *  
slouken@3407
   503
 *  \sa SDL_HideWindow()
slouken@1895
   504
 */
slouken@3685
   505
extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
slouken@1895
   506
slouken@1895
   507
/**
slouken@4883
   508
 *  \brief Hide a window.
slouken@3407
   509
 *  
slouken@3407
   510
 *  \sa SDL_ShowWindow()
slouken@1895
   511
 */
slouken@3685
   512
extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
slouken@1895
   513
slouken@1895
   514
/**
slouken@4883
   515
 *  \brief Raise a window above other windows and set the input focus.
slouken@1895
   516
 */
slouken@3685
   517
extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
slouken@1895
   518
slouken@1895
   519
/**
slouken@4883
   520
 *  \brief Make a window as large as possible.
slouken@3407
   521
 *  
slouken@3407
   522
 *  \sa SDL_RestoreWindow()
slouken@1895
   523
 */
slouken@3685
   524
extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
slouken@1895
   525
slouken@1895
   526
/**
slouken@4883
   527
 *  \brief Minimize a window to an iconic representation.
slouken@3407
   528
 *  
slouken@3407
   529
 *  \sa SDL_RestoreWindow()
slouken@1895
   530
 */
slouken@3685
   531
extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
slouken@1895
   532
slouken@1895
   533
/**
slouken@3407
   534
 *  \brief Restore the size and position of a minimized or maximized window.
slouken@3407
   535
 *  
slouken@3407
   536
 *  \sa SDL_MaximizeWindow()
slouken@3407
   537
 *  \sa SDL_MinimizeWindow()
slouken@1895
   538
 */
slouken@3685
   539
extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
slouken@1895
   540
slouken@1895
   541
/**
slouken@4883
   542
 *  \brief Set a window's fullscreen state.
slouken@3407
   543
 *  
slouken@3407
   544
 *  \return 0 on success, or -1 if setting the display mode failed.
slouken@3407
   545
 *  
slouken@3522
   546
 *  \sa SDL_SetWindowDisplayMode()
slouken@3522
   547
 *  \sa SDL_GetWindowDisplayMode()
slouken@1895
   548
 */
slouken@3685
   549
extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
slouken@5246
   550
                                                    SDL_bool fullscreen);
slouken@1895
   551
slouken@1895
   552
/**
slouken@5166
   553
 *  \brief Get an SDL surface associated with the window.
slouken@5166
   554
 *
slouken@5166
   555
 *  \return A surface in the optimal format for the window, or NULL on error.
slouken@5166
   556
 *
slouken@5166
   557
 *  \note You may not combine this with 3D or the rendering API on this window.
slouken@5166
   558
 *
slouken@5166
   559
 *  \sa SDL_UpdateWindowSurface()
slouken@5166
   560
 *  \sa SDL_UpdateWindowSurfaceRects()
slouken@5166
   561
 */
slouken@5166
   562
extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
slouken@5166
   563
slouken@5166
   564
/**
slouken@5166
   565
 *  \brief Copy the window surface to the screen.
slouken@5166
   566
 *
slouken@5166
   567
 *  \return 0 on success, or -1 on error.
slouken@5166
   568
 *
slouken@5166
   569
 *  \sa SDL_GetWindowSurface()
slouken@5166
   570
 *  \sa SDL_UpdateWindowSurfaceRects()
slouken@5166
   571
 */
slouken@5166
   572
extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
slouken@5166
   573
slouken@5166
   574
/**
slouken@5166
   575
 *  \brief Copy a number of rectangles on the window surface to the screen.
slouken@5166
   576
 *
slouken@5166
   577
 *  \return 0 on success, or -1 on error.
slouken@5166
   578
 *
slouken@5166
   579
 *  \sa SDL_GetWindowSurface()
slouken@5166
   580
 *  \sa SDL_UpdateWindowSurfaceRect()
slouken@5166
   581
 */
slouken@5166
   582
extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
slouken@5166
   583
                                                         int numrects,
slouken@5166
   584
                                                         SDL_Rect * rects);
slouken@5166
   585
slouken@5166
   586
/**
slouken@4883
   587
 *  \brief Set a window's input grab mode.
slouken@3407
   588
 *  
slouken@3407
   589
 *  \param mode This is 1 to grab input, and 0 to release input.
slouken@3407
   590
 *  
slouken@3407
   591
 *  \sa SDL_GetWindowGrab()
slouken@1895
   592
 */
slouken@3685
   593
extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
slouken@1895
   594
                                               int mode);
slouken@1895
   595
slouken@1895
   596
/**
slouken@4883
   597
 *  \brief Get a window's input grab mode.
slouken@3407
   598
 *  
slouken@3407
   599
 *  \return This returns 1 if input is grabbed, and 0 otherwise.
slouken@3407
   600
 *  
slouken@3407
   601
 *  \sa SDL_SetWindowGrab()
slouken@1895
   602
 */
slouken@3685
   603
extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_Window * window);
slouken@1895
   604
slouken@1895
   605
/**
slouken@3407
   606
 *  \brief Destroy a window.
slouken@1895
   607
 */
slouken@3685
   608
extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
slouken@1895
   609
slouken@0
   610
slouken@3025
   611
/**
slouken@4875
   612
 *  \brief Returns whether the screensaver is currently enabled (default on).
slouken@3407
   613
 *  
slouken@3407
   614
 *  \sa SDL_EnableScreenSaver()
slouken@3407
   615
 *  \sa SDL_DisableScreenSaver()
slouken@3025
   616
 */
couriersud@3033
   617
extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
slouken@3025
   618
slouken@3025
   619
/**
slouken@3407
   620
 *  \brief Allow the screen to be blanked by a screensaver
slouken@3407
   621
 *  
slouken@3407
   622
 *  \sa SDL_IsScreenSaverEnabled()
slouken@3407
   623
 *  \sa SDL_DisableScreenSaver()
slouken@3025
   624
 */
couriersud@3033
   625
extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
slouken@3025
   626
slouken@3025
   627
/**
slouken@3407
   628
 *  \brief Prevent the screen from being blanked by a screensaver
slouken@3407
   629
 *  
slouken@3407
   630
 *  \sa SDL_IsScreenSaverEnabled()
slouken@3407
   631
 *  \sa SDL_EnableScreenSaver()
slouken@3025
   632
 */
couriersud@3033
   633
extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
slouken@3025
   634
slouken@0
   635
slouken@3407
   636
/**
slouken@3407
   637
 *  \name OpenGL support functions
slouken@3407
   638
 */
slouken@3407
   639
/*@{*/
slouken@0
   640
slouken@1895
   641
/**
slouken@3407
   642
 *  \brief Dynamically load an OpenGL library.
slouken@3407
   643
 *  
slouken@3407
   644
 *  \param path The platform dependent OpenGL library name, or NULL to open the 
slouken@3407
   645
 *              default OpenGL library.
slouken@3407
   646
 *  
slouken@3407
   647
 *  \return 0 on success, or -1 if the library couldn't be loaded.
slouken@3407
   648
 *  
slouken@3407
   649
 *  This should be done after initializing the video driver, but before
slouken@3407
   650
 *  creating any OpenGL windows.  If no OpenGL library is loaded, the default
slouken@3407
   651
 *  library will be loaded upon creation of the first OpenGL window.
slouken@3407
   652
 *  
slouken@3407
   653
 *  \note If you do this, you need to retrieve all of the GL functions used in
slouken@3407
   654
 *        your program from the dynamic library using SDL_GL_GetProcAddress().
slouken@3407
   655
 *  
slouken@3407
   656
 *  \sa SDL_GL_GetProcAddress()
slouken@3407
   657
 *  \sa SDL_GL_UnloadLibrary()
slouken@0
   658
 */
slouken@337
   659
extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
slouken@0
   660
slouken@1895
   661
/**
slouken@3407
   662
 *  \brief Get the address of an OpenGL function.
slouken@0
   663
 */
slouken@1895
   664
extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
slouken@0
   665
slouken@1895
   666
/**
slouken@3407
   667
 *  \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
slouken@3407
   668
 *  
slouken@3407
   669
 *  \sa SDL_GL_LoadLibrary()
slouken@3057
   670
 */
slouken@3057
   671
extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
slouken@3057
   672
slouken@3057
   673
/**
slouken@3407
   674
 *  \brief Return true if an OpenGL extension is supported for the current 
slouken@3407
   675
 *         context.
slouken@1926
   676
 */
slouken@1926
   677
extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
slouken@1926
   678
                                                           *extension);
slouken@1926
   679
slouken@1926
   680
/**
slouken@3407
   681
 *  \brief Set an OpenGL window attribute before window creation.
slouken@0
   682
 */
slouken@337
   683
extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
slouken@0
   684
slouken@1895
   685
/**
slouken@3407
   686
 *  \brief Get the actual value for an attribute from the current context.
slouken@0
   687
 */
slouken@1936
   688
extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
slouken@0
   689
slouken@1895
   690
/**
slouken@3407
   691
 *  \brief Create an OpenGL context for use with an OpenGL window, and make it 
slouken@3407
   692
 *         current.
slouken@3407
   693
 *  
slouken@3407
   694
 *  \sa SDL_GL_DeleteContext()
slouken@1895
   695
 */
slouken@3685
   696
extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
slouken@3685
   697
                                                           window);
slouken@1895
   698
slouken@1895
   699
/**
slouken@3407
   700
 *  \brief Set up an OpenGL context for rendering into an OpenGL window.
slouken@3407
   701
 *  
slouken@3407
   702
 *  \note The context must have been created with a compatible window.
slouken@1895
   703
 */
slouken@3685
   704
extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
slouken@1895
   705
                                               SDL_GLContext context);
slouken@1895
   706
slouken@1895
   707
/**
slouken@3407
   708
 *  \brief Set the swap interval for the current OpenGL context.
slouken@3407
   709
 *  
slouken@3407
   710
 *  \param interval 0 for immediate updates, 1 for updates synchronized with the
slouken@3407
   711
 *                  vertical retrace.
slouken@3407
   712
 *  
slouken@3407
   713
 *  \return 0 on success, or -1 if setting the swap interval is not supported.
slouken@3407
   714
 *  
slouken@3407
   715
 *  \sa SDL_GL_GetSwapInterval()
slouken@1895
   716
 */
slouken@1895
   717
extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
slouken@1895
   718
slouken@1895
   719
/**
slouken@3407
   720
 *  \brief Get the swap interval for the current OpenGL context.
slouken@3407
   721
 *  
slouken@3407
   722
 *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer 
slouken@3407
   723
 *          swap is synchronized with the vertical retrace, and -1 if getting 
slouken@3407
   724
 *          the swap interval is not supported.
slouken@3407
   725
 *  
slouken@3407
   726
 *  \sa SDL_GL_SetSwapInterval()
slouken@1895
   727
 */
slouken@1895
   728
extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
slouken@1895
   729
slouken@1895
   730
/**
slouken@4883
   731
 * \brief Swap the OpenGL buffers for a window, if double-buffering is 
slouken@3407
   732
 *        supported.
slouken@0
   733
 */
slouken@3685
   734
extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
slouken@0
   735
slouken@1895
   736
/**
slouken@3407
   737
 *  \brief Delete an OpenGL context.
slouken@3407
   738
 *  
slouken@3407
   739
 *  \sa SDL_GL_CreateContext()
slouken@0
   740
 */
slouken@1895
   741
extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
slouken@0
   742
slouken@3407
   743
/*@}*//*OpenGL support functions*/
slouken@3407
   744
slouken@0
   745
slouken@0
   746
/* Ends C function definitions when using C++ */
slouken@0
   747
#ifdef __cplusplus
slouken@1895
   748
/* *INDENT-OFF* */
slouken@0
   749
}
slouken@1895
   750
/* *INDENT-ON* */
slouken@0
   751
#endif
slouken@0
   752
#include "close_code.h"
slouken@0
   753
slouken@0
   754
#endif /* _SDL_video_h */
slouken@1895
   755
slouken@1895
   756
/* vi: set ts=4 sw=4 expandtab: */