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