include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 17 Oct 2009 07:36:45 +0000
changeset 3400 4ec48602f1db
parent 3227 458e53d8662c
child 3407 d3baf5ac4e37
permissions -rw-r--r--
iPhone interruption patch / SDL 1.3

Eric Wing to Sam

I've been sitting on this too long. I need to push.
It's untested because of the unrelated crashing bug I've been experiencing.
Also have a fix for SIZEOF_VOIDP in the config for both iPhone and Mac.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2009 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 SDL video functions.
    27  */
    28 
    29 #ifndef _SDL_video_h
    30 #define _SDL_video_h
    31 
    32 #include "SDL_stdinc.h"
    33 #include "SDL_pixels.h"
    34 #include "SDL_rect.h"
    35 #include "SDL_surface.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 /**
    46  * \struct SDL_DisplayMode
    47  *
    48  * \brief  The structure that defines a display mode
    49  *
    50  * \sa SDL_GetNumDisplayModes()
    51  * \sa SDL_GetDisplayMode()
    52  * \sa SDL_GetDesktopDisplayMode()
    53  * \sa SDL_GetCurrentDisplayMode()
    54  * \sa SDL_GetClosestDisplayMode()
    55  * \sa SDL_SetDisplayMode()
    56  */
    57 typedef struct
    58 {
    59     Uint32 format;              /**< pixel format */
    60     int w;                      /**< width */
    61     int h;                      /**< height */
    62     int refresh_rate;           /**< refresh rate (or zero for unspecified) */
    63     void *driverdata;           /**< driver-specific data, initialize to 0 */
    64 } SDL_DisplayMode;
    65 
    66 /**
    67  * \typedef SDL_WindowID
    68  *
    69  * \brief The type used to identify a window
    70  *
    71  * \sa SDL_CreateWindow()
    72  * \sa SDL_CreateWindowFrom()
    73  * \sa SDL_DestroyWindow()
    74  * \sa SDL_GetWindowData()
    75  * \sa SDL_GetWindowFlags()
    76  * \sa SDL_GetWindowGrab()
    77  * \sa SDL_GetWindowPosition()
    78  * \sa SDL_GetWindowSize()
    79  * \sa SDL_GetWindowTitle()
    80  * \sa SDL_HideWindow()
    81  * \sa SDL_MaximizeWindow()
    82  * \sa SDL_MinimizeWindow()
    83  * \sa SDL_RaiseWindow()
    84  * \sa SDL_RestoreWindow()
    85  * \sa SDL_SetWindowData()
    86  * \sa SDL_SetWindowFullscreen()
    87  * \sa SDL_SetWindowGrab()
    88  * \sa SDL_SetWindowIcon()
    89  * \sa SDL_SetWindowPosition()
    90  * \sa SDL_SetWindowSize()
    91  * \sa SDL_SetWindowTitle()
    92  * \sa SDL_ShowWindow()
    93  */
    94 typedef Uint32 SDL_WindowID;
    95 
    96 /**
    97  * \enum SDL_WindowFlags
    98  *
    99  * \brief The flags on a window
   100  *
   101  * \sa SDL_GetWindowFlags()
   102  */
   103 typedef enum
   104 {
   105     SDL_WINDOW_FULLSCREEN = 0x00000001,         /**< fullscreen window, implies borderless */
   106     SDL_WINDOW_OPENGL = 0x00000002,             /**< window usable with OpenGL context */
   107     SDL_WINDOW_SHOWN = 0x00000004,              /**< window is visible */
   108     SDL_WINDOW_BORDERLESS = 0x00000008,         /**< no window decoration */
   109     SDL_WINDOW_RESIZABLE = 0x00000010,          /**< window can be resized */
   110     SDL_WINDOW_MINIMIZED = 0x00000020,          /**< minimized */
   111     SDL_WINDOW_MAXIMIZED = 0x00000040,          /**< maximized */
   112     SDL_WINDOW_INPUT_GRABBED = 0x00000100,      /**< window has grabbed input focus */
   113     SDL_WINDOW_INPUT_FOCUS = 0x00000200,        /**< window has input focus */
   114     SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        /**< window has mouse focus */
   115     SDL_WINDOW_FOREIGN = 0x00000800             /**< window not created by SDL */
   116 } SDL_WindowFlags;
   117 
   118 /**
   119  * \def SDL_WINDOWPOS_UNDEFINED
   120  * \brief Used to indicate that you don't care what the window position is.
   121  */
   122 #define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
   123 /**
   124  * \def SDL_WINDOWPOS_CENTERED
   125  * \brief Used to indicate that the window position should be centered.
   126  */
   127 #define SDL_WINDOWPOS_CENTERED  0x7FFFFFE
   128 
   129 /**
   130  * \enum SDL_WindowEventID
   131  *
   132  * \brief Event subtype for window events
   133  */
   134 typedef enum
   135 {
   136     SDL_WINDOWEVENT_NONE,               /**< Never used */
   137     SDL_WINDOWEVENT_SHOWN,              /**< Window has been shown */
   138     SDL_WINDOWEVENT_HIDDEN,             /**< Window has been hidden */
   139     SDL_WINDOWEVENT_EXPOSED,            /**< Window has been exposed and should be redrawn */
   140     SDL_WINDOWEVENT_MOVED,              /**< Window has been moved to data1,data2 */
   141     SDL_WINDOWEVENT_RESIZED,            /**< Window size changed to data1xdata2 */
   142     SDL_WINDOWEVENT_MINIMIZED,          /**< Window has been minimized */
   143     SDL_WINDOWEVENT_MAXIMIZED,          /**< Window has been maximized */
   144     SDL_WINDOWEVENT_RESTORED,           /**< Window has been restored to normal size and position */
   145     SDL_WINDOWEVENT_ENTER,              /**< The window has gained mouse focus */
   146     SDL_WINDOWEVENT_LEAVE,              /**< The window has lost mouse focus */
   147     SDL_WINDOWEVENT_FOCUS_GAINED,       /**< The window has gained keyboard focus */
   148     SDL_WINDOWEVENT_FOCUS_LOST,         /**< The window has lost keyboard focus */
   149     SDL_WINDOWEVENT_CLOSE               /**< The window manager requests that the window be closed */
   150 } SDL_WindowEventID;
   151 
   152 /**
   153  * \enum SDL_RendererFlags
   154  *
   155  * \brief Flags used when creating a rendering context
   156  */
   157 typedef enum
   158 {
   159     SDL_RENDERER_SINGLEBUFFER = 0x00000001,     /**< Render directly to the window, if possible */
   160     SDL_RENDERER_PRESENTCOPY = 0x00000002,      /**< Present uses a copy from back buffer to the front buffer */
   161     SDL_RENDERER_PRESENTFLIP2 = 0x00000004,     /**< Present uses a flip, swapping back buffer and front buffer */
   162     SDL_RENDERER_PRESENTFLIP3 = 0x00000008,     /**< Present uses a flip, rotating between two back buffers and a front buffer */
   163     SDL_RENDERER_PRESENTDISCARD = 0x00000010,   /**< Present leaves the contents of the backbuffer undefined */
   164     SDL_RENDERER_PRESENTVSYNC = 0x00000020,     /**< Present is synchronized with the refresh rate */
   165     SDL_RENDERER_ACCELERATED = 0x00000040       /**< The renderer uses hardware acceleration */
   166 } SDL_RendererFlags;
   167 
   168 /**
   169  * \struct SDL_RendererInfo
   170  *
   171  * \brief Information on the capabilities of a render driver or context
   172  */
   173 typedef struct SDL_RendererInfo
   174 {
   175     const char *name;           /**< The name of the renderer */
   176     Uint32 flags;               /**< Supported SDL_RendererFlags */
   177     Uint32 mod_modes;           /**< A mask of supported channel modulation */
   178     Uint32 blend_modes;         /**< A mask of supported blend modes */
   179     Uint32 scale_modes;         /**< A mask of supported scale modes */
   180     Uint32 num_texture_formats; /**< The number of available texture formats */
   181     Uint32 texture_formats[20]; /**< The available texture formats */
   182     int max_texture_width;      /**< The maximimum texture width */
   183     int max_texture_height;     /**< The maximimum texture height */
   184 } SDL_RendererInfo;
   185 
   186 /**
   187  * \enum SDL_TextureAccess
   188  *
   189  * \brief The access pattern allowed for a texture
   190  */
   191 typedef enum
   192 {
   193     SDL_TEXTUREACCESS_STATIC,    /**< Changes rarely, not lockable */
   194     SDL_TEXTUREACCESS_STREAMING  /**< Changes frequently, lockable */
   195 } SDL_TextureAccess;
   196 
   197 /**
   198  * \enum SDL_TextureModulate
   199  *
   200  * \brief The texture channel modulation used in SDL_RenderCopy()
   201  */
   202 typedef enum
   203 {
   204     SDL_TEXTUREMODULATE_NONE = 0x00000000,     /**< No modulation */
   205     SDL_TEXTUREMODULATE_COLOR = 0x00000001,    /**< srcC = srcC * color */
   206     SDL_TEXTUREMODULATE_ALPHA = 0x00000002     /**< srcA = srcA * alpha */
   207 } SDL_TextureModulate;
   208 
   209 /**
   210  * \enum SDL_BlendMode
   211  *
   212  * \brief The blend mode used in SDL_RenderCopy() and drawing operations
   213  */
   214 typedef enum
   215 {
   216     SDL_BLENDMODE_NONE = 0x00000000,     /**< No blending */
   217     SDL_BLENDMODE_MASK = 0x00000001,     /**< dst = A ? src : dst (alpha is mask) */
   218     SDL_BLENDMODE_BLEND = 0x00000002,    /**< dst = (src * A) + (dst * (1-A)) */
   219     SDL_BLENDMODE_ADD = 0x00000004,      /**< dst = (src * A) + dst */
   220     SDL_BLENDMODE_MOD = 0x00000008       /**< dst = src * dst */
   221 } SDL_BlendMode;
   222 
   223 /**
   224  * \enum SDL_TextureScaleMode
   225  *
   226  * \brief The texture scale mode used in SDL_RenderCopy()
   227  */
   228 typedef enum
   229 {
   230     SDL_TEXTURESCALEMODE_NONE = 0x00000000,     /**< No scaling, rectangles must match dimensions */
   231     SDL_TEXTURESCALEMODE_FAST = 0x00000001,     /**< Point sampling or equivalent algorithm */
   232     SDL_TEXTURESCALEMODE_SLOW = 0x00000002,     /**< Linear filtering or equivalent algorithm */
   233     SDL_TEXTURESCALEMODE_BEST = 0x00000004      /**< Bicubic filtering or equivalent algorithm */
   234 } SDL_TextureScaleMode;
   235 
   236 /**
   237  * \typedef SDL_TextureID
   238  *
   239  * \brief An efficient driver-specific representation of pixel data
   240  */
   241 typedef Uint32 SDL_TextureID;
   242 
   243 /**
   244  * \typedef SDL_GLContext
   245  *
   246  * \brief An opaque handle to an OpenGL context.
   247  */
   248 typedef void *SDL_GLContext;
   249 
   250 /**
   251  * \enum SDL_GLattr
   252  *
   253  * \brief OpenGL configuration attributes
   254  */
   255 typedef enum
   256 {
   257     SDL_GL_RED_SIZE,
   258     SDL_GL_GREEN_SIZE,
   259     SDL_GL_BLUE_SIZE,
   260     SDL_GL_ALPHA_SIZE,
   261     SDL_GL_BUFFER_SIZE,
   262     SDL_GL_DOUBLEBUFFER,
   263     SDL_GL_DEPTH_SIZE,
   264     SDL_GL_STENCIL_SIZE,
   265     SDL_GL_ACCUM_RED_SIZE,
   266     SDL_GL_ACCUM_GREEN_SIZE,
   267     SDL_GL_ACCUM_BLUE_SIZE,
   268     SDL_GL_ACCUM_ALPHA_SIZE,
   269     SDL_GL_STEREO,
   270     SDL_GL_MULTISAMPLEBUFFERS,
   271     SDL_GL_MULTISAMPLESAMPLES,
   272     SDL_GL_ACCELERATED_VISUAL,
   273     SDL_GL_RETAINED_BACKING,
   274     SDL_GL_CONTEXT_MAJOR_VERSION,
   275     SDL_GL_CONTEXT_MINOR_VERSION
   276 } SDL_GLattr;
   277 
   278 
   279 /* Function prototypes */
   280 
   281 /**
   282  * \fn int SDL_GetNumVideoDrivers(void)
   283  *
   284  * \brief Get the number of video drivers compiled into SDL
   285  *
   286  * \sa SDL_GetVideoDriver()
   287  */
   288 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
   289 
   290 /**
   291  * \fn const char *SDL_GetVideoDriver(int index)
   292  *
   293  * \brief Get the name of a built in video driver.
   294  *
   295  * \note The video drivers are presented in the order in which they are
   296  * normally checked during initialization.
   297  *
   298  * \sa SDL_GetNumVideoDrivers()
   299  */
   300 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
   301 
   302 /**
   303  * \fn int SDL_VideoInit(const char *driver_name, Uint32 flags)
   304  *
   305  * \brief Initialize the video subsystem, optionally specifying a video driver.
   306  *
   307  * \param driver_name Initialize a specific driver by name, or NULL for the default video driver.
   308  * \param flags FIXME: Still needed?
   309  *
   310  * \return 0 on success, -1 on error
   311  *
   312  * This function initializes the video subsystem; setting up a connection
   313  * to the window manager, etc, and determines the available display modes
   314  * and pixel formats, but does not initialize a window or graphics mode.
   315  *
   316  * \sa SDL_VideoQuit()
   317  */
   318 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name,
   319                                           Uint32 flags);
   320 
   321 /**
   322  * \fn void SDL_VideoQuit(void)
   323  *
   324  * \brief Shuts down the video subsystem.
   325  *
   326  * This function closes all windows, and restores the original video mode.
   327  *
   328  * \sa SDL_VideoInit()
   329  */
   330 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
   331 
   332 /**
   333  * \fn const char *SDL_GetCurrentVideoDriver(void)
   334  *
   335  * \brief Returns the name of the currently initialized video driver.
   336  *
   337  * \return The name of the current video driver or NULL if no driver
   338  *         has been initialized
   339  *
   340  * \sa SDL_GetNumVideoDrivers()
   341  * \sa SDL_GetVideoDriver()
   342  */
   343 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
   344 
   345 /**
   346  * \fn int SDL_GetNumVideoDisplays(void)
   347  *
   348  * \brief Returns the number of available video displays.
   349  *
   350  * \sa SDL_SelectVideoDisplay()
   351  */
   352 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
   353 
   354 /**
   355  * \fn int SDL_SelectVideoDisplay(int index)
   356  *
   357  * \brief Set the index of the currently selected display.
   358  *
   359  * \return 0 on success, or -1 if the index is out of range.
   360  *
   361  * \sa SDL_GetNumVideoDisplays()
   362  * \sa SDL_GetCurrentVideoDisplay()
   363  */
   364 extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
   365 
   366 /**
   367  * \fn int SDL_GetCurrentVideoDisplay(void)
   368  *
   369  * \brief Get the index of the currently selected display.
   370  *
   371  * \return The index of the currently selected display.
   372  *
   373  * \sa SDL_GetNumVideoDisplays()
   374  * \sa SDL_SelectVideoDisplay()
   375  */
   376 extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
   377 
   378 /**
   379  * \fn int SDL_GetNumDisplayModes(void)
   380  *
   381  * \brief Returns the number of available display modes for the current display.
   382  *
   383  * \sa SDL_GetDisplayMode()
   384  */
   385 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
   386 
   387 /**
   388  * \fn int SDL_GetDisplayMode(int index, SDL_DisplayMode *mode)
   389  *
   390  * \brief Fill in information about a specific display mode.
   391  *
   392  * \note The display modes are sorted in this priority:
   393  *       \li bits per pixel -> more colors to fewer colors
   394  *       \li width -> largest to smallest
   395  *       \li height -> largest to smallest
   396  *       \li refresh rate -> highest to lowest
   397  *
   398  * \sa SDL_GetNumDisplayModes()
   399  */
   400 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index,
   401                                                SDL_DisplayMode * mode);
   402 
   403 /**
   404  * \fn int SDL_GetDesktopDisplayMode(SDL_DisplayMode *mode)
   405  *
   406  * \brief Fill in information about the desktop display mode for the current display.
   407  */
   408 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
   409 
   410 /**
   411  * \fn int SDL_GetCurrentDisplayMode(SDL_DisplayMode *mode)
   412  *
   413  * \brief Fill in information about the current display mode.
   414  */
   415 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
   416 
   417 
   418 /**
   419  * \fn SDL_DisplayMode SDL_GetClosestDisplayMode(const SDL_DisplayMode mode, SDL_DisplayMode closest)
   420  *
   421  * \brief Get the closest match to the requested display mode.
   422  *
   423  * \param mode The desired display mode
   424  * \param closest A pointer to a display mode to be filled in with the closest match of the available display modes.
   425  *
   426  * \return The passed in value 'closest', or NULL if no matching video mode was available.
   427  *
   428  * 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.
   429  *
   430  * \sa SDL_GetNumDisplayModes()
   431  * \sa SDL_GetDisplayMode()
   432  */
   433 extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
   434                                                                    SDL_DisplayMode
   435                                                                    * mode,
   436                                                                    SDL_DisplayMode
   437                                                                    * closest);
   438 
   439 /**
   440  * \fn int SDL_SetFullscreenDisplayMode(const SDL_DisplayMode *mode)
   441  *
   442  * \brief Set the display mode used when a fullscreen window is visible
   443  *        on the currently selected display.
   444  *
   445  * \param mode The mode to use, or NULL for the desktop mode.
   446  *
   447  * \return 0 on success, or -1 if setting the display mode failed.
   448  *
   449  * \sa SDL_SetWindowFullscreen()
   450  */
   451 extern DECLSPEC int SDLCALL SDL_SetFullscreenDisplayMode(const SDL_DisplayMode
   452                                                          * mode);
   453 
   454 /**
   455  * \fn int SDL_GetFullscreenDisplayMode(SDL_DisplayMode *mode)
   456  *
   457  * \brief Fill in information about the display mode used when a fullscreen
   458  *        window is visible on the currently selected display.
   459  */
   460 extern DECLSPEC int SDLCALL SDL_GetFullscreenDisplayMode(SDL_DisplayMode *
   461                                                          mode);
   462 
   463 /**
   464  * \fn int SDL_SetDisplayPalette(const SDL_Color *colors, int firstcolor, int ncolors)
   465  *
   466  * \brief Set the palette entries for indexed display modes.
   467  *
   468  * \return 0 on success, or -1 if the display mode isn't palettized or the colors couldn't be set.
   469  */
   470 extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,
   471                                                   int firstcolor,
   472                                                   int ncolors);
   473 
   474 /**
   475  * \fn int SDL_GetDisplayPalette(SDL_Color *colors, int firstcolor, int ncolors)
   476  *
   477  * \brief Gets the palette entries for indexed display modes.
   478  *
   479  * \return 0 on success, or -1 if the display mode isn't palettized
   480  */
   481 extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,
   482                                                   int firstcolor,
   483                                                   int ncolors);
   484 
   485 /**
   486  * \fn int SDL_SetGamma(float red, float green, float blue)
   487  *
   488  * \brief Set the gamma correction for each of the color channels on the currently selected display.
   489  *
   490  * \return 0 on success, or -1 if setting the gamma isn't supported.
   491  *
   492  * \sa SDL_SetGammaRamp()
   493  */
   494 extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
   495 
   496 /**
   497  * \fn int SDL_SetGammaRamp(const Uint16 * red, const Uint16 * green, const Uint16 * blue)
   498  *
   499  * \brief Set the gamma ramp for the currently selected display.
   500  *
   501  * \param red The translation table for the red channel, or NULL
   502  * \param green The translation table for the green channel, or NULL
   503  * \param blue The translation table for the blue channel, or NULL
   504  *
   505  * \return 0 on success, or -1 if gamma ramps are unsupported.
   506  *
   507  * Set the gamma translation table for the red, green, and blue channels
   508  * of the video hardware.  Each table is an array of 256 16-bit quantities,
   509  * representing a mapping between the input and output for that channel.
   510  * The input is the index into the array, and the output is the 16-bit
   511  * gamma value at that index, scaled to the output color precision.
   512  * 
   513  * \sa SDL_GetGammaRamp()
   514  */
   515 extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
   516                                              const Uint16 * green,
   517                                              const Uint16 * blue);
   518 
   519 /**
   520  * \fn int SDL_GetGammaRamp(Uint16 * red, Uint16 * green, Uint16 * blue)
   521  *
   522  * \brief Get the gamma ramp for the currently selected display.
   523  *
   524  * \param red A pointer to a 256 element array of 16-bit quantities to hold the translation table for the red channel, or NULL.
   525  * \param green A pointer to a 256 element array of 16-bit quantities to hold the translation table for the green channel, or NULL.
   526  * \param blue A pointer to a 256 element array of 16-bit quantities to hold the translation table for the blue channel, or NULL.
   527  * 
   528  * \return 0 on success, or -1 if gamma ramps are unsupported.
   529  *
   530  * \sa SDL_SetGammaRamp()
   531  */
   532 extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
   533                                              Uint16 * blue);
   534 
   535 
   536 /**
   537  * \fn SDL_WindowID SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)
   538  *
   539  * \brief Create a window with the specified position, dimensions, and flags.
   540  *
   541  * \param title The title of the window, in UTF-8 encoding
   542  * \param x The x position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
   543  * \param y The y position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
   544  * \param w The width of the window
   545  * \param h The height of the window
   546  * \param flags The flags for the window, a mask of any of the following: SDL_WINDOW_FULLSCREEN, SDL_WINDOW_OPENGL, SDL_WINDOW_SHOWN, SDL_WINDOW_BORDERLESS, SDL_WINDOW_RESIZABLE, SDL_WINDOW_MAXIMIZED, SDL_WINDOW_MINIMIZED, SDL_WINDOW_INPUT_GRABBED
   547  *
   548  * \return The id of the window created, or zero if window creation failed.
   549  *
   550  * \sa SDL_DestroyWindow()
   551  */
   552 extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindow(const char *title,
   553                                                       int x, int y, int w,
   554                                                       int h, Uint32 flags);
   555 
   556 /**
   557  * \fn SDL_WindowID SDL_CreateWindowFrom(void *data)
   558  *
   559  * \brief Create an SDL window struct from an existing native window.
   560  *
   561  * \param data A pointer to driver-dependent window creation data
   562  *
   563  * \return The id of the window created, or zero if window creation failed.
   564  *
   565  * \warning This function is NOT SUPPORTED, use at your own risk!
   566  *
   567  * \sa SDL_DestroyWindow()
   568  */
   569 extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindowFrom(const void *data);
   570 
   571 /**
   572  * \fn Uint32 SDL_GetWindowFlags(SDL_WindowID windowID)
   573  *
   574  * \brief Get the window flags.
   575  */
   576 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_WindowID windowID);
   577 
   578 /**
   579  * \fn void SDL_SetWindowTitle(SDL_WindowID windowID, const char *title)
   580  *
   581  * \brief Set the title of the window, in UTF-8 format.
   582  *
   583  * \sa SDL_GetWindowTitle()
   584  */
   585 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_WindowID windowID,
   586                                                 const char *title);
   587 
   588 /**
   589  * \fn const char *SDL_GetWindowTitle(SDL_WindowID windowID)
   590  *
   591  * \brief Get the title of the window, in UTF-8 format.
   592  *
   593  * \sa SDL_SetWindowTitle()
   594  */
   595 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_WindowID windowID);
   596 
   597 /**
   598  * \fn void SDL_SetWindowIcon(SDL_WindowID windowID, SDL_Surface *icon)
   599  *
   600  * \brief Set the icon of the window.
   601  *
   602  * \param icon The icon for the window
   603  */
   604 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_WindowID windowID,
   605                                                SDL_Surface * icon);
   606 
   607 /**
   608  * \fn void SDL_SetWindowData(SDL_WindowID windowID, void *userdata)
   609  *
   610  * \brief Associate an arbitrary pointer with the window.
   611  *
   612  * \sa SDL_GetWindowData()
   613  */
   614 extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_WindowID windowID,
   615                                                void *userdata);
   616 
   617 /**
   618  * \fn void *SDL_GetWindowData(SDL_WindowID windowID)
   619  *
   620  * \brief Retrieve the data pointer associated with the window.
   621  *
   622  * \sa SDL_SetWindowData()
   623  */
   624 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_WindowID windowID);
   625 
   626 /**
   627  * \fn void SDL_SetWindowPosition(SDL_WindowID windowID, int x, int y)
   628  *
   629  * \brief Set the position of the window.
   630  *
   631  * \param windowID The window to reposition
   632  * \param x The x coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
   633  * \param y The y coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
   634  *
   635  * \note The window coordinate origin is the upper left of the display.
   636  *
   637  * \sa SDL_GetWindowPosition()
   638  */
   639 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_WindowID windowID,
   640                                                    int x, int y);
   641 
   642 /**
   643  * \fn void SDL_GetWindowPosition(SDL_WindowID windowID, int *x, int *y)
   644  *
   645  * \brief Get the position of the window.
   646  *
   647  * \sa SDL_SetWindowPosition()
   648  */
   649 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_WindowID windowID,
   650                                                    int *x, int *y);
   651 
   652 /**
   653  * \fn void SDL_SetWindowSize(SDL_WindowID windowID, int w, int w)
   654  *
   655  * \brief Set the size of the window's client area.
   656  *
   657  * \note You can't change the size of a fullscreen window, it automatically
   658  * matches the size of the display mode.
   659  *
   660  * \sa SDL_GetWindowSize()
   661  */
   662 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_WindowID windowID, int w,
   663                                                int h);
   664 
   665 /**
   666  * \fn void SDL_GetWindowSize(SDL_WindowID windowID, int *w, int *h)
   667  *
   668  * \brief Get the size of the window's client area.
   669  *
   670  * \sa SDL_SetWindowSize()
   671  */
   672 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_WindowID windowID, int *w,
   673                                                int *h);
   674 
   675 /**
   676  * \fn void SDL_ShowWindow(SDL_WindowID windowID)
   677  *
   678  * \brief Show the window
   679  *
   680  * \sa SDL_HideWindow()
   681  */
   682 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_WindowID windowID);
   683 
   684 /**
   685  * \fn void SDL_HideWindow(SDL_WindowID windowID)
   686  *
   687  * \brief Hide the window
   688  *
   689  * \sa SDL_ShowWindow()
   690  */
   691 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_WindowID windowID);
   692 
   693 /**
   694  * \fn void SDL_RaiseWindow(SDL_WindowID windowID)
   695  *
   696  * \brief Raise the window above other windows and set the input focus.
   697  */
   698 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_WindowID windowID);
   699 
   700 /**
   701  * \fn void SDL_MaximizeWindow(SDL_WindowID windowID)
   702  *
   703  * \brief Make the window as large as possible.
   704  *
   705  * \sa SDL_RestoreWindow()
   706  */
   707 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_WindowID windowID);
   708 
   709 /**
   710  * \fn void SDL_MinimizeWindow(SDL_WindowID windowID)
   711  *
   712  * \brief Minimize the window to an iconic representation.
   713  *
   714  * \sa SDL_RestoreWindow()
   715  */
   716 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_WindowID windowID);
   717 
   718 /**
   719  * \fn void SDL_RestoreWindow(SDL_WindowID windowID)
   720  *
   721  * \brief Restore the size and position of a minimized or maximized window.
   722  *
   723  * \sa SDL_MaximizeWindow()
   724  * \sa SDL_MinimizeWindow()
   725  */
   726 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_WindowID windowID);
   727 
   728 /**
   729  * \fn int SDL_SetWindowFullscreen(SDL_WindowID windowID, int fullscreen)
   730  *
   731  * \brief Set the window's fullscreen state.
   732  *
   733  * \return 0 on success, or -1 if setting the display mode failed.
   734  *
   735  * \sa SDL_SetFullscreenDisplayMode()
   736  */
   737 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_WindowID windowID,
   738                                                     int fullscreen);
   739 
   740 /**
   741  * \fn void SDL_SetWindowGrab(SDL_WindowID windowID, int mode)
   742  *
   743  * \brief Set the window's input grab mode.
   744  *
   745  * \param mode This is 1 to grab input, and 0 to release input.
   746  *
   747  * \sa SDL_GetWindowGrab()
   748  */
   749 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_WindowID windowID,
   750                                                int mode);
   751 
   752 /**
   753  * \fn int SDL_GetWindowGrab(SDL_WindowID windowID)
   754  *
   755  * \brief Get the window's input grab mode.
   756  *
   757  * \return This returns 1 if input is grabbed, and 0 otherwise.
   758  *
   759  * \sa SDL_SetWindowGrab()
   760  */
   761 extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_WindowID windowID);
   762 
   763 /**
   764  * \fn SDL_bool SDL_GetWindowWMInfo(SDL_WindowID windowID, struct SDL_SysWMinfo * info)
   765  *
   766  * \brief Get driver specific information about a window.
   767  *
   768  * \note Include SDL_syswm.h for the declaration of SDL_SysWMinfo.
   769  */
   770 struct SDL_SysWMinfo;
   771 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
   772                                                      struct SDL_SysWMinfo
   773                                                      *info);
   774 
   775 /**
   776  * \fn void SDL_DestroyWindow(SDL_WindowID windowID)
   777  *
   778  * \brief Destroy a window.
   779  */
   780 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_WindowID windowID);
   781 
   782 /**
   783  * \fn int SDL_GetNumRenderDrivers(void)
   784  *
   785  * \brief Get the number of 2D rendering drivers available for the current display.
   786  *
   787  * A render driver is a set of code that handles rendering and texture
   788  * management on a particular display.  Normally there is only one, but
   789  * some drivers may have several available with different capabilities.
   790  *
   791  * \sa SDL_GetRenderDriverInfo()
   792  * \sa SDL_CreateRenderer()
   793  */
   794 extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
   795 
   796 /**
   797  * \fn int SDL_GetRenderDriverInfo(int index, SDL_RendererInfo *info)
   798  *
   799  * \brief Get information about a specific 2D rendering driver for the current display.
   800  *
   801  * \param index The index of the driver to query information about.
   802  * \param info A pointer to an SDL_RendererInfo struct to be filled with information on the rendering driver.
   803  *
   804  * \return 0 on success, -1 if the index was out of range
   805  *
   806  * \sa SDL_CreateRenderer()
   807  */
   808 extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
   809                                                     SDL_RendererInfo * info);
   810 
   811 /**
   812  * \fn int SDL_CreateRenderer(SDL_WindowID window, int index, Uint32 flags)
   813  *
   814  * \brief Create and make active a 2D rendering context for a window.
   815  *
   816  * \param windowID The window used for rendering
   817  * \param index The index of the rendering driver to initialize, or -1 to initialize the first one supporting the requested flags.
   818  * \param flags SDL_RendererFlags
   819  *
   820  * \return 0 on success, -1 if there was an error creating the renderer.
   821  *
   822  * \sa SDL_SelectRenderer()
   823  * \sa SDL_GetRendererInfo()
   824  * \sa SDL_DestroyRenderer()
   825  */
   826 extern DECLSPEC int SDLCALL SDL_CreateRenderer(SDL_WindowID windowID,
   827                                                int index, Uint32 flags);
   828 
   829 /**
   830  * \fn int SDL_SelectRenderer(SDL_WindowID windowID)
   831  *
   832  * \brief Select the rendering context for a particular window.
   833  *
   834  * \return 0 on success, -1 if the selected window doesn't have a
   835  *         rendering context.
   836  */
   837 extern DECLSPEC int SDLCALL SDL_SelectRenderer(SDL_WindowID windowID);
   838 
   839 /**
   840  * \fn int SDL_GetRendererInfo(SDL_RendererInfo *info)
   841  *
   842  * \brief Get information about the current rendering context.
   843  */
   844 extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_RendererInfo * info);
   845 
   846 /**
   847  * \fn SDL_TextureID SDL_CreateTexture(Uint32 format, int access, int w, int h)
   848  *
   849  * \brief Create a texture for the current rendering context.
   850  *
   851  * \param format The format of the texture
   852  * \param access One of the enumerated values in SDL_TextureAccess
   853  * \param w The width of the texture in pixels
   854  * \param h The height of the texture in pixels
   855  *
   856  * \return The created texture is returned, or 0 if no rendering context was active,  the format was unsupported, or the width or height were out of range.
   857  *
   858  * \sa SDL_QueryTexture()
   859  * \sa SDL_DestroyTexture()
   860  */
   861 extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTexture(Uint32 format,
   862                                                         int access, int w,
   863                                                         int h);
   864 
   865 /**
   866  * \fn SDL_TextureID SDL_CreateTextureFromSurface(Uint32 format, SDL_Surface *surface)
   867  *
   868  * \brief Create a texture from an existing surface.
   869  *
   870  * \param format The format of the texture, or 0 to pick an appropriate format
   871  * \param surface The surface containing pixel data used to fill the texture
   872  *
   873  * \return The created texture is returned, or 0 if no rendering context was active,  the format was unsupported, or the surface width or height were out of range.
   874  *
   875  * \note The surface is not modified or freed by this function.
   876  *
   877  * \sa SDL_QueryTexture()
   878  * \sa SDL_DestroyTexture()
   879  */
   880 extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTextureFromSurface(Uint32
   881                                                                    format,
   882                                                                    SDL_Surface
   883                                                                    * surface);
   884 
   885 /**
   886  * \fn int SDL_QueryTexture(SDL_TextureID textureID, Uint32 *format, int *access, int *w, int *h)
   887  *
   888  * \brief Query the attributes of a texture
   889  *
   890  * \param texture A texture to be queried
   891  * \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.
   892  * \param access A pointer filled in with the actual access to the texture.
   893  * \param w A pointer filled in with the width of the texture in pixels
   894  * \param h A pointer filled in with the height of the texture in pixels
   895  *
   896  * \return 0 on success, or -1 if the texture is not valid
   897  */
   898 extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_TextureID textureID,
   899                                              Uint32 * format, int *access,
   900                                              int *w, int *h);
   901 
   902 /**
   903  * \fn int SDL_QueryTexturePixels(SDL_TextureID textureID, void **pixels, int pitch)
   904  *
   905  * \brief Query the pixels of a texture, if the texture does not need to be locked for pixel access.
   906  *
   907  * \param texture A texture to be queried, which was created with SDL_TEXTUREACCESS_STREAMING
   908  * \param pixels A pointer filled with a pointer to the pixels for the texture 
   909  * \param pitch A pointer filled in with the pitch of the pixel data
   910  *
   911  * \return 0 on success, or -1 if the texture is not valid, or must be locked for pixel access.
   912  */
   913 extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_TextureID textureID,
   914                                                    void **pixels, int *pitch);
   915 
   916 /**
   917  * \fn int SDL_SetTexturePalette(SDL_TextureID textureID, const SDL_Color * colors, int firstcolor, int ncolors)
   918  *
   919  * \brief Set the color palette of an indexed texture.
   920  *
   921  * \param texture The texture to update
   922  * \param colors The array of RGB color data
   923  * \param firstcolor The first index to update
   924  * \param ncolors The number of palette entries to fill with the color data
   925  *
   926  * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
   927  */
   928 extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_TextureID textureID,
   929                                                   const SDL_Color * colors,
   930                                                   int firstcolor,
   931                                                   int ncolors);
   932 
   933 /**
   934  * \fn int SDL_GetTexturePalette(SDL_TextureID textureID, SDL_Color * colors, int firstcolor, int ncolors)
   935  *
   936  * \brief Get the color palette from an indexed texture if it has one.
   937  *
   938  * \param texture The texture to update
   939  * \param colors The array to fill with RGB color data
   940  * \param firstcolor The first index to retrieve
   941  * \param ncolors The number of palette entries to retrieve
   942  *
   943  * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
   944  */
   945 extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_TextureID textureID,
   946                                                   SDL_Color * colors,
   947                                                   int firstcolor,
   948                                                   int ncolors);
   949 
   950 /**
   951  * \fn int SDL_SetTextureColorMod(SDL_TextureID textureID, Uint8 r, Uint8 g, Uint8 b)
   952  *
   953  * \brief Set an additional color value used in render copy operations
   954  *
   955  * \param texture The texture to update
   956  * \param r The red source color value multiplied into copy operations
   957  * \param g The green source color value multiplied into copy operations
   958  * \param b The blue source color value multiplied into copy operations
   959  *
   960  * \return 0 on success, or -1 if the texture is not valid or color modulation is not supported
   961  *
   962  * \sa SDL_GetTextureColorMod()
   963  */
   964 extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_TextureID textureID,
   965                                                    Uint8 r, Uint8 g, Uint8 b);
   966 
   967 
   968 /**
   969  * \fn int SDL_GetTextureColorMod(SDL_TextureID textureID, Uint8 *r, Uint8 *g, Uint8 *b)
   970  *
   971  * \brief Get the additional color value used in render copy operations
   972  *
   973  * \param texture The texture to query
   974  * \param r A pointer filled in with the source red color value
   975  * \param g A pointer filled in with the source green color value
   976  * \param b A pointer filled in with the source blue color value
   977  *
   978  * \return 0 on success, or -1 if the texture is not valid
   979  *
   980  * \sa SDL_SetTextureColorMod()
   981  */
   982 extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_TextureID textureID,
   983                                                    Uint8 * r, Uint8 * g,
   984                                                    Uint8 * b);
   985 
   986 /**
   987  * \fn int SDL_SetTextureAlphaMod(SDL_TextureID textureID, Uint8 alpha)
   988  *
   989  * \brief Set an additional alpha value used in render copy operations
   990  *
   991  * \param texture The texture to update
   992  * \param alpha The source alpha value multiplied into copy operations.
   993  *
   994  * \return 0 on success, or -1 if the texture is not valid or alpha modulation is not supported
   995  *
   996  * \sa SDL_GetTextureAlphaMod()
   997  */
   998 extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_TextureID textureID,
   999                                                    Uint8 alpha);
  1000 
  1001 /**
  1002  * \fn int SDL_GetTextureAlphaMod(SDL_TextureID textureID, Uint8 *alpha)
  1003  *
  1004  * \brief Get the additional alpha value used in render copy operations
  1005  *
  1006  * \param texture The texture to query
  1007  * \param alpha A pointer filled in with the source alpha value
  1008  *
  1009  * \return 0 on success, or -1 if the texture is not valid
  1010  *
  1011  * \sa SDL_SetTextureAlphaMod()
  1012  */
  1013 extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_TextureID textureID,
  1014                                                    Uint8 * alpha);
  1015 
  1016 /**
  1017  * \fn int SDL_SetTextureBlendMode(SDL_TextureID textureID, int blendMode)
  1018  *
  1019  * \brief Set the blend mode used for texture copy operations
  1020  *
  1021  * \param texture The texture to update
  1022  * \param blendMode SDL_TextureBlendMode to use for texture blending
  1023  *
  1024  * \return 0 on success, or -1 if the texture is not valid or the blend mode is not supported
  1025  *
  1026  * \note If the blend mode is not supported, the closest supported mode is chosen.
  1027  *
  1028  * \sa SDL_GetTextureBlendMode()
  1029  */
  1030 extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_TextureID textureID,
  1031                                                     int blendMode);
  1032 
  1033 /**
  1034  * \fn int SDL_GetTextureBlendMode(SDL_TextureID textureID, int *blendMode)
  1035  *
  1036  * \brief Get the blend mode used for texture copy operations
  1037  *
  1038  * \param texture The texture to query
  1039  * \param blendMode A pointer filled in with the current blend mode
  1040  *
  1041  * \return 0 on success, or -1 if the texture is not valid
  1042  *
  1043  * \sa SDL_SetTextureBlendMode()
  1044  */
  1045 extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_TextureID textureID,
  1046                                                     int *blendMode);
  1047 
  1048 /**
  1049  * \fn int SDL_SetTextureScaleMode(SDL_TextureID textureID, int scaleMode)
  1050  *
  1051  * \brief Set the scale mode used for texture copy operations
  1052  *
  1053  * \param texture The texture to update
  1054  * \param scaleMode SDL_TextureScaleMode to use for texture scaling
  1055  *
  1056  * \return 0 on success, or -1 if the texture is not valid or the scale mode is not supported
  1057  *
  1058  * \note If the scale mode is not supported, the closest supported mode is chosen.
  1059  *
  1060  * \sa SDL_GetTextureScaleMode()
  1061  */
  1062 extern DECLSPEC int SDLCALL SDL_SetTextureScaleMode(SDL_TextureID textureID,
  1063                                                     int scaleMode);
  1064 
  1065 /**
  1066  * \fn int SDL_GetTextureScaleMode(SDL_TextureID textureID, int *scaleMode)
  1067  *
  1068  * \brief Get the scale mode used for texture copy operations
  1069  *
  1070  * \param texture The texture to query
  1071  * \param scaleMode A pointer filled in with the current scale mode
  1072  *
  1073  * \return 0 on success, or -1 if the texture is not valid
  1074  *
  1075  * \sa SDL_SetTextureScaleMode()
  1076  */
  1077 extern DECLSPEC int SDLCALL SDL_GetTextureScaleMode(SDL_TextureID textureID,
  1078                                                     int *scaleMode);
  1079 
  1080 /**
  1081  * \fn int SDL_UpdateTexture(SDL_TextureID textureID, const SDL_Rect *rect, const void *pixels, int pitch)
  1082  *
  1083  * \brief Update the given texture rectangle with new pixel data.
  1084  *
  1085  * \param texture The texture to update
  1086  * \param rect A pointer to the rectangle of pixels to update, or NULL to update the entire texture.
  1087  * \param pixels The raw pixel data
  1088  * \param pitch The number of bytes between rows of pixel data
  1089  *
  1090  * \return 0 on success, or -1 if the texture is not valid
  1091  *
  1092  * \note This is a fairly slow function.
  1093  */
  1094 extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_TextureID textureID,
  1095                                               const SDL_Rect * rect,
  1096                                               const void *pixels, int pitch);
  1097 
  1098 /**
  1099  * \fn void SDL_LockTexture(SDL_TextureID textureID, const SDL_Rect *rect, int markDirty, void **pixels, int *pitch)
  1100  *
  1101  * \brief Lock a portion of the texture for pixel access.
  1102  *
  1103  * \param textureID The texture to lock for access, which was created with SDL_TEXTUREACCESS_STREAMING.
  1104  * \param rect A pointer to the rectangle to lock for access. If the rect is NULL, the entire texture will be locked.
  1105  * \param markDirty If this is nonzero, the locked area will be marked dirty when the texture is unlocked.
  1106  * \param pixels This is filled in with a pointer to the locked pixels, appropriately offset by the locked area.
  1107  * \param pitch This is filled in with the pitch of the locked pixels.
  1108  *
  1109  * \return 0 on success, or -1 if the texture is not valid or was created with SDL_TEXTUREACCESS_STATIC
  1110  *
  1111  * \sa SDL_DirtyTexture()
  1112  * \sa SDL_UnlockTexture()
  1113  */
  1114 extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_TextureID textureID,
  1115                                             const SDL_Rect * rect,
  1116                                             int markDirty, void **pixels,
  1117                                             int *pitch);
  1118 
  1119 /**
  1120  * \fn void SDL_UnlockTexture(SDL_TextureID textureID)
  1121  *
  1122  * \brief Unlock a texture, uploading the changes to video memory, if needed.
  1123  *
  1124  * \sa SDL_LockTexture()
  1125  * \sa SDL_DirtyTexture()
  1126  */
  1127 extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_TextureID textureID);
  1128 
  1129 /**
  1130  * \fn void SDL_DirtyTexture(SDL_TextureID textureID, int numrects, const SDL_Rect * rects)
  1131  *
  1132  * \brief Mark the specified rectangles of the texture as dirty.
  1133  *
  1134  * \param textureID The texture to mark dirty, which was created with SDL_TEXTUREACCESS_STREAMING.
  1135  * \param numrects The number of rectangles pointed to by rects.
  1136  * \param rects The pointer to an array of dirty rectangles.
  1137  *
  1138  * \sa SDL_LockTexture()
  1139  * \sa SDL_UnlockTexture()
  1140  */
  1141 extern DECLSPEC void SDLCALL SDL_DirtyTexture(SDL_TextureID textureID,
  1142                                               int numrects,
  1143                                               const SDL_Rect * rects);
  1144 
  1145 /**
  1146  * \fn int SDL_SetRenderDrawColor(Uint8 r, Uint8 g, Uint8 b, Uint8 a)
  1147  *
  1148  * \brief Set the color used for drawing operations (Fill and Line).
  1149  *
  1150  * \param r The red value used to draw on the rendering target
  1151  * \param g The green value used to draw on the rendering target
  1152  * \param b The blue value used to draw on the rendering target
  1153  * \param a The alpha value used to draw on the rendering target, usually SDL_ALPHA_OPAQUE (255)
  1154  * \return 0 on success, or -1 if there is no rendering context current
  1155  */
  1156 extern DECLSPEC int SDL_SetRenderDrawColor(Uint8 r, Uint8 g, Uint8 b,
  1157                                            Uint8 a);
  1158 
  1159 /**
  1160  * \fn int SDL_GetRenderDrawColor(Uint8 * r, Uint8 * g, Uint8 * b, Uint8 * a)
  1161  *
  1162  * \brief Get the color used for drawing operations (Fill and Line).
  1163  *
  1164  * \param r A pointer to the red value used to draw on the rendering target
  1165  * \param g A pointer to the green value used to draw on the rendering target
  1166  * \param b A pointer to the blue value used to draw on the rendering target
  1167  * \param a A pointer to the alpha value used to draw on the rendering target, usually SDL_ALPHA_OPAQUE (255)
  1168  * \return 0 on success, or -1 if there is no rendering context current
  1169  */
  1170 extern DECLSPEC int SDL_GetRenderDrawColor(Uint8 * r, Uint8 * g, Uint8 * b,
  1171                                            Uint8 * a);
  1172 
  1173 /**
  1174  * \fn int SDL_SetRenderDrawBlendMode(int blendMode)
  1175  *
  1176  * \brief Set the blend mode used for drawing operations (Fill and Line).
  1177  *
  1178  * \param blendMode SDL_BlendMode to use for blending
  1179  *
  1180  * \return 0 on success, or -1 if there is no rendering context current
  1181  *
  1182  * \note If the blend mode is not supported, the closest supported mode is chosen.
  1183  *
  1184  * \sa SDL_SetRenderDrawBlendMode()
  1185  */
  1186 extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(int blendMode);
  1187 
  1188 /**
  1189  * \fn int SDL_GetRenderDrawBlendMode(int *blendMode)
  1190  *
  1191  * \brief Get the blend mode used for drawing operations
  1192  *
  1193  * \param blendMode A pointer filled in with the current blend mode
  1194  *
  1195  * \return 0 on success, or -1 if there is no rendering context current
  1196  *
  1197  * \sa SDL_SetRenderDrawBlendMode()
  1198  */
  1199 extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(int *blendMode);
  1200 
  1201 /**
  1202  * \fn int SDL_RenderPoint(int x, int y)
  1203  *
  1204  * \brief Draw a point on the current rendering target.
  1205  *
  1206  * \param x The x coordinate of the point
  1207  * \param y The y coordinate of the point
  1208  *
  1209  * \return 0 on success, or -1 if there is no rendering context current
  1210  */
  1211 extern DECLSPEC int SDLCALL SDL_RenderPoint(int x, int y);
  1212 
  1213 /**
  1214  * \fn int SDL_RenderLine(int x1, int y1, int x2, int y2)
  1215  *
  1216  * \brief Draw a line on the current rendering target.
  1217  *
  1218  * \param x1 The x coordinate of the start point
  1219  * \param y1 The y coordinate of the start point
  1220  * \param x2 The x coordinate of the end point
  1221  * \param y2 The y coordinate of the end point
  1222  *
  1223  * \return 0 on success, or -1 if there is no rendering context current
  1224  */
  1225 extern DECLSPEC int SDLCALL SDL_RenderLine(int x1, int y1, int x2, int y2);
  1226 
  1227 /**
  1228  * \fn void SDL_RenderFill(const SDL_Rect *rect)
  1229  *
  1230  * \brief Fill the current rendering target with the drawing color.
  1231  *
  1232  * \param rect A pointer to the destination rectangle, or NULL for the entire rendering target.
  1233  *
  1234  * \return 0 on success, or -1 if there is no rendering context current
  1235  */
  1236 extern DECLSPEC int SDLCALL SDL_RenderFill(const SDL_Rect * rect);
  1237 
  1238 /**
  1239  * \fn int SDL_RenderCopy(SDL_TextureID textureID, const SDL_Rect *srcrect, const SDL_Rect *dstrect)
  1240  *
  1241  * \brief Copy a portion of the texture to the current rendering target.
  1242  *
  1243  * \param texture The source texture.
  1244  * \param srcrect A pointer to the source rectangle, or NULL for the entire texture.
  1245  * \param dstrect A pointer to the destination rectangle, or NULL for the entire rendering target.
  1246  *
  1247  * \return 0 on success, or -1 if there is no rendering context current, or the driver doesn't support the requested operation.
  1248  */
  1249 extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_TextureID textureID,
  1250                                            const SDL_Rect * srcrect,
  1251                                            const SDL_Rect * dstrect);
  1252 
  1253 /**
  1254  * \fn int SDL_RenderReadPixels(const SDL_Rect *rect, void *pixels, int pitch)
  1255  *
  1256  * \brief Read pixels from the current rendering target.
  1257  *
  1258  * \param rect A pointer to the rectangle to read, or NULL for the entire render target
  1259  * \param pixels A pointer to be filled in with the pixel data in the rendering target format
  1260  * \param pitch The pitch of the pixels parameter
  1261  *
  1262  * \return 0 on success, or -1 if pixel reading is not supported.
  1263  *
  1264  * \warning This is a very slow operation, and should not be used frequently.
  1265  */
  1266 extern DECLSPEC int SDLCALL SDL_RenderReadPixels(const SDL_Rect * rect,
  1267                                                  void *pixels, int pitch);
  1268 
  1269 /**
  1270  * \fn int SDL_RenderWritePixels(const SDL_Rect *rect, const void *pixels, int pitch)
  1271  *
  1272  * \brief Write pixels to the current rendering target.
  1273  *
  1274  * \param rect A pointer to the rectangle to write, or NULL for the entire render target
  1275  * \param pixels A pointer to the pixel data to write
  1276  * \param pitch The pitch of the pixels parameter
  1277  *
  1278  * \return 0 on success, or -1 if pixel writing is not supported.
  1279  *
  1280  * \warning This is a very slow operation, and should not be used frequently.
  1281  */
  1282 extern DECLSPEC int SDLCALL SDL_RenderWritePixels(const SDL_Rect * rect,
  1283                                                   const void *pixels,
  1284                                                   int pitch);
  1285 
  1286 /**
  1287  * \fn void SDL_RenderPresent(void)
  1288  *
  1289  * \brief Update the screen with rendering performed.
  1290  */
  1291 extern DECLSPEC void SDLCALL SDL_RenderPresent(void);
  1292 
  1293 /**
  1294  * \fn void SDL_DestroyTexture(SDL_TextureID textureID);
  1295  *
  1296  * \brief Destroy the specified texture.
  1297  *
  1298  * \sa SDL_CreateTexture()
  1299  * \sa SDL_CreateTextureFromSurface()
  1300  */
  1301 extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_TextureID textureID);
  1302 
  1303 /**
  1304  * \fn void SDL_DestroyRenderer(SDL_WindowID windowID);
  1305  *
  1306  * \brief Destroy the rendering context for a window and free associated
  1307  *        textures.
  1308  *
  1309  * \sa SDL_CreateRenderer()
  1310  */
  1311 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_WindowID windowID);
  1312 
  1313 /**
  1314  * \fn SDL_bool SDL_IsScreenSaverEnabled();
  1315  *
  1316  * \brief Returns whether the screensaver is currently enabled (default off).
  1317  *
  1318  * \sa SDL_EnableScreenSaver()
  1319  * \sa SDL_DisableScreenSaver()
  1320  */
  1321 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
  1322 
  1323 /**
  1324  * \fn void SDL_EnableScreenSaver();
  1325  *
  1326  * \brief Allow the screen to be blanked by a screensaver
  1327  *
  1328  * \sa SDL_IsScreenSaverEnabled()
  1329  * \sa SDL_DisableScreenSaver()
  1330  */
  1331 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
  1332 
  1333 /**
  1334  * \fn void SDL_DisableScreenSaver();
  1335  *
  1336  * \brief Prevent the screen from being blanked by a screensaver
  1337  *
  1338  * \sa SDL_IsScreenSaverEnabled()
  1339  * \sa SDL_EnableScreenSaver()
  1340  */
  1341 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
  1342 
  1343 
  1344 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  1345 /* OpenGL support functions.                                                 */
  1346 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  1347 
  1348 /**
  1349  * \fn int SDL_GL_LoadLibrary(const char *path)
  1350  *
  1351  * \brief Dynamically load an OpenGL library.
  1352  *
  1353  * \param path The platform dependent OpenGL library name, or NULL to open the default OpenGL library
  1354  *
  1355  * \return 0 on success, or -1 if the library couldn't be loaded
  1356  *
  1357  * This should be done after initializing the video driver, but before
  1358  * creating any OpenGL windows.  If no OpenGL library is loaded, the default
  1359  * library will be loaded upon creation of the first OpenGL window.
  1360  *
  1361  * \note If you do this, you need to retrieve all of the GL functions used in
  1362  *       your program from the dynamic library using SDL_GL_GetProcAddress().
  1363  *
  1364  * \sa SDL_GL_GetProcAddress()
  1365  * \sa SDL_GL_UnloadLibrary()
  1366  */
  1367 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
  1368 
  1369 /**
  1370  * \fn void *SDL_GL_GetProcAddress(const char *proc)
  1371  *
  1372  * \brief Get the address of an OpenGL function.
  1373  */
  1374 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
  1375 
  1376 /**
  1377  * \fn void SDL_GL_UnloadLibrary(void)
  1378  *
  1379  * \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary()
  1380  *
  1381  * \sa SDL_GL_LoadLibrary()
  1382  */
  1383 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
  1384 
  1385 /**
  1386  * \fn SDL_bool SDL_GL_ExtensionSupported(const char *extension)
  1387  *
  1388  * \brief Return true if an OpenGL extension is supported for the current context.
  1389  */
  1390 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
  1391                                                            *extension);
  1392 
  1393 /**
  1394  * \fn int SDL_GL_SetAttribute(SDL_GLattr attr, int value)
  1395  *
  1396  * \brief Set an OpenGL window attribute before window creation.
  1397  */
  1398 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
  1399 
  1400 /**
  1401  * \fn int SDL_GL_GetWindowAttribute(SDL_WindowID windowID, SDL_GLattr attr, int *value)
  1402  *
  1403  * \brief Get the actual value for an attribute from the current context.
  1404  */
  1405 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
  1406 
  1407 /**
  1408  * \fn SDL_GLContext SDL_GL_CreateContext(SDL_WindowID windowID)
  1409  *
  1410  * \brief Create an OpenGL context for use with an OpenGL window, and make it current.
  1411  *
  1412  * \sa SDL_GL_DeleteContext()
  1413  */
  1414 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_WindowID
  1415                                                            windowID);
  1416 
  1417 /**
  1418  * \fn int SDL_GL_MakeCurrent(SDL_WindowID windowID, SDL_GLContext context)
  1419  *
  1420  * \brief Set up an OpenGL context for rendering into an OpenGL window.
  1421  *
  1422  * \note The context must have been created with a compatible window.
  1423  */
  1424 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_WindowID windowID,
  1425                                                SDL_GLContext context);
  1426 
  1427 /**
  1428  * \fn int SDL_GL_SetSwapInterval(int interval)
  1429  *
  1430  * \brief Set the swap interval for the current OpenGL context.
  1431  *
  1432  * \param interval 0 for immediate updates, 1 for updates synchronized with the vertical retrace
  1433  *
  1434  * \return 0 on success, or -1 if setting the swap interval is not supported.
  1435  *
  1436  * \sa SDL_GL_GetSwapInterval()
  1437  */
  1438 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
  1439 
  1440 /**
  1441  * \fn int SDL_GL_GetSwapInterval(void)
  1442  *
  1443  * \brief Get the swap interval for the current OpenGL context.
  1444  *
  1445  * \return 0 if there is no vertical retrace synchronization, 1 if the buffer swap is synchronized with the vertical retrace, and -1 if getting the swap interval is not supported.
  1446  *
  1447  * \sa SDL_GL_SetSwapInterval()
  1448  */
  1449 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
  1450 
  1451 /**
  1452  * \fn void SDL_GL_SwapWindow(SDL_WindowID windowID)
  1453  *
  1454  * \brief Swap the OpenGL buffers for the window, if double-buffering is supported.
  1455  */
  1456 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_WindowID windowID);
  1457 
  1458 /**
  1459  * \fn void SDL_GL_DeleteContext(SDL_GLContext context)
  1460  *
  1461  * \brief Delete an OpenGL context.
  1462  *
  1463  * \sa SDL_GL_CreateContext()
  1464  */
  1465 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
  1466 
  1467 
  1468 /* Ends C function definitions when using C++ */
  1469 #ifdef __cplusplus
  1470 /* *INDENT-OFF* */
  1471 }
  1472 /* *INDENT-ON* */
  1473 #endif
  1474 #include "close_code.h"
  1475 
  1476 #endif /* _SDL_video_h */
  1477 
  1478 /* vi: set ts=4 sw=4 expandtab: */