include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 28 Jun 2006 08:12:07 +0000
branchSDL-1.3
changeset 1719 5b9f50c957ed
parent 1707 57ce47f033a5
child 1720 a1ebb17f9c52
permissions -rw-r--r--
You can now create multiple windows on Win32
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@1312
     3
    Copyright (C) 1997-2006 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@1662
    23
/**
slouken@1662
    24
 * \file SDL_video.h
slouken@1662
    25
 *
slouken@1662
    26
 * Header file for access to the SDL raw framebuffer window
slouken@1662
    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@1358
    33
#include "SDL_error.h"
slouken@1662
    34
#include "SDL_pixels.h"
slouken@0
    35
#include "SDL_rwops.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@1662
    40
/* *INDENT-OFF* */
slouken@0
    41
extern "C" {
slouken@1662
    42
/* *INDENT-ON* */
slouken@0
    43
#endif
slouken@0
    44
slouken@0
    45
/* Transparency definitions: These define alpha as the opacity of a surface */
slouken@0
    46
#define SDL_ALPHA_OPAQUE 255
slouken@0
    47
#define SDL_ALPHA_TRANSPARENT 0
slouken@0
    48
slouken@1670
    49
/**
slouken@1670
    50
 * \struct SDL_Rect
slouken@1670
    51
 *
slouken@1670
    52
 * \brief A rectangle, with the origin at the upper left.
slouken@1670
    53
 */
slouken@1662
    54
typedef struct SDL_Rect
slouken@1662
    55
{
slouken@1662
    56
    Sint16 x, y;
slouken@1662
    57
    Uint16 w, h;
slouken@0
    58
} SDL_Rect;
slouken@0
    59
slouken@1662
    60
/**
slouken@1662
    61
 * \struct SDL_DisplayMode
slouken@1662
    62
 *
slouken@1662
    63
 * \brief  The structure that defines a display mode
slouken@1662
    64
 *
slouken@1662
    65
 * \sa SDL_GetNumDisplayModes()
slouken@1662
    66
 * \sa SDL_GetDisplayMode()
slouken@1662
    67
 * \sa SDL_GetDesktopDisplayMode()
slouken@1662
    68
 * \sa SDL_GetCurrentDisplayMode()
slouken@1662
    69
 * \sa SDL_GetClosestDisplayMode()
slouken@1662
    70
 * \sa SDL_SetDisplayMode()
slouken@1662
    71
 */
slouken@1662
    72
typedef struct
slouken@1662
    73
{
slouken@1662
    74
    Uint32 format;              /**< pixel format */
slouken@1662
    75
    int w;                      /**< width */
slouken@1662
    76
    int h;                      /**< height */
slouken@1662
    77
    int refresh_rate;           /**< refresh rate (or zero for unspecified) */
slouken@1662
    78
} SDL_DisplayMode;
slouken@1662
    79
slouken@1662
    80
/**
slouken@1662
    81
 * \typedef SDL_WindowID
slouken@1662
    82
 *
slouken@1662
    83
 * \brief The type used to identify a window
slouken@1662
    84
 *
slouken@1662
    85
 * \sa SDL_CreateWindow()
slouken@1662
    86
 * \sa SDL_CreateWindowFrom()
slouken@1662
    87
 * \sa SDL_DestroyWindow()
slouken@1662
    88
 * \sa SDL_GetWindowData()
slouken@1662
    89
 * \sa SDL_GetWindowFlags()
slouken@1662
    90
 * \sa SDL_GetWindowGrab()
slouken@1662
    91
 * \sa SDL_GetWindowPosition()
slouken@1662
    92
 * \sa SDL_GetWindowSize()
slouken@1662
    93
 * \sa SDL_GetWindowTitle()
slouken@1662
    94
 * \sa SDL_HideWindow()
slouken@1662
    95
 * \sa SDL_MaximizeWindow()
slouken@1662
    96
 * \sa SDL_MinimizeWindow()
slouken@1662
    97
 * \sa SDL_RaiseWindow()
slouken@1662
    98
 * \sa SDL_RestoreWindow()
slouken@1662
    99
 * \sa SDL_SetWindowData()
slouken@1662
   100
 * \sa SDL_SetWindowGrab()
slouken@1662
   101
 * \sa SDL_SetWindowIcon()
slouken@1662
   102
 * \sa SDL_SetWindowPosition()
slouken@1662
   103
 * \sa SDL_SetWindowSize()
slouken@1662
   104
 * \sa SDL_SetWindowTitle()
slouken@1662
   105
 * \sa SDL_ShowWindow()
slouken@1662
   106
 */
slouken@1662
   107
typedef Uint32 SDL_WindowID;
slouken@1662
   108
slouken@1662
   109
/**
slouken@1662
   110
 * \enum SDL_WindowFlags
slouken@1662
   111
 *
slouken@1662
   112
 * \brief The flags on a window
slouken@1670
   113
 *
slouken@1670
   114
 * \sa SDL_GetWindowFlags()
slouken@1662
   115
 */
slouken@1662
   116
typedef enum
slouken@1662
   117
{
slouken@1662
   118
    SDL_WINDOW_FULLSCREEN = 0x00000001,         /**< fullscreen window, implies borderless */
slouken@1719
   119
    SDL_WINDOW_OPENGL = 0x00000002,             /**< window usable with OpenGL context */
slouken@1662
   120
    SDL_WINDOW_SHOWN = 0x00000004,              /**< window is visible */
slouken@1719
   121
    SDL_WINDOW_BORDERLESS = 0x00000008,         /**< no window decoration */
slouken@1662
   122
    SDL_WINDOW_RESIZABLE = 0x00000010,          /**< window can be resized */
slouken@1662
   123
    SDL_WINDOW_MAXIMIZED = 0x00000020,          /**< maximized */
slouken@1662
   124
    SDL_WINDOW_MINIMIZED = 0x00000040,          /**< minimized */
slouken@1719
   125
    SDL_WINDOW_INPUT_GRABBED = 0x00000100,      /**< window has grabbed input focus */
slouken@1719
   126
    SDL_WINDOW_KEYBOARD_FOCUS = 0x00000200,     /**< window has keyboard focus */
slouken@1719
   127
    SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        /**< window has mouse focus */
slouken@1662
   128
} SDL_WindowFlags;
slouken@1662
   129
slouken@1662
   130
/**
slouken@1719
   131
 * \def SDL_WINDOWPOS_UNDEFINED
slouken@1719
   132
 * \brief Used to indicate that you don't care what the window position is.
slouken@1719
   133
 */
slouken@1719
   134
#define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
slouken@1719
   135
/**
slouken@1719
   136
 * \def SDL_WINDOWPOS_CENTERED
slouken@1719
   137
 * \brief Used to indicate that the window position should be centered.
slouken@1719
   138
 */
slouken@1719
   139
#define SDL_WINDOWPOS_CENTERED  0x7FFFFFE
slouken@1719
   140
slouken@1719
   141
/**
slouken@1662
   142
 * \enum SDL_WindowEventID
slouken@1662
   143
 *
slouken@1662
   144
 * \brief Event subtype for window events
slouken@1662
   145
 */
slouken@1662
   146
typedef enum
slouken@1662
   147
{
slouken@1662
   148
    SDL_WINDOWEVENT_NONE,               /**< Never used */
slouken@1662
   149
    SDL_WINDOWEVENT_SHOWN,              /**< Window has been shown */
slouken@1662
   150
    SDL_WINDOWEVENT_HIDDEN,             /**< Window has been hidden */
slouken@1662
   151
    SDL_WINDOWEVENT_MOVED,              /**< Window has been moved to data1,data2 */
slouken@1662
   152
    SDL_WINDOWEVENT_RESIZED,            /**< Window size changed to data1xdata2 */
slouken@1662
   153
    SDL_WINDOWEVENT_MINIMIZED,          /**< Window has been minimized */
slouken@1662
   154
    SDL_WINDOWEVENT_MAXIMIZED,          /**< Window has been maximized */
slouken@1662
   155
    SDL_WINDOWEVENT_RESTORED,           /**< Window has been restored to normal size and position */
slouken@1662
   156
    SDL_WINDOWEVENT_ENTER,              /**< The window has gained mouse focus */
slouken@1662
   157
    SDL_WINDOWEVENT_LEAVE,              /**< The window has lost mouse focus */
slouken@1662
   158
    SDL_WINDOWEVENT_FOCUS_GAINED,       /**< The window has gained keyboard focus */
slouken@1662
   159
    SDL_WINDOWEVENT_FOCUS_LOST,         /**< The window has lost keyboard focus */
slouken@1662
   160
} SDL_WindowEventID;
slouken@1662
   161
slouken@1662
   162
/**
slouken@1670
   163
 * \enum SDL_RendererFlags
slouken@1670
   164
 *
slouken@1670
   165
 * \brief Flags used when initializing a render manager.
slouken@1670
   166
 */
slouken@1670
   167
typedef enum
slouken@1670
   168
{
slouken@1670
   169
    SDL_Renderer_PresentDiscard = 0x00000001,   /**< Present leaves the contents of the backbuffer undefined */
slouken@1670
   170
    SDL_Renderer_PresentCopy = 0x00000002,      /**< Present uses a copy from back buffer to the front buffer */
slouken@1670
   171
    SDL_Renderer_PresentFlip2 = 0x00000004,     /**< Present uses a flip, swapping back buffer and front buffer */
slouken@1670
   172
    SDL_Renderer_PresentFlip3 = 0x00000008,     /**< Present uses a flip, rotating between two back buffers and a front buffer */
slouken@1670
   173
    SDL_Renderer_PresentVSync = 0x00000010,     /**< Present is synchronized with the refresh rate */
slouken@1670
   174
    SDL_Renderer_RenderTarget = 0x00000020,     /**< The renderer can create texture render targets */
slouken@1670
   175
    SDL_Renderer_Accelerated = 0x00000040,      /**< The renderer uses hardware acceleration */
slouken@1670
   176
    SDL_Renderer_Minimal = 0x00000080,          /**< The renderer only supports the read/write pixel and present functions */
slouken@1670
   177
} SDL_RendererFlags;
slouken@1670
   178
slouken@1670
   179
/**
slouken@1670
   180
 * \struct SDL_RendererInfo
slouken@1670
   181
 *
slouken@1670
   182
 * \brief Information on the capabilities of a render manager.
slouken@1670
   183
 */
slouken@1670
   184
typedef struct SDL_RendererInfo
slouken@1670
   185
{
slouken@1670
   186
    const char *name;           /**< The name of the renderer */
slouken@1670
   187
    Uint32 flags;               /**< Supported SDL_RendererFlags */
slouken@1670
   188
    Uint32 blend_modes;         /**< A mask of supported blend modes */
slouken@1670
   189
    Uint32 scale_modes;         /**< A mask of supported scale modes */
slouken@1670
   190
    Uint32 num_texture_formats; /**< The number of available texture formats */
slouken@1670
   191
    Uint32 texture_formats[32]; /**< The available texture formats */
slouken@1670
   192
    int max_texture_width;      /**< The maximimum texture width */
slouken@1670
   193
    int max_texture_height;     /**< The maximimum texture height */
slouken@1670
   194
} SDL_RendererInfo;
slouken@1670
   195
slouken@1670
   196
/**
slouken@1670
   197
 * \enum SDL_TextureAccess
slouken@1670
   198
 *
slouken@1670
   199
 * \brief The access pattern allowed for a texture
slouken@1670
   200
 */
slouken@1670
   201
typedef enum
slouken@1670
   202
{
slouken@1670
   203
    SDL_TextureAccess_Render,   /**< Unlockable video memory, rendering allowed */
slouken@1670
   204
    SDL_TextureAccess_Remote,   /**< Unlockable video memory */
slouken@1670
   205
    SDL_TextureAccess_Local,    /**< Lockable system memory */
slouken@1670
   206
} SDL_TextureAccess;
slouken@1670
   207
slouken@1670
   208
/**
slouken@1670
   209
 * \enum SDL_TextureBlendMode
slouken@1670
   210
 *
slouken@1670
   211
 * \brief The blend mode used in SDL_RenderCopy()
slouken@1670
   212
 */
slouken@1670
   213
typedef enum
slouken@1670
   214
{
slouken@1676
   215
    SDL_TextureBlendMode_None = 0x00000000,     /**< No blending */
slouken@1676
   216
    SDL_TextureBlendMode_Mask = 0x00000001,     /**< dst = A ? src : dst (alpha is mask) */
slouken@1676
   217
    SDL_TextureBlendMode_Blend = 0x00000002,    /**< dst = (src * A) + (dst * (1-A)) */
slouken@1676
   218
    SDL_TextureBlendMode_Add = 0x00000004,      /**< dst = (src * A) + dst */
slouken@1676
   219
    SDL_TextureBlendMode_Mod = 0x00000008,      /**< dst = src * dst */
slouken@1670
   220
} SDL_TextureBlendMode;
slouken@1670
   221
slouken@1670
   222
/**
slouken@1670
   223
 * \enum SDL_TextureScaleMode
slouken@1670
   224
 *
slouken@1670
   225
 * \brief The scale mode used in SDL_RenderCopy()
slouken@1670
   226
 */
slouken@1670
   227
typedef enum
slouken@1670
   228
{
slouken@1676
   229
    SDL_TextureScaleMode_None = 0x00000000,     /**< No scaling, rectangles must match dimensions */
slouken@1676
   230
    SDL_TextureScaleMode_Fast = 0x00000001,     /**< Point sampling or equivalent algorithm */
slouken@1676
   231
    SDL_TextureScaleMode_Slow = 0x00000002,     /**< Linear filtering or equivalent algorithm */
slouken@1676
   232
    SDL_TextureScaleMode_Best = 0x00000004,     /**< Bicubic filtering or equivalent algorithm */
slouken@1670
   233
} SDL_TextureScaleMode;
slouken@1670
   234
slouken@1670
   235
/**
slouken@1670
   236
 * \typedef SDL_TextureID
slouken@1670
   237
 *
slouken@1670
   238
 * \brief An efficient driver-specific representation of pixel data
slouken@1670
   239
 */
slouken@1670
   240
typedef Uint32 SDL_TextureID;
slouken@1670
   241
slouken@1670
   242
slouken@1670
   243
/* These are the currently supported flags for the SDL_surface */
slouken@1670
   244
/* Used internally (read-only) */
slouken@1670
   245
#define SDL_HWSURFACE       0x00000001  /* Surface represents a texture */
slouken@1670
   246
#define SDL_PREALLOC        0x00000002  /* Surface uses preallocated memory */
slouken@1670
   247
#define SDL_SRCALPHA        0x00000004  /* Blit uses source alpha blending */
slouken@1670
   248
#define SDL_SRCCOLORKEY     0x00000008  /* Blit uses a source color key */
slouken@1670
   249
#define SDL_RLEACCELOK      0x00000010  /* Private flag */
slouken@1670
   250
#define SDL_RLEACCEL        0x00000020  /* Surface is RLE encoded */
slouken@1670
   251
slouken@1670
   252
/* Evaluates to true if the surface needs to be locked before access */
slouken@1670
   253
#define SDL_MUSTLOCK(S)	(((S)->flags & (SDL_HWSURFACE|SDL_RLEACCEL)) != 0)
slouken@1670
   254
slouken@1670
   255
/* This structure should be treated as read-only, except for 'pixels',
slouken@1670
   256
   which, if not NULL, contains the raw pixel data for the surface.
slouken@1670
   257
*/
slouken@1670
   258
typedef struct SDL_Surface
slouken@1670
   259
{
slouken@1670
   260
    Uint32 flags;               /* Read-only */
slouken@1670
   261
    SDL_PixelFormat *format;    /* Read-only */
slouken@1670
   262
    int w, h;                   /* Read-only */
slouken@1670
   263
    int pitch;                  /* Read-only */
slouken@1670
   264
    void *pixels;               /* Read-write */
slouken@1670
   265
slouken@1683
   266
    /* texture associated with the surface, if any */
slouken@1683
   267
    SDL_TextureID textureID;
slouken@1683
   268
slouken@1670
   269
    /* information needed for surfaces requiring locks */
slouken@1670
   270
    int locked;
slouken@1670
   271
    void *lock_data;
slouken@1670
   272
slouken@1670
   273
    /* clipping information */
slouken@1670
   274
    SDL_Rect clip_rect;         /* Read-only */
slouken@1670
   275
slouken@1670
   276
    /* info for fast blit mapping to other surfaces */
slouken@1670
   277
    struct SDL_BlitMap *map;    /* Private */
slouken@1670
   278
slouken@1670
   279
    /* format version, bumped at every change to invalidate blit maps */
slouken@1670
   280
    unsigned int format_version;        /* Private */
slouken@1670
   281
slouken@1670
   282
    /* Reference count -- used when freeing surface */
slouken@1670
   283
    int refcount;               /* Read-mostly */
slouken@1670
   284
} SDL_Surface;
slouken@1670
   285
slouken@1670
   286
/* typedef for private surface blitting functions */
slouken@1670
   287
typedef int (*SDL_blit) (struct SDL_Surface * src, SDL_Rect * srcrect,
slouken@1670
   288
                         struct SDL_Surface * dst, SDL_Rect * dstrect);
slouken@1670
   289
slouken@1670
   290
slouken@1670
   291
/**
slouken@1662
   292
 * \enum SDL_GLattr
slouken@1662
   293
 *
slouken@1662
   294
 * \brief OpenGL configuration attributes
slouken@1662
   295
 */
slouken@1662
   296
typedef enum
slouken@1662
   297
{
slouken@0
   298
    SDL_GL_RED_SIZE,
slouken@0
   299
    SDL_GL_GREEN_SIZE,
slouken@0
   300
    SDL_GL_BLUE_SIZE,
slouken@0
   301
    SDL_GL_ALPHA_SIZE,
slouken@0
   302
    SDL_GL_BUFFER_SIZE,
slouken@0
   303
    SDL_GL_DOUBLEBUFFER,
slouken@0
   304
    SDL_GL_DEPTH_SIZE,
slouken@0
   305
    SDL_GL_STENCIL_SIZE,
slouken@0
   306
    SDL_GL_ACCUM_RED_SIZE,
slouken@0
   307
    SDL_GL_ACCUM_GREEN_SIZE,
slouken@0
   308
    SDL_GL_ACCUM_BLUE_SIZE,
slouken@450
   309
    SDL_GL_ACCUM_ALPHA_SIZE,
slouken@655
   310
    SDL_GL_STEREO,
slouken@656
   311
    SDL_GL_MULTISAMPLEBUFFERS,
slouken@1656
   312
    SDL_GL_MULTISAMPLESAMPLES,
slouken@1656
   313
    SDL_GL_ACCELERATED_VISUAL,
slouken@1656
   314
    SDL_GL_SWAP_CONTROL
slouken@0
   315
} SDL_GLattr;
slouken@0
   316
slouken@0
   317
slouken@0
   318
/* Function prototypes */
slouken@0
   319
slouken@1662
   320
/**
slouken@1662
   321
 * \fn int SDL_GetNumVideoDrivers(void)
slouken@1662
   322
 *
slouken@1662
   323
 * \brief Get the number of video drivers compiled into SDL
slouken@1662
   324
 *
slouken@1662
   325
 * \sa SDL_GetVideoDriver()
slouken@1662
   326
 */
slouken@1668
   327
extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
slouken@1662
   328
slouken@1662
   329
/**
slouken@1662
   330
 * \fn const char *SDL_GetVideoDriver(int index)
slouken@1662
   331
 *
slouken@1662
   332
 * \brief Get the name of a built in video driver.
slouken@1662
   333
 *
slouken@1662
   334
 * \note The video drivers are presented in the order in which they are
slouken@1662
   335
 * normally checked during initialization.
slouken@1662
   336
 *
slouken@1662
   337
 * \sa SDL_GetNumVideoDrivers()
slouken@1660
   338
 */
slouken@1668
   339
extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
slouken@1660
   340
slouken@1662
   341
/**
slouken@1662
   342
 * \fn int SDL_VideoInit(const char *driver_name, Uint32 flags)
slouken@1662
   343
 *
slouken@1662
   344
 * \brief Initialize the video subsystem, optionally specifying a video driver.
slouken@1662
   345
 *
slouken@1662
   346
 * \param driver_name Initialize a specific driver by name, or NULL for the default video driver.
slouken@1662
   347
 * \param flags FIXME: Still needed?
slouken@1662
   348
 *
slouken@1662
   349
 * \return 0 on success, -1 on error
slouken@1662
   350
 *
slouken@1662
   351
 * This function initializes the video subsystem; setting up a connection
slouken@1662
   352
 * to the window manager, etc, and determines the available display modes
slouken@1662
   353
 * and pixel formats, but does not initialize a window or graphics mode.
slouken@1662
   354
 *
slouken@1662
   355
 * \sa SDL_VideoQuit()
slouken@1662
   356
 */
slouken@1668
   357
extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name,
slouken@1668
   358
                                          Uint32 flags);
