include/SDL_pixels.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 07 Feb 2009 17:56:08 +0000
changeset 3054 8d93bfecb9dc
parent 2859 99210400e8b9
child 3163 a252014ce27d
permissions -rw-r--r--
Fixed alpha blending textures with the GDI renderer
     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_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_ALPHA(format)   \
   121     ((SDL_PIXELORDER(format) == SDL_PACKEDORDER_ARGB) || \
   122      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_RGBA) || \
   123      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_ABGR) || \
   124      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_BGRA))
   125 
   126 #define SDL_ISPIXELFORMAT_FOURCC(format)    \
   127     ((format) && !((format) & 0x80000000))
   128 
   129 enum
   130 {
   131     SDL_PIXELFORMAT_UNKNOWN,
   132     SDL_PIXELFORMAT_INDEX1LSB =
   133         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
   134                                1, 0),
   135     SDL_PIXELFORMAT_INDEX1MSB =
   136         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_4321, 0,
   137                                1, 0),
   138     SDL_PIXELFORMAT_INDEX4LSB =
   139         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_1234, 0,
   140                                2, 0),
   141     SDL_PIXELFORMAT_INDEX4MSB =
   142         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
   143                                2, 0),
   144     SDL_PIXELFORMAT_INDEX8 =
   145         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX8, 0, 0, 8, 1),
   146     SDL_PIXELFORMAT_RGB332 =
   147         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED8, SDL_PACKEDORDER_XRGB,
   148                                SDL_PACKEDLAYOUT_332, 8, 1),
   149     SDL_PIXELFORMAT_RGB444 =
   150         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
   151                                SDL_PACKEDLAYOUT_4444, 12, 2),
   152     SDL_PIXELFORMAT_RGB555 =
   153         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
   154                                SDL_PACKEDLAYOUT_1555, 15, 2),
   155     SDL_PIXELFORMAT_BGR555 =
   156         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
   157                                SDL_PACKEDLAYOUT_1555, 15, 2),
   158     SDL_PIXELFORMAT_ARGB4444 =
   159         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
   160                                SDL_PACKEDLAYOUT_4444, 16, 2),
   161     SDL_PIXELFORMAT_ARGB1555 =
   162         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
   163                                SDL_PACKEDLAYOUT_1555, 16, 2),
   164     SDL_PIXELFORMAT_ABGR1555 =
   165         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
   166                                SDL_PACKEDLAYOUT_1555, 16, 2),
   167     SDL_PIXELFORMAT_RGB565 =
   168         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
   169                                SDL_PACKEDLAYOUT_565, 16, 2),
   170     SDL_PIXELFORMAT_RGB24 =
   171         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_RGB, 0,
   172                                24, 3),
   173     SDL_PIXELFORMAT_BGR24 =
   174         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_BGR, 0,
   175                                24, 3),
   176     SDL_PIXELFORMAT_RGB888 =
   177         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XRGB,
   178                                SDL_PACKEDLAYOUT_8888, 24, 4),
   179     SDL_PIXELFORMAT_BGR888 =
   180         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XBGR,
   181                                SDL_PACKEDLAYOUT_8888, 24, 4),
   182     SDL_PIXELFORMAT_ARGB8888 =
   183         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
   184                                SDL_PACKEDLAYOUT_8888, 32, 4),
   185     SDL_PIXELFORMAT_RGBA8888 =
   186         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBA,
   187                                SDL_PACKEDLAYOUT_8888, 32, 4),
   188     SDL_PIXELFORMAT_ABGR8888 =
   189         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ABGR,
   190                                SDL_PACKEDLAYOUT_8888, 32, 4),
   191     SDL_PIXELFORMAT_BGRA8888 =
   192         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRA,
   193                                SDL_PACKEDLAYOUT_8888, 32, 4),
   194     SDL_PIXELFORMAT_ARGB2101010 =
   195         SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
   196                                SDL_PACKEDLAYOUT_2101010, 32, 4),
   197 
   198     SDL_PIXELFORMAT_YV12 =      /* Planar mode: Y + V + U  (3 planes) */
   199         SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
   200     SDL_PIXELFORMAT_IYUV =      /* Planar mode: Y + U + V  (3 planes) */
   201         SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
   202     SDL_PIXELFORMAT_YUY2 =      /* Packed mode: Y0+U0+Y1+V0 (1 plane) */
   203         SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
   204     SDL_PIXELFORMAT_UYVY =      /* Packed mode: U0+Y0+V0+Y1 (1 plane) */
   205         SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
   206     SDL_PIXELFORMAT_YVYU =      /* Packed mode: Y0+V0+Y1+U0 (1 plane) */
   207         SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U')
   208 };
   209 
   210 typedef struct SDL_Color
   211 {
   212     Uint8 r;
   213     Uint8 g;
   214     Uint8 b;
   215     Uint8 unused;
   216 } SDL_Color;
   217 #define SDL_Colour SDL_Color
   218 
   219 typedef struct SDL_Palette SDL_Palette;
   220 typedef int (*SDL_PaletteChangedFunc) (void *userdata, SDL_Palette * palette);
   221 
   222 typedef struct SDL_PaletteWatch
   223 {
   224     SDL_PaletteChangedFunc callback;
   225     void *userdata;
   226     struct SDL_PaletteWatch *next;
   227 } SDL_PaletteWatch;
   228 
   229 struct SDL_Palette
   230 {
   231     int ncolors;
   232     SDL_Color *colors;
   233 
   234     int refcount;
   235     SDL_PaletteWatch *watch;
   236 };
   237 
   238 /* Everything in the pixel format structure is read-only */
   239 typedef struct SDL_PixelFormat
   240 {
   241     SDL_Palette *palette;
   242     Uint8 BitsPerPixel;
   243     Uint8 BytesPerPixel;
   244     Uint8 Rloss;
   245     Uint8 Gloss;
   246     Uint8 Bloss;
   247     Uint8 Aloss;
   248     Uint8 Rshift;
   249     Uint8 Gshift;
   250     Uint8 Bshift;
   251     Uint8 Ashift;
   252     Uint32 Rmask;
   253     Uint32 Gmask;
   254     Uint32 Bmask;
   255     Uint32 Amask;
   256 } SDL_PixelFormat;
   257 
   258 /**
   259  * \fn SDL_bool SDL_PixelFormatEnumToMasks(Uint32 format, int *bpp, Uint32 * Rmask, Uint32 * Gmask, Uint32 * Bmask, Uint32 * Amask)
   260  *
   261  * \brief Convert one of the enumerated pixel formats to a bpp and RGBA masks.
   262  *
   263  * \return SDL_TRUE, or SDL_FALSE if the conversion wasn't possible.
   264  *
   265  * \sa SDL_MasksToPixelFormatEnum()
   266  */
   267 extern DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format,
   268                                                             int *bpp,
   269                                                             Uint32 * Rmask,
   270                                                             Uint32 * Gmask,
   271                                                             Uint32 * Bmask,
   272                                                             Uint32 * Amask);
   273 
   274 /**
   275  * \fn Uint32 SDL_MasksToPixelFormatEnum(int bpp, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)
   276  *
   277  * \brief Convert a bpp and RGBA masks to an enumerated pixel format.
   278  *
   279  * \return The pixel format, or SDL_PixelFormat_Unknown if the conversion wasn't possible.
   280  *
   281  * \sa SDL_PixelFormatEnumToMasks()
   282  */
   283 extern DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp,
   284                                                           Uint32 Rmask,
   285                                                           Uint32 Gmask,
   286                                                           Uint32 Bmask,
   287                                                           Uint32 Amask);
   288 
   289 /**
   290  * \fn SDL_Palette *SDL_AllocPalette(int ncolors)
   291  *
   292  * \brief Create a palette structure with the specified number of color entries.
   293  *
   294  * \return A new palette, or NULL if there wasn't enough memory
   295  *
   296  * \note The palette entries are initialized to white.
   297  *
   298  * \sa SDL_FreePalette()
   299  */
   300 extern DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors);
   301 
   302 /**
   303  * \fn int SDL_AddPaletteWatch(SDL_Palette *palette, SDL_PaletteChangedFunc callback, void *userdata)
   304  *
   305  * \brief Add a callback function which is called when the palette changes.
   306  *
   307  * \sa SDL_DelPaletteWatch()
   308  */
   309 extern DECLSPEC int SDLCALL SDL_AddPaletteWatch(SDL_Palette * palette,
   310                                                 SDL_PaletteChangedFunc
   311                                                 callback, void *userdata);
   312 
   313 /**
   314  * \fn void SDL_DelPaletteWatch(SDL_Palette *palette, SDL_PaletteChangedFunc callback, void *userdata)
   315  *
   316  * \brief Remove a callback function previously added with SDL_AddPaletteWatch()
   317  *
   318  * \sa SDL_AddPaletteWatch()
   319  */
   320 extern DECLSPEC void SDLCALL SDL_DelPaletteWatch(SDL_Palette * palette,
   321                                                  SDL_PaletteChangedFunc
   322                                                  callback, void *userdata);
   323 
   324 /**
   325  * \fn int SDL_SetPaletteColors(SDL_Palette *palette, const SDL_Colors *colors, int firstcolor, int numcolors)
   326  *
   327  * \brief Set a range of colors in a palette.
   328  *
   329  * \param palette The palette to modify
   330  * \param colors An array of colors to copy into the palette
   331  * \param firstcolor The index of the first palette entry to modify
   332  * \param ncolors The number of entries to modify
   333  *
   334  * \return 0 on success, or -1 if not all of the colors could be set
   335  */
   336 extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette,
   337                                                  const SDL_Color * colors,
   338                                                  int firstcolor, int ncolors);
   339 
   340 /**
   341  * \fn void SDL_FreePalette(SDL_Palette *palette)
   342  *
   343  * \brief Free a palette created with SDL_AllocPalette()
   344  *
   345  * \sa SDL_AllocPalette()
   346  */
   347 extern DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette * palette);
   348 
   349 /**
   350  * \fn Uint32 SDL_MapRGB(const SDL_PixelFormat *format,
   351  *                       Uint8 r, Uint8 g, Uint8 b)
   352  *
   353  * \brief Maps an RGB triple to an opaque pixel value for a given pixel format
   354  *
   355  * \sa SDL_MapRGBA
   356  */
   357 extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format,
   358                                           Uint8 r, Uint8 g, Uint8 b);
   359 
   360 /**
   361  * \fn Uint32 SDL_MapRGBA(const SDL_PixelFormat *fmt,
   362  *                        Uint8 r, Uint8 g, Uint8 b, Uint8 a)
   363  *
   364  * \brief Maps an RGBA quadruple to a pixel value for a given pixel format
   365  *
   366  * \sa SDL_MapRGB
   367  */
   368 extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format,
   369                                            Uint8 r, Uint8 g, Uint8 b,
   370                                            Uint8 a);
   371 
   372 /**
   373  * \fn void SDL_GetRGB(Uint32 pixel, const SDL_PixelFormat * format,
   374  *                     Uint8 * r, Uint8 * g, Uint8 * b)
   375  *
   376  * \brief Maps a pixel value into the RGB components for a given pixel format
   377  *
   378  * \sa SDL_GetRGBA
   379  */
   380 extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel,
   381                                         const SDL_PixelFormat * format,
   382                                         Uint8 * r, Uint8 * g, Uint8 * b);
   383 
   384 /**
   385  * \fn void SDL_GetRGBA(Uint32 pixel, const SDL_PixelFormat * format,
   386  *                      Uint8 * r, Uint8 * g, Uint8 * b, Uint8 * a)
   387  *
   388  * \brief Maps a pixel value into the RGBA components for a given pixel format
   389  *
   390  * \sa SDL_GetRGB
   391  */
   392 extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel,
   393                                          const SDL_PixelFormat * format,
   394                                          Uint8 * r, Uint8 * g, Uint8 * b,
   395                                          Uint8 * a);
   396 
   397 /* Ends C function definitions when using C++ */
   398 #ifdef __cplusplus
   399 /* *INDENT-OFF* */
   400 }
   401 /* *INDENT-ON* */
   402 #endif
   403 #include "close_code.h"
   404 
   405 #endif /* _SDL_pixels_h */
   406 
   407 /* vi: set ts=4 sw=4 expandtab: */