include/SDL_pixels.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 15 Feb 2013 08:47:44 -0800
changeset 6885 700f1b25f77f
parent 6683 b1124b32b07d
child 7024 72cb3e205571
permissions -rw-r--r--
Happy New Year!
slouken@1895
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
slouken@1895
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@1895
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@1895
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@1895
    20
*/
slouken@1895
    21
slouken@1895
    22
/**
slouken@3407
    23
 *  \file SDL_pixels.h
slouken@3407
    24
 *  
slouken@3407
    25
 *  Header for the enumerated pixel format definitions.
slouken@1895
    26
 */
slouken@1895
    27
slouken@1895
    28
#ifndef _SDL_pixels_h
slouken@1895
    29
#define _SDL_pixels_h
slouken@1895
    30
slouken@1895
    31
#include "begin_code.h"
slouken@1895
    32
/* Set up for C function definitions, even when using C++ */
slouken@1895
    33
#ifdef __cplusplus
slouken@1895
    34
/* *INDENT-OFF* */
slouken@1895
    35
extern "C" {
slouken@1895
    36
/* *INDENT-ON* */
slouken@1895
    37
#endif
slouken@1895
    38
slouken@3407
    39
/**
slouken@3407
    40
 *  \name Transparency definitions
slouken@3407
    41
 *  
slouken@3407
    42
 *  These define alpha as the opacity of a surface.
slouken@3407
    43
 */
slouken@3407
    44
/*@{*/
slouken@2275
    45
#define SDL_ALPHA_OPAQUE 255
slouken@2275
    46
#define SDL_ALPHA_TRANSPARENT 0
slouken@3407
    47
/*@}*/
slouken@2275
    48
slouken@3407
    49
/** Pixel type. */
slouken@1895
    50
enum
slouken@3407
    51
{
slouken@1965
    52
    SDL_PIXELTYPE_UNKNOWN,
slouken@1965
    53
    SDL_PIXELTYPE_INDEX1,
slouken@1965
    54
    SDL_PIXELTYPE_INDEX4,
slouken@1965
    55
    SDL_PIXELTYPE_INDEX8,
slouken@1965
    56
    SDL_PIXELTYPE_PACKED8,
slouken@1965
    57
    SDL_PIXELTYPE_PACKED16,
slouken@1965
    58
    SDL_PIXELTYPE_PACKED32,
slouken@1965
    59
    SDL_PIXELTYPE_ARRAYU8,
slouken@1965
    60
    SDL_PIXELTYPE_ARRAYU16,
slouken@1965
    61
    SDL_PIXELTYPE_ARRAYU32,
slouken@1965
    62
    SDL_PIXELTYPE_ARRAYF16,
slouken@2208
    63
    SDL_PIXELTYPE_ARRAYF32
slouken@1895
    64
};
slouken@1895
    65
slouken@3407
    66
/** Bitmap pixel order, high bit -> low bit. */
slouken@1895
    67
enum
slouken@3407
    68
{
slouken@1965
    69
    SDL_BITMAPORDER_NONE,
slouken@1965
    70
    SDL_BITMAPORDER_4321,
slouken@2208
    71
    SDL_BITMAPORDER_1234
slouken@1895
    72
};
slouken@3407
    73
slouken@3407
    74
/** Packed component order, high bit -> low bit. */
slouken@1895
    75
enum
slouken@3407
    76
{
slouken@1965
    77
    SDL_PACKEDORDER_NONE,
slouken@1965
    78
    SDL_PACKEDORDER_XRGB,
slouken@1965
    79
    SDL_PACKEDORDER_RGBX,
slouken@1965
    80
    SDL_PACKEDORDER_ARGB,
slouken@1965
    81
    SDL_PACKEDORDER_RGBA,
slouken@1965
    82
    SDL_PACKEDORDER_XBGR,
slouken@1965
    83
    SDL_PACKEDORDER_BGRX,
slouken@1965
    84
    SDL_PACKEDORDER_ABGR,
slouken@2208
    85
    SDL_PACKEDORDER_BGRA
slouken@1895
    86
};
slouken@3407
    87
slouken@3407
    88
/** Array component order, low byte -> high byte. */
slouken@1895
    89
enum
slouken@3407
    90
{
slouken@1965
    91
    SDL_ARRAYORDER_NONE,
slouken@1965
    92
    SDL_ARRAYORDER_RGB,
slouken@1965
    93
    SDL_ARRAYORDER_RGBA,
slouken@1965
    94
    SDL_ARRAYORDER_ARGB,
slouken@1965
    95
    SDL_ARRAYORDER_BGR,
slouken@1965
    96
    SDL_ARRAYORDER_BGRA,
slouken@2208
    97
    SDL_ARRAYORDER_ABGR
slouken@1895
    98
};
slouken@1895
    99
slouken@3407
   100
/** Packed component layout. */
slouken@1895
   101
enum
slouken@3407
   102
{
slouken@1965
   103
    SDL_PACKEDLAYOUT_NONE,
slouken@1965
   104
    SDL_PACKEDLAYOUT_332,
slouken@1965
   105
    SDL_PACKEDLAYOUT_4444,
slouken@1965
   106
    SDL_PACKEDLAYOUT_1555,
slouken@1965
   107
    SDL_PACKEDLAYOUT_5551,
slouken@1965
   108
    SDL_PACKEDLAYOUT_565,
slouken@1965
   109
    SDL_PACKEDLAYOUT_8888,
slouken@1965
   110
    SDL_PACKEDLAYOUT_2101010,
slouken@2208
   111
    SDL_PACKEDLAYOUT_1010102
slouken@1895
   112
};
slouken@1895
   113
slouken@4492
   114
#define SDL_DEFINE_PIXELFOURCC(A, B, C, D) SDL_FOURCC(A, B, C, D)
slouken@1895
   115
slouken@1895
   116
#define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes) \
slouken@6683
   117
    ((1 << 28) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \
slouken@1895
   118
     ((bits) << 8) | ((bytes) << 0))
slouken@1895
   119
slouken@6683
   120
#define SDL_PIXELFLAG(X)	(((X) >> 28) & 0x0F)
slouken@1895
   121
#define SDL_PIXELTYPE(X)	(((X) >> 24) & 0x0F)
slouken@1895
   122
#define SDL_PIXELORDER(X)	(((X) >> 20) & 0x0F)
slouken@1895
   123
#define SDL_PIXELLAYOUT(X)	(((X) >> 16) & 0x0F)
slouken@1895
   124
#define SDL_BITSPERPIXEL(X)	(((X) >> 8) & 0xFF)
slouken@5156
   125
#define SDL_BYTESPERPIXEL(X) \
slouken@5156
   126
    (SDL_ISPIXELFORMAT_FOURCC(X) ? \
slouken@5264
   127
        ((((X) == SDL_PIXELFORMAT_YUY2) || \
slouken@5156
   128
          ((X) == SDL_PIXELFORMAT_UYVY) || \
slouken@5156
   129
          ((X) == SDL_PIXELFORMAT_YVYU)) ? 2 : 1) : (((X) >> 0) & 0xFF))
slouken@1895
   130
slouken@1895
   131
#define SDL_ISPIXELFORMAT_INDEXED(format)   \
slouken@5156
   132
    (!SDL_ISPIXELFORMAT_FOURCC(format) && \
slouken@5156
   133
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \
slouken@5156
   134
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \
slouken@5156
   135
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8)))
slouken@1895
   136
