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