include/SDL_pixels.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 31 May 2015 01:45:20 -0400
changeset 9687 ad9917a91c06
parent 9619 b94b6d0bff0f
child 9998 f67cf37e9cd4
permissions -rw-r--r--
Fixed SDL_ISPIXELFORMAT_ALPHA to check pixel orders that match pixel type.

Otherwise, SDL_PIXELFORMAT_BGR24 is reported as having alpha, because
its SDL_ARRAYORDER_BGR pixel order uses the same integer value as
SDL_PACKEDORDER_RGBA, since we weren't checking the pixel type to
differentiate.

Fixes Bugzilla #2977.
slouken@1895
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@9619
     3
  Copyright (C) 1997-2015 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@7191
    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
icculus@8175
    31
#include "SDL_stdinc.h"
icculus@8175
    32
slouken@1895
    33
#include "begin_code.h"
slouken@1895
    34
/* Set up for C function definitions, even when using C++ */
slouken@1895
    35
#ifdef __cplusplus
slouken@1895
    36
extern "C" {
slouken@1895
    37
#endif
slouken@1895
    38
slouken@3407
    39
/**
slouken@3407
    40
 *  \name Transparency definitions
slouken@7191
    41
 *
slouken@3407
    42
 *  These define alpha as the opacity of a surface.
slouken@3407
    43
 */
gabomdq@7678
    44
/* @{ */
slouken@2275
    45
#define SDL_ALPHA_OPAQUE 255
slouken@2275
    46
#define SDL_ALPHA_TRANSPARENT 0
gabomdq@7678
    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. */
icculus@9687
    89
/* !!! FIXME: in 2.1, make these not overlap differently with
icculus@9687
    90
   !!! FIXME:  SDL_PACKEDORDER_*, so we can simplify SDL_ISPIXELFORMAT_ALPHA */
slouken@1895
    91
enum
slouken@3407
    92
{
slouken@1965
    93
    SDL_ARRAYORDER_NONE,
slouken@1965
    94
    SDL_ARRAYORDER_RGB,
slouken@1965
    95
    SDL_ARRAYORDER_RGBA,
slouken@1965
    96
    SDL_ARRAYORDER_ARGB,
slouken@1965
    97
    SDL_ARRAYORDER_BGR,
slouken@1965
    98
    SDL_ARRAYORDER_BGRA,
slouken@2208
    99
    SDL_ARRAYORDER_ABGR
slouken@1895
   100
};
slouken@1895
   101
slouken@3407
   102
/** Packed component layout. */
slouken@1895
   103
enum
slouken@3407
   104
{
slouken@1965
   105
    SDL_PACKEDLAYOUT_NONE,
slouken@1965
   106
    SDL_PACKEDLAYOUT_332,
slouken@1965
   107
    SDL_PACKEDLAYOUT_4444,
slouken@1965
   108
    SDL_PACKEDLAYOUT_1555,
slouken@1965
   109
    SDL_PACKEDLAYOUT_5551,
slouken@1965
   110
    SDL_PACKEDLAYOUT_565,
slouken@1965
   111
    SDL_PACKEDLAYOUT_8888,
slouken@1965
   112
    SDL_PACKEDLAYOUT_2101010,
slouken@2208
   113
    SDL_PACKEDLAYOUT_1010102
slouken@1895
   114
};
slouken@1895
   115
slouken@4492
   116
#define SDL_DEFINE_PIXELFOURCC(A, B, C, D) SDL_FOURCC(A, B, C, D)
slouken@1895
   117
slouken@1895
   118
#define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes) \
slouken@6683
   119
    ((1 << 28) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \
slouken@1895
   120
     ((bits) << 8) | ((bytes) << 0))
slouken@1895
   121
slouken@7191
   122
#define SDL_PIXELFLAG(X)    (((X) >> 28) & 0x0F)
slouken@7191
   123
#define SDL_PIXELTYPE(X)    (((X) >> 24) & 0x0F)
slouken@7191
   124
#define SDL_PIXELORDER(X)   (((X) >> 20) & 0x0F)
slouken@7191
   125
#define SDL_PIXELLAYOUT(X)  (((X) >> 16) & 0x0F)
slouken@7191
   126
#define SDL_BITSPERPIXEL(X) (((X) >> 8) & 0xFF)
slouken@5156
   127
#define SDL_BYTESPERPIXEL(X) \
slouken@5156
   128
    (SDL_ISPIXELFORMAT_FOURCC(X) ? \
slouken@5264
   129
        ((((X) == SDL_PIXELFORMAT_YUY2) || \
slouken@5156
   130
          ((X) == SDL_PIXELFORMAT_UYVY) || \
slouken@5156
   131
          ((X) == SDL_PIXELFORMAT_YVYU)) ? 2 : 1) : (((X) >> 0) & 0xFF))
slouken@1895
   132
slouken@1895
   133
#define SDL_ISPIXELFORMAT_INDEXED(format)   \
slouken@5156
   134
    (!SDL_ISPIXELFORMAT_FOURCC(format) && \
slouken@5156
   135
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \
slouken@5156
   136
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \
slouken@5156
   137
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8)))
slouken@1895
   138
