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