slouken@1662
   359
slouken@1662
   360
/**
slouken@1662
   361
 * \fn void SDL_VideoQuit(void)
slouken@1662
   362
 *
slouken@1662
   363
 * \brief Shuts down the video subsystem.
slouken@1662
   364
 *
slouken@1662
   365
 * This function closes all windows, and restores the original video mode.
slouken@0
   366
 *
slouken@1662
   367
 * \sa SDL_VideoInit()
slouken@1662
   368
 */
slouken@1668
   369
extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
slouken@1662
   370
slouken@1662
   371
/**
slouken@1662
   372
 * \fn const char *SDL_GetCurrentVideoDriver(void)
slouken@1662
   373
 *
slouken@1662
   374
 * \brief Returns the name of the currently initialized video driver.
slouken@1662
   375
 *
slouken@1662
   376
 * \return The name of the current video driver or NULL if no driver
slouken@1662
   377
 *         has been initialized
slouken@1662
   378
 *
slouken@1662
   379
 * \sa SDL_GetNumVideoDrivers()
slouken@1662
   380
 * \sa SDL_GetVideoDriver()
slouken@1662
   381
 */
slouken@1668
   382
extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
slouken@1662
   383
slouken@1662
   384
/**
slouken@1662
   385
 * \fn int SDL_GetNumVideoDisplays(void)
slouken@1662
   386
 *
slouken@1662
   387
 * \brief Returns the number of available video displays.
slouken@1662
   388
 *
slouken@1662
   389
 * \sa SDL_SelectVideoDisplay()
slouken@0
   390
 */