icculus@9687
   139
#define SDL_ISPIXELFORMAT_PACKED(format) \
icculus@9687
   140
    (!SDL_ISPIXELFORMAT_FOURCC(format) && \
icculus@9687
   141
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED8) || \
icculus@9687
   142
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED16) || \
icculus@9687
   143
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED32)))
icculus@9687
   144
icculus@9687
   145
#define SDL_ISPIXELFORMAT_ARRAY(format) \
icculus@9687
   146
    (!SDL_ISPIXELFORMAT_FOURCC(format) && \
icculus@9687
   147
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU8) || \
icculus@9687
   148
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU16) || \
icculus@9687
   149
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU32) || \
icculus@9687
   150
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF16) || \
icculus@9687
   151
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF32)))
icculus@9687
   152
slouken@3054
   153
#define SDL_ISPIXELFORMAT_ALPHA(format)   \
icculus@9687
   154
    ((SDL_ISPIXELFORMAT_PACKED(format) && \
slouken@5156
   155
     ((SDL_PIXELORDER(format) == SDL_PACKEDORDER_ARGB) || \
slouken@5156
   156
      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_RGBA) || \
slouken@5156
   157
      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_ABGR) || \
icculus@9687
   158
      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_BGRA))) || \
icculus@9687
   159
    (SDL_ISPIXELFORMAT_ARRAY(format) && \
icculus@9687
   160
     ((SDL_PIXELORDER(format) == SDL_ARRAYORDER_ARGB) || \
icculus@9687
   161
      (SDL_PIXELORDER(format) == SDL_ARRAYORDER_RGBA) || \
icculus@9687
   162
      (SDL_PIXELORDER(format) == SDL_ARRAYORDER_ABGR) || \
icculus@9687
   163
      (SDL_PIXELORDER(format) == SDL_ARRAYORDER_BGRA))))
slouken@3054
   164
slouken@6683
   165
/* The flag is set to 1 because 0x1? is not in the printable ASCII range */
slouken@1895
   166
#define SDL_ISPIXELFORMAT_FOURCC(format)    \
slouken@6683
   167
    ((format) && (SDL_PIXELFLAG(format) != 1))
slouken@1895
   168
slouken@4982
   169
/* Note: If you modify this list, update SDL_GetPixelFormatName() */
slouken@1895
   170
enum
slouken@1895
   171
{
slouken@1965
   172
    SDL_PIXELFORMAT_UNKNOWN,
slouken@1965
   173
    SDL_PIXELFORMAT_INDEX1LSB =
slouken@5438
   174
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_4321, 0,
slouken@5438
   175
                               1, 0),
slouken@5438
   176
    SDL_PIXELFORMAT_INDEX1MSB =
slouken@1965
   177
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
slouken@1895
   178
                               1, 0),
slouken@1965
   179
    SDL_PIXELFORMAT_INDEX4LSB =
slouken@5438
   180
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
slouken@3177
   181
                               4, 0),
slouken@1965
   182
    SDL_PIXELFORMAT_INDEX4MSB =
slouken@5438
   183
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_1234, 0,
slouken@3177
   184
                               4, 0),