slouken@3054
   137
#define SDL_ISPIXELFORMAT_ALPHA(format)   \
slouken@5156
   138
    (!SDL_ISPIXELFORMAT_FOURCC(format) && \
slouken@5156
   139
     ((SDL_PIXELORDER(format) == SDL_PACKEDORDER_ARGB) || \
slouken@5156
   140
      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_RGBA) || \
slouken@5156
   141
      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_ABGR) || \
slouken@5156
   142
      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_BGRA)))
slouken@3054
   143
slouken@6683
   144
/* The flag is set to 1 because 0x1? is not in the printable ASCII range */
slouken@1895
   145
#define SDL_ISPIXELFORMAT_FOURCC(format)    \
slouken@6683
   146
    ((format) && (SDL_PIXELFLAG(format) != 1))
slouken@1895
   147
slouken@4982
   148
/* Note: If you modify this list, update SDL_GetPixelFormatName() */
slouken@1895
   149
enum
slouken@1895
   150
{
slouken@1965
   151
    SDL_PIXELFORMAT_UNKNOWN,
slouken@1965
   152
    SDL_PIXELFORMAT_INDEX1LSB =
slouken@5438
   153
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_4321, 0,
slouken@5438
   154
                               1, 0),
slouken@5438
   155
    SDL_PIXELFORMAT_INDEX1MSB =
