2 Simple DirectMedia Layer
3 Copyright (C) 1997-2016 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 "SDL_stdinc.h"
33 #include "begin_code.h"
34 /* 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. */
89 /* !!! FIXME: in 2.1, make these not overlap differently with
90 !!! FIXME: SDL_PACKEDORDER_*, so we can simplify SDL_ISPIXELFORMAT_ALPHA */
102 /** Packed component layout. */
105 SDL_PACKEDLAYOUT_NONE,
106 SDL_PACKEDLAYOUT_332,
107 SDL_PACKEDLAYOUT_4444,
108 SDL_PACKEDLAYOUT_1555,
109 SDL_PACKEDLAYOUT_5551,
110 SDL_PACKEDLAYOUT_565,
111 SDL_PACKEDLAYOUT_8888,
112 SDL_PACKEDLAYOUT_2101010,
113 SDL_PACKEDLAYOUT_1010102
116 #define SDL_DEFINE_PIXELFOURCC(A, B, C, D) SDL_FOURCC(A, B, C, D)
118 #define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes) \
119 ((1 << 28) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \
120 ((bits) << 8) | ((bytes) << 0))
122 #define SDL_PIXELFLAG(X) (((X) >> 28) & 0x0F)
123 #define SDL_PIXELTYPE(X) (((X) >> 24) & 0x0F)
124 #define SDL_PIXELORDER(X) (((X) >> 20) & 0x0F)
125 #define SDL_PIXELLAYOUT(X) (((X) >> 16) & 0x0F)
126 #define SDL_BITSPERPIXEL(X) (((X) >> 8) & 0xFF)
127 #define SDL_BYTESPERPIXEL(X) \
128 (SDL_ISPIXELFORMAT_FOURCC(X) ? \
129 ((((X) == SDL_PIXELFORMAT_YUY2) || \
130 ((X) == SDL_PIXELFORMAT_UYVY) || \
131 ((X) == SDL_PIXELFORMAT_YVYU)) ? 2 : 1) : (((X) >> 0) & 0xFF))
133 #define SDL_ISPIXELFORMAT_INDEXED(format) \
134 (!SDL_ISPIXELFORMAT_FOURCC(format) && \
135 ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \
136 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \
137 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8)))
139 #define SDL_ISPIXELFORMAT_PACKED(format) \
140 (!SDL_ISPIXELFORMAT_FOURCC(format) && \
141 ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED8) || \
142 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED16) || \
143 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED32)))
145 #define SDL_ISPIXELFORMAT_ARRAY(format) \
146 (!SDL_ISPIXELFORMAT_FOURCC(format) && \
147 ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU8) || \
148 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU16) || \
149 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU32) || \
150 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF16) || \
151 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF32)))
153 #define SDL_ISPIXELFORMAT_ALPHA(format) \
154 ((SDL_ISPIXELFORMAT_PACKED(format) && \
155 ((SDL_PIXELORDER(format) == SDL_PACKEDORDER_ARGB) || \
156 (SDL_PIXELORDER(format) == SDL_PACKEDORDER_RGBA) || \
157 (SDL_PIXELORDER(format) == SDL_PACKEDORDER_ABGR) || \
158 (SDL_PIXELORDER(format) == SDL_PACKEDORDER_BGRA))) || \
159 (SDL_ISPIXELFORMAT_ARRAY(format) && \
160 ((SDL_PIXELORDER(format) == SDL_ARRAYORDER_ARGB) || \
161 (SDL_PIXELORDER(format) == SDL_ARRAYORDER_RGBA) || \
162 (SDL_PIXELORDER(format) == SDL_ARRAYORDER_ABGR) || \
163 (SDL_PIXELORDER(format) == SDL_ARRAYORDER_BGRA))))
165 /* The flag is set to 1 because 0x1? is not in the printable ASCII range */
166 #define SDL_ISPIXELFORMAT_FOURCC(format) \
167 ((format) && (SDL_PIXELFLAG(format) != 1))
169 /* Note: If you modify this list, update SDL_GetPixelFormatName() */
172 SDL_PIXELFORMAT_UNKNOWN,
173 SDL_PIXELFORMAT_INDEX1LSB =
174 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_4321, 0,
176 SDL_PIXELFORMAT_INDEX1MSB =
177 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
179 SDL_PIXELFORMAT_INDEX4LSB =
180 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
182 SDL_PIXELFORMAT_INDEX4MSB =
183 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_1234, 0,
185 SDL_PIXELFORMAT_INDEX8 =
186 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX8, 0, 0, 8, 1),
187 SDL_PIXELFORMAT_RGB332 =
188 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED8, SDL_PACKEDORDER_XRGB,
189 SDL_PACKEDLAYOUT_332, 8, 1),
190 SDL_PIXELFORMAT_RGB444 =
191 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
192 SDL_PACKEDLAYOUT_4444, 12, 2),
193 SDL_PIXELFORMAT_RGB555 =
194 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
195 SDL_PACKEDLAYOUT_1555, 15, 2),
196 SDL_PIXELFORMAT_BGR555 =
197 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
198 SDL_PACKEDLAYOUT_1555, 15, 2),
199 SDL_PIXELFORMAT_ARGB4444 =
200 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
201 SDL_PACKEDLAYOUT_4444, 16, 2),
202 SDL_PIXELFORMAT_RGBA4444 =
203 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
204 SDL_PACKEDLAYOUT_4444, 16, 2),
205 SDL_PIXELFORMAT_ABGR4444 =
206 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
207 SDL_PACKEDLAYOUT_4444, 16, 2),
208 SDL_PIXELFORMAT_BGRA4444 =
209 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
210 SDL_PACKEDLAYOUT_4444, 16, 2),
211 SDL_PIXELFORMAT_ARGB1555 =
212 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
213 SDL_PACKEDLAYOUT_1555, 16, 2),
214 SDL_PIXELFORMAT_RGBA5551 =
215 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
216 SDL_PACKEDLAYOUT_5551, 16, 2),
217 SDL_PIXELFORMAT_ABGR1555 =
218 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
219 SDL_PACKEDLAYOUT_1555, 16, 2),
220 SDL_PIXELFORMAT_BGRA5551 =
221 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
222 SDL_PACKEDLAYOUT_5551, 16, 2),
223 SDL_PIXELFORMAT_RGB565 =
224 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
225 SDL_PACKEDLAYOUT_565, 16, 2),
226 SDL_PIXELFORMAT_BGR565 =
227 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
228 SDL_PACKEDLAYOUT_565, 16, 2),
229 SDL_PIXELFORMAT_RGB24 =
230 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_RGB, 0,
232 SDL_PIXELFORMAT_BGR24 =
233 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_BGR, 0,
235 SDL_PIXELFORMAT_RGB888 =
236 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XRGB,
237 SDL_PACKEDLAYOUT_8888, 24, 4),
238 SDL_PIXELFORMAT_RGBX8888 =
239 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBX,
240 SDL_PACKEDLAYOUT_8888, 24, 4),
241 SDL_PIXELFORMAT_BGR888 =
242 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XBGR,
243 SDL_PACKEDLAYOUT_8888, 24, 4),
244 SDL_PIXELFORMAT_BGRX8888 =
245 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRX,
246 SDL_PACKEDLAYOUT_8888, 24, 4),
247 SDL_PIXELFORMAT_ARGB8888 =
248 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
249 SDL_PACKEDLAYOUT_8888, 32, 4),
250 SDL_PIXELFORMAT_RGBA8888 =
251 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBA,
252 SDL_PACKEDLAYOUT_8888, 32, 4),
253 SDL_PIXELFORMAT_ABGR8888 =
254 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ABGR,
255 SDL_PACKEDLAYOUT_8888, 32, 4),
256 SDL_PIXELFORMAT_BGRA8888 =
257 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRA,
258 SDL_PACKEDLAYOUT_8888, 32, 4),
259 SDL_PIXELFORMAT_ARGB2101010 =
260 SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
261 SDL_PACKEDLAYOUT_2101010, 32, 4),
263 SDL_PIXELFORMAT_YV12 = /**< Planar mode: Y + V + U (3 planes) */
264 SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
265 SDL_PIXELFORMAT_IYUV = /**< Planar mode: Y + U + V (3 planes) */
266 SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
267 SDL_PIXELFORMAT_YUY2 = /**< Packed mode: Y0+U0+Y1+V0 (1 plane) */
268 SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
269 SDL_PIXELFORMAT_UYVY = /**< Packed mode: U0+Y0+V0+Y1 (1 plane) */
270 SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
271 SDL_PIXELFORMAT_YVYU = /**< Packed mode: Y0+V0+Y1+U0 (1 plane) */
272 SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U'),
273 SDL_PIXELFORMAT_NV12 = /**< Planar mode: Y + U/V interleaved (2 planes) */
274 SDL_DEFINE_PIXELFOURCC('N', 'V', '1', '2'),
275 SDL_PIXELFORMAT_NV21 = /**< Planar mode: Y + V/U interleaved (2 planes) */
276 SDL_DEFINE_PIXELFOURCC('N', 'V', '2', '1')
279 typedef struct SDL_Color
286 #define SDL_Colour SDL_Color
288 typedef struct SDL_Palette
297 * \note Everything in the pixel format structure is read-only.
299 typedef struct SDL_PixelFormat
302 SDL_Palette *palette;
319 struct SDL_PixelFormat *next;
323 * \brief Get the human readable name of a pixel format
325 extern DECLSPEC const char* SDLCALL SDL_GetPixelFormatName(Uint32 format);
328 * \brief Convert one of the enumerated pixel formats to a bpp and RGBA masks.
330 * \return SDL_TRUE, or SDL_FALSE if the conversion wasn't possible.
332 * \sa SDL_MasksToPixelFormatEnum()
334 extern DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format,
342 * \brief Convert a bpp and RGBA masks to an enumerated pixel format.
344 * \return The pixel format, or ::SDL_PIXELFORMAT_UNKNOWN if the conversion
347 * \sa SDL_PixelFormatEnumToMasks()
349 extern DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp,
356 * \brief Create an SDL_PixelFormat structure from a pixel format enum.
358 extern DECLSPEC SDL_PixelFormat * SDLCALL SDL_AllocFormat(Uint32 pixel_format);
361 * \brief Free an SDL_PixelFormat structure.
363 extern DECLSPEC void SDLCALL SDL_FreeFormat(SDL_PixelFormat *format);
366 * \brief Create a palette structure with the specified number of color
369 * \return A new palette, or NULL if there wasn't enough memory.
371 * \note The palette entries are initialized to white.
373 * \sa SDL_FreePalette()
375 extern DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors);
378 * \brief Set the palette for a pixel format structure.
380 extern DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat * format,
381 SDL_Palette *palette);
384 * \brief Set a range of colors in a palette.
386 * \param palette The palette to modify.
387 * \param colors An array of colors to copy into the palette.
388 * \param firstcolor The index of the first palette entry to modify.
389 * \param ncolors The number of entries to modify.
391 * \return 0 on success, or -1 if not all of the colors could be set.
393 extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette,
394 const SDL_Color * colors,
395 int firstcolor, int ncolors);
398 * \brief Free a palette created with SDL_AllocPalette().
400 * \sa SDL_AllocPalette()
402 extern DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette * palette);
405 * \brief Maps an RGB triple to an opaque pixel value for a given pixel format.
409 extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format,
410 Uint8 r, Uint8 g, Uint8 b);
413 * \brief Maps an RGBA quadruple to a pixel value for a given pixel format.
417 extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format,
418 Uint8 r, Uint8 g, Uint8 b,
422 * \brief Get the RGB components from a pixel of the specified format.
426 extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel,
427 const SDL_PixelFormat * format,
428 Uint8 * r, Uint8 * g, Uint8 * b);
431 * \brief Get the RGBA components from a pixel of the specified format.
435 extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel,
436 const SDL_PixelFormat * format,
437 Uint8 * r, Uint8 * g, Uint8 * b,
441 * \brief Calculate a 256 entry gamma ramp for a gamma value.
443 extern DECLSPEC void SDLCALL SDL_CalculateGammaRamp(float gamma, Uint16 * ramp);
446 /* Ends C function definitions when using C++ */
450 #include "close_code.h"
452 #endif /* _SDL_pixels_h */
454 /* vi: set ts=4 sw=4 expandtab: */