slouken@1965
   185
    SDL_PIXELFORMAT_INDEX8 =
slouken@1965
   186
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX8, 0, 0, 8, 1),
slouken@1965
   187
    SDL_PIXELFORMAT_RGB332 =
slouken@1965
   188
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED8, SDL_PACKEDORDER_XRGB,
slouken@1965
   189
                               SDL_PACKEDLAYOUT_332, 8, 1),
slouken@1965
   190
    SDL_PIXELFORMAT_RGB444 =
slouken@1965
   191
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
slouken@1965
   192
                               SDL_PACKEDLAYOUT_4444, 12, 2),
slouken@1965
   193
    SDL_PIXELFORMAT_RGB555 =
slouken@1965
   194
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
slouken@1965
   195
                               SDL_PACKEDLAYOUT_1555, 15, 2),
slouken@2735
   196
    SDL_PIXELFORMAT_BGR555 =
slouken@2735
   197
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
slouken@2735
   198
                               SDL_PACKEDLAYOUT_1555, 15, 2),
slouken@1965
   199
    SDL_PIXELFORMAT_ARGB4444 =
slouken@1965
   200
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
slouken@1965
   201
                               SDL_PACKEDLAYOUT_4444, 16, 2),
slouken@4982
   202
    SDL_PIXELFORMAT_RGBA4444 =
slouken@4982
   203
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
slouken@4982
   204
                               SDL_PACKEDLAYOUT_4444, 16, 2),
lestat@3163
   205
    SDL_PIXELFORMAT_ABGR4444 =
lestat@3163
   206
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
lestat@3163
   207
                               SDL_PACKEDLAYOUT_4444, 16, 2),
slouken@4982
   208
    SDL_PIXELFORMAT_BGRA4444 =
slouken@4982
   209
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
slouken@4982
   210
                               SDL_PACKEDLAYOUT_4444, 16, 2),
slouken@1965
   211
    SDL_PIXELFORMAT_ARGB1555 =
slouken@1965
   212
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
slouken@1965
   213
                               SDL_PACKEDLAYOUT_1555, 16, 2),
slouken@4982
   214
    SDL_PIXELFORMAT_RGBA5551 =
slouken@4982
   215
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
slouken@4982
   216
                               SDL_PACKEDLAYOUT_5551, 16, 2),
slouken@2735
   217
    SDL_PIXELFORMAT_ABGR1555 =
slouken@2735
   218
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
slouken@2735
   219
                               SDL_PACKEDLAYOUT_1555, 16, 2),
slouken@4982
   220
    SDL_PIXELFORMAT_BGRA5551 =
slouken@4982
   221
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
slouken@4982
   222
                               SDL_PACKEDLAYOUT_5551, 16, 2),
slouken@1965
   223
    SDL_PIXELFORMAT_RGB565 =
slouken@1965
   224
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
slouken@1965
   225
                               SDL_PACKEDLAYOUT_565, 16, 2),
lestat@3163
   226
    SDL_PIXELFORMAT_BGR565 =
lestat@3163
   227
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
lestat@3163
   228
                               SDL_PACKEDLAYOUT_565, 16, 2),
slouken@1965
   229
    SDL_PIXELFORMAT_RGB24 =
slouken@1965
   230
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_RGB, 0,
slouken@1895
   231
                               24, 3),
slouken@1965
   232
    SDL_PIXELFORMAT_BGR24 =
slouken@1965
   233
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_BGR, 0,
slouken@1895
   234
                               24, 3),
slouken@1965
   235
    SDL_PIXELFORMAT_RGB888 =
slouken@1965
   236
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XRGB,
slouken@1965
   237
                               SDL_PACKEDLAYOUT_8888, 24, 4),
slouken@6074
   238
    SDL_PIXELFORMAT_RGBX8888 =
slouken@6074
   239
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBX,
slouken@6074
   240
                               SDL_PACKEDLAYOUT_8888, 24, 4),
slouken@1965
   241
    SDL_PIXELFORMAT_BGR888 =
slouken@1965
   242
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XBGR,
slouken@1965
   243
                               SDL_PACKEDLAYOUT_8888, 24, 4),
