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