slouken@1965
   156
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
slouken@1895
   157
                               1, 0),
slouken@1965
   158
    SDL_PIXELFORMAT_INDEX4LSB =
slouken@5438
   159
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
slouken@3177
   160
                               4, 0),
slouken@1965
   161
    SDL_PIXELFORMAT_INDEX4MSB =
slouken@5438
   162
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_1234, 0,
slouken@3177
   163
                               4, 0),
slouken@1965
   164
    SDL_PIXELFORMAT_INDEX8 =
slouken@1965
   165
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX8, 0, 0, 8, 1),
slouken@1965
   166
    SDL_PIXELFORMAT_RGB332 =
slouken@1965
   167
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED8, SDL_PACKEDORDER_XRGB,
slouken@1965
   168
                               SDL_PACKEDLAYOUT_332, 8, 1),
slouken@1965
   169
    SDL_PIXELFORMAT_RGB444 =
slouken@1965
   170
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
slouken@1965
   171
                               SDL_PACKEDLAYOUT_4444, 12, 2),
slouken@1965
   172
    SDL_PIXELFORMAT_RGB555 =
slouken@1965
   173
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
slouken@1965
   174
                               SDL_PACKEDLAYOUT_1555, 15, 2),
slouken@2735
   175
    SDL_PIXELFORMAT_BGR555 =
slouken@2735
   176
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
slouken@2735
   177
                               SDL_PACKEDLAYOUT_1555, 15, 2),
slouken@1965
   178
    SDL_PIXELFORMAT_ARGB4444 =
slouken@1965
   179
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
slouken@1965
   180
                               SDL_PACKEDLAYOUT_4444, 16, 2),
slouken@4982
   181
    SDL_PIXELFORMAT_RGBA4444 =
slouken@4982
   182
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
slouken@4982
   183
                               SDL_PACKEDLAYOUT_4444, 16, 2),
lestat@3163
   184
    SDL_PIXELFORMAT_ABGR4444 =
lestat@3163
   185
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
lestat@3163
   186
                               SDL_PACKEDLAYOUT_4444, 16, 2),
slouken@4982
   187
    SDL_PIXELFORMAT_BGRA4444 =
slouken@4982
   188
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
slouken@4982
   189
                               SDL_PACKEDLAYOUT_4444, 16, 2),
slouken@1965
   190
    SDL_PIXELFORMAT_ARGB1555 =
slouken@1965
   191
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
slouken@1965
   192
                               SDL_PACKEDLAYOUT_1555, 16, 2),
slouken@4982
   193
    SDL_PIXELFORMAT_RGBA5551 =
slouken@4982
   194
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
slouken@4982
   195
                               SDL_PACKEDLAYOUT_5551, 16, 2),
slouken@2735
   196
    SDL_PIXELFORMAT_ABGR1555 =
slouken@2735
   197
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
slouken@2735
   198
                               SDL_PACKEDLAYOUT_1555, 16, 2),
slouken@4982
   199
    SDL_PIXELFORMAT_BGRA5551 =
slouken@4982
   200
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
slouken@4982
   201
                               SDL_PACKEDLAYOUT_5551, 16, 2),
slouken@1965
   202
    SDL_PIXELFORMAT_RGB565 =
slouken@1965
   203
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
slouken@1965
   204
                               SDL_PACKEDLAYOUT_565, 16, 2),
lestat@3163
   205
    SDL_PIXELFORMAT_BGR565 =
lestat@3163
   206
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
lestat@3163
   207
                               SDL_PACKEDLAYOUT_565, 16, 2),
slouken@1965
   208
    SDL_PIXELFORMAT_RGB24 =
slouken@1965
   209
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_RGB, 0,
slouken@1895
   210
                               24, 3),
slouken@1965
   211
    SDL_PIXELFORMAT_BGR24 =