slouken@6074
   244
    SDL_PIXELFORMAT_BGRX8888 =
slouken@6074
   245
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRX,
slouken@6074
   246
                               SDL_PACKEDLAYOUT_8888, 24, 4),
slouken@1965
   247
    SDL_PIXELFORMAT_ARGB8888 =
slouken@1965
   248
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
slouken@1965
   249
                               SDL_PACKEDLAYOUT_8888, 32, 4),
slouken@1965
   250
    SDL_PIXELFORMAT_RGBA8888 =
slouken@1965
   251
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBA,
slouken@1965
   252
                               SDL_PACKEDLAYOUT_8888, 32, 4),
slouken@1965
   253
    SDL_PIXELFORMAT_ABGR8888 =
slouken@1965
   254
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ABGR,
slouken@1965
   255
                               SDL_PACKEDLAYOUT_8888, 32, 4),
slouken@1965
   256
    SDL_PIXELFORMAT_BGRA8888 =
slouken@1965
   257
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRA,
slouken@1965
   258
                               SDL_PACKEDLAYOUT_8888, 32, 4),
slouken@1965
   259
    SDL_PIXELFORMAT_ARGB2101010 =
slouken@1965
   260
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
slouken@1965
   261
                               SDL_PACKEDLAYOUT_2101010, 32, 4),
slouken@1895
   262
slouken@3407
   263
    SDL_PIXELFORMAT_YV12 =      /**< Planar mode: Y + V + U  (3 planes) */
slouken@1895
   264
        SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
slouken@3407
   265
    SDL_PIXELFORMAT_IYUV =      /**< Planar mode: Y + U + V  (3 planes) */
slouken@1895
   266
        SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
slouken@3407
   267
    SDL_PIXELFORMAT_YUY2 =      /**< Packed mode: Y0+U0+Y1+V0 (1 plane) */
slouken@1895
   268
        SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
slouken@3407
   269
    SDL_PIXELFORMAT_UYVY =      /**< Packed mode: U0+Y0+V0+Y1 (1 plane) */
slouken@1895
   270
        SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
slouken@3407
   271
    SDL_PIXELFORMAT_YVYU =      /**< Packed mode: Y0+V0+Y1+U0 (1 plane) */
slouken@9046
   272
        SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U'),
slouken@9046
   273
    SDL_PIXELFORMAT_NV12 =      /**< Planar mode: Y + U/V interleaved  (2 planes) */
slouken@9046
   274
        SDL_DEFINE_PIXELFOURCC('N', 'V', '1', '2'),
slouken@9046
   275
    SDL_PIXELFORMAT_NV21 =      /**< Planar mode: Y + V/U interleaved  (2 planes) */
slouken@9046
   276
        SDL_DEFINE_PIXELFOURCC('N', 'V', '2', '1')
slouken@1895
   277
};
slouken@1895
   278
slouken@1895
   279
typedef struct SDL_Color
slouken@1895
   280
{
slouken@1895
   281
    Uint8 r;
slouken@1895
   282
    Uint8 g;
slouken@1895
   283
    Uint8 b;
slouken@7024
   284
    Uint8 a;
slouken@1895
   285
} SDL_Color;
slouken@1895
   286
#define SDL_Colour SDL_Color
slouken@1895
   287
slouken@5288
   288
typedef struct SDL_Palette
slouken@1895
   289
{
slouken@1895
   290
    int ncolors;
slouken@1895
   291
    SDL_Color *colors;
slouken@5288
   292
    Uint32 version;
slouken@1895
   293
    int refcount;
slouken@5288
   294
} SDL_Palette;
slouken@1895
   295
slouken@3407
   296
/**
slouken@3407
   297
 *  \note Everything in the pixel format structure is read-only.
slouken@3407
   298
 */
slouken@1895
   299
