include/SDL_pixels.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 19 Oct 2009 13:31:58 +0000
changeset 3407 d3baf5ac4e37
parent 3177 efe3b3971e4f
child 3483 a54df8e52333
permissions -rw-r--r--
Partial fix for bug #859

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