include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 29 May 2006 05:08:33 +0000
branchSDL-1.3
changeset 1669 9857d21967bb
parent 1668 4da1ee79c9af
child 1670 eef792d31de8
permissions -rw-r--r--
The test programs compile again.
The dummy video driver is partially functional now.
     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 /* Useful data types */
    50 typedef struct SDL_Rect
    51 {
    52     Sint16 x, y;
    53     Uint16 w, h;
    54 } SDL_Rect;
    55 
    56 /* This structure should be treated as read-only, except for 'pixels',
    57    which, if not NULL, contains the raw pixel data for the surface.
    58 */
    59 typedef struct SDL_Surface
    60 {
    61     Uint32 flags;               /* Read-only */
    62     SDL_PixelFormat *format;    /* Read-only */
    63     int w, h;                   /* Read-only */
    64     Uint16 pitch;               /* Read-only */
    65     void *pixels;               /* Read-write */
    66     int offset;                 /* Private */
    67 
    68     /* Hardware-specific surface info */
    69     struct private_hwdata *hwdata;
    70 
    71     /* clipping information */
    72     SDL_Rect clip_rect;         /* Read-only */
    73     Uint32 unused1;             /* for binary compatibility */
    74 
    75     /* Allow recursive locks */
    76     Uint32 locked;              /* Private */
    77 
    78     /* info for fast blit mapping to other surfaces */
    79     struct SDL_BlitMap *map;    /* Private */
    80 
    81     /* format version, bumped at every change to invalidate blit maps */
    82     unsigned int format_version;        /* Private */
    83 
    84     /* Reference count -- used when freeing surface */
    85     int refcount;               /* Read-mostly */
    86 } SDL_Surface;
    87 
    88 /* The most common video overlay formats.
    89    For an explanation of these pixel formats, see:
    90 	http://www.webartz.com/fourcc/indexyuv.htm
    91 
    92    For information on the relationship between color spaces, see:
    93    http://www.neuro.sfc.keio.ac.jp/~aly/polygon/info/color-space-faq.html
    94  */
    95 #define SDL_YV12_OVERLAY  0x32315659    /* Planar mode: Y + V + U  (3 planes) */
    96 #define SDL_IYUV_OVERLAY  0x56555949    /* Planar mode: Y + U + V  (3 planes) */
    97 #define SDL_YUY2_OVERLAY  0x32595559    /* Packed mode: Y0+U0+Y1+V0 (1 plane) */
    98 #define SDL_UYVY_OVERLAY  0x59565955    /* Packed mode: U0+Y0+V0+Y1 (1 plane) */
    99 #define SDL_YVYU_OVERLAY  0x55595659    /* Packed mode: Y0+V0+Y1+U0 (1 plane) */
   100 
   101 /* The YUV hardware video overlay */
   102 typedef struct SDL_Overlay
   103 {
   104     Uint32 format;              /* Read-only */
   105     int w, h;                   /* Read-only */
   106     int planes;                 /* Read-only */
   107     Uint16 *pitches;            /* Read-only */
   108     Uint8 **pixels;             /* Read-write */
   109 
   110     /* Hardware-specific surface info */
   111     struct private_yuvhwfuncs *hwfuncs;
   112     struct private_yuvhwdata *hwdata;
   113 
   114     /* Special flags */
   115     Uint32 hw_overlay:1;        /* Flag: This overlay hardware accelerated? */
   116     Uint32 UnusedBits:31;
   117 } SDL_Overlay;
   118 
   119 /* Evaluates to true if the surface needs to be locked before access */
   120 #define SDL_MUSTLOCK(surface)	\
   121   (surface->offset ||		\
   122   ((surface->flags & (SDL_HWSURFACE|SDL_RLEACCEL)) != 0))
   123 
   124 /* typedef for private surface blitting functions */
   125 typedef int (*SDL_blit) (struct SDL_Surface * src, SDL_Rect * srcrect,
   126                          struct SDL_Surface * dst, SDL_Rect * dstrect);
   127 
   128 
   129 /**
   130  * \struct SDL_VideoInfo
   131  *
   132  * \brief Useful for determining the video hardware capabilities
   133  */
   134 typedef struct SDL_VideoInfo
   135 {
   136     Uint32 hw_available:1;  /**< Flag: Can you create hardware surfaces? */
   137     Uint32 wm_available:1;  /**< Flag: Can you talk to a window manager? */
   138     Uint32 UnusedBits1:6;
   139     Uint32 UnusedBits2:1;
   140     Uint32 blit_hw:1;       /**< Flag: Accelerated blits HW --> HW */
   141     Uint32 blit_hw_CC:1;    /**< Flag: Accelerated blits with Colorkey */
   142     Uint32 blit_hw_A:1;     /**< Flag: Accelerated blits with Alpha */
   143     Uint32 blit_sw:1;       /**< Flag: Accelerated blits SW --> HW */
   144     Uint32 blit_sw_CC:1;    /**< Flag: Accelerated blits with Colorkey */
   145     Uint32 blit_sw_A:1;     /**< Flag: Accelerated blits with Alpha */
   146     Uint32 blit_fill:1;     /**< Flag: Accelerated color fill */
   147     Uint32 UnusedBits3:16;
   148     Uint32 video_mem;           /* The total amount of video memory (in K) */
   149 
   150     /* Here for backwards compatibility */
   151     SDL_PixelFormat *vfmt;
   152 } SDL_VideoInfo;
   153 
   154 /**
   155  * \struct SDL_DisplayMode
   156  *
   157  * \brief  The structure that defines a display mode
   158  *
   159  * \sa SDL_GetNumDisplayModes()
   160  * \sa SDL_GetDisplayMode()
   161  * \sa SDL_GetDesktopDisplayMode()
   162  * \sa SDL_GetCurrentDisplayMode()
   163  * \sa SDL_GetClosestDisplayMode()
   164  * \sa SDL_SetDisplayMode()
   165  */
   166 typedef struct
   167 {
   168     Uint32 format;              /**< pixel format */
   169     int w;                      /**< width */
   170     int h;                      /**< height */
   171     int refresh_rate;           /**< refresh rate (or zero for unspecified) */
   172 } SDL_DisplayMode;
   173 
   174 /**
   175  * \typedef SDL_WindowID
   176  *
   177  * \brief The type used to identify a window
   178  *
   179  * \sa SDL_CreateWindow()
   180  * \sa SDL_CreateWindowFrom()
   181  * \sa SDL_DestroyWindow()
   182  * \sa SDL_GetWindowData()
   183  * \sa SDL_GetWindowFlags()
   184  * \sa SDL_GetWindowGrab()
   185  * \sa SDL_GetWindowPosition()
   186  * \sa SDL_GetWindowSize()
   187  * \sa SDL_GetWindowTitle()
   188  * \sa SDL_HideWindow()
   189  * \sa SDL_MaximizeWindow()
   190  * \sa SDL_MinimizeWindow()
   191  * \sa SDL_RaiseWindow()
   192  * \sa SDL_RestoreWindow()
   193  * \sa SDL_SetWindowData()
   194  * \sa SDL_SetWindowGrab()
   195  * \sa SDL_SetWindowIcon()
   196  * \sa SDL_SetWindowPosition()
   197  * \sa SDL_SetWindowSize()
   198  * \sa SDL_SetWindowTitle()
   199  * \sa SDL_ShowWindow()
   200  */
   201 typedef Uint32 SDL_WindowID;
   202 
   203 /**
   204  * \enum SDL_WindowFlags
   205  *
   206  * \brief The flags on a window
   207  */
   208 typedef enum
   209 {
   210     SDL_WINDOW_FULLSCREEN = 0x00000001,         /**< fullscreen window, implies borderless */
   211     SDL_WINDOW_BORDERLESS = 0x00000002,         /**< no window decoration */
   212     SDL_WINDOW_SHOWN = 0x00000004,              /**< window is visible */
   213     SDL_WINDOW_OPENGL = 0x00000008,             /**< window usable with OpenGL context */
   214     SDL_WINDOW_RESIZABLE = 0x00000010,          /**< window can be resized */
   215     SDL_WINDOW_MAXIMIZED = 0x00000020,          /**< maximized */
   216     SDL_WINDOW_MINIMIZED = 0x00000040,          /**< minimized */
   217     SDL_WINDOW_INPUT_GRABBED = 0x00000080,      /**< window has grabbed input focus */
   218     SDL_WINDOW_KEYBOARD_FOCUS = 0x00000100,     /**< window has keyboard focus */
   219     SDL_WINDOW_MOUSE_FOCUS = 0x00000200,        /**< window has mouse focus */
   220 } SDL_WindowFlags;
   221 
   222 /**
   223  * \enum SDL_WindowEventID
   224  *
   225  * \brief Event subtype for window events
   226  */
   227 typedef enum
   228 {
   229     SDL_WINDOWEVENT_NONE,               /**< Never used */
   230     SDL_WINDOWEVENT_SHOWN,              /**< Window has been shown */
   231     SDL_WINDOWEVENT_HIDDEN,             /**< Window has been hidden */
   232     SDL_WINDOWEVENT_MOVED,              /**< Window has been moved to data1,data2 */
   233     SDL_WINDOWEVENT_RESIZED,            /**< Window size changed to data1xdata2 */
   234     SDL_WINDOWEVENT_MINIMIZED,          /**< Window has been minimized */
   235     SDL_WINDOWEVENT_MAXIMIZED,          /**< Window has been maximized */
   236     SDL_WINDOWEVENT_RESTORED,           /**< Window has been restored to normal size and position */
   237     SDL_WINDOWEVENT_ENTER,              /**< The window has gained mouse focus */
   238     SDL_WINDOWEVENT_LEAVE,              /**< The window has lost mouse focus */
   239     SDL_WINDOWEVENT_FOCUS_GAINED,       /**< The window has gained keyboard focus */
   240     SDL_WINDOWEVENT_FOCUS_LOST,         /**< The window has lost keyboard focus */
   241 } SDL_WindowEventID;
   242 
   243 /**
   244  * \enum SDL_GLattr
   245  *
   246  * \brief OpenGL configuration attributes
   247  */
   248 typedef enum
   249 {
   250     SDL_GL_RED_SIZE,
   251     SDL_GL_GREEN_SIZE,
   252     SDL_GL_BLUE_SIZE,
   253     SDL_GL_ALPHA_SIZE,
   254     SDL_GL_BUFFER_SIZE,
   255     SDL_GL_DOUBLEBUFFER,
   256     SDL_GL_DEPTH_SIZE,
   257     SDL_GL_STENCIL_SIZE,
   258     SDL_GL_ACCUM_RED_SIZE,
   259     SDL_GL_ACCUM_GREEN_SIZE,
   260     SDL_GL_ACCUM_BLUE_SIZE,
   261     SDL_GL_ACCUM_ALPHA_SIZE,
   262     SDL_GL_STEREO,
   263     SDL_GL_MULTISAMPLEBUFFERS,
   264     SDL_GL_MULTISAMPLESAMPLES,
   265     SDL_GL_ACCELERATED_VISUAL,
   266     SDL_GL_SWAP_CONTROL
   267 } SDL_GLattr;
   268 
   269 /* These are the currently supported flags for the SDL_surface */
   270 #define SDL_SWSURFACE	0x00000000      /* Surface is in system memory */
   271 #define SDL_HWSURFACE	0x00000001      /* Surface is in video memory */
   272 /* Available for SDL_CreateWindowSurface() */
   273 #define SDL_ANYFORMAT	0x10000000      /* Allow any video depth/pixel-format */
   274 #define SDL_HWPALETTE	0x20000000      /* Surface has exclusive palette */
   275 #define SDL_DOUBLEBUF	0x40000000      /* Set up double-buffered surface */
   276 /* Used internally (read-only) */
   277 #define SDL_HWACCEL	0x00000100      /* Blit uses hardware acceleration */
   278 #define SDL_SRCCOLORKEY	0x00001000      /* Blit uses a source color key */
   279 #define SDL_RLEACCELOK	0x00002000      /* Private flag */
   280 #define SDL_RLEACCEL	0x00004000      /* Surface is RLE encoded */
   281 #define SDL_SRCALPHA	0x00010000      /* Blit uses source alpha blending */
   282 #define SDL_PREALLOC	0x00100000      /* Surface uses preallocated memory */
   283 #define SDL_SCREEN_SURFACE 0x01000000   /* Surface is a window screen surface */
   284 #define SDL_SHADOW_SURFACE 0x02000000   /* Surface is a window shadow surface */
   285 
   286 /* Function prototypes */
   287 
   288 /**
   289  * \fn int SDL_GetNumVideoDrivers(void)
   290  *
   291  * \brief Get the number of video drivers compiled into SDL
   292  *
   293  * \sa SDL_GetVideoDriver()
   294  */
   295 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
   296 
   297 /**
   298  * \fn const char *SDL_GetVideoDriver(int index)
   299  *
   300  * \brief Get the name of a built in video driver.
   301  *
   302  * \note The video drivers are presented in the order in which they are
   303  * normally checked during initialization.
   304  *
   305  * \sa SDL_GetNumVideoDrivers()
   306  */
   307 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
   308 
   309 /**
   310  * \fn int SDL_VideoInit(const char *driver_name, Uint32 flags)
   311  *
   312  * \brief Initialize the video subsystem, optionally specifying a video driver.
   313  *
   314  * \param driver_name Initialize a specific driver by name, or NULL for the default video driver.
   315  * \param flags FIXME: Still needed?
   316  *
   317  * \return 0 on success, -1 on error
   318  *
   319  * This function initializes the video subsystem; setting up a connection
   320  * to the window manager, etc, and determines the available display modes
   321  * and pixel formats, but does not initialize a window or graphics mode.
   322  *
   323  * \sa SDL_VideoQuit()
   324  */
   325 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name,
   326                                           Uint32 flags);
   327 
   328 /**
   329  * \fn void SDL_VideoQuit(void)
   330  *
   331  * \brief Shuts down the video subsystem.
   332  *
   333  * This function closes all windows, and restores the original video mode.
   334  *
   335  * \sa SDL_VideoInit()
   336  */
   337 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
   338 
   339 /**
   340  * \fn const char *SDL_GetCurrentVideoDriver(void)
   341  *
   342  * \brief Returns the name of the currently initialized video driver.
   343  *
   344  * \return The name of the current video driver or NULL if no driver
   345  *         has been initialized
   346  *
   347  * \sa SDL_GetNumVideoDrivers()
   348  * \sa SDL_GetVideoDriver()
   349  */
   350 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
   351 
   352 /**
   353  * \fn const SDL_VideoInfo *SDL_GetVideoInfo(void)
   354  *
   355  * \brief Returns information about the currently initialized video driver.
   356  *
   357  * \return A read-only pointer to information about the video hardware,
   358  *         or NULL if no video driver has been initialized.
   359  */
   360 extern DECLSPEC const SDL_VideoInfo *SDLCALL SDL_GetVideoInfo(void);
   361 
   362 /**
   363  * \fn int SDL_GetNumVideoDisplays(void)
   364  *
   365  * \brief Returns the number of available video displays.
   366  *
   367  * \sa SDL_SelectVideoDisplay()
   368  */
   369 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
   370 
   371 /**
   372  * \fn int SDL_SelectVideoDisplay(int index)
   373  *
   374  * \brief Set the index of the currently selected display.
   375  *
   376  * \note You can query the currently selected display by passing an index of -1.
   377  *
   378  * \sa SDL_GetNumVideoDisplays()
   379  */
   380 extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
   381 
   382 /**
   383  * \fn int SDL_GetNumDisplayModes(void)
   384  *
   385  * \brief Returns the number of available display modes for the current display.
   386  *
   387  * \sa SDL_GetDisplayMode()
   388  */
   389 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
   390 
   391 /**
   392  * \fn const SDL_DisplayMode *SDL_GetDisplayMode(int index)
   393  *
   394  * \brief Retrieve information about a specific display mode.
   395  *
   396  * \note The display modes are sorted in this priority:
   397  *       \li bits per pixel -> more colors to fewer colors
   398  *       \li width -> largest to smallest
   399  *       \li height -> largest to smallest
   400  *       \li refresh rate -> highest to lowest
   401  *
   402  * \sa SDL_GetNumDisplayModes()
   403  */
   404 extern DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetDisplayMode(int index);
   405 
   406 /**
   407  * \fn const SDL_DisplayMode *SDL_GetDesktopDisplayMode(void)
   408  *
   409  * \brief Retrieve information about the desktop display mode for the current display.
   410  */
   411 extern DECLSPEC const SDL_DisplayMode *SDLCALL
   412 SDL_GetDesktopDisplayMode(void);
   413 
   414 /**
   415  * \fn const SDL_DisplayMode *SDL_GetCurrentDisplayMode(void)
   416  *
   417  * \brief Retrieve information about the current display mode.
   418  */
   419 extern DECLSPEC const SDL_DisplayMode *SDLCALL
   420 SDL_GetCurrentDisplayMode(void);
   421 
   422 /**
   423  * \fn SDL_DisplayMode *SDL_GetClosestDisplayMode(const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
   424  *
   425  * \brief Get the closest match to the requested display mode.
   426  *
   427  * \param mode The desired display mode
   428  * \param closest A pointer to a display mode to be filled in with the closest match of the available display modes.
   429  *
   430  * \return The passed in value 'closest', or NULL if no matching video mode was available.
   431  *
   432  * 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.
   433  *
   434  * \sa SDL_GetNumDisplayModes()
   435  * \sa SDL_GetDisplayMode()
   436  */
   437 extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
   438                                                                    SDL_DisplayMode
   439                                                                    * mode,
   440                                                                    SDL_DisplayMode
   441                                                                    * closest);
   442 
   443 /**
   444  * \fn int SDL_SetDisplayMode(const SDL_DisplayMode *mode)
   445  *
   446  * \brief Set up the closest available mode on the current display.
   447  *
   448  * \param mode The desired display mode
   449  *
   450  * \return 0 on success, or -1 if setting the display mode failed.
   451  */
   452 extern DECLSPEC int SDLCALL SDL_SetDisplayMode(const SDL_DisplayMode * mode);
   453 
   454 /**
   455  * \fn SDL_WindowID SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)
   456  *
   457  * \brief Create a window with the specified position, dimensions, and flags.
   458  *
   459  * \param title The title of the window
   460  * \param x The x position of the window
   461  * \param y The y position of the window
   462  * \param w The width of the window
   463  * \param h The height of the window
   464  * \param flags The flags for the window
   465  *
   466  * \return The id of the window created, or zero if window creation failed.
   467  *
   468  * \note Setting the position to -1, -1, indicates any position is fine.
   469  *
   470  * \sa SDL_DestroyWindow()
   471  */
   472 extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindow(const char *title,
   473                                                       int x, int y, int w,
   474                                                       int h, Uint32 flags);
   475 
   476 /**
   477  * \fn SDL_WindowID SDL_CreateWindowFrom(void *data)
   478  *
   479  * \brief Create an SDL window struct from an existing native window.
   480  *
   481  * \param data A pointer to driver-dependent window creation data
   482  *
   483  * \return The id of the window created, or zero if window creation failed.
   484  *
   485  * \warning This function is NOT SUPPORTED, use at your own risk!
   486  *
   487  * \sa SDL_DestroyWindow()
   488  */
   489 extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindowFrom(void *data);
   490 
   491 /**
   492  * \fn Uint32 SDL_GetWindowFlags(SDL_WindowID windowID)
   493  *
   494  * \brief Get the window flags.
   495  */
   496 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_WindowID windowID);
   497 
   498 /**
   499  * \fn void SDL_SetWindowTitle(SDL_WindowID windowID, const char *title)
   500  *
   501  * \brief Set the title of the window, in UTF-8 format.
   502  *
   503  * \sa SDL_GetWindowTitle()
   504  */
   505 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_WindowID windowID,
   506                                                 const char *title);
   507 
   508 /**
   509  * \fn const char *SDL_GetWindowTitle(SDL_WindowID windowID)
   510  *
   511  * \brief Get the title of the window, in UTF-8 format.
   512  *
   513  * \sa SDL_SetWindowTitle()
   514  */
   515 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_WindowID windowID);
   516 
   517 /**
   518  * \fn void SDL_SetWindowIcon(SDL_Surface *icon)
   519  *
   520  * \brief Set the icon of the window.
   521  *
   522  * \param icon The icon for the window
   523  *
   524  * FIXME: The icon needs to be set before the window is first shown.  Should some icon representation be part of the window creation data?
   525  */
   526 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Surface * icon);
   527 
   528 /**
   529  * \fn void SDL_SetWindowData(SDL_WindowID windowID, void *userdata)
   530  *
   531  * \brief Associate an arbitrary pointer with the window.
   532  *
   533  * \sa SDL_GetWindowData()
   534  */
   535 extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_WindowID windowID,
   536                                                void *userdata);
   537 
   538 /**
   539  * \fn void *SDL_GetWindowData(SDL_WindowID windowID)
   540  *
   541  * \brief Retrieve the data pointer associated with the window.
   542  *
   543  * \sa SDL_SetWindowData()
   544  */
   545 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_WindowID windowID);
   546 
   547 /**
   548  * \fn void SDL_SetWindowPosition(SDL_WindowID windowID, int x, int y)
   549  *
   550  * \brief Set the position of the window.
   551  *
   552  * \sa SDL_GetWindowPosition()
   553  */
   554 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_WindowID windowID,
   555                                                    int x, int y);
   556 
   557 /**
   558  * \fn void SDL_GetWindowPosition(SDL_WindowID windowID, int *x, int *y)
   559  *
   560  * \brief Get the position of the window.
   561  *
   562  * \sa SDL_SetWindowPosition()
   563  */
   564 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_WindowID windowID,
   565                                                    int *x, int *y);
   566 
   567 /**
   568  * \fn void SDL_SetWindowSize(SDL_WindowID windowID, int w, int w)
   569  *
   570  * \brief Set the size of the window's client area.
   571  *
   572  * \note You can't change the size of a fullscreen window, it automatically
   573  * matches the size of the display mode.
   574  *
   575  * \sa SDL_GetWindowSize()
   576  */
   577 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_WindowID windowID, int w,
   578                                                int h);
   579 
   580 /**
   581  * \fn void SDL_GetWindowSize(SDL_WindowID windowID, int *w, int *w)
   582  *
   583  * \brief Get the size of the window's client area.
   584  *
   585  * \sa SDL_SetWindowSize()
   586  */
   587 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_WindowID windowID, int *w,
   588                                                int *h);
   589 
   590 /**
   591  * \fn void SDL_ShowWindow(SDL_WindowID windowID)
   592  *
   593  * \brief Show the window
   594  *
   595  * \sa SDL_HideWindow()
   596  */
   597 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_WindowID windowID);
   598 
   599 /**
   600  * \fn void SDL_HideWindow(SDL_WindowID windowID)
   601  *
   602  * \brief Hide the window
   603  *
   604  * \sa SDL_ShowWindow()
   605  */
   606 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_WindowID windowID);
   607 
   608 /**
   609  * \fn void SDL_RaiseWindow(SDL_WindowID windowID)
   610  *
   611  * \brief Raise the window so it's above other windows.
   612  */
   613 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_WindowID windowID);
   614 
   615 /**
   616  * \fn void SDL_MaximizeWindow(SDL_WindowID windowID)
   617  *
   618  * \brief Make the window as large as possible.
   619  *
   620  * \sa SDL_RestoreWindow()
   621  */
   622 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_WindowID windowID);
   623 
   624 /**
   625  * \fn void SDL_MinimizeWindow(SDL_WindowID windowID)
   626  *
   627  * \brief Minimize the window to an iconic representation.
   628  *
   629  * \sa SDL_RestoreWindow()
   630  */
   631 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_WindowID windowID);
   632 
   633 /**
   634  * \fn void SDL_RestoreWindow(SDL_WindowID windowID)
   635  *
   636  * \brief Restore the size and position of a minimized or maximized window.
   637  *
   638  * \sa SDL_MaximizeWindow()
   639  * \sa SDL_MinimizeWindow()
   640  */
   641 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_WindowID windowID);
   642 
   643 /**
   644  * \fn void SDL_SetWindowGrab(SDL_WindowID windowID, int mode)
   645  *
   646  * \brief Set the window's input grab mode.
   647  *
   648  * \param mode This is 1 to grab input, and 0 to release input.
   649  *
   650  * \sa SDL_GrabMode
   651  * \sa SDL_GetWindowGrab()
   652  */
   653 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_WindowID windowID,
   654                                                int mode);
   655 
   656 /**
   657  * \fn int SDL_GetWindowGrab(SDL_WindowID windowID)
   658  *
   659  * \brief Get the window's input grab mode.
   660  *
   661  * \return This returns 1 if input is grabbed, and 0 otherwise.
   662  *
   663  * \sa SDL_GrabMode
   664  * \sa SDL_SetWindowGrab()
   665  */
   666 extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_WindowID windowID);
   667 
   668 /**
   669  * \fn void SDL_DestroyWindow(SDL_WindowID windowID)
   670  *
   671  * \brief Destroy a window.
   672  */
   673 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_WindowID windowID);
   674 
   675 /**
   676  * \fn SDL_Surface *SDL_CreateWindowSurface (SDL_WindowID windowID, Uint32 format, Uint32 flags)
   677  *
   678  * \brief Create an SDL_Surface representing the drawing area of the window.
   679  */
   680 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateWindowSurface(SDL_WindowID
   681                                                              windowID,
   682                                                              Uint32 format,
   683                                                              Uint32 flags);
   684 
   685 /*
   686  * Makes sure the given list of rectangles is updated on the given screen.
   687  * If 'x', 'y', 'w' and 'h' are all 0, SDL_UpdateRect will update the entire
   688  * screen.
   689  * These functions should not be called while 'screen' is locked.
   690  */
   691 extern DECLSPEC void SDLCALL SDL_UpdateRects
   692     (SDL_Surface * screen, int numrects, SDL_Rect * rects);
   693 extern DECLSPEC void SDLCALL SDL_UpdateRect
   694     (SDL_Surface * screen, Sint32 x, Sint32 y, Uint32 w, Uint32 h);
   695 
   696 /*
   697  * On hardware that supports double-buffering, this function sets up a flip
   698  * and returns.  The hardware will wait for vertical retrace, and then swap
   699  * video buffers before the next video surface blit or lock will return.
   700  * On hardware that doesn not support double-buffering, this is equivalent
   701  * to calling SDL_UpdateRect(screen, 0, 0, 0, 0);
   702  * The SDL_DOUBLEBUF flag must have been passed to SDL_SetVideoMode() when
   703  * setting the video mode for this function to perform hardware flipping.
   704  * This function returns 0 if successful, or -1 if there was an error.
   705  */
   706 extern DECLSPEC int SDLCALL SDL_Flip(SDL_Surface * screen);
   707 
   708 /*
   709  * Set the gamma correction for each of the color channels.
   710  * The gamma values range (approximately) between 0.1 and 10.0
   711  * 
   712  * If this function isn't supported directly by the hardware, it will
   713  * be emulated using gamma ramps, if available.  If successful, this
   714  * function returns 0, otherwise it returns -1.
   715  */
   716 extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
   717 
   718 /*
   719  * Set the gamma translation table for the red, green, and blue channels
   720  * of the video hardware.  Each table is an array of 256 16-bit quantities,
   721  * representing a mapping between the input and output for that channel.
   722  * The input is the index into the array, and the output is the 16-bit
   723  * gamma value at that index, scaled to the output color precision.
   724  * 
   725  * You may pass NULL for any of the channels to leave it unchanged.
   726  * If the call succeeds, it will return 0.  If the display driver or
   727  * hardware does not support gamma translation, or otherwise fails,
   728  * this function will return -1.
   729  */
   730 extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
   731                                              const Uint16 * green,
   732                                              const Uint16 * blue);
   733 
   734 /*
   735  * Retrieve the current values of the gamma translation tables.
   736  * 
   737  * You must pass in valid pointers to arrays of 256 16-bit quantities.
   738  * Any of the pointers may be NULL to ignore that channel.
   739  * If the call succeeds, it will return 0.  If the display driver or
   740  * hardware does not support gamma translation, or otherwise fails,
   741  * this function will return -1.
   742  */
   743 extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
   744                                              Uint16 * blue);
   745 
   746 /*
   747  * Sets a portion of the colormap for the given 8-bit surface.  If 'surface'
   748  * is not a palettized surface, this function does nothing, returning 0.
   749  * If all of the colors were set as passed to SDL_SetColors(), it will
   750  * return 1.  If not all the color entries were set exactly as given,
   751  * it will return 0, and you should look at the surface palette to
   752  * determine the actual color palette.
   753  *
   754  * When 'surface' is the surface associated with the current display, the
   755  * display colormap will be updated with the requested colors.  If 
   756  * SDL_HWPALETTE was set in SDL_SetVideoMode() flags, SDL_SetColors()
   757  * will always return 1, and the palette is guaranteed to be set the way
   758  * you desire, even if the window colormap has to be warped or run under
   759  * emulation.
   760  */
   761 extern DECLSPEC int SDLCALL SDL_SetColors(SDL_Surface * surface,
   762                                           SDL_Color * colors, int firstcolor,
   763                                           int ncolors);
   764 
   765 /*
   766  * Maps an RGB triple to an opaque pixel value for a given pixel format
   767  */
   768 extern DECLSPEC Uint32 SDLCALL SDL_MapRGB
   769     (SDL_PixelFormat * format, Uint8 r, Uint8 g, Uint8 b);
   770 
   771 /*
   772  * Maps an RGBA quadruple to a pixel value for a given pixel format
   773  */
   774 extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(SDL_PixelFormat * format,
   775                                            Uint8 r, Uint8 g, Uint8 b,
   776                                            Uint8 a);
   777 
   778 /*
   779  * Maps a pixel value into the RGB components for a given pixel format
   780  */
   781 extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, SDL_PixelFormat * fmt,
   782                                         Uint8 * r, Uint8 * g, Uint8 * b);
   783 
   784 /*
   785  * Maps a pixel value into the RGBA components for a given pixel format
   786  */
   787 extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel, SDL_PixelFormat * fmt,
   788                                          Uint8 * r, Uint8 * g, Uint8 * b,
   789                                          Uint8 * a);
   790 
   791 /*
   792  * Allocate and free an RGB surface (must be called after SDL_SetVideoMode)
   793  * If the depth is 4 or 8 bits, an empty palette is allocated for the surface.
   794  * If the depth is greater than 8 bits, the pixel format is set using the
   795  * flags '[RGB]mask'.
   796  * If the function runs out of memory, it will return NULL.
   797  *
   798  * The 'flags' tell what kind of surface to create.
   799  * SDL_SWSURFACE means that the surface should be created in system memory.
   800  * SDL_HWSURFACE means that the surface should be created in video memory,
   801  * with the same format as the display surface.  This is useful for surfaces
   802  * that will not change much, to take advantage of hardware acceleration
   803  * when being blitted to the display surface.
   804  * SDL_ASYNCBLIT means that SDL will try to perform asynchronous blits with
   805  * this surface, but you must always lock it before accessing the pixels.
   806  * SDL will wait for current blits to finish before returning from the lock.
   807  * SDL_SRCCOLORKEY indicates that the surface will be used for colorkey blits.
   808  * If the hardware supports acceleration of colorkey blits between
   809  * two surfaces in video memory, SDL will try to place the surface in
   810  * video memory. If this isn't possible or if there is no hardware
   811  * acceleration available, the surface will be placed in system memory.
   812  * SDL_SRCALPHA means that the surface will be used for alpha blits and 
   813  * if the hardware supports hardware acceleration of alpha blits between
   814  * two surfaces in video memory, to place the surface in video memory
   815  * if possible, otherwise it will be placed in system memory.
   816  * If the surface is created in video memory, blits will be _much_ faster,
   817  * but the surface format must be identical to the video surface format,
   818  * and the only way to access the pixels member of the surface is to use
   819  * the SDL_LockSurface() and SDL_UnlockSurface() calls.
   820  * If the requested surface actually resides in video memory, SDL_HWSURFACE
   821  * will be set in the flags member of the returned surface.  If for some
   822  * reason the surface could not be placed in video memory, it will not have
   823  * the SDL_HWSURFACE flag set, and will be created in system memory instead.
   824  */
   825 #define SDL_AllocSurface    SDL_CreateRGBSurface
   826 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface
   827     (Uint32 flags, int width, int height, int depth,
   828      Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
   829 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceFrom(void *pixels,
   830                                                               int width,
   831                                                               int height,
   832                                                               int depth,
   833                                                               int pitch,
   834                                                               Uint32 Rmask,
   835                                                               Uint32 Gmask,
   836                                                               Uint32 Bmask,
   837                                                               Uint32 Amask);
   838 extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface * surface);
   839 
   840 /*
   841  * SDL_LockSurface() sets up a surface for directly accessing the pixels.
   842  * Between calls to SDL_LockSurface()/SDL_UnlockSurface(), you can write
   843  * to and read from 'surface->pixels', using the pixel format stored in 
   844  * 'surface->format'.  Once you are done accessing the surface, you should 
   845  * use SDL_UnlockSurface() to release it.
   846  *
   847  * Not all surfaces require locking.  If SDL_MUSTLOCK(surface) evaluates
   848  * to 0, then you can read and write to the surface at any time, and the
   849  * pixel format of the surface will not change.  In particular, if the
   850  * SDL_HWSURFACE flag is not given when calling SDL_SetVideoMode(), you
   851  * will not need to lock the display surface before accessing it.
   852  * 
   853  * No operating system or library calls should be made between lock/unlock
   854  * pairs, as critical system locks may be held during this time.
   855  *
   856  * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
   857  */
   858 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
   859 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
   860 
   861 /*
   862  * Load a surface from a seekable SDL data source (memory or file.)
   863  * If 'freesrc' is non-zero, the source will be closed after being read.
   864  * Returns the new surface, or NULL if there was an error.
   865  * The new surface should be freed with SDL_FreeSurface().
   866  */
   867 extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_RW(SDL_RWops * src,
   868                                                     int freesrc);
   869 
   870 /* Convenience macro -- load a surface from a file */
   871 #define SDL_LoadBMP(file)	SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
   872 
   873 /*
   874  * Save a surface to a seekable SDL data source (memory or file.)
   875  * If 'freedst' is non-zero, the source will be closed after being written.
   876  * Returns 0 if successful or -1 if there was an error.
   877  */
   878 extern DECLSPEC int SDLCALL SDL_SaveBMP_RW
   879     (SDL_Surface * surface, SDL_RWops * dst, int freedst);
   880 
   881 /* Convenience macro -- save a surface to a file */
   882 #define SDL_SaveBMP(surface, file) \
   883 		SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1)
   884 
   885 /*
   886  * Sets the color key (transparent pixel) in a blittable surface.
   887  * If 'flag' is SDL_SRCCOLORKEY (optionally OR'd with SDL_RLEACCEL), 
   888  * 'key' will be the transparent pixel in the source image of a blit.
   889  * SDL_RLEACCEL requests RLE acceleration for the surface if present,
   890  * and removes RLE acceleration if absent.
   891  * If 'flag' is 0, this function clears any current color key.
   892  * This function returns 0, or -1 if there was an error.
   893  */
   894 extern DECLSPEC int SDLCALL SDL_SetColorKey
   895     (SDL_Surface * surface, Uint32 flag, Uint32 key);
   896 
   897 /*
   898  * This function sets the alpha value for the entire surface, as opposed to
   899  * using the alpha component of each pixel. This value measures the range
   900  * of transparency of the surface, 0 being completely transparent to 255
   901  * being completely opaque. An 'alpha' value of 255 causes blits to be
   902  * opaque, the source pixels copied to the destination (the default). Note
   903  * that per-surface alpha can be combined with colorkey transparency.
   904  *
   905  * If 'flag' is 0, alpha blending is disabled for the surface.
   906  * If 'flag' is SDL_SRCALPHA, alpha blending is enabled for the surface.
   907  * OR:ing the flag with SDL_RLEACCEL requests RLE acceleration for the
   908  * surface; if SDL_RLEACCEL is not specified, the RLE accel will be removed.
   909  *
   910  * The 'alpha' parameter is ignored for surfaces that have an alpha channel.
   911  */
   912 extern DECLSPEC int SDLCALL SDL_SetAlpha(SDL_Surface * surface, Uint32 flag,
   913                                          Uint8 alpha);
   914 
   915 /*
   916  * Sets the clipping rectangle for the destination surface in a blit.
   917  *
   918  * If the clip rectangle is NULL, clipping will be disabled.
   919  * If the clip rectangle doesn't intersect the surface, the function will
   920  * return SDL_FALSE and blits will be completely clipped.  Otherwise the
   921  * function returns SDL_TRUE and blits to the surface will be clipped to
   922  * the intersection of the surface area and the clipping rectangle.
   923  *
   924  * Note that blits are automatically clipped to the edges of the source
   925  * and destination surfaces.
   926  */
   927 extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface * surface,
   928                                                  const SDL_Rect * rect);
   929 
   930 /*
   931  * Gets the clipping rectangle for the destination surface in a blit.
   932  * 'rect' must be a pointer to a valid rectangle which will be filled
   933  * with the correct values.
   934  */
   935 extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface * surface,
   936                                              SDL_Rect * rect);
   937 
   938 /*
   939  * Creates a new surface of the specified format, and then copies and maps 
   940  * the given surface to it so the blit of the converted surface will be as 
   941  * fast as possible.  If this function fails, it returns NULL.
   942  *
   943  * The 'flags' parameter is passed to SDL_CreateRGBSurface() and has those 
   944  * semantics.  You can also pass SDL_RLEACCEL in the flags parameter and
   945  * SDL will try to RLE accelerate colorkey and alpha blits in the resulting
   946  * surface.
   947  *
   948  * This function is used internally by SDL_DisplayFormat().
   949  */
   950 extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface
   951     (SDL_Surface * src, SDL_PixelFormat * fmt, Uint32 flags);
   952 
   953 /*
   954  * This performs a fast blit from the source surface to the destination
   955  * surface.  It assumes that the source and destination rectangles are
   956  * the same size.  If either 'srcrect' or 'dstrect' are NULL, the entire
   957  * surface (src or dst) is copied.  The final blit rectangles are saved
   958  * in 'srcrect' and 'dstrect' after all clipping is performed.
   959  * If the blit is successful, it returns 0, otherwise it returns -1.
   960  *
   961  * The blit function should not be called on a locked surface.
   962  *
   963  * The blit semantics for surfaces with and without alpha and colorkey
   964  * are defined as follows:
   965  *
   966  * RGBA->RGB:
   967  *     SDL_SRCALPHA set:
   968  * 	alpha-blend (using alpha-channel).
   969  * 	SDL_SRCCOLORKEY ignored.
   970  *     SDL_SRCALPHA not set:
   971  * 	copy RGB.
   972  * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
   973  * 	RGB values of the source colour key, ignoring alpha in the
   974  * 	comparison.
   975  * 
   976  * RGB->RGBA:
   977  *     SDL_SRCALPHA set:
   978  * 	alpha-blend (using the source per-surface alpha value);
   979  * 	set destination alpha to opaque.
   980  *     SDL_SRCALPHA not set:
   981  * 	copy RGB, set destination alpha to source per-surface alpha value.
   982  *     both:
   983  * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
   984  * 	source colour key.
   985  * 
   986  * RGBA->RGBA:
   987  *     SDL_SRCALPHA set:
   988  * 	alpha-blend (using the source alpha channel) the RGB values;
   989  * 	leave destination alpha untouched. [Note: is this correct?]
   990  * 	SDL_SRCCOLORKEY ignored.
   991  *     SDL_SRCALPHA not set:
   992  * 	copy all of RGBA to the destination.
   993  * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
   994  * 	RGB values of the source colour key, ignoring alpha in the
   995  * 	comparison.
   996  * 
   997  * RGB->RGB: 
   998  *     SDL_SRCALPHA set:
   999  * 	alpha-blend (using the source per-surface alpha value).
  1000  *     SDL_SRCALPHA not set:
  1001  * 	copy RGB.
  1002  *     both:
  1003  * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
  1004  * 	source colour key.
  1005  *
  1006  * If either of the surfaces were in video memory, and the blit returns -2,
  1007  * the video memory was lost, so it should be reloaded with artwork and 
  1008  * re-blitted:
  1009 	while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) {
  1010 		while ( SDL_LockSurface(image) < 0 )
  1011 			Sleep(10);
  1012 		-- Write image pixels to image->pixels --
  1013 		SDL_UnlockSurface(image);
  1014 	}
  1015  * This happens under DirectX 5.0 when the system switches away from your
  1016  * fullscreen application.  The lock will also fail until you have access
  1017  * to the video memory again.
  1018  */
  1019 /* You should call SDL_BlitSurface() unless you know exactly how SDL
  1020    blitting works internally and how to use the other blit functions.
  1021 */
  1022 #define SDL_BlitSurface SDL_UpperBlit
  1023 
  1024 /* This is the public blit function, SDL_BlitSurface(), and it performs
  1025    rectangle validation and clipping before passing it to SDL_LowerBlit()
  1026 */
  1027 extern DECLSPEC int SDLCALL SDL_UpperBlit
  1028     (SDL_Surface * src, SDL_Rect * srcrect,
  1029      SDL_Surface * dst, SDL_Rect * dstrect);
  1030 /* This is a semi-private blit function and it performs low-level surface
  1031    blitting only.
  1032 */
  1033 extern DECLSPEC int SDLCALL SDL_LowerBlit
  1034     (SDL_Surface * src, SDL_Rect * srcrect,
  1035      SDL_Surface * dst, SDL_Rect * dstrect);
  1036 
  1037 /*
  1038  * This function performs a fast fill of the given rectangle with 'color'
  1039  * The given rectangle is clipped to the destination surface clip area
  1040  * and the final fill rectangle is saved in the passed in pointer.
  1041  * If 'dstrect' is NULL, the whole surface will be filled with 'color'
  1042  * The color should be a pixel of the format used by the surface, and 
  1043  * can be generated by the SDL_MapRGB() function.
  1044  * This function returns 0 on success, or -1 on error.
  1045  */
  1046 extern DECLSPEC int SDLCALL SDL_FillRect
  1047     (SDL_Surface * dst, SDL_Rect * dstrect, Uint32 color);
  1048 
  1049 /* 
  1050  * This function takes a surface and copies it to a new surface of the
  1051  * pixel format and colors of the video framebuffer, suitable for fast
  1052  * blitting onto the display surface.  It calls SDL_ConvertSurface()
  1053  *
  1054  * If you want to take advantage of hardware colorkey or alpha blit
  1055  * acceleration, you should set the colorkey and alpha value before
  1056  * calling this function.
  1057  *
  1058  * If the conversion fails or runs out of memory, it returns NULL
  1059  */
  1060 extern DECLSPEC SDL_Surface *SDLCALL SDL_DisplayFormat(SDL_Surface * surface);
  1061 
  1062 /* 
  1063  * This function takes a surface and copies it to a new surface of the
  1064  * pixel format and colors of the video framebuffer (if possible),
  1065  * suitable for fast alpha blitting onto the display surface.
  1066  * The new surface will always have an alpha channel.
  1067  *
  1068  * If you want to take advantage of hardware colorkey or alpha blit
  1069  * acceleration, you should set the colorkey and alpha value before
  1070  * calling this function.
  1071  *
  1072  * If the conversion fails or runs out of memory, it returns NULL
  1073  */
  1074 extern DECLSPEC SDL_Surface *SDLCALL SDL_DisplayFormatAlpha(SDL_Surface *
  1075                                                             surface);
  1076 
  1077 
  1078 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  1079 /* YUV video surface overlay functions                                       */
  1080 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  1081 
  1082 /* This function creates a video output overlay
  1083    Calling the returned surface an overlay is something of a misnomer because
  1084    the contents of the display surface underneath the area where the overlay
  1085    is shown is undefined - it may be overwritten with the converted YUV data.
  1086 */
  1087 extern DECLSPEC SDL_Overlay *SDLCALL SDL_CreateYUVOverlay(int width,
  1088                                                           int height,
  1089                                                           Uint32 format,
  1090                                                           SDL_Surface *
  1091                                                           display);
  1092 
  1093 /* Lock an overlay for direct access, and unlock it when you are done */
  1094 extern DECLSPEC int SDLCALL SDL_LockYUVOverlay(SDL_Overlay * overlay);
  1095 extern DECLSPEC void SDLCALL SDL_UnlockYUVOverlay(SDL_Overlay * overlay);
  1096 
  1097 /* Blit a video overlay to the display surface.
  1098    The contents of the video surface underneath the blit destination are
  1099    not defined.  
  1100    The width and height of the destination rectangle may be different from
  1101    that of the overlay, but currently only 2x scaling is supported.
  1102 */
  1103 extern DECLSPEC int SDLCALL SDL_DisplayYUVOverlay(SDL_Overlay * overlay,
  1104                                                   SDL_Rect * dstrect);
  1105 
  1106 /* Free a video overlay */
  1107 extern DECLSPEC void SDLCALL SDL_FreeYUVOverlay(SDL_Overlay * overlay);
  1108 
  1109 
  1110 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  1111 /* OpenGL support functions.                                                 */
  1112 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  1113 
  1114 /*
  1115  * Dynamically load an OpenGL library, or the default one if path is NULL
  1116  *
  1117  * If you do this, you need to retrieve all of the GL functions used in
  1118  * your program from the dynamic library using SDL_GL_GetProcAddress().
  1119  */
  1120 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
  1121 
  1122 /*
  1123  * Get the address of a GL function
  1124  */
  1125 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
  1126 
  1127 /*
  1128  * Set an attribute of the OpenGL subsystem before window creation.
  1129  */
  1130 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
  1131 
  1132 /*
  1133  * Get an attribute of the OpenGL subsystem from the windowing
  1134  * interface, such as glX. This is of course different from getting
  1135  * the values from SDL's internal OpenGL subsystem, which only
  1136  * stores the values you request before initialization.
  1137  *
  1138  * Developers should track the values they pass into SDL_GL_SetAttribute
  1139  * themselves if they want to retrieve these values.
  1140  */
  1141 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
  1142 
  1143 /*
  1144  * Swap the OpenGL buffers, if double-buffering is supported.
  1145  */
  1146 extern DECLSPEC void SDLCALL SDL_GL_SwapBuffers(void);
  1147 
  1148 /* Not in public API at the moment - do not use! */
  1149 extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src,
  1150                                             SDL_Rect * srcrect,
  1151                                             SDL_Surface * dst,
  1152                                             SDL_Rect * dstrect);
  1153 
  1154 /* Ends C function definitions when using C++ */
  1155 #ifdef __cplusplus
  1156 /* *INDENT-OFF* */
  1157 }
  1158 /* *INDENT-ON* */
  1159 #endif
  1160 #include "close_code.h"
  1161 
  1162 #endif /* _SDL_video_h */
  1163 
  1164 /* vi: set ts=4 sw=4 expandtab: */