slouken@1668
   391
extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
slouken@0
   392
slouken@1662
   393
/**
slouken@1662
   394
 * \fn int SDL_SelectVideoDisplay(int index)
slouken@1662
   395
 *
slouken@1662
   396
 * \brief Set the index of the currently selected display.
slouken@1662
   397
 *
slouken@1670
   398
 * \return The index of the currently selected display.
slouken@1670
   399
 *
slouken@1662
   400
 * \note You can query the currently selected display by passing an index of -1.
slouken@1662
   401
 *
slouken@1662
   402
 * \sa SDL_GetNumVideoDisplays()
slouken@0
   403
 */
slouken@1668
   404
extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
slouken@0
   405
slouken@1662
   406
/**
slouken@1662
   407
 * \fn int SDL_GetNumDisplayModes(void)
slouken@1662
   408
 *
slouken@1662
   409
 * \brief Returns the number of available display modes for the current display.
slouken@1662
   410
 *
slouken@1662
   411
 * \sa SDL_GetDisplayMode()
slouken@0
   412
 */
slouken@1668
   413
extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
slouken@0
   414
slouken@1662
   415
/**
slouken@1662
   416
 * \fn const SDL_DisplayMode *SDL_GetDisplayMode(int index)
slouken@1662
   417
 *
slouken@1662
   418
 * \brief Retrieve information about a specific display mode.
slouken@1662
   419
 *
slouken@1662
   420
 * \note The display modes are sorted in this priority:
slouken@1662
   421
 *       \li bits per pixel -> more colors to fewer colors
slouken@1662
   422
 *       \li width -> largest to smallest
slouken@1662
   423
 *       \li height -> largest to smallest
slouken@1662
   424
 *       \li refresh rate -> highest to lowest
slouken@1662
   425
 *
slouken@1662
   426
 * \sa SDL_GetNumDisplayModes()
slouken@0
   427
 */
slouken@1668
   428
extern DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetDisplayMode(int index);
slouken@1662
   429
slouken@1662
   430
/**
slouken@1662
   431
 * \fn const SDL_DisplayMode *SDL_GetDesktopDisplayMode(void)
slouken@1662
   432
 *
slouken@1662
   433
 * \brief Retrieve information about the desktop display mode for the current display.
slouken@1662
   434
 */
slouken@1662
   435
extern DECLSPEC const SDL_DisplayMode *SDLCALL
slouken@1668
   436
SDL_GetDesktopDisplayMode(void);
slouken@1662
   437
slouken@1662
   438
/**
slouken@1662
   439
 * \fn const SDL_DisplayMode *SDL_GetCurrentDisplayMode(void)
slouken@1662
   440
 *
slouken@1662
   441
 * \brief Retrieve information about the current display mode.
slouken@1662
   442
 */
slouken@1662
   443
extern DECLSPEC const SDL_DisplayMode *SDLCALL
slouken@1668
   444
SDL_GetCurrentDisplayMode(void);
slouken@0
   445
slouken@1662
   446
/**
slouken@1662
   447
 * \fn SDL_DisplayMode *SDL_GetClosestDisplayMode(const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
slouken@1662
   448
 *
slouken@1662
   449
 * \brief Get the closest match to the requested display mode.
slouken@1662
   450
 *
slouken@1662
   451
 * \param mode The desired display mode
slouken@1662
   452
 * \param closest A pointer to a display mode to be filled in with the closest match of the available display modes.
slouken@1662
   453
 *
slouken@1662
   454
 * \return The passed in value 'closest', or NULL if no matching video mode was available.
slouken@1662
   455
 *
slouken@1662
   456
 * The available display modes are scanned, and 'closest' is filled in with the closest mode matching the requested mode and returned.  The mode format and refresh_rate default to the desktop mode if they are 0.  The modes are scanned with size being first priority, format being second priority, and finally checking the refresh_rate.  If all the available modes are too small, then NULL is returned.
slouken@1662
   457
 *
slouken@1662
   458
 * \sa SDL_GetNumDisplayModes()
slouken@1662
   459
 * \sa SDL_GetDisplayMode()
slouken@1662
   460
 */
slouken@1668
   461
extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
slouken@1668
   462
                                                                   SDL_DisplayMode
slouken@1668
   463
                                                                   * mode,
slouken@1668
   464
                                                                   SDL_DisplayMode
slouken@1668
   465
                                                                   * closest);
slouken@1662
   466
slouken@1662
   467
/**
slouken@1662
   468
 * \fn int SDL_SetDisplayMode(const SDL_DisplayMode *mode)
slouken@1662
   469
 *
slouken@1662
   470
 * \brief Set up the closest available mode on the current display.
slouken@1662
   471
 *
slouken@1707
   472
 * \param mode The desired display mode, or NULL to set the desktop mode.
slouken@0
   473
 *
slouken@1662
   474
 * \return 0 on success, or -1 if setting the display mode failed.
slouken@0
   475
 */
slouken@1668
   476
extern DECLSPEC int SDLCALL SDL_SetDisplayMode(const SDL_DisplayMode * mode);
slouken@0
   477
slouken@1662
   478
/**
slouken@1681
   479
 * \fn int SDL_SetDisplayPalette(const SDL_Color *colors, int firstcolor, int ncolors)
slouken@1670
   480
 *
slouken@1681
   481
 * \brief Set the palette entries for indexed display modes.
slouken@1670
   482
 *
slouken@1681
   483
 * \return 0 on success, or -1 if the display mode isn't palettized or the colors couldn't be set.
slouken@1670
   484
 */
slouken@1681
   485
extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,
slouken@1681
   486
                                                  int firstcolor,
slouken@1681
   487
                                                  int ncolors);
slouken@1681
   488
slouken@1681
   489
/**
slouken@1681
   490
 * \fn int SDL_GetDisplayPalette(SDL_Color *colors, int firstcolor, int ncolors)
slouken@1681
   491
 *
slouken@1681
   492
 * \brief Gets the palette entries for indexed display modes.
slouken@1681
   493
 *
slouken@1681
   494
 * \return 0 on success, or -1 if the display mode isn't palettized
slouken@1681
   495
 */
slouken@1681
   496
extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,
slouken@1681
   497
                                                  int firstcolor,
slouken@1681
   498
                                                  int ncolors);
slouken@1670
   499
slouken@1670
   500
/**
slouken@1662
   501
 * \fn SDL_WindowID SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)
slouken@1662
   502
 *
slouken@1662
   503
 * \brief Create a window with the specified position, dimensions, and flags.
slouken@1662
   504
 *
slouken@1662
   505
 * \param title The title of the window
slouken@1662
   506
 * \param x The x position of the window
slouken@1662
   507
 * \param y The y position of the window
slouken@1662
   508
 * \param w The width of the window
slouken@1662
   509
 * \param h The height of the window
slouken@1662
   510
 * \param flags The flags for the window
slouken@1662
   511
 *
slouken@1662
   512
 * \return The id of the window created, or zero if window creation failed.
slouken@1662
   513
 *
slouken@1662
   514
 * \note Setting the position to -1, -1, indicates any position is fine.
slouken@1662
   515
 *
slouken@1662
   516
 * \sa SDL_DestroyWindow()
slouken@1662
   517
 */
slouken@1668
   518
extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindow(const char *title,
slouken@1668
   519
                                                      int x, int y, int w,
slouken@1668
   520
                                                      int h, Uint32 flags);
slouken@1662
   521
slouken@1662
   522
/**
slouken@1662
   523
 * \fn SDL_WindowID SDL_CreateWindowFrom(void *data)
slouken@1662
   524
 *
slouken@1662
   525
 * \brief Create an SDL window struct from an existing native window.
slouken@1662
   526
 *
slouken@1662
   527
 * \param data A pointer to driver-dependent window creation data
slouken@1662
   528
 *
slouken@1662
   529
 * \return The id of the window created, or zero if window creation failed.
slouken@0
   530
 *
slouken@1662
   531
 * \warning This function is NOT SUPPORTED, use at your own risk!
slouken@1662
   532
 *
slouken@1662
   533
 * \sa SDL_DestroyWindow()
slouken@1662
   534
 */
slouken@1681
   535
extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindowFrom(const void *data);
slouken@1662
   536
slouken@1662
   537
/**
slouken@1662
   538
 * \fn Uint32 SDL_GetWindowFlags(SDL_WindowID windowID)
slouken@1662
   539
 *
slouken@1662
   540
 * \brief Get the window flags.
slouken@0
   541
 */
slouken@1668
   542
extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_WindowID windowID);
slouken@1662
   543
slouken@1662
   544
