My Project
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
SDL_pixels.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
4 
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.
8 
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:
12 
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.
20 */
21 
28 #ifndef _SDL_pixels_h
29 #define _SDL_pixels_h
30 
31 #include "SDL_stdinc.h"
32 
33 #include "begin_code.h"
34 /* Set up for C function definitions, even when using C++ */
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
44 /* @{ */
45 #define SDL_ALPHA_OPAQUE 255
46 #define SDL_ALPHA_TRANSPARENT 0
47 /* @} */
48 
50 enum
51 {
52  SDL_PIXELTYPE_UNKNOWN,
53  SDL_PIXELTYPE_INDEX1,
54  SDL_PIXELTYPE_INDEX4,
55  SDL_PIXELTYPE_INDEX8,
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
64 };
65 
67 enum
68 {
69  SDL_BITMAPORDER_NONE,
70  SDL_BITMAPORDER_4321,
71  SDL_BITMAPORDER_1234
72 };
73 
75 enum
76 {
77  SDL_PACKEDORDER_NONE,
78  SDL_PACKEDORDER_XRGB,
79  SDL_PACKEDORDER_RGBX,
80  SDL_PACKEDORDER_ARGB,
81  SDL_PACKEDORDER_RGBA,
82  SDL_PACKEDORDER_XBGR,
83  SDL_PACKEDORDER_BGRX,
84  SDL_PACKEDORDER_ABGR,
85  SDL_PACKEDORDER_BGRA
86 };
87 
89 /* !!! FIXME: in 2.1, make these not overlap differently with
90  !!! FIXME: SDL_PACKEDORDER_*, so we can simplify SDL_ISPIXELFORMAT_ALPHA */
91 enum
92 {
93  SDL_ARRAYORDER_NONE,
94  SDL_ARRAYORDER_RGB,
95  SDL_ARRAYORDER_RGBA,
96  SDL_ARRAYORDER_ARGB,
97  SDL_ARRAYORDER_BGR,
98  SDL_ARRAYORDER_BGRA,
99  SDL_ARRAYORDER_ABGR
100 };
101 
103 enum
104 {
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
114 };
115 
116 #define SDL_DEFINE_PIXELFOURCC(A, B, C, D) SDL_FOURCC(A, B, C, D)
117 
118 #define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes) \
119  ((1 << 28) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \
120  ((bits) << 8) | ((bytes) << 0))
121 
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))
132 
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)))
138 
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)))
144 
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)))
152 
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))))
164 
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))
168 
169 /* Note: If you modify this list, update SDL_GetPixelFormatName() */
170 enum
171 {
172  SDL_PIXELFORMAT_UNKNOWN,
173  SDL_PIXELFORMAT_INDEX1LSB =
174  SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_4321, 0,
175  1, 0),
176  SDL_PIXELFORMAT_INDEX1MSB =
177  SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
178  1, 0),
179  SDL_PIXELFORMAT_INDEX4LSB =
180  SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
181  4, 0),
182  SDL_PIXELFORMAT_INDEX4MSB =
183  SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_1234, 0,
184  4, 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,
231  24, 3),
232  SDL_PIXELFORMAT_BGR24 =
233  SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_BGR, 0,
234  24, 3),
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),
262 
264  SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
266  SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
268  SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
270  SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
272  SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U'),
274  SDL_DEFINE_PIXELFOURCC('N', 'V', '1', '2'),
276  SDL_DEFINE_PIXELFOURCC('N', 'V', '2', '1')
277 };
278 
279 typedef struct SDL_Color
280 {
281  Uint8 r;
282  Uint8 g;
283  Uint8 b;
284  Uint8 a;
285 } SDL_Color;
286 #define SDL_Colour SDL_Color
287 
288 typedef struct SDL_Palette
289 {
290  int ncolors;
291  SDL_Color *colors;
292  Uint32 version;
293  int refcount;
294 } SDL_Palette;
295 
299 typedef struct SDL_PixelFormat
300 {
301  Uint32 format;
302  SDL_Palette *palette;
303  Uint8 BitsPerPixel;
304  Uint8 BytesPerPixel;
305  Uint8 padding[2];
306  Uint32 Rmask;
307  Uint32 Gmask;
308  Uint32 Bmask;
309  Uint32 Amask;
310  Uint8 Rloss;
311  Uint8 Gloss;
312  Uint8 Bloss;
313  Uint8 Aloss;
314  Uint8 Rshift;
315  Uint8 Gshift;
316  Uint8 Bshift;
317  Uint8 Ashift;
318  int refcount;
319  struct SDL_PixelFormat *next;
321 
325 extern DECLSPEC const char* SDLCALL SDL_GetPixelFormatName(Uint32 format);
326 
334 extern DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format,
335  int *bpp,
336  Uint32 * Rmask,
337  Uint32 * Gmask,
338  Uint32 * Bmask,
339  Uint32 * Amask);
340 
349 extern DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp,
350  Uint32 Rmask,
351  Uint32 Gmask,
352  Uint32 Bmask,
353  Uint32 Amask);
354 
358 extern DECLSPEC SDL_PixelFormat * SDLCALL SDL_AllocFormat(Uint32 pixel_format);
359 
363 extern DECLSPEC void SDLCALL SDL_FreeFormat(SDL_PixelFormat *format);
364 
375 extern DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors);
376 
380 extern DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat * format,
381  SDL_Palette *palette);
382 
393 extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette,
394  const SDL_Color * colors,
395  int firstcolor, int ncolors);
396 
402 extern DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette * palette);
403 
409 extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format,
410  Uint8 r, Uint8 g, Uint8 b);
411 
417 extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format,
418  Uint8 r, Uint8 g, Uint8 b,
419  Uint8 a);
420 
426 extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel,
427  const SDL_PixelFormat * format,
428  Uint8 * r, Uint8 * g, Uint8 * b);
429 
435 extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel,
436  const SDL_PixelFormat * format,
437  Uint8 * r, Uint8 * g, Uint8 * b,
438  Uint8 * a);
439 
443 extern DECLSPEC void SDLCALL SDL_CalculateGammaRamp(float gamma, Uint16 * ramp);
444 
445 
446 /* Ends C function definitions when using C++ */
447 #ifdef __cplusplus
448 }
449 #endif
450 #include "close_code.h"
451 
452 #endif /* _SDL_pixels_h */
453 
454 /* vi: set ts=4 sw=4 expandtab: */
DECLSPEC void SDLCALL SDL_CalculateGammaRamp(float gamma, Uint16 *ramp)
Calculate a 256 entry gamma ramp for a gamma value.
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:139
DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat *format, SDL_Palette *palette)
Set the palette for a pixel format structure.
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:155
DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors)
Create a palette structure with the specified number of color entries.
DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format, int *bpp, Uint32 *Rmask, Uint32 *Gmask, Uint32 *Bmask, Uint32 *Amask)
Convert one of the enumerated pixel formats to a bpp and RGBA masks.
uint16_t Uint16
An unsigned 16-bit integer type.
Definition: SDL_stdinc.h:147
DECLSPEC const char *SDLCALL SDL_GetPixelFormatName(Uint32 format)
Get the human readable name of a pixel format.
DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel, const SDL_PixelFormat *format, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)
Get the RGBA components from a pixel of the specified format.
Definition: SDL_pixels.h:275
Definition: SDL_pixels.h:288
DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette *palette)
Free a palette created with SDL_AllocPalette().
DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors)
Set a range of colors in a palette.
Definition: SDL_pixels.h:265
DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, const SDL_PixelFormat *format, Uint8 *r, Uint8 *g, Uint8 *b)
Get the RGB components from a pixel of the specified format.
DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)
Convert a bpp and RGBA masks to an enumerated pixel format.
Definition: SDL_pixels.h:279
Definition: SDL_pixels.h:263
DECLSPEC void SDLCALL SDL_FreeFormat(SDL_PixelFormat *format)
Free an SDL_PixelFormat structure.
Definition: SDL_pixels.h:271
Definition: SDL_pixels.h:273
DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b, Uint8 a)
Maps an RGBA quadruple to a pixel value for a given pixel format.
Definition: SDL_pixels.h:267
DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b)
Maps an RGB triple to an opaque pixel value for a given pixel format.
struct SDL_PixelFormat SDL_PixelFormat
Definition: SDL_pixels.h:299
Definition: SDL_pixels.h:269
DECLSPEC SDL_PixelFormat *SDLCALL SDL_AllocFormat(Uint32 pixel_format)
Create an SDL_PixelFormat structure from a pixel format enum.