include/SDL_pixels.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 10 Sep 2007 12:20:02 +0000
changeset 2275 12ea0fdc0df2
parent 2257 340942cfda48
child 2673 24a6b3588eac
permissions -rw-r--r--
Split out the SDL_rect and SDL_surface functions into their own headers.
Removed unused count from the dirty rect list.
     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_pixels.h
    25  *
    26  * Header for the enumerated pixel format definitions
    27  */
    28 
    29 #ifndef _SDL_pixels_h
    30 #define _SDL_pixels_h
    31 
    32 #include "begin_code.h"
    33 /* Set up for C function definitions, even when using C++ */
    34 #ifdef __cplusplus
    35 /* *INDENT-OFF* */
    36 extern "C" {
    37 /* *INDENT-ON* */
    38 #endif
    39 
    40 /* Transparency definitions: These define alpha as the opacity of a surface */
    41 #define SDL_ALPHA_OPAQUE 255
    42 #define SDL_ALPHA_TRANSPARENT 0
    43 
    44 enum
    45 {                               /* Pixel type */
    46     SDL_PIXELTYPE_UNKNOWN,
    47     SDL_PIXELTYPE_INDEX1,
    48     SDL_PIXELTYPE_INDEX4,
    49     SDL_PIXELTYPE_INDEX8,
    50     SDL_PIXELTYPE_PACKED8,
    51     SDL_PIXELTYPE_PACKED16,
    52     SDL_PIXELTYPE_PACKED32,
    53     SDL_PIXELTYPE_ARRAYU8,
    54     SDL_PIXELTYPE_ARRAYU16,
    55     SDL_PIXELTYPE_ARRAYU32,
    56     SDL_PIXELTYPE_ARRAYF16,
    57     SDL_PIXELTYPE_ARRAYF32
    58 };
    59 
    60 enum
    61 {                               /* bitmap pixel order, high bit -> low bit */
    62     SDL_BITMAPORDER_NONE,
    63     SDL_BITMAPORDER_4321,
    64     SDL_BITMAPORDER_1234
    65 };
    66 enum
    67 {                               /* packed component order, high bit -> low bit */
    68     SDL_PACKEDORDER_NONE,
    69     SDL_PACKEDORDER_XRGB,
    70     SDL_PACKEDORDER_RGBX,
    71     SDL_PACKEDORDER_ARGB,
    72     SDL_PACKEDORDER_RGBA,
    73     SDL_PACKEDORDER_XBGR,
    74     SDL_PACKEDORDER_BGRX,
    75     SDL_PACKEDORDER_ABGR,
    76     SDL_PACKEDORDER_BGRA
    77 };
    78 enum
    79 {                               /* array component order, low byte -> high byte */
    80     SDL_ARRAYORDER_NONE,
    81     SDL_ARRAYORDER_RGB,
    82     SDL_ARRAYORDER_RGBA,
    83     SDL_ARRAYORDER_ARGB,
    84     SDL_ARRAYORDER_BGR,
    85     SDL_ARRAYORDER_BGRA,
    86     SDL_ARRAYORDER_ABGR
    87 };
    88 
    89 enum
    90 {                               /* Packed component layout */
    91     SDL_PACKEDLAYOUT_NONE,
    92     SDL_PACKEDLAYOUT_332,
    93     SDL_PACKEDLAYOUT_4444,
    94     SDL_PACKEDLAYOUT_1555,
    95     SDL_PACKEDLAYOUT_5551,
    96     SDL_PACKEDLAYOUT_565,
    97     SDL_PACKEDLAYOUT_8888,
    98     SDL_PACKEDLAYOUT_2101010,
    99     SDL_PACKEDLAYOUT_1010102
   100 };
   101 
   102 #define SDL_DEFINE_PIXELFOURCC(A, B, C, D) \
   103     ((A) | ((B) << 8) | ((C) << 16) | ((D) << 24))
   104 
   105 #define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes) \
   106     ((1 << 31) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \
   107      ((bits) << 8) | ((bytes) << 0))
   108 
   109 #define SDL_PIXELTYPE(X)	(((X) >> 24) & 0x0F)
   110 #define SDL_PIXELORDER(X)	(((X) >> 20) & 0x0F)
   111 #define SDL_PIXELLAYOUT(X)	(((X) >> 16) & 0x0F)
   112 #define SDL_BITSPERPIXEL(X)	(((X) >> 8) & 0xFF)
   113 #define SDL_BYTESPERPIXEL(X)	(((X) >> 0) & 0xFF)
   114 
   115 #define SDL_ISPIXELFORMAT_INDEXED(format)   \
   116     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \
   117      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \
   118      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8))
   119 
   120 #define SDL_ISPIXELFORMAT_FOURCC(format)    \
   121     ((format) && !((format) & 0x80000000))
   122 
   123 enum
   124 {
   125     SDL_PIXELFORMAT_UNKNOWN,
   126     SDL_PIXELFORMAT_INDEX1LSB =
   127         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
   128                                1, 0),
   129     SDL_PIXELFORMAT_INDEX1MSB =
   130         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_4321, 0,
   131                                1, 0),
   132     SDL_PIXELFORMAT_INDEX4LSB =
   133         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_1234, 0,
   134                                2, 0),
   135     SDL_PIXELFORMAT_INDEX4MSB =
   136         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
   137                                2, 0),
   138     SDL_PIXELFORMAT_INDEX8 =
   139         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX8, 0, 0, 8, 1),
   140     SDL_PIXELFORMAT_RGB332 =
   141         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED8, SDL_PACKEDORDER_XRGB,
   142                                SDL_PACKEDLAYOUT_332, 8, 1),
   143     SDL_PIXELFORMAT_RGB444 =
   144         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
   145                                SDL_PACKEDLAYOUT_4444, 12, 2),
   146     SDL_PIXELFORMAT_RGB555 =
   147         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
   148                                SDL_PACKEDLAYOUT_1555, 15, 2),
   149     SDL_PIXELFORMAT_ARGB4444 =
   150         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
   151                                SDL_PACKEDLAYOUT_4444, 16, 2),
   152     SDL_PIXELFORMAT_ARGB1555 =
   153         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
   154                                SDL_PACKEDLAYOUT_1555, 16, 2),
   155     SDL_PIXELFORMAT_RGB565 =
   156         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
   157                                SDL_PACKEDLAYOUT_565, 16, 2),
   158     SDL_PIXELFORMAT_RGB24 =
   159         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_RGB, 0,
   160                                24, 3),
   161     SDL_PIXELFORMAT_BGR24 =
   162         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_BGR, 0,
   163                                24, 3),
   164     SDL_PIXELFORMAT_RGB888 =
   165         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XRGB,
   166                                SDL_PACKEDLAYOUT_8888, 24, 4),
   167     SDL_PIXELFORMAT_BGR888 =
   168         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XBGR,
   169                                SDL_PACKEDLAYOUT_8888, 24, 4),
   170     SDL_PIXELFORMAT_ARGB8888 =
   171         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
   172                                SDL_PACKEDLAYOUT_8888, 32, 4),
   173     SDL_PIXELFORMAT_RGBA8888 =
   174         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBA,
   175                                SDL_PACKEDLAYOUT_8888, 32, 4),
   176     SDL_PIXELFORMAT_ABGR8888 =
   177         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ABGR,
   178                                SDL_PACKEDLAYOUT_8888, 32, 4),
   179     SDL_PIXELFORMAT_BGRA8888 =
   180         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRA,
   181                                SDL_PACKEDLAYOUT_8888, 32, 4),
   182     SDL_PIXELFORMAT_ARGB2101010 =
   183         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
   184                                SDL_PACKEDLAYOUT_2101010, 32, 4),
   185 
   186     SDL_PIXELFORMAT_YV12 =      /* Planar mode: Y + V + U  (3 planes) */
   187         SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
   188     SDL_PIXELFORMAT_IYUV =      /* Planar mode: Y + U + V  (3 planes) */
   189         SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
   190     SDL_PIXELFORMAT_YUY2 =      /* Packed mode: Y0+U0+Y1+V0 (1 plane) */
   191         SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
   192     SDL_PIXELFORMAT_UYVY =      /* Packed mode: U0+Y0+V0+Y1 (1 plane) */
   193         SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
   194     SDL_PIXELFORMAT_YVYU =      /* Packed mode: Y0+V0+Y1+U0 (1 plane) */
   195         SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U')
   196 };
   197 
   198 typedef struct SDL_Color
   199 {
   200     Uint8 r;
   201     Uint8 g;
   202     Uint8 b;
   203     Uint8 unused;
   204 } SDL_Color;
   205 #define SDL_Colour SDL_Color
   206 
   207 typedef struct SDL_Palette SDL_Palette;
   208 typedef int (*SDL_PaletteChangedFunc) (void *userdata, SDL_Palette * palette);
   209 
   210 typedef struct SDL_PaletteWatch
   211 {
   212     SDL_PaletteChangedFunc callback;
   213     void *userdata;
   214     struct SDL_PaletteWatch *next;
   215 } SDL_PaletteWatch;
   216 
   217 struct SDL_Palette
   218 {
   219     int ncolors;
   220     SDL_Color *colors;
   221 
   222     int refcount;
   223     SDL_PaletteWatch *watch;
   224 };
   225 
   226 /* Everything in the pixel format structure is read-only */
   227 typedef struct SDL_PixelFormat
   228 {
   229     SDL_Palette *palette;
   230     Uint8 BitsPerPixel;
   231     Uint8 BytesPerPixel;
   232     Uint8 Rloss;
   233     Uint8 Gloss;
   234     Uint8 Bloss;
   235     Uint8 Aloss;
   236     Uint8 Rshift;
   237     Uint8 Gshift;
   238     Uint8 Bshift;
   239     Uint8 Ashift;
   240     Uint32 Rmask;
   241     Uint32 Gmask;
   242     Uint32 Bmask;
   243     Uint32 Amask;
   244 } SDL_PixelFormat;
   245 
   246 /**
   247  * \fn SDL_bool SDL_PixelFormatEnumToMasks(Uint32 format, int *bpp, Uint32 * Rmask, Uint32 * Gmask, Uint32 * Bmask, Uint32 * Amask)
   248  *
   249  * \brief Convert one of the enumerated pixel formats to a bpp and RGBA masks.
   250  *
   251  * \return SDL_TRUE, or SDL_FALSE if the conversion wasn't possible.
   252  *
   253  * \sa SDL_MasksToPixelFormatEnum()
   254  */
   255 extern DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format,
   256                                                             int *bpp,
   257                                                             Uint32 * Rmask,
   258                                                             Uint32 * Gmask,
   259                                                             Uint32 * Bmask,
   260                                                             Uint32 * Amask);
   261 
   262 /**
   263  * \fn Uint32 SDL_MasksToPixelFormatEnum(int bpp, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)
   264  *
   265  * \brief Convert a bpp and RGBA masks to an enumerated pixel format.
   266  *
   267  * \return The pixel format, or SDL_PixelFormat_Unknown if the conversion wasn't possible.
   268  *
   269  * \sa SDL_PixelFormatEnumToMasks()
   270  */
   271 extern DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp,
   272                                                           Uint32 Rmask,
   273                                                           Uint32 Gmask,
   274                                                           Uint32 Bmask,
   275                                                           Uint32 Amask);
   276 
   277 /**
   278  * \fn SDL_Palette *SDL_AllocPalette(int ncolors)
   279  *
   280  * \brief Create a palette structure with the specified number of color entries.
   281  *
   282  * \return A new palette, or NULL if there wasn't enough memory
   283  *
   284  * \note The palette entries are initialized to white.
   285  *
   286  * \sa SDL_FreePalette()
   287  */
   288 extern DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors);
   289 
   290 /**
   291  * \fn int SDL_AddPaletteWatch(SDL_Palette *palette, SDL_PaletteChangedFunc callback, void *userdata)
   292  *
   293  * \brief Add a callback function which is called when the palette changes.
   294  *
   295  * \sa SDL_DelPaletteWatch()
   296  */
   297 extern DECLSPEC int SDLCALL SDL_AddPaletteWatch(SDL_Palette * palette,
   298                                                 SDL_PaletteChangedFunc
   299                                                 callback, void *userdata);
   300 
   301 /**
   302  * \fn void SDL_DelPaletteWatch(SDL_Palette *palette, SDL_PaletteChangedFunc callback, void *userdata)
   303  *
   304  * \brief Remove a callback function previously added with SDL_AddPaletteWatch()
   305  *
   306  * \sa SDL_AddPaletteWatch()
   307  */
   308 extern DECLSPEC void SDLCALL SDL_DelPaletteWatch(SDL_Palette * palette,
   309                                                  SDL_PaletteChangedFunc
   310                                                  callback, void *userdata);
   311 
   312 /**
   313  * \fn int SDL_SetPaletteColors(SDL_Palette *palette, const SDL_Colors *colors, int firstcolor, int numcolors)
   314  *
   315  * \brief Set a range of colors in a palette.
   316  *
   317  * \param palette The palette to modify
   318  * \param colors An array of colors to copy into the palette
   319  * \param firstcolor The index of the first palette entry to modify
   320  * \param ncolors The number of entries to modify
   321  *
   322  * \return 0 on success, or -1 if not all of the colors could be set
   323  */
   324 extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette,
   325                                                  const SDL_Color * colors,
   326                                                  int firstcolor, int ncolors);
   327 
   328 /**
   329  * \fn void SDL_FreePalette(SDL_Palette *palette)
   330  *
   331  * \brief Free a palette created with SDL_AllocPalette()
   332  *
   333  * \sa SDL_AllocPalette()
   334  */
   335 extern DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette * palette);
   336 
   337 /**
   338  * \fn Uint32 SDL_MapRGB(const SDL_PixelFormat *format,
   339  *                       Uint8 r, Uint8 g, Uint8 b)
   340  *
   341  * \brief Maps an RGB triple to an opaque pixel value for a given pixel format
   342  *
   343  * \sa SDL_MapRGBA
   344  */
   345 extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format,
   346                                           Uint8 r, Uint8 g, Uint8 b);
   347 
   348 /**
   349  * \fn Uint32 SDL_MapRGBA(const SDL_PixelFormat *fmt,
   350  *                        Uint8 r, Uint8 g, Uint8 b, Uint8 a)
   351  *
   352  * \brief Maps an RGBA quadruple to a pixel value for a given pixel format
   353  *
   354  * \sa SDL_MapRGB
   355  */
   356 extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format,
   357                                            Uint8 r, Uint8 g, Uint8 b,
   358                                            Uint8 a);
   359 
   360 /**
   361  * \fn void SDL_GetRGB(Uint32 pixel, const SDL_PixelFormat * format,
   362  *                     Uint8 * r, Uint8 * g, Uint8 * b)
   363  *
   364  * \brief Maps a pixel value into the RGB components for a given pixel format
   365  *
   366  * \sa SDL_GetRGBA
   367  */
   368 extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel,
   369                                         const SDL_PixelFormat * format,
   370                                         Uint8 * r, Uint8 * g, Uint8 * b);
   371 
   372 /**
   373  * \fn void SDL_GetRGBA(Uint32 pixel, const SDL_PixelFormat * format,
   374  *                      Uint8 * r, Uint8 * g, Uint8 * b, Uint8 * a)
   375  *
   376  * \brief Maps a pixel value into the RGBA components for a given pixel format
   377  *
   378  * \sa SDL_GetRGB
   379  */
   380 extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel,
   381                                          const SDL_PixelFormat * format,
   382                                          Uint8 * r, Uint8 * g, Uint8 * b,
   383                                          Uint8 * a);
   384 
   385 /* Ends C function definitions when using C++ */
   386 #ifdef __cplusplus
   387 /* *INDENT-OFF* */
   388 }
   389 /* *INDENT-ON* */
   390 #endif
   391 #include "close_code.h"
   392 
   393 #endif /* _SDL_pixels_h */
   394 
   395 /* vi: set ts=4 sw=4 expandtab: */