/**
slouken@1662
   545
 * \fn void SDL_SetWindowTitle(SDL_WindowID windowID, const char *title)
slouken@1662
   546
 *
slouken@1662
   547
 * \brief Set the title of the window, in UTF-8 format.
slouken@1662
   548
 *
slouken@1662
   549
 * \sa SDL_GetWindowTitle()
slouken@1662
   550
 */
slouken@1668
   551
extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_WindowID windowID,
slouken@1668
   552
                                                const char *title);
slouken@0
   553
slouken@1662
   554
/**
slouken@1662
   555
 * \fn const char *SDL_GetWindowTitle(SDL_WindowID windowID)
slouken@1662
   556
 *
slouken@1662
   557
 * \brief Get the title of the window, in UTF-8 format.
slouken@0
   558
 *
slouken@1662
   559
 * \sa SDL_SetWindowTitle()
slouken@1662
   560
 */
slouken@1668
   561
extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_WindowID windowID);
slouken@1662
   562
slouken@1662
   563
/**
slouken@1662
   564
 * \fn void SDL_SetWindowIcon(SDL_Surface *icon)
slouken@0
   565
 *
slouken@1662
   566
 * \brief Set the icon of the window.
slouken@1662
   567
 *
slouken@1662
   568
 * \param icon The icon for the window
slouken@1662
   569
 *
slouken@1662
   570
 * FIXME: The icon needs to be set before the window is first shown.  Should some icon representation be part of the window creation data?
slouken@1662
   571
 */
slouken@1668
   572
extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Surface * icon);
slouken@1662
   573
slouken@1662
   574
/**
slouken@1662
   575
 * \fn void SDL_SetWindowData(SDL_WindowID windowID, void *userdata)
slouken@1662
   576
 *
slouken@1662
   577
 * \brief Associate an arbitrary pointer with the window.
slouken@0
   578
 *
slouken@1662
   579
 * \sa SDL_GetWindowData()
slouken@1662
   580
 */
slouken@1668
   581
extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_WindowID windowID,
slouken@1668
   582
                                               void *userdata);
slouken@1662
   583
slouken@1662
   584
/**
slouken@1662
   585
 * \fn void *SDL_GetWindowData(SDL_WindowID windowID)
slouken@0
   586
 *
slouken@1662
   587
 * \brief Retrieve the data pointer associated with the window.
slouken@1662
   588
 *
slouken@1662
   589
 * \sa SDL_SetWindowData()
slouken@1662
   590
 */
slouken@1668
   591
extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_WindowID windowID);
slouken@1662
   592
slouken@1662
   593
/**
slouken@1662
   594
 * \fn void SDL_SetWindowPosition(SDL_WindowID windowID, int x, int y)
slouken@1662
   595
 *
slouken@1662
   596
 * \brief Set the position of the window.
slouken@0
   597
 *
slouken@1719
   598
 * \param windowID The window to reposition
slouken@1719
   599
 * \param x The x coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
slouken@1719
   600
 * \param y The y coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
slouken@1719
   601
 *
slouken@1719
   602
 * \note The window coordinate origin is the upper left of the display.
slouken@1719
   603
 *
slouken@1662
   604
 * \sa SDL_GetWindowPosition()
slouken@1662
   605
 */
slouken@1668
   606
extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_WindowID windowID,
slouken@1668
   607
                                                   int x, int y);
slouken@1662
   608
slouken@1662
   609
/**
slouken@1662
   610
 * \fn void SDL_GetWindowPosition(SDL_WindowID windowID, int *x, int *y)
slouken@1662
   611
 *
slouken@1662
   612
 * \brief Get the position of the window.
slouken@1662
   613
 *
slouken@1662
   614
 * \sa SDL_SetWindowPosition()
slouken@1662
   615
 */
slouken@1668
   616
extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_WindowID windowID,
slouken@1668
   617
                                                   int *x, int *y);
slouken@1662
   618
slouken@1662
   619
/**
slouken@1662
   620
 * \fn void SDL_SetWindowSize(SDL_WindowID windowID, int w, int w)
slouken@1662
   621
 *
slouken@1662
   622
 * \brief Set the size of the window's client area.
slouken@1662
   623
 *
slouken@1662
   624
 * \note You can't change the size of a fullscreen window, it automatically
slouken@1662
   625
 * matches the size of the display mode.
slouken@1662
   626
 *
slouken@1662
   627
 * \sa SDL_GetWindowSize()
slouken@1662
   628
 */
slouken@1668
   629
extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_WindowID windowID, int w,
slouken@1668
   630
                                               int h);
slouken@1662
   631
slouken@1662
   632
/**
slouken@1662
   633
 * \fn void SDL_GetWindowSize(SDL_WindowID windowID, int *w, int *w)
slouken@0
   634
 *
slouken@1662
   635
 * \brief Get the size of the window's client area.
slouken@1662
   636
 *
slouken@1662
   637
 * \sa SDL_SetWindowSize()
slouken@1662
   638
 */
slouken@1668
   639
extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_WindowID windowID, int *w,
slouken@1668
   640
                                               int *h);
slouken@1662
   641
slouken@1662
   642
/**
slouken@1662
   643
 * \fn void SDL_ShowWindow(SDL_WindowID windowID)
slouken@1662
   644
 *
slouken@1662
   645
 * \brief Show the window
slouken@1662
   646
 *
slouken@1662
   647
 * \sa SDL_HideWindow()
slouken@1662
   648
 */
slouken@1668
   649
extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_WindowID windowID);
slouken@1662
   650
slouken@1662
   651
/**
slouken@1662
   652
 * \fn void SDL_HideWindow(SDL_WindowID windowID)
slouken@1662
   653
 *
slouken@1662
   654
 * \brief Hide the window
slouken@0
   655
 *
slouken@1662
   656
 * \sa SDL_ShowWindow()
slouken@1662
   657
 */
slouken@1668
   658
extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_WindowID windowID);
slouken@1662
   659
slouken@1662
   660
/**
slouken@1662
   661
 * \fn void SDL_RaiseWindow(SDL_WindowID windowID)
slouken@1662
   662
 *
slouken@1662
   663
 * \brief Raise the window so it's above other windows.
slouken@1662
   664
 */
slouken@1668
   665
extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_WindowID windowID);
slouken@1662
   666
slouken@1662
   667
/**
slouken@1662
   668
 * \fn void SDL_MaximizeWindow(SDL_WindowID windowID)
slouken@1662
   669
 *
slouken@1662
   670
 * \brief Make the window as large as possible.
slouken@1662
   671
 *
slouken@1662
   672
 * \sa SDL_RestoreWindow()
slouken@1662
   673
 */
slouken@1668
   674
extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_WindowID windowID);
slouken@1662
   675
slouken@1662
   676
/**
slouken@1662
   677
 * \fn void SDL_MinimizeWindow(SDL_WindowID windowID)
slouken@1662
   678
 *
slouken@1662
   679
 * \brief Minimize the window to an iconic representation.
slouken@0
   680
 *
slouken@1662
   681
 * \sa SDL_RestoreWindow()
slouken@1662
   682
 */
slouken@1668
   683
extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_WindowID windowID);
slouken@1662
   684
slouken@1662
   685
/**
slouken@1662
   686
 * \fn void SDL_RestoreWindow(SDL_WindowID windowID)
slouken@1662
   687
 *
slouken@1662
   688
 * \brief Restore the size and position of a minimized or maximized window.
slouken@0
   689
 *
slouken@1662
   690
 * \sa SDL_MaximizeWindow()
slouken@1662
   691
 * \sa SDL_MinimizeWindow()
slouken@1662
   692
 */
slouken@1668
   693
extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_WindowID windowID);
slouken@1662
   694
slouken@1662
   695
/**
slouken@1662
   696
 * \fn void SDL_SetWindowGrab(SDL_WindowID windowID, int mode)
slouken@1662
   697
 *
slouken@1662
   698
 * \brief Set the window's input grab mode.
slouken@1662
   699
 *
slouken@1662
   700
 * \param mode This is 1 to grab input, and 0 to release input.
slouken@0
   701
 *
slouken@1662
   702
 * \sa SDL_GrabMode
slouken@1662
   703
 * \sa SDL_GetWindowGrab()
slouken@1662
   704
 */
slouken@1668
   705
extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_WindowID windowID,
slouken@1668
   706
                                               int mode);
slouken@1662
   707
slouken@1662
   708
/**
slouken@1662
   709
 * \fn int SDL_GetWindowGrab(SDL_WindowID windowID)
slouken@1662
   710
 *
slouken@1662
   711
 * \brief Get the window's input grab mode.
slouken@1662
   712
 *
slouken@1662
   713
 * \return This returns 1 if input is grabbed, and 0 otherwise.
slouken@0
   714
 *
slouken@1662
   715
 * \sa SDL_GrabMode
slouken@1662
   716
 * \sa SDL_SetWindowGrab()
slouken@1662
   717
 */
slouken@1668
   718
extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_WindowID windowID);
slouken@1662
   719
slouken@1662
   720
/**
slouken@1662
   721
 * \fn void SDL_DestroyWindow(SDL_WindowID windowID)
slouken@1662
   722
 *
slouken@1662
   723
 * \brief Destroy a window.
slouken@0
   724
 */
slouken@1668
   725
extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_WindowID windowID);
slouken@1662
   726
slouken@1662
   727
/**
slouken@1670
   728
 * \fn int SDL_GetNumRenderers(void)
slouken@1670
   729
 *
slouken@1670
   730
 * \brief Get the number of render managers on the current display.
slouken@1670
   731
 *
slouken@1670
   732
 * A render manager is a set of code that handles rendering and texture
slouken@1670
   733
 * management on a particular display.  Normally there is only one, but
slouken@1670
   734
 * some drivers may have several available with different capabilities.
slouken@1670
   735
 *
slouken@1670
   736
 * \sa SDL_GetRendererInfo()
slouken@1670
   737
 * \sa SDL_CreateRenderer()
slouken@1670
   738
 */
slouken@1670
   739
extern DECLSPEC int SDLCALL SDL_GetNumRenderers(void);
slouken@1670
   740
slouken@1670
   741
/**
slouken@1670
   742
 * \fn SDL_RendererInfo *SDL_GetRendererInfo(int index)
slouken@1670
   743
 *
slouken@1670
   744
 * \brief Get information about a specific render manager on the current
slouken@1670
   745
 *        display.
slouken@1670
   746
 *
slouken@1670
   747
 * \sa SDL_CreateRenderer()
slouken@1670
   748
 */
slouken@1670
   749