slouken@1965
   212
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_BGR, 0,
slouken@1895
   213
                               24, 3),
slouken@1965
   214
    SDL_PIXELFORMAT_RGB888 =
slouken@1965
   215
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XRGB,
slouken@1965
   216
                               SDL_PACKEDLAYOUT_8888, 24, 4),
slouken@6074
   217
    SDL_PIXELFORMAT_RGBX8888 =
slouken@6074
   218
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBX,
slouken@6074
   219
                               SDL_PACKEDLAYOUT_8888, 24, 4),
slouken@1965
   220
    SDL_PIXELFORMAT_BGR888 =
slouken@1965
   221
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XBGR,
slouken@1965
   222
                               SDL_PACKEDLAYOUT_8888, 24, 4),
slouken@6074
   223
    SDL_PIXELFORMAT_BGRX8888 =
slouken@6074
   224
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRX,
slouken@6074
   225
                               SDL_PACKEDLAYOUT_8888, 24, 4),
slouken@1965
   226
    SDL_PIXELFORMAT_ARGB8888 =
slouken@1965
   227
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
slouken@1965
   228
                               SDL_PACKEDLAYOUT_8888, 32, 4),
slouken@1965
   229
    SDL_PIXELFORMAT_RGBA8888 =
slouken@1965
   230
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBA,
slouken@1965
   231
                               SDL_PACKEDLAYOUT_8888, 32, 4),
slouken@1965
   232
    SDL_PIXELFORMAT_ABGR8888 =
slouken@1965
   233
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ABGR,
slouken@1965
   234
                               SDL_PACKEDLAYOUT_8888, 32, 4),
slouken@1965
   235
    SDL_PIXELFORMAT_BGRA8888 =
slouken@1965
   236
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRA,
slouken@1965
   237
                               SDL_PACKEDLAYOUT_8888, 32, 4),
slouken@1965
   238
    SDL_PIXELFORMAT_ARGB2101010 =
slouken@1965
   239
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
slouken@1965
   240
                               SDL_PACKEDLAYOUT_2101010, 32, 4),
slouken@1895
   241
slouken@3407
   242
    SDL_PIXELFORMAT_YV12 =      /**< Planar mode: Y + V + U  (3 planes) */
slouken@1895
   243
        SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
slouken@3407
   244
    SDL_PIXELFORMAT_IYUV =      /**< Planar mode: Y + U + V  (3 planes) */
slouken@1895
   245
        SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
slouken@3407
   246
    SDL_PIXELFORMAT_YUY2 =      /**< Packed mode: Y0+U0+Y1+V0 (1 plane) */
slouken@1895
   247
        SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
slouken@3407
   248
    SDL_PIXELFORMAT_UYVY =      /**< Packed mode: U0+Y0+V0+Y1 (1 plane) */
slouken@1895
   249
        SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
slouken@3407
   250
    SDL_PIXELFORMAT_YVYU =      /**< Packed mode: Y0+V0+Y1+U0 (1 plane) */
slouken@2208
   251
        SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U')
slouken@1895
   252
};
slouken@1895
   253
slouken@1895
   254
typedef struct SDL_Color
slouken@1895
   255
{
slouken@1895
   256
    Uint8 r;
slouken@1895
   257
    Uint8 g;
slouken@1895
   258
    Uint8 b;
slouken@1895
   259
    Uint8 unused;
slouken@1895
   260
} SDL_Color;
slouken@1895
   261
#define SDL_Colour SDL_Color
slouken@1895
   262
slouken@5288
   263
typedef struct SDL_Palette
slouken@1895
   264
{
slouken@1895
   265
    int ncolors;
slouken@1895
   266
    SDL_Color *colors;
slouken@5288
   267
    Uint32 version;
slouken@1895
   268
    int refcount;
slouken@5288
   269
} SDL_Palette;
slouken@1895
   270
slouken@3407
   271
/**
slouken@3407
   272
 *  \note Everything in the pixel format structure is read-only.
slouken@3407
   273
 */
slouken@1895
   274