typedef struct SDL_PixelFormat
slouken@1895
   300
{
slouken@5288
   301
    Uint32 format;
slouken@1895
   302
    SDL_Palette *palette;
slouken@1895
   303
    Uint8 BitsPerPixel;
slouken@1895
   304
    Uint8 BytesPerPixel;
slouken@5434
   305
    Uint8 padding[2];
slouken@5434
   306
    Uint32 Rmask;
slouken@5434
   307
    Uint32 Gmask;
slouken@5434
   308
    Uint32 Bmask;
slouken@5434
   309
    Uint32 Amask;
slouken@1895
   310
    Uint8 Rloss;
slouken@1895
   311
    Uint8 Gloss;
slouken@1895
   312
    Uint8 Bloss;
slouken@1895
   313
    Uint8 Aloss;
slouken@1895
   314
    Uint8 Rshift;
slouken@1895
   315
    Uint8 Gshift;
slouken@1895
   316
    Uint8 Bshift;
slouken@1895
   317
    Uint8 Ashift;
slouken@5288
   318
    int refcount;
slouken@5288
   319
    struct SDL_PixelFormat *next;
slouken@1895
   320
} SDL_PixelFormat;
slouken@1895
   321
slouken@1895
   322
/**
slouken@4982
   323
 * \brief Get the human readable name of a pixel format
slouken@4982
   324
 */
slouken@4982
   325
extern DECLSPEC const char* SDLCALL SDL_GetPixelFormatName(Uint32 format);
slouken@4982
   326
slouken@4982
   327
/**
slouken@3407
   328
 *  \brief Convert one of the enumerated pixel formats to a bpp and RGBA masks.
slouken@7191
   329
 *
slouken@3407
   330
 *  \return SDL_TRUE, or SDL_FALSE if the conversion wasn't possible.
slouken@7191
   331
 *
slouken@3407
   332
 *  \sa SDL_MasksToPixelFormatEnum()
slouken@1895
   333
 */
slouken@1895
   334
extern DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format,
slouken@1895
   335
                                                            int *bpp,
slouken@1895
   336
                                                            Uint32 * Rmask,
slouken@1895
   337
                                                            Uint32 * Gmask,
slouken@1895
   338
                                                            Uint32 * Bmask,
slouken@1895
   339
                                                            Uint32 * Amask);
slouken@1895
   340
slouken@1895
   341
/**
slouken@3407
   342
 *  \brief Convert a bpp and RGBA masks to an enumerated pixel format.
slouken@7191
   343
 *
slouken@7191
   344
 *  \return The pixel format, or ::SDL_PIXELFORMAT_UNKNOWN if the conversion
slouken@3407
   345
 *          wasn't possible.
slouken@7191
   346
 *
slouken@3407
   347
 *  \sa SDL_PixelFormatEnumToMasks()
slouken@1895
   348
 */
slouken@1895
   349
extern DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp,
slouken@1895
   350
                                                          Uint32 Rmask,
slouken@1895
   351
                                                          Uint32 Gmask,
slouken@1895
   352
                                                          Uint32 Bmask,
slouken@1895
   353
                                                          Uint32 Amask);
slouken@1895
   354
slouken@1895
   355
/**
slouken@5288
   356
 *  \brief Create an SDL_PixelFormat structure from a pixel format enum.
slouken@5288
   357
 */
slouken@5288
   358
extern DECLSPEC SDL_PixelFormat * SDLCALL SDL_AllocFormat(Uint32 pixel_format);
slouken@5288
   359
slouken@5288
   360
/**
slouken@5288
   361
 *  \brief Free an SDL_PixelFormat structure.
slouken@5288
   362
 */
slouken@5288
   363
extern DECLSPEC void SDLCALL SDL_FreeFormat(SDL_PixelFormat *format);
slouken@5288
   364
slouken@5288
   365
/**
slouken@7191
   366
 *  \brief Create a palette structure with the specified number of color
slouken@3407
   367
 *         entries.
slouken@7191
   368
 *
slouken@3407
   369
 *  \return A new palette, or NULL if there wasn't enough memory.
slouken@7191
   370
 *
slouken@3407
   371
 *  \note The palette entries are initialized to white.
slouken@7191
   372
 *
slouken@3407
   373
 *  \sa SDL_FreePalette()
slouken@1895
   374
 */
slouken@1895
   375
extern DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors);
slouken@1895
   376
slouken@1895
   377
