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