extern DECLSPEC int SDLCALL SDL_GetRendererInfo(int index,
slouken@1670
   750
                                                SDL_RendererInfo * info);
slouken@1670
   751
slouken@1670
   752
/**
slouken@1670
   753
 * \fn int SDL_CreateRenderer(SDL_WindowID window, int index, Uint32 flags)
slouken@1670
   754
 *
slouken@1670
   755
 * \brief Create and make active a 2D rendering context for a window.
slouken@1670
   756
 *
slouken@1719
   757
 * \param windowID The window used for rendering
slouken@1670
   758
 * \param index The index of the render manager to initialize, or -1 to initialize the first one supporting the requested flags.
slouken@1670
   759
 * \param flags SDL_RendererFlags
slouken@1662
   760
 *
slouken@1670
   761
 * \return 0 on success, -1 if the flags were not supported, or -2 if
slouken@1670
   762
 *         there isn't enough memory to support the requested flags
slouken@1670
   763
 *
slouken@1670
   764
 * \sa SDL_SelectRenderer()
slouken@1670
   765
 * \sa SDL_DestroyRenderer()
slouken@1670
   766
 */
slouken@1670
   767
extern DECLSPEC int SDLCALL SDL_CreateRenderer(SDL_WindowID windowID,
slouken@1670
   768
                                               int index, Uint32 flags);
slouken@1670
   769
slouken@1670
   770
/**
slouken@1670
   771
 * \fn int SDL_SelectRenderer(SDL_WindowID windowID)
slouken@1670
   772
 *
slouken@1670
   773
 * \brief Select the rendering context for a particular window.
slouken@1670
   774
 *
slouken@1670
   775
 * \return 0 on success, -1 if the selected window doesn't have a
slouken@1670
   776
 *         rendering context.
slouken@1670
   777
 */
slouken@1670
   778
extern DECLSPEC int SDLCALL SDL_SelectRenderer(SDL_WindowID windowID);
slouken@1670
   779
slouken@1670
   780
/**
slouken@1670
   781
 * \fn SDL_TextureID SDL_CreateTexture(Uint32 format, int access, int w, int h)
slouken@1670
   782
 *
slouken@1706
   783
 * \brief Create a texture for the current rendering context.
slouken@1670
   784
 *
slouken@1670
   785
 * \param format The format of the texture
slouken@1670
   786
 * \param access One of the enumerated values in SDL_TextureAccess
slouken@1670
   787
 * \param w The width of the texture in pixels
slouken@1670
   788
 * \param h The height of the texture in pixels
slouken@1670
   789
 *
slouken@1670
   790
 * \return The created texture is returned, or 0 if no render manager was active,  the format was unsupported, or the width or height were out of range.
slouken@1670
   791
 *
slouken@1670
   792
 * \sa SDL_QueryTexture()
slouken@1670
   793
 * \sa SDL_DestroyTexture()
slouken@1662
   794
 */
slouken@1670
   795
extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTexture(Uint32 format,
slouken@1670
   796
                                                        int access, int w,
slouken@1670
   797
                                                        int h);
slouken@1670
   798
slouken@1670
   799
/**
slouken@1670
   800
 * \fn SDL_TextureID SDL_CreateTextureFromSurface(Uint32 format, int access, SDL_Surface *surface)
slouken@1670
   801
 *
slouken@1678
   802
 * \brief Create a texture from an existing surface.
slouken@1670
   803
 *
slouken@1670
   804
 * \param format The format of the texture, or 0 to pick an appropriate format
slouken@1670
   805
 * \param access One of the enumerated values in SDL_TextureAccess
slouken@1670
   806
 * \param surface The surface containing pixel data used to fill the texture
slouken@1670
   807
 *
slouken@1670
   808
 * \return The created texture is returned, or 0 if no render manager was active,  the format was unsupported, or the surface width or height were out of range.
slouken@1670
   809
 *
slouken@1670
   810
 * \note The surface is not modified or freed by this function.
slouken@1670
   811
 *
slouken@1670
   812
 * \sa SDL_QueryTexture()
slouken@1670
   813
 * \sa SDL_DestroyTexture()
slouken@1670
   814
 */
slouken@1670
   815
extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTextureFromSurface(Uint32
slouken@1670
   816
                                                                   format,
slouken@1670
   817
                                                                   int access,
slouken@1670
   818
                                                                   SDL_Surface
slouken@1670
   819
                                                                   * surface);
slouken@0
   820
slouken@1670
   821
/**
slouken@1670
   822
 * \fn int SDL_QueryTexture(SDL_TextureID textureID, Uint32 *format, int *access, int *w, int *h)
slouken@1670
   823
 *
slouken@1670
   824
 * \brief Query the attributes of a texture
slouken@1670
   825
 *
slouken@1670
   826
 * \param texture A texture to be queried
slouken@1670
   827
 * \param format A pointer filled in with the raw format of the texture.  The actual format may differ, but pixel transfers will use this format.
slouken@1670
   828
 * \param access A pointer filled in with the actual access to the texture.
slouken@1670
   829
 * \param w A pointer filled in with the width of the texture in pixels
slouken@1670
   830
 * \param h A pointer filled in with the height of the texture in pixels
slouken@1670
   831
 *
slouken@1670
   832
 * \return 0 on success, or -1 if the texture is not valid
slouken@1670
   833
 */
slouken@1670
   834
extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_TextureID textureID,
slouken@1670
   835
                                             Uint32 * format, int *access,
slouken@1670
   836
                                             int *w, int *h);
slouken@1670
   837
slouken@1670
   838
/**
slouken@1678
   839
 * \fn int SDL_QueryTexturePixels(SDL_TextureID textureID, void **pixels, int pitch)
slouken@1678
   840
 *
slouken@1678
   841
 * \brief Query the pixels of a texture, if the texture does not need to be locked for pixel access.
slouken@1678
   842
 *
slouken@1678
   843
 * \param texture A texture to be queried, which was created with SDL_TextureAccess_Local
slouken@1678
   844
 * \param pixels A pointer filled with a pointer to the pixels for the texture 
slouken@1678
   845
 * \param pitch A pointer filled in with the pitch of the pixel data
slouken@1678
   846
 *
slouken@1678
   847
 * \return 0 on success, or -1 if the texture is not valid, or must be locked for pixel access.
slouken@1678
   848
 */
slouken@1678
   849
extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_TextureID textureID,
slouken@1678
   850
                                                   void **pixels, int *pitch);
slouken@1678
   851
slouken@1678
   852
/**
slouken@1681
   853
 * \fn int SDL_SetTexturePalette(SDL_TextureID textureID, const SDL_Color * colors, int firstcolor, int ncolors)
slouken@1670
   854
 *
slouken@1670
   855
 * \brief Update an indexed texture with a color palette
slouken@1670
   856
 *
slouken@1670
   857
 * \param texture The texture to update
slouken@1670
   858
 * \param colors The array of RGB color data
slouken@1670
   859
 * \param firstcolor The first index to update
slouken@1670
   860
 * \param ncolors The number of palette entries to fill with the color data
slouken@1670
   861
 *
slouken@1670
   862
 * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
slouken@1670
   863
 */
slouken@1670
   864
extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_TextureID textureID,
slouken@1681
   865
                                                  const SDL_Color * colors,
slouken@1681
   866
                                                  int firstcolor,
slouken@1681
   867
                                                  int ncolors);
slouken@1681
   868
slouken@1681
   869
/**
slouken@1681
   870
 * \fn int SDL_GetTexturePalette(SDL_TextureID textureID, SDL_Color * colors, int firstcolor, int ncolors)
slouken@1681
   871
 *
slouken@1681
   872
 * \brief Update an indexed texture with a color palette
slouken@1681
   873
 *
slouken@1681
   874
 * \param texture The texture to update
slouken@1681
   875
 * \param colors The array to fill with RGB color data
slouken@1681
   876
 * \param firstcolor The first index to retrieve
slouken@1681
   877
 * \param ncolors The number of palette entries to retrieve
slouken@1681
   878
 *
slouken@1681
   879
 * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
slouken@1681
   880
 */
slouken@1681
   881
extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_TextureID textureID,
slouken@1670
   882
                                                  SDL_Color * colors,
slouken@1670
   883
                                                  int firstcolor,
slouken@1670
   884
                                                  int ncolors);
slouken@1670
   885
slouken@1670
   886
/**
slouken@1681
   887
 * \fn int SDL_UpdateTexture(SDL_TextureID textureID, const SDL_Rect *rect, const void *pixels, int pitch)
slouken@1670
   888
 *
slouken@1670
   889
 * \brief Update the given texture rectangle with new pixel data.
slouken@1670
   890
 *
slouken@1670
   891
 * \param texture The texture to update
slouken@1670
   892
 * \param rect A pointer to the rectangle of pixels to update, or NULL to update the entire texture.
slouken@1670
   893
 * \param pixels The raw pixel data
slouken@1670
   894
 * \param pitch The number of bytes between rows of pixel data
slouken@1670
   895
 *
slouken@1670
   896
 * \return 0 on success, or -1 if the texture is not valid
slouken@1670
   897
 *
slouken@1670
   898
 * \note This is a very slow function for textures not created with SDL_TextureAccess_Local.
slouken@0
   899
 */
slouken@1670
   900
extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_TextureID textureID,
slouken@1681
   901
                                              const SDL_Rect * rect,
slouken@1670
   902
                                              const void *pixels, int pitch);
slouken@1670
   903
slouken@1670
   904
/**
slouken@1681
   905
 * \fn void SDL_LockTexture(SDL_TextureID textureID, const SDL_Rect *rect, int markDirty, void **pixels, int *pitch)
slouken@1670
   906
 *
slouken@1670
   907
 * \brief Lock a portion of the texture for pixel access.
slouken@1670
   908
 *
slouken@1670
   909
 * \param texture The texture to lock for access, which must have been created with SDL_TextureAccess_Local.
slouken@1670
   910
 * \param rect A pointer to the rectangle to lock for access. If the rect is NULL, the entire texture will be locked.
slouken@1670
   911
 * \param markDirty If this is nonzero, the locked area will be marked dirty when the texture is unlocked.
slouken@1670
   912
 * \param pixels This is filled in with a pointer to the locked pixels, appropriately offset by the locked area.
slouken@1670
   913
 * \param pitch This is filled in with the pitch of the locked pixels.
slouken@1670
   914
 *
slouken@1670
   915
 * \return 0 on success, or -1 if the texture is not valid or was created with SDL_TextureAccess_Remote
slouken@1670
   916
 *
slouken@1670
   917
 * \sa SDL_DirtyTexture()
slouken@1670
   918
 * \sa SDL_UnlockTexture()
slouken@1670
   919
 */
