2
Simple DirectMedia Layer
3
Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
5
This software is provided 'as-is', without any express or implied
6
warranty. In no event will the authors be held liable for any damages
7
arising from the use of this software.
9
Permission is granted to anyone to use this software for any purpose,
10
including commercial applications, and to alter it and redistribute it
11
freely, subject to the following restrictions:
13
1. The origin of this software must not be misrepresented; you must not
14
claim that you wrote the original software. If you use this software
15
in a product, an acknowledgment in the product documentation would be
16
appreciated but is not required.
17
2. Altered source versions must be plainly marked as such, and must not be
18
misrepresented as being the original software.
19
3. This notice may not be removed or altered from any source distribution.
25
* Header for the enumerated pixel format definitions.
31
#include "begin_code.h"
32
/* Set up for C function definitions, even when using C++ */
40
* \name Transparency definitions
42
* These define alpha as the opacity of a surface.
45
#define SDL_ALPHA_OPAQUE 255
46
#define SDL_ALPHA_TRANSPARENT 0
52
SDL_PIXELTYPE_UNKNOWN,
56
SDL_PIXELTYPE_PACKED8,
57
SDL_PIXELTYPE_PACKED16,
58
SDL_PIXELTYPE_PACKED32,
59
SDL_PIXELTYPE_ARRAYU8,
60
SDL_PIXELTYPE_ARRAYU16,
61
SDL_PIXELTYPE_ARRAYU32,
62
SDL_PIXELTYPE_ARRAYF16,
63
SDL_PIXELTYPE_ARRAYF32
66
/** Bitmap pixel order, high bit -> low bit. */
74
/** Packed component order, high bit -> low bit. */
88
/** Array component order, low byte -> high byte. */
100
/** Packed component layout. */
103
SDL_PACKEDLAYOUT_NONE,
104
SDL_PACKEDLAYOUT_332,
105
SDL_PACKEDLAYOUT_4444,
106
SDL_PACKEDLAYOUT_1555,
107
SDL_PACKEDLAYOUT_5551,
108
SDL_PACKEDLAYOUT_565,
109
SDL_PACKEDLAYOUT_8888,
110
SDL_PACKEDLAYOUT_2101010,
111
SDL_PACKEDLAYOUT_1010102
114
#define SDL_DEFINE_PIXELFOURCC(A, B, C, D) SDL_FOURCC(A, B, C, D)
116
#define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes) \
117
((1 << 31) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \
118
((bits) << 8) | ((bytes) << 0))
120
#define SDL_PIXELTYPE(X) (((X) >> 24) & 0x0F)
121
#define SDL_PIXELORDER(X) (((X) >> 20) & 0x0F)
122
#define SDL_PIXELLAYOUT(X) (((X) >> 16) & 0x0F)
123
#define SDL_BITSPERPIXEL(X) (((X) >> 8) & 0xFF)
124
#define SDL_BYTESPERPIXEL(X) \
125
(SDL_ISPIXELFORMAT_FOURCC(X) ? \
126
((((X) == SDL_PIXELFORMAT_YUY2) || \
127
((X) == SDL_PIXELFORMAT_UYVY) || \
128
((X) == SDL_PIXELFORMAT_YVYU)) ? 2 : 1) : (((X) >> 0) & 0xFF))
130
#define SDL_ISPIXELFORMAT_INDEXED(format) \
131
(!SDL_ISPIXELFORMAT_FOURCC(format) && \
132
((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \
133
(SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \
134
(SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8)))
136
#define SDL_ISPIXELFORMAT_ALPHA(format) \
137
(!SDL_ISPIXELFORMAT_FOURCC(format) && \
138
((SDL_PIXELORDER(format) == SDL_PACKEDORDER_ARGB) || \
139
(SDL_PIXELORDER(format) == SDL_PACKEDORDER_RGBA) || \
140
(SDL_PIXELORDER(format) == SDL_PACKEDORDER_ABGR) || \
141
(SDL_PIXELORDER(format) == SDL_PACKEDORDER_BGRA)))
143
#define SDL_ISPIXELFORMAT_FOURCC(format) \
144
((format) && !((format) & 0x80000000))
146
/* Note: If you modify this list, update SDL_GetPixelFormatName() */
149
SDL_PIXELFORMAT_UNKNOWN,
150
SDL_PIXELFORMAT_INDEX1LSB =
151
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_4321, 0,
153
SDL_PIXELFORMAT_INDEX1MSB =
154
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
156
SDL_PIXELFORMAT_INDEX4LSB =
157
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
159
SDL_PIXELFORMAT_INDEX4MSB =
160
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_1234, 0,
162
SDL_PIXELFORMAT_INDEX8 =
163
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX8, 0, 0, 8, 1),
164
SDL_PIXELFORMAT_RGB332 =
165
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED8, SDL_PACKEDORDER_XRGB,
166
SDL_PACKEDLAYOUT_332, 8, 1),
167
SDL_PIXELFORMAT_RGB444 =
168
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
169
SDL_PACKEDLAYOUT_4444, 12, 2),
170
SDL_PIXELFORMAT_RGB555 =
171
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
172
SDL_PACKEDLAYOUT_1555, 15, 2),
173
SDL_PIXELFORMAT_BGR555 =
174
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
175
SDL_PACKEDLAYOUT_1555, 15, 2),
176
SDL_PIXELFORMAT_ARGB4444 =
177
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
178
SDL_PACKEDLAYOUT_4444, 16, 2),
179
SDL_PIXELFORMAT_RGBA4444 =
180
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
181
SDL_PACKEDLAYOUT_4444, 16, 2),
182
SDL_PIXELFORMAT_ABGR4444 =
183
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
184
SDL_PACKEDLAYOUT_4444, 16, 2),
185
SDL_PIXELFORMAT_BGRA4444 =
186
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
187
SDL_PACKEDLAYOUT_4444, 16, 2),
188
SDL_PIXELFORMAT_ARGB1555 =
189
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
190
SDL_PACKEDLAYOUT_1555, 16, 2),
191
SDL_PIXELFORMAT_RGBA5551 =
192
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
193
SDL_PACKEDLAYOUT_5551, 16, 2),
194
SDL_PIXELFORMAT_ABGR1555 =
195
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
196
SDL_PACKEDLAYOUT_1555, 16, 2),
197
SDL_PIXELFORMAT_BGRA5551 =
198
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
199
SDL_PACKEDLAYOUT_5551, 16, 2),
200
SDL_PIXELFORMAT_RGB565 =
201
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
202
SDL_PACKEDLAYOUT_565, 16, 2),
203
SDL_PIXELFORMAT_BGR565 =
204
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
205
SDL_PACKEDLAYOUT_565, 16, 2),
206
SDL_PIXELFORMAT_RGB24 =
207
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_RGB, 0,
209
SDL_PIXELFORMAT_BGR24 =
210
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_BGR, 0,
212
SDL_PIXELFORMAT_RGB888 =
213
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XRGB,
214
SDL_PACKEDLAYOUT_8888, 24, 4),
215
SDL_PIXELFORMAT_BGR888 =
216
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XBGR,
217
SDL_PACKEDLAYOUT_8888, 24, 4),
218
SDL_PIXELFORMAT_ARGB8888 =
219
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
220
SDL_PACKEDLAYOUT_8888, 32, 4),
221
SDL_PIXELFORMAT_RGBA8888 =
222
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBA,
223
SDL_PACKEDLAYOUT_8888, 32, 4),
224
SDL_PIXELFORMAT_ABGR8888 =
225
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ABGR,
226
SDL_PACKEDLAYOUT_8888, 32, 4),
227
SDL_PIXELFORMAT_BGRA8888 =
228
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRA,
229
SDL_PACKEDLAYOUT_8888, 32, 4),
230
SDL_PIXELFORMAT_ARGB2101010 =
231
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
232
SDL_PACKEDLAYOUT_2101010, 32, 4),
234
SDL_PIXELFORMAT_YV12 = /**< Planar mode: Y + V + U (3 planes) */
235
SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
236
SDL_PIXELFORMAT_IYUV = /**< Planar mode: Y + U + V (3 planes) */
237
SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
238
SDL_PIXELFORMAT_YUY2 = /**< Packed mode: Y0+U0+Y1+V0 (1 plane) */
239
SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
240
SDL_PIXELFORMAT_UYVY = /**< Packed mode: U0+Y0+V0+Y1 (1 plane) */
241
SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
242
SDL_PIXELFORMAT_YVYU = /**< Packed mode: Y0+V0+Y1+U0 (1 plane) */
243
SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U')
246
typedef struct SDL_Color
253
#define SDL_Colour SDL_Color
255
typedef struct SDL_Palette
264
* \note Everything in the pixel format structure is read-only.
266
typedef struct SDL_PixelFormat
269
SDL_Palette *palette;
286
struct SDL_PixelFormat *next;
290
* \brief Get the human readable name of a pixel format
292
extern DECLSPEC const char* SDLCALL SDL_GetPixelFormatName(Uint32 format);
295
* \brief Convert one of the enumerated pixel formats to a bpp and RGBA masks.
297
* \return SDL_TRUE, or SDL_FALSE if the conversion wasn't possible.
299
* \sa SDL_MasksToPixelFormatEnum()
301
extern DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format,
309
* \brief Convert a bpp and RGBA masks to an enumerated pixel format.
311
* \return The pixel format, or ::SDL_PIXELFORMAT_UNKNOWN if the conversion
314
* \sa SDL_PixelFormatEnumToMasks()
316
extern DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp,
323
* \brief Create an SDL_PixelFormat structure from a pixel format enum.
325
extern DECLSPEC SDL_PixelFormat * SDLCALL SDL_AllocFormat(Uint32 pixel_format);
328
* \brief Free an SDL_PixelFormat structure.
330
extern DECLSPEC void SDLCALL SDL_FreeFormat(SDL_PixelFormat *format);
333
* \brief Create a palette structure with the specified number of color
336
* \return A new palette, or NULL if there wasn't enough memory.
338
* \note The palette entries are initialized to white.
340
* \sa SDL_FreePalette()
342
extern DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors);
345
* \brief Set the palette for a pixel format structure.
347
extern DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat * format,
348
SDL_Palette *palette);
351
* \brief Set a range of colors in a palette.
353
* \param palette The palette to modify.
354
* \param colors An array of colors to copy into the palette.
355
* \param firstcolor The index of the first palette entry to modify.
356
* \param ncolors The number of entries to modify.
358
* \return 0 on success, or -1 if not all of the colors could be set.
360
extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette,
361
const SDL_Color * colors,
362
int firstcolor, int ncolors);
365
* \brief Free a palette created with SDL_AllocPalette().
367
* \sa SDL_AllocPalette()
369
extern DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette * palette);
372
* \brief Maps an RGB triple to an opaque pixel value for a given pixel format.
376
extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format,
377
Uint8 r, Uint8 g, Uint8 b);
380
* \brief Maps an RGBA quadruple to a pixel value for a given pixel format.
384
extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format,
385
Uint8 r, Uint8 g, Uint8 b,
389
* \brief Get the RGB components from a pixel of the specified format.
393
extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel,
394
const SDL_PixelFormat * format,
395
Uint8 * r, Uint8 * g, Uint8 * b);
398
* \brief Get the RGBA components from a pixel of the specified format.
402
extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel,
403
const SDL_PixelFormat * format,
404
Uint8 * r, Uint8 * g, Uint8 * b,
408
* \brief Calculate a 256 entry gamma ramp for a gamma value.
410
extern DECLSPEC void SDLCALL SDL_CalculateGammaRamp(float gamma, Uint16 * ramp);
413
/* Ends C function definitions when using C++ */
419
#include "close_code.h"
421
#endif /* _SDL_pixels_h */
423
/* vi: set ts=4 sw=4 expandtab: */