/**
slouken@5288
   378
 *  \brief Set the palette for a pixel format structure.
slouken@1895
   379
 */
slouken@5288
   380
extern DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat * format,
slouken@5288
   381
                                                      SDL_Palette *palette);
slouken@1895
   382
slouken@1895
   383
/**
slouken@3407
   384
 *  \brief Set a range of colors in a palette.
slouken@7191
   385
 *
slouken@3407
   386
 *  \param palette    The palette to modify.
slouken@3407
   387
 *  \param colors     An array of colors to copy into the palette.
slouken@3407
   388
 *  \param firstcolor The index of the first palette entry to modify.
slouken@3407
   389
 *  \param ncolors    The number of entries to modify.
slouken@7191
   390
 *
slouken@3407
   391
 *  \return 0 on success, or -1 if not all of the colors could be set.
slouken@1895
   392
 */
slouken@1895
   393
extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette,
slouken@1895
   394
                                                 const SDL_Color * colors,
slouken@1895
   395
                                                 int firstcolor, int ncolors);
slouken@1895
   396
slouken@1895
   397
/**
slouken@3407
   398
 *  \brief Free a palette created with SDL_AllocPalette().
slouken@7191
   399
 *
slouken@3407
   400
 *  \sa SDL_AllocPalette()
slouken@1895
   401
 */
slouken@1895
   402
extern DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette * palette);
slouken@1895
   403
slouken@2275
   404
/**
slouken@3407
   405
 *  \brief Maps an RGB triple to an opaque pixel value for a given pixel format.
slouken@7191
   406
 *
slouken@3407
   407
 *  \sa SDL_MapRGBA
slouken@2275
   408
 */
slouken@2275
   409
extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format,
slouken@2275
   410
                                          Uint8 r, Uint8 g, Uint8 b);
slouken@2275
   411
slouken@2275
   412
/**
slouken@3407
   413
 *  \brief Maps an RGBA quadruple to a pixel value for a given pixel format.
slouken@7191
   414
 *
slouken@3407
   415
 *  \sa SDL_MapRGB
slouken@2275
   416
 */
slouken@2275
   417
extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format,
slouken@2275
   418
                                           Uint8 r, Uint8 g, Uint8 b,
slouken@2275
   419
                                           Uint8 a);
slouken@2275
   420
slouken@2275
   421
/**
slouken@3483
   422
 *  \brief Get the RGB components from a pixel of the specified format.
slouken@7191
   423
 *
slouken@3407
   424
 *  \sa SDL_GetRGBA
slouken@2275
   425
 */
slouken@2275
   426
extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel,
slouken@2275
   427
                                        const SDL_PixelFormat * format,
slouken@2275
   428
                                        Uint8 * r, Uint8 * g, Uint8 * b);
slouken@2275
   429
slouken@2275
   430
/**
slouken@3483
   431
 *  \brief Get the RGBA components from a pixel of the specified format.
slouken@7191
   432
 *
slouken@3407
   433
 *  \sa SDL_GetRGB
slouken@2275
   434
 */
slouken@2275
   435
extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel,
slouken@2275
   436
                                         const SDL_PixelFormat * format,
slouken@2275
   437
                                         Uint8 * r, Uint8 * g, Uint8 * b,
slouken@2275
   438
                                         Uint8 * a);
slouken@2275
   439
slouken@5466
   440
/**
slouken@5466
   441
 *  \brief Calculate a 256 entry gamma ramp for a gamma value.
slouken@5466
   442
 */
slouken@5466
   443
extern DECLSPEC void SDLCALL SDL_CalculateGammaRamp(float gamma, Uint16 * ramp);
slouken@5466
   444
slouken@5466
   445
slouken@1895
   446
/* Ends C function definitions when using C++ */
slouken@1895
   447
#ifdef __cplusplus
slouken@1895
   448
}
slouken@1895
   449
#endif
slouken@1895
   450
#include "close_code.h"
slouken@1895
   451
slouken@1895
   452
#endif /* _SDL_pixels_h */
slouken@1895
   453
slouken@1895
   454
/* vi: set ts=4 sw=4 expandtab: */