slouken@1670
   920
extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_TextureID textureID,
slouken@1681
   921
                                            const SDL_Rect * rect,
slouken@1681
   922
                                            int markDirty, void **pixels,
slouken@1681
   923
                                            int *pitch);
slouken@1670
   924
slouken@1670
   925
/**
slouken@1670
   926
 * \fn void SDL_UnlockTexture(SDL_TextureID textureID)
slouken@1670
   927
 *
slouken@1670
   928
 * \brief Unlock a texture, uploading the changes to video memory, if needed.
slouken@1670
   929
 *
slouken@1670
   930
 * \sa SDL_LockTexture()
slouken@1670
   931
 * \sa SDL_DirtyTexture()
slouken@1670
   932
 */
slouken@1670
   933
extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_TextureID textureID);
slouken@1670
   934
slouken@1670
   935
/**
slouken@1681
   936
 * \fn void SDL_DirtyTexture(SDL_TextureID textureID, int numrects, const SDL_Rect * rects)
slouken@1670
   937
 *
slouken@1670
   938
 * \brief Mark the specified rectangles of the texture as dirty.
slouken@1670
   939
 *
slouken@1670
   940
 * \note The texture must have been created with SDL_TextureAccess_Local.
slouken@1670
   941
 *
slouken@1670
   942
 * \sa SDL_LockTexture()
slouken@1670
   943
 * \sa SDL_UnlockTexture()
slouken@1670
   944
 */
slouken@1670
   945
extern DECLSPEC void SDLCALL SDL_DirtyTexture(SDL_TextureID textureID,
slouken@1681
   946
                                              int numrects,
slouken@1681
   947
                                              const SDL_Rect * rects);
slouken@1670
   948
slouken@1670
   949
/**
slouken@1670
   950
 * \fn void SDL_SelectRenderTexture(SDL_TextureID textureID)
slouken@1670
   951
 *
slouken@1670
   952
 * \brief Select a texture as the rendering target, or 0 to reselect the current window.
slouken@1670
   953
 *
slouken@1670
   954
 * \note The texture must have been created with SDL_TextureAccess_Render.
slouken@1670
   955
 */
slouken@1670
   956
extern DECLSPEC void SDLCALL SDL_SelectRenderTexture(SDL_TextureID textureID);
slouken@1670
   957
slouken@1670
   958
/**
slouken@1681
   959
 * \fn void SDL_RenderFill(const SDL_Rect *rect, Uint32 color)
slouken@1670
   960
 *
slouken@1670
   961
 * \brief Fill the current rendering target with the specified color.
slouken@1670
   962
 *
slouken@1670
   963
 * \param rect A pointer to the destination rectangle, or NULL for the entire rendering target.
slouken@1670
   964
 * \param color An ARGB color value.
slouken@1670
   965
 *
slouken@1670
   966
 * \return 0 on success, or -1 if there is no renderer current
slouken@1670
   967
 */
slouken@1681
   968
extern DECLSPEC int SDLCALL SDL_RenderFill(const SDL_Rect * rect,
slouken@1681
   969
                                           Uint32 color);
slouken@0
   970
slouken@1670
   971
/**
slouken@1681
   972
 * \fn int SDL_RenderCopy(SDL_TextureID textureID, const SDL_Rect *srcrect, const SDL_Rect *dstrect, Uint32 blendMode, Uint32 scaleMode)
slouken@1670
   973
 *
slouken@1670
   974
 * \brief Copy a portion of the texture to the current rendering target.
slouken@1670
   975
 *
slouken@1670
   976
 * \param texture The source texture.
slouken@1670
   977
 * \param srcrect A pointer to the source rectangle, or NULL for the entire texture.
slouken@1670
   978
 * \param dstrect A pointer to the destination rectangle, or NULL for the entire rendering target.
slouken@1670
   979
 * \param blendMode SDL_TextureBlendMode to be used if the source texture has an alpha channel.
slouken@1670
   980
 * \param scaleMode SDL_TextureScaleMode to be used if the source and destination rectangles don't have the same width and height.
slouken@1670
   981
 *
slouken@1670
   982
 * \return 0 on success, or -1 if there is no renderer current, or the driver doesn't support the requested operation.
slouken@1670
   983
 *
slouken@1670
   984
 * \note You can check the video driver info to see what operations are supported.
slouken@1670
   985
 */
slouken@1670
   986
extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_TextureID textureID,
slouken@1681
   987
                                           const SDL_Rect * srcrect,
slouken@1681
   988
                                           const SDL_Rect * dstrect,
slouken@1681
   989
                                           int blendMode, int scaleMode);
slouken@1670
   990
slouken@1670
   991
/**
slouken@1681
   992
 * \fn int SDL_RenderReadPixels(const SDL_Rect *rect, void *pixels, int pitch)
slouken@1670
   993
 *
slouken@1670
   994
 * \brief Read pixels from the current rendering target.
slouken@1670
   995
 *
slouken@1670
   996
 * \param rect A pointer to the rectangle to read, or NULL for the entire render target
slouken@1670
   997
 * \param pixels A pointer to be filled in with the pixel data
slouken@1670
   998
 * \param pitch The pitch of the pixels parameter
slouken@1670
   999
 *
slouken@1670
  1000
 * \return 0 on success, or -1 if pixel reading is not supported.
slouken@1670
  1001
 *
slouken@1670
  1002
 * \warning This is a very slow operation, and should not be used frequently.
slouken@0
  1003
 */
slouken@1681
  1004
extern DECLSPEC int SDLCALL SDL_RenderReadPixels(const SDL_Rect * rect,
slouken@1670
  1005
                                                 void *pixels, int pitch);
slouken@1670
  1006
slouken@1670
  1007
/**
slouken@1681
  1008
 * \fn int SDL_RenderWritePixels(const SDL_Rect *rect, const void *pixels, int pitch)
slouken@1670
  1009
 *
slouken@1670
  1010
 * \brief Write pixels to the current rendering target.
slouken@1670
  1011
 *
slouken@1670
  1012
 * \param rect A pointer to the rectangle to write, or NULL for the entire render target
slouken@1670
  1013
 * \param pixels A pointer to the pixel data to write
slouken@1670
  1014
 * \param pitch The pitch of the pixels parameter
slouken@1670
  1015
 *
slouken@1670
  1016
 * \return 0 on success, or -1 if pixel writing is not supported.
slouken@1670
  1017
 *
slouken@1670
  1018
 * \warning This is a very slow operation, and should not be used frequently.
slouken@1670
  1019
 */
slouken@1681
  1020
extern DECLSPEC int SDLCALL SDL_RenderWritePixels(const SDL_Rect * rect,
slouken@1670
  1021
                                                  const void *pixels,
slouken@1670
  1022
                                                  int pitch);
slouken@1670
  1023
slouken@1670
  1024
/**
slouken@1670
  1025
 * \fn void SDL_RenderPresent(void)
slouken@1670
  1026
 *
slouken@1670
  1027
 * \brief Update the screen with rendering performed.
slouken@1670
  1028
 */
slouken@1670
  1029
extern DECLSPEC void SDLCALL SDL_RenderPresent(void);
slouken@1670
  1030
slouken@1670
  1031
/**
slouken@1670
  1032
 * \fn void SDL_DestroyTexture(SDL_TextureID textureID);
slouken@1670
  1033
 *
slouken@1670
  1034
 * \brief Destroy the specified texture.
slouken@1670
  1035
 *
slouken@1670
  1036
 * \sa SDL_CreateTexture()
slouken@1670
  1037
 * \sa SDL_CreateTextureFromSurface()
slouken@1670
  1038
 */
slouken@1670
  1039
extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_TextureID textureID);
slouken@1670
  1040
slouken@1670
  1041
/**
slouken@1670
  1042
 * \fn void SDL_DestroyRenderer(SDL_WindowID windowID);
slouken@1670
  1043
 *
slouken@1670
  1044
 * \brief Destroy the rendering context for a window and free associated
slouken@1670
  1045
 *        textures.
slouken@1670
  1046
 *
slouken@1670
  1047
 * \sa SDL_CreateRenderer()
slouken@1670
  1048
 */
slouken@1670
  1049
extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_WindowID windowID);
slouken@0
  1050
slouken@0
  1051
/*
slouken@0
  1052
 * Set the gamma correction for each of the color channels.
slouken@0
  1053
 * The gamma values range (approximately) between 0.1 and 10.0
slouken@0
  1054
 * 
slouken@0
  1055
 * If this function isn't supported directly by the hardware, it will
slouken@0
  1056
 * be emulated using gamma ramps, if available.  If successful, this
slouken@0
  1057
 * function returns 0, otherwise it returns -1.
slouken@0
  1058
 */
slouken@1668
  1059
extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
slouken@0
  1060
slouken@0
  1061
/*
slouken@0
  1062
 * Set the gamma translation table for the red, green, and blue channels
slouken@0
  1063
 * of the video hardware.  Each table is an array of 256 16-bit quantities,
slouken@0
  1064
 * representing a mapping between the input and output for that channel.
slouken@0
  1065
 * The input is the index into the array, and the output is the 16-bit
slouken@0
  1066
 * gamma value at that index, scaled to the output color precision.
slouken@0
  1067
 * 
slouken@0
  1068
 * You may pass NULL for any of the channels to leave it unchanged.
slouken@0
  1069
 * If the call succeeds, it will return 0.  If the display driver or
slouken@0
  1070
 * hardware does not support gamma translation, or otherwise fails,
slouken@0
  1071
 * this function will return -1.
slouken@0
  1072
 */
slouken@1668
  1073
extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
slouken@1668
  1074
                                             const Uint16 * green,
slouken@1668
  1075
                                             const Uint16 * blue);
slouken@0
  1076
slouken@0
  1077
/*
slouken@0
  1078
 * Retrieve the current values of the gamma translation tables.
slouken@0
  1079
 * 
slouken@0
  1080
 * You must pass in valid pointers to arrays of 256 16-bit quantities.
slouken@0
  1081
 * Any of the pointers may be NULL to ignore that channel.
slouken@0
  1082
 * If the call succeeds, it will return 0.  If the display driver or
slouken@0
  1083
 * hardware does not support gamma translation, or otherwise fails,
slouken@0
  1084
 * this function will return -1.
slouken@0
  1085
 */
