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