typedef struct SDL_PixelFormat
slouken@1895
   275
{
slouken@5288
   276
    Uint32 format;
slouken@1895
   277
    SDL_Palette *palette;
slouken@1895
   278
    Uint8 BitsPerPixel;
slouken@1895
   279
    Uint8 BytesPerPixel;
slouken@5434
   280
    Uint8 padding[2];
slouken@5434
   281
    Uint32 Rmask;
slouken@5434
   282
    Uint32 Gmask;
slouken@5434
   283
    Uint32 Bmask;
slouken@5434
   284
    Uint32 Amask;
slouken@1895
   285
    Uint8 Rloss;
slouken@1895
   286
    Uint8 Gloss;
slouken@1895
   287
    Uint8 Bloss;
slouken@1895
   288
    Uint8 Aloss;
slouken@1895
   289
    Uint8 Rshift;
slouken@1895
   290
    Uint8 Gshift;
slouken@1895
   291
    Uint8 Bshift;
slouken@1895
   292
    Uint8 Ashift;
slouken@5288
   293
    int refcount;
slouken@5288
   294
    struct SDL_PixelFormat *next;
slouken@1895
   295
} SDL_PixelFormat;
slouken@1895
   296
slouken@1895
   297
/**
slouken@4982
   298
 * \brief Get the human readable name of a pixel format
slouken@4982
   299
 */
slouken@4982
   300
extern DECLSPEC const char* SDLCALL SDL_GetPixelFormatName(Uint32 format);
slouken@4982
   301
slouken@4982
   302
/**
slouken@3407
   303
 *  \brief Convert one of the enumerated pixel formats to a bpp and RGBA masks.
slouken@3407
   304
 *  
slouken@3407
   305
 *  \return SDL_TRUE, or SDL_FALSE if the conversion wasn't possible.
slouken@3407
   306
 *  
slouken@3407
   307
 *  \sa SDL_MasksToPixelFormatEnum()
slouken@1895
   308
 */
slouken@1895
   309
extern DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format,
slouken@1895
   310
                                                            int *bpp,
slouken@1895
   311
                                                            Uint32 * Rmask,
slouken@1895
   312
                                                            Uint32 * Gmask,
slouken@1895
   313
                                                            Uint32 * Bmask,
slouken@1895
   314
                                                            Uint32 * Amask);
slouken@1895
   315
slouken@1895
   316
/**
slouken@3407
   317
 *  \brief Convert a bpp and RGBA masks to an enumerated pixel format.
slouken@3407
   318
 *  
slouken@3407
   319
 *  \return The pixel format, or ::SDL_PIXELFORMAT_UNKNOWN if the conversion 
slouken@3407
   320
 *          wasn't possible.
slouken@3407
   321
 *  
slouken@3407
   322
 *  \sa SDL_PixelFormatEnumToMasks()
slouken@1895
   323
 */
slouken@1895
   324
extern DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp,
slouken@1895
   325
                                                          Uint32 Rmask,
slouken@1895
   326
                                                          Uint32 Gmask,
slouken@1895
   327
                                                          Uint32 Bmask,
slouken@1895
   328
                                                          Uint32 Amask);
slouken@1895
   329
slouken@1895
   330
/**
slouken@5288
   331
 *  \brief Create an SDL_PixelFormat structure from a pixel format enum.
slouken@5288
   332
 */
slouken@5288
   333
extern DECLSPEC SDL_PixelFormat * SDLCALL SDL_AllocFormat(Uint32 pixel_format);
slouken@5288
   334
slouken@5288
   335
/**
slouken@5288
   336
 *  \brief Free an SDL_PixelFormat structure.
slouken@5288
   337
 */
slouken@5288
   338
extern DECLSPEC void SDLCALL SDL_FreeFormat(SDL_PixelFormat *format);
slouken@5288
   339
slouken@5288
   340
/**
slouken@3407
   341
 *  \brief Create a palette structure with the specified number of color 
slouken@3407
   342
 *         entries.
slouken@3407
   343
 *  
slouken@3407
   344
 *  \return A new palette, or NULL if there wasn't enough memory.
slouken@3407
   345
 *  
slouken@3407
   346
 *  \note The palette entries are initialized to white.
slouken@3407
   347
 *  
slouken@3407
   348
 *  \sa SDL_FreePalette()
slouken@1895
   349
 */
slouken@1895
   350
extern DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors);
slouken@1895
   351
slouken@1895
   352