slouken@1668
  1086
extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
slouken@1668
  1087
                                             Uint16 * blue);
slouken@0
  1088
slouken@0
  1089
/*
slouken@0
  1090
 * Maps an RGB triple to an opaque pixel value for a given pixel format
slouken@0
  1091
 */
slouken@337
  1092
extern DECLSPEC Uint32 SDLCALL SDL_MapRGB
slouken@1662
  1093
    (SDL_PixelFormat * format, Uint8 r, Uint8 g, Uint8 b);
slouken@0
  1094
slouken@0
  1095
/*
slouken@0
  1096
 * Maps an RGBA quadruple to a pixel value for a given pixel format
slouken@0
  1097
 */
slouken@1668
  1098
extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(SDL_PixelFormat * format,
slouken@1668
  1099
                                           Uint8 r, Uint8 g, Uint8 b,
slouken@1668
  1100
                                           Uint8 a);
slouken@0
  1101
slouken@0
  1102
/*
slouken@0
  1103
 * Maps a pixel value into the RGB components for a given pixel format
slouken@0
  1104
 */
slouken@1668
  1105
extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, SDL_PixelFormat * fmt,
slouken@1668
  1106
                                        Uint8 * r, Uint8 * g, Uint8 * b);
slouken@0
  1107
slouken@0
  1108
/*
slouken@0
  1109
 * Maps a pixel value into the RGBA components for a given pixel format
slouken@0
  1110
 */
slouken@1668
  1111
extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel, SDL_PixelFormat * fmt,
slouken@1668
  1112
                                         Uint8 * r, Uint8 * g, Uint8 * b,
slouken@1668
  1113
                                         Uint8 * a);
slouken@0
  1114
slouken@0
  1115
/*
slouken@0
  1116
 * Allocate and free an RGB surface (must be called after SDL_SetVideoMode)
slouken@0
  1117
 * If the depth is 4 or 8 bits, an empty palette is allocated for the surface.
slouken@0
  1118
 * If the depth is greater than 8 bits, the pixel format is set using the
slouken@0
  1119
 * flags '[RGB]mask'.
slouken@0
  1120
 * If the function runs out of memory, it will return NULL.
slouken@0
  1121
 *
slouken@0
  1122
 * The 'flags' tell what kind of surface to create.
slouken@0
  1123
 * SDL_SRCCOLORKEY indicates that the surface will be used for colorkey blits.
slouken@1670
  1124
 * SDL_SRCALPHA means that the surface will be used for alpha blits.
slouken@0
  1125
 */
slouken@1662
  1126
extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface
slouken@1662
  1127
    (Uint32 flags, int width, int height, int depth,
slouken@1662
  1128
     Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
slouken@1668
  1129
extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceFrom(void *pixels,
slouken@1668
  1130
                                                              int width,
slouken@1668
  1131
                                                              int height,
slouken@1668
  1132
                                                              int depth,
slouken@1668
  1133
                                                              int pitch,
slouken@1668
  1134
                                                              Uint32 Rmask,
slouken@1668
  1135
                                                              Uint32 Gmask,
slouken@1668
  1136
                                                              Uint32 Bmask,
slouken@1668
  1137
                                                              Uint32 Amask);
slouken@1670
  1138
extern DECLSPEC SDL_Surface *SDLCALL
slouken@1670
  1139
SDL_CreateRGBSurfaceFromTexture(SDL_TextureID textureID);
slouken@1668
  1140
extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface * surface);
slouken@0
  1141
slouken@1683
  1142
/**
slouken@1683
  1143
 * \fn int SDL_SetSurfacePalette(SDL_Surface *surface, SDL_Palette *palette)
slouken@1683
  1144
 *
slouken@1683
  1145
 * \brief Set the palette used by a surface.
slouken@1683
  1146
 *
slouken@1683
  1147
 * \return 0, or -1 if the surface format doesn't use a palette.
slouken@1683
  1148
 *
slouken@1683
  1149
 * \note A single palette can be shared with many surfaces.
slouken@1683
  1150
 */
slouken@1683
  1151
extern DECLSPEC int SDLCALL SDL_SetSurfacePalette(SDL_Surface * surface,
slouken@1683
  1152
                                                  SDL_Palette * palette);
slouken@1683
  1153
slouken@0
  1154
/*
slouken@0
  1155
 * SDL_LockSurface() sets up a surface for directly accessing the pixels.
slouken@0
  1156
 * Between calls to SDL_LockSurface()/SDL_UnlockSurface(), you can write
slouken@0
  1157
 * to and read from 'surface->pixels', using the pixel format stored in 
slouken@0
  1158
 * 'surface->format'.  Once you are done accessing the surface, you should 
slouken@0
  1159
 * use SDL_UnlockSurface() to release it.
slouken@0
  1160
 *
slouken@0
  1161
 * Not all surfaces require locking.  If SDL_MUSTLOCK(surface) evaluates
slouken@0
  1162
 * to 0, then you can read and write to the surface at any time, and the
slouken@1670
  1163
 * pixel format of the surface will not change.
slouken@0
  1164
 * 
slouken@0
  1165
 * No operating system or library calls should be made between lock/unlock
slouken@0
  1166
 * pairs, as critical system locks may be held during this time.
slouken@0
  1167
 *
slouken@0
  1168
 * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
slouken@0
  1169
 */
slouken@1668
  1170
extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
slouken@1668
  1171
extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
slouken@0
  1172
slouken@0
  1173
/*
slouken@0
  1174
 * Load a surface from a seekable SDL data source (memory or file.)
slouken@0
  1175
 * If 'freesrc' is non-zero, the source will be closed after being read.
slouken@0
  1176
 * Returns the new surface, or NULL if there was an error.
slouken@0
  1177
 * The new surface should be freed with SDL_FreeSurface().
slouken@0
  1178
 */
slouken@1668
  1179
extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_RW(SDL_RWops * src,
slouken@1668
  1180
                                                    int freesrc);
slouken@0
  1181
slouken@0
  1182
/* Convenience macro -- load a surface from a file */
slouken@0
  1183
#define SDL_LoadBMP(file)	SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
slouken@0
  1184
slouken@0
  1185
/*
slouken@0
  1186
 * Save a surface to a seekable SDL data source (memory or file.)
slouken@0
  1187
 * If 'freedst' is non-zero, the source will be closed after being written.
slouken@0
  1188
 * Returns 0 if successful or -1 if there was an error.
slouken@0
  1189
 */
slouken@337
  1190
extern DECLSPEC int SDLCALL SDL_SaveBMP_RW
slouken@1662
  1191
    (SDL_Surface * surface, SDL_RWops * dst, int freedst);
slouken@0
  1192
slouken@0
  1193
/* Convenience macro -- save a surface to a file */
slouken@0
  1194
#define SDL_SaveBMP(surface, file) \
slouken@0
  1195
		SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1)
slouken@0
  1196
slouken@0
  1197
/*
slouken@0
  1198
 * Sets the color key (transparent pixel) in a blittable surface.
slouken@0
  1199
 * If 'flag' is SDL_SRCCOLORKEY (optionally OR'd with SDL_RLEACCEL), 
slouken@0
  1200
 * 'key' will be the transparent pixel in the source image of a blit.
slouken@0
  1201
 * SDL_RLEACCEL requests RLE acceleration for the surface if present,
slouken@0
  1202
 * and removes RLE acceleration if absent.
slouken@0
  1203
 * If 'flag' is 0, this function clears any current color key.
slouken@0
  1204
 * This function returns 0, or -1 if there was an error.
slouken@0
  1205
 */
slouken@337
  1206
extern DECLSPEC int SDLCALL SDL_SetColorKey
slouken@1662
  1207
    (SDL_Surface * surface, Uint32 flag, Uint32 key);
slouken@0
  1208
slouken@0
  1209
/*
slouken@0
  1210
 * This function sets the alpha value for the entire surface, as opposed to
slouken@0
  1211
 * using the alpha component of each pixel. This value measures the range
slouken@0
  1212
 * of transparency of the surface, 0 being completely transparent to 255
slouken@0
  1213
 * being completely opaque. An 'alpha' value of 255 causes blits to be
slouken@0
  1214
 * opaque, the source pixels copied to the destination (the default). Note
slouken@0
  1215
 * that per-surface alpha can be combined with colorkey transparency.
slouken@0
  1216
 *
slouken@0
  1217
 * If 'flag' is 0, alpha blending is disabled for the surface.
slouken@0
  1218
 * If 'flag' is SDL_SRCALPHA, alpha blending is enabled for the surface.
slouken@0
  1219
 * OR:ing the flag with SDL_RLEACCEL requests RLE acceleration for the
slouken@0
  1220
 * surface; if SDL_RLEACCEL is not specified, the RLE accel will be removed.
slouken@432
  1221
 *
slouken@432
  1222
 * The 'alpha' parameter is ignored for surfaces that have an alpha channel.
slouken@0
  1223
 */
slouken@1668
  1224
extern DECLSPEC int SDLCALL SDL_SetAlpha(SDL_Surface * surface, Uint32 flag,
slouken@1668
  1225
                                         Uint8 alpha);
slouken@0
  1226
slouken@0
  1227
/*
slouken@0
  1228
 * Sets the clipping rectangle for the destination surface in a blit.
slouken@0
  1229
 *
slouken@0
  1230
 * If the clip rectangle is NULL, clipping will be disabled.
slouken@0
  1231
 * If the clip rectangle doesn't intersect the surface, the function will
slouken@0
  1232
 * return SDL_FALSE and blits will be completely clipped.  Otherwise the
slouken@0
  1233
 * function returns SDL_TRUE and blits to the surface will be clipped to
slouken@0
  1234
 * the intersection of the surface area and the clipping rectangle.
slouken@0
  1235
 *
slouken@0
  1236
 * Note that blits are automatically clipped to the edges of the source
slouken@0
  1237
 * and destination surfaces.
slouken@0
  1238
 */
slouken@1668
  1239
extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface * surface,
slouken@1668
  1240
                                                 const SDL_Rect * rect);
slouken@0
  1241
slouken@0
  1242
/*
slouken@0
  1243
 * Gets the clipping rectangle for the destination surface in a blit.
slouken@0
  1244
 * 'rect' must be a pointer to a valid rectangle which will be filled
slouken@0
  1245
 * with the correct values.
slouken@0
  1246
 */
slouken@1668
  1247
extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface * surface,
slouken@1668
  1248
                                             SDL_Rect * rect);
slouken@0
  1249
slouken@0
  1250
/*
slouken@0
  1251
 * Creates a new surface of the specified format, and then copies and maps 
slouken@0
  1252
 * the given surface to it so the blit of the converted surface will be as 
slouken@0
  1253
 * fast as possible.  If this function fails, it returns NULL.
slouken@0
  1254
 *
slouken@0
  1255
 * The 'flags' parameter is passed to SDL_CreateRGBSurface() and has those 
slouken@0
  1256
 * semantics.  You can also pass SDL_RLEACCEL in the flags parameter and
slouken@0
  1257
 * SDL will try to RLE accelerate colorkey and alpha blits in the resulting
slouken@0
  1258
 * surface.
slouken@0
  1259
 *
slouken@0
  1260
 * This function is used internally by SDL_DisplayFormat().
slouken@0
  1261
 */
slouken@1662
  1262
extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface
slouken@1662
  1263
    (SDL_Surface * src, SDL_PixelFormat * fmt, Uint32 flags);
slouken@0
  1264
slouken@0
  1265
/*
slouken@1670
  1266
 * This function performs a fast fill of the given rectangle with 'color'
slouken@1670
  1267
 * The given rectangle is clipped to the destination surface clip area
slouken@1670
  1268
 * and the final fill rectangle is saved in the passed in pointer.
slouken@1670
  1269
 * If 'dstrect' is NULL, the whole surface will be filled with 'color'
slouken@1670
  1270
 * The color should be a pixel of the format used by the surface, and 
slouken@1670
  1271
 * can be generated by the SDL_MapRGB() function.
slouken@1670
  1272
 * This function returns 0 on success, or -1 on error.
slouken@1670
  1273
 */
slouken@1670
  1274
extern DECLSPEC int SDLCALL SDL_FillRect
slouken@1670
  1275
    (SDL_Surface * dst, SDL_Rect * dstrect, Uint32 color);
slouken@1670
  1276
slouken@1670
  1277
/*
slouken@0
  1278
 * This performs a fast blit from the source surface to the destination
slouken@0
  1279
 * surface.  It assumes that the source and destination rectangles are
slouken@0
  1280
 * the same size.  If either 'srcrect' or 'dstrect' are NULL, the entire
slouken@0
  1281
 * surface (src or dst) is copied.  The final blit rectangles are saved
slouken@0
  1282
 * in 'srcrect' and 'dstrect' after all clipping is performed.
slouken@0
  1283
 * If the blit is successful, it returns 0, otherwise it returns -1.
slouken@0
  1284
 *
slouken@0
  1285
 * The blit function should not be called on a locked surface.
slouken@0
  1286
 *
slouken@0
  1287
 * The blit semantics for surfaces with and without alpha and colorkey
slouken@0
  1288
 * are defined as follows:
slouken@0
  1289
 *
slouken@0
  1290
 * RGBA->RGB:
slouken@0
  1291
 *     SDL_SRCALPHA set:
slouken@0
  1292
 * 	alpha-blend (using alpha-channel).
slouken@0
  1293
 * 	SDL_SRCCOLORKEY ignored.
slouken@0
  1294
 *     SDL_SRCALPHA not set:
slouken@0
  1295
 * 	copy RGB.
slouken@0
  1296
 * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
slouken@0
  1297
 * 	RGB values of the source colour key, ignoring alpha in the
slouken@0
  1298
 * 	comparison.
slouken@0
  1299
 * 
slouken@0
  1300
 * RGB->RGBA:
slouken@0
  1301
 *     SDL_SRCALPHA set:
slouken@0
  1302
 * 	alpha-blend (using the source per-surface alpha value);
slouken@0
  1303
 * 	set destination alpha to opaque.
slouken@0
  1304
 *     SDL_SRCALPHA not set:
slouken@431
  1305
 * 	copy RGB, set destination alpha to source per-surface alpha value.
slouken@0
  1306
 *     both:
slouken@0
  1307
 * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
slouken@0
  1308
 * 	source colour key.
slouken@0
  1309
 * 
slouken@0
  1310
 * RGBA->RGBA:
slouken@0
  1311
 *     SDL_SRCALPHA set:
slouken@0
  1312
 * 	alpha-blend (using the source alpha channel) the RGB values;
slouken@0
  1313
 * 	leave destination alpha untouched. [Note: is this correct?]
slouken@0
  1314
 * 	SDL_SRCCOLORKEY ignored.
slouken@0
  1315
 *     SDL_SRCALPHA not set:
slouken@0
  1316
 * 	copy all of RGBA to the destination.
slouken@0
  1317
 * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
slouken@0
  1318
 * 	RGB values of the source colour key, ignoring alpha in the
slouken@0
  1319
 * 	comparison.
slouken@0
  1320
 * 
slouken@0
  1321
 * RGB->RGB: 
slouken@0
  1322
 *     SDL_SRCALPHA set:
slouken@0
  1323
 * 	alpha-blend (using the source per-surface alpha value).
slouken@0
  1324
 *     SDL_SRCALPHA not set:
slouken@0
  1325
 * 	copy RGB.
slouken@0
  1326
 *     both:
slouken@0
  1327
 * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
slouken@0
  1328
 * 	source colour key.
slouken@0
  1329
 *
slouken@0
  1330
 * If either of the surfaces were in video memory, and the blit returns -2,
slouken@0
  1331
 * the video memory was lost, so it should be reloaded with artwork and 
slouken@0
  1332
 * re-blitted:
slouken@0
  1333
	while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) {
slouken@0
  1334
		while ( SDL_LockSurface(image) < 0 )
slouken@0
  1335
			Sleep(10);
slouken@0
  1336
		-- Write image pixels to image->pixels --
slouken@0
  1337
		SDL_UnlockSurface(image);
slouken@0
  1338
	}
slouken@0
  1339
 * This happens under DirectX 5.0 when the system switches away from your
slouken@0
  1340
 * fullscreen application.  The lock will also fail until you have access
slouken@0
  1341
 * to the video memory again.
slouken@0
  1342
 */
slouken@0
  1343
/* You should call SDL_BlitSurface() unless you know exactly how SDL
slouken@0
  1344
   blitting works internally and how to use the other blit functions.
slouken@0
  1345
*/
slouken@0
  1346
#define SDL_BlitSurface SDL_UpperBlit
slouken@0
  1347
slouken@0
  1348
/* This is the public blit function, SDL_BlitSurface(), and it performs
slouken@0
  1349
   rectangle validation and clipping before passing it to SDL_LowerBlit()
slouken@0
  1350
*/
slouken@337
  1351
extern DECLSPEC int SDLCALL SDL_UpperBlit
slouken@1662
  1352
    (SDL_Surface * src, SDL_Rect * srcrect,
slouken@1662
  1353
     SDL_Surface * dst, SDL_Rect * dstrect);
slouken@0
  1354
/* This is a semi-private blit function and it performs low-level surface
slouken@0
  1355
   blitting only.
slouken@0
  1356
*/
slouken@337
  1357
extern DECLSPEC int SDLCALL SDL_LowerBlit
slouken@1662
  1358
    (SDL_Surface * src, SDL_Rect * srcrect,
slouken@1662
  1359
     SDL_Surface * dst, SDL_Rect * dstrect);
slouken@0
  1360
slouken@1670
  1361
/**
slouken@1670
  1362
 * \fn int SDL_SoftStretch(SDL_Surface * src, SDL_Rect * srcrect, SDL_Surface * dst, SDL_Rect * dstrect)
slouken@0
  1363
 *
slouken@1670
  1364
 * \brief Perform a fast, low quality, stretch blit between two surfaces of the same pixel format.
slouken@1670
  1365
 * \note This function uses a static buffer, and is not thread-safe.
slouken@0
  1366
 */
slouken@1670
  1367
extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src,
slouken@1670
  1368
                                            SDL_Rect * srcrect,
slouken@1670
  1369
                                            SDL_Surface * dst,
slouken@1670
  1370
                                            SDL_Rect * dstrect);
slouken@0
  1371
slouken@0
  1372
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
slouken@0
  1373
/* OpenGL support functions.                                                 */
slouken@0
  1374
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
slouken@0
  1375
slouken@0
  1376
/*
slouken@1490
  1377
 * Dynamically load an OpenGL library, or the default one if path is NULL
slouken@0
  1378
 *
slouken@0
  1379
 * If you do this, you need to retrieve all of the GL functions used in
slouken@0
  1380
 * your program from the dynamic library using SDL_GL_GetProcAddress().
slouken@0
  1381
 */
slouken@1668
  1382
extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
slouken@0
  1383
slouken@0
  1384
/*
slouken@1490
  1385
 * Get the address of a GL function
slouken@0
  1386
 */
slouken@1668
  1387
extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
slouken@0
  1388
slouken@0
  1389
/*
slouken@1662
  1390
 * Set an attribute of the OpenGL subsystem before window creation.
slouken@0
  1391
 */
slouken@1668
  1392
extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
slouken@0
  1393
slouken@0
  1394
/*
slouken@0
  1395
 * Get an attribute of the OpenGL subsystem from the windowing
slouken@0
  1396
 * interface, such as glX. This is of course different from getting
slouken@0
  1397
 * the values from SDL's internal OpenGL subsystem, which only
slouken@0
  1398
 * stores the values you request before initialization.
slouken@0
  1399
 *
slouken@0
  1400
 * Developers should track the values they pass into SDL_GL_SetAttribute
slouken@0
  1401
 * themselves if they want to retrieve these values.
slouken@0
  1402
 */
slouken@1668
  1403
extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
slouken@0
  1404
slouken@0
  1405
/*
slouken@0
  1406
 * Swap the OpenGL buffers, if double-buffering is supported.
slouken@0
  1407
 */
slouken@1668
  1408
extern DECLSPEC void SDLCALL SDL_GL_SwapBuffers(void);
slouken@0
  1409
slouken@0
  1410
/* Ends C function definitions when using C++ */
slouken@0
  1411
#ifdef __cplusplus
slouken@1662
  1412
/* *INDENT-OFF* */
slouken@0
  1413
}
slouken@1662
  1414
/* *INDENT-ON* */
slouken@0
  1415
#endif
slouken@0
  1416
#include "close_code.h"
slouken@0
  1417
slouken@0
  1418
#endif /* _SDL_video_h */
slouken@1662
  1419
slouken@1662
  1420
/* vi: set ts=4 sw=4 expandtab: */