include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 11 Jun 2006 07:30:16 +0000
branchSDL-1.3
changeset 1675 d33dcfc3fde7
parent 1670 eef792d31de8
child 1676 e136f3ffdc1b
permissions -rw-r--r--
Overlay functions are being replaced by YUV textures.
If the driver doesn't support YUV textures, they can be emulated by backing
the texture with an RGB texture and using the software conversion routines.

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