/**
slouken@5288
   353
 *  \brief Set the palette for a pixel format structure.
slouken@1895
   354
 */
slouken@5288
   355
extern DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat * format,
slouken@5288
   356
                                                      SDL_Palette *palette);
slouken@1895
   357
slouken@1895
   358
/**
slouken@3407
   359
 *  \brief Set a range of colors in a palette.
slouken@3407
   360
 *  
slouken@3407
   361
 *  \param palette    The palette to modify.
slouken@3407
   362
 *  \param colors     An array of colors to copy into the palette.
slouken@3407
   363
 *  \param firstcolor The index of the first palette entry to modify.
slouken@3407
   364
 *  \param ncolors    The number of entries to modify.
slouken@3407
   365
 *  
slouken@3407
   366
 *  \return 0 on success, or -1 if not all of the colors could be set.
slouken@1895
   367
 */
slouken@1895
   368
extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette,
slouken@1895
   369
                                                 const SDL_Color * colors,
slouken@1895
   370
                                                 int firstcolor, int ncolors);
slouken@1895
   371
slouken@1895
   372
/**
slouken@3407
   373
 *  \brief Free a palette created with SDL_AllocPalette().
slouken@3407
   374
 *  
slouken@3407
   375
 *  \sa SDL_AllocPalette()
slouken@1895
   376
 */
slouken@1895
   377
extern DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette * palette);
slouken@1895
   378
slouken@2275
   379
/**
slouken@3407
   380
 *  \brief Maps an RGB triple to an opaque pixel value for a given pixel format.
slouken@3407
   381
 *  
slouken@3407
   382
 *  \sa SDL_MapRGBA
slouken@2275
   383
 */
slouken@2275
   384
extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format,
slouken@2275
   385
                                          Uint8 r, Uint8 g, Uint8 b);
slouken@2275
   386
slouken@2275
   387
/**
slouken@3407
   388
 *  \brief Maps an RGBA quadruple to a pixel value for a given pixel format.
slouken@3407
   389
 *  
slouken@3407
   390
 *  \sa SDL_MapRGB
slouken@2275
   391
 */
slouken@2275
   392
extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format,
slouken@2275
   393
                                           Uint8 r, Uint8 g, Uint8 b,
slouken@2275
   394
                                           Uint8 a);
slouken@2275
   395
slouken@2275
   396
/**
slouken@3483
   397
 *  \brief Get the RGB components from a pixel of the specified format.
slouken@3407
   398
 *  
slouken@3407
   399
 *  \sa SDL_GetRGBA
slouken@2275
   400
 */
slouken@2275
   401
extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel,
slouken@2275
   402
                                        const SDL_PixelFormat * format,
slouken@2275
   403
                                        Uint8 * r, Uint8 * g, Uint8 * b);
slouken@2275
   404
slouken@2275
   405
/**
slouken@3483
   406
 *  \brief Get the RGBA components from a pixel of the specified format.
slouken@3407
   407
 *  
slouken@3407
   408
 *  \sa SDL_GetRGB
slouken@2275
   409
 */
slouken@2275
   410
extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel,
slouken@2275
   411
                                         const SDL_PixelFormat * format,
slouken@2275
   412
                                         Uint8 * r, Uint8 * g, Uint8 * b,
slouken@2275
   413
                                         Uint8 * a);
slouken@2275
   414
slouken@5466
   415
/**
slouken@5466
   416
 *  \brief Calculate a 256 entry gamma ramp for a gamma value.
slouken@5466
   417
 */
slouken@5466
   418
extern DECLSPEC void SDLCALL SDL_CalculateGammaRamp(float gamma, Uint16 * ramp);
slouken@5466
   419
slouken@5466
   420
slouken@1895
   421
/* Ends C function definitions when using C++ */
slouken@1895
   422
#ifdef __cplusplus
slouken@1895
   423
/* *INDENT-OFF* */
slouken@1895
   424
}
slouken@1895
   425
/* *INDENT-ON* */
slouken@1895
   426
#endif
slouken@1895
   427
#include "close_code.h"
slouken@1895
   428
slouken@1895
   429
#endif /* _SDL_pixels_h */
slouken@1895
   430
slouken@1895
   431
/* vi: set ts=4 sw=4 expandtab: */