SDL 3.0
SDL_pixels.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2023 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
22/**
23 * \file SDL_pixels.h
24 *
25 * \brief Header for the enumerated pixel format definitions.
26 */
27
28#ifndef SDL_pixels_h_
29#define SDL_pixels_h_
30
31#include <SDL3/SDL_stdinc.h>
32#include <SDL3/SDL_endian.h>
33
34#include <SDL3/SDL_begin_code.h>
35/* Set up for C function definitions, even when using C++ */
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40/**
41 * \name Transparency definitions
42 *
43 * These define alpha as the opacity of a surface.
44 */
45/* @{ */
46#define SDL_ALPHA_OPAQUE 255
47#define SDL_ALPHA_TRANSPARENT 0
48/* @} */
49
50/** Pixel type. */
51typedef enum
52{
66
67/** Bitmap pixel order, high bit -> low bit. */
68typedef enum
69{
74
75/** Packed component order, high bit -> low bit. */
76typedef enum
77{
88
89/** Array component order, low byte -> high byte. */
90typedef enum
91{
94 SDL_ARRAYORDER_UNUSED1, /* Left for compatibility with SDL2 */
95 SDL_ARRAYORDER_UNUSED2, /* Left for compatibility with SDL2 */
98
99/** Packed component layout. */
100typedef enum
101{
112
113#define SDL_DEFINE_PIXELFOURCC(A, B, C, D) SDL_FOURCC(A, B, C, D)
114
115#define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes) \
116 ((1 << 28) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \
117 ((bits) << 8) | ((bytes) << 0))
118
119#define SDL_PIXELFLAG(X) (((X) >> 28) & 0x0F)
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))
129
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)))
135
136#define SDL_ISPIXELFORMAT_PACKED(format) \
137 (!SDL_ISPIXELFORMAT_FOURCC(format) && \
138 ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED8) || \
139 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED16) || \
140 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED32)))
141
142#define SDL_ISPIXELFORMAT_ARRAY(format) \
143 (!SDL_ISPIXELFORMAT_FOURCC(format) && \
144 ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU8) || \
145 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU16) || \
146 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU32) || \
147 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF16) || \
148 (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF32)))
149
150#define SDL_ISPIXELFORMAT_ALPHA(format) \
151 ((SDL_ISPIXELFORMAT_PACKED(format) && \
152 ((SDL_PIXELORDER(format) == SDL_PACKEDORDER_ARGB) || \
153 (SDL_PIXELORDER(format) == SDL_PACKEDORDER_RGBA) || \
154 (SDL_PIXELORDER(format) == SDL_PACKEDORDER_ABGR) || \
155 (SDL_PIXELORDER(format) == SDL_PACKEDORDER_BGRA))))
156
157/* The flag is set to 1 because 0x1? is not in the printable ASCII range */
158#define SDL_ISPIXELFORMAT_FOURCC(format) \
159 ((format) && (SDL_PIXELFLAG(format) != 1))
160
161/* Note: If you modify this list, update SDL_GetPixelFormatName() */
162typedef enum
163{
167 1, 0),
170 1, 0),
173 4, 0),
176 4, 0),
230 24, 3),
233 24, 3),
261
262 /* Aliases for RGBA byte arrays of color data, for the current platform */
263#if SDL_BYTEORDER == SDL_BIG_ENDIAN
272#else
281#endif
282
283 SDL_PIXELFORMAT_YV12 = /**< Planar mode: Y + V + U (3 planes) */
284 SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
285 SDL_PIXELFORMAT_IYUV = /**< Planar mode: Y + U + V (3 planes) */
286 SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
287 SDL_PIXELFORMAT_YUY2 = /**< Packed mode: Y0+U0+Y1+V0 (1 plane) */
288 SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
289 SDL_PIXELFORMAT_UYVY = /**< Packed mode: U0+Y0+V0+Y1 (1 plane) */
290 SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
291 SDL_PIXELFORMAT_YVYU = /**< Packed mode: Y0+V0+Y1+U0 (1 plane) */
292 SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U'),
293 SDL_PIXELFORMAT_NV12 = /**< Planar mode: Y + U/V interleaved (2 planes) */
294 SDL_DEFINE_PIXELFOURCC('N', 'V', '1', '2'),
295 SDL_PIXELFORMAT_NV21 = /**< Planar mode: Y + V/U interleaved (2 planes) */
296 SDL_DEFINE_PIXELFOURCC('N', 'V', '2', '1'),
297 SDL_PIXELFORMAT_EXTERNAL_OES = /**< Android video texture format */
298 SDL_DEFINE_PIXELFOURCC('O', 'E', 'S', ' ')
300
301/**
302 * The bits of this structure can be directly reinterpreted as an integer-packed
303 * color which uses the SDL_PIXELFORMAT_RGBA32 format (SDL_PIXELFORMAT_ABGR8888
304 * on little-endian systems and SDL_PIXELFORMAT_RGBA8888 on big-endian systems).
305 */
306typedef struct SDL_Color
307{
312} SDL_Color;
313#define SDL_Colour SDL_Color
314
315typedef struct SDL_Palette
316{
322
323/**
324 * \note Everything in the pixel format structure is read-only.
325 */
326typedef struct SDL_PixelFormat
327{
348
349/**
350 * Get the human readable name of a pixel format.
351 *
352 * \param format the pixel format to query
353 * \returns the human readable name of the specified pixel format or
354 * `SDL_PIXELFORMAT_UNKNOWN` if the format isn't recognized.
355 *
356 * \since This function is available since SDL 3.0.0.
357 */
358extern DECLSPEC const char* SDLCALL SDL_GetPixelFormatName(Uint32 format);
359
360/**
361 * Convert one of the enumerated pixel formats to a bpp value and RGBA masks.
362 *
363 * \param format one of the SDL_PixelFormatEnum values
364 * \param bpp a bits per pixel value; usually 15, 16, or 32
365 * \param Rmask a pointer filled in with the red mask for the format
366 * \param Gmask a pointer filled in with the green mask for the format
367 * \param Bmask a pointer filled in with the blue mask for the format
368 * \param Amask a pointer filled in with the alpha mask for the format
369 * \returns SDL_TRUE on success or SDL_FALSE if the conversion wasn't
370 * possible; call SDL_GetError() for more information.
371 *
372 * \since This function is available since SDL 3.0.0.
373 *
374 * \sa SDL_GetPixelFormatEnumForMasks
375 */
377 int *bpp,
378 Uint32 * Rmask,
379 Uint32 * Gmask,
380 Uint32 * Bmask,
381 Uint32 * Amask);
382
383/**
384 * Convert a bpp value and RGBA masks to an enumerated pixel format.
385 *
386 * This will return `SDL_PIXELFORMAT_UNKNOWN` if the conversion wasn't
387 * possible.
388 *
389 * \param bpp a bits per pixel value; usually 15, 16, or 32
390 * \param Rmask the red mask for the format
391 * \param Gmask the green mask for the format
392 * \param Bmask the blue mask for the format
393 * \param Amask the alpha mask for the format
394 * \returns one of the SDL_PixelFormatEnum values
395 *
396 * \since This function is available since SDL 3.0.0.
397 *
398 * \sa SDL_GetMasksForPixelFormatEnum
399 */
400extern DECLSPEC Uint32 SDLCALL SDL_GetPixelFormatEnumForMasks(int bpp,
404 Uint32 Amask);
405
406/**
407 * Create an SDL_PixelFormat structure corresponding to a pixel format.
408 *
409 * Returned structure may come from a shared global cache (i.e. not newly
410 * allocated), and hence should not be modified, especially the palette. Weird
411 * errors such as `Blit combination not supported` may occur.
412 *
413 * \param pixel_format one of the SDL_PixelFormatEnum values
414 * \returns the new SDL_PixelFormat structure or NULL on failure; call
415 * SDL_GetError() for more information.
416 *
417 * \since This function is available since SDL 3.0.0.
418 *
419 * \sa SDL_DestroyPixelFormat
420 */
421extern DECLSPEC SDL_PixelFormat * SDLCALL SDL_CreatePixelFormat(Uint32 pixel_format);
422
423/**
424 * Free an SDL_PixelFormat structure allocated by SDL_CreatePixelFormat().
425 *
426 * \param format the SDL_PixelFormat structure to free
427 *
428 * \since This function is available since SDL 3.0.0.
429 *
430 * \sa SDL_CreatePixelFormat
431 */
432extern DECLSPEC void SDLCALL SDL_DestroyPixelFormat(SDL_PixelFormat *format);
433
434/**
435 * Create a palette structure with the specified number of color entries.
436 *
437 * The palette entries are initialized to white.
438 *
439 * \param ncolors represents the number of color entries in the color palette
440 * \returns a new SDL_Palette structure on success or NULL on failure (e.g. if
441 * there wasn't enough memory); call SDL_GetError() for more
442 * information.
443 *
444 * \since This function is available since SDL 3.0.0.
445 *
446 * \sa SDL_DestroyPalette
447 */
448extern DECLSPEC SDL_Palette *SDLCALL SDL_CreatePalette(int ncolors);
449
450/**
451 * Set the palette for a pixel format structure.
452 *
453 * \param format the SDL_PixelFormat structure that will use the palette
454 * \param palette the SDL_Palette structure that will be used
455 * \returns 0 on success or a negative error code on failure; call
456 * SDL_GetError() for more information.
457 *
458 * \since This function is available since SDL 3.0.0.
459 *
460 * \sa SDL_CreatePalette
461 * \sa SDL_DestroyPalette
462 */
465
466/**
467 * Set a range of colors in a palette.
468 *
469 * \param palette the SDL_Palette structure to modify
470 * \param colors an array of SDL_Color structures to copy into the palette
471 * \param firstcolor the index of the first palette entry to modify
472 * \param ncolors the number of entries to modify
473 * \returns 0 on success or a negative error code on failure; call
474 * SDL_GetError() for more information.
475 *
476 * \since This function is available since SDL 3.0.0.
477 *
478 * \sa SDL_CreatePalette
479 * \sa SDL_CreateSurface
480 */
481extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette,
482 const SDL_Color * colors,
483 int firstcolor, int ncolors);
484
485/**
486 * Free a palette created with SDL_CreatePalette().
487 *
488 * \param palette the SDL_Palette structure to be freed
489 *
490 * \since This function is available since SDL 3.0.0.
491 *
492 * \sa SDL_CreatePalette
493 */
494extern DECLSPEC void SDLCALL SDL_DestroyPalette(SDL_Palette * palette);
495
496/**
497 * Map an RGB triple to an opaque pixel value for a given pixel format.
498 *
499 * This function maps the RGB color value to the specified pixel format and
500 * returns the pixel value best approximating the given RGB color value for
501 * the given pixel format.
502 *
503 * If the format has a palette (8-bit) the index of the closest matching color
504 * in the palette will be returned.
505 *
506 * If the specified pixel format has an alpha component it will be returned as
507 * all 1 bits (fully opaque).
508 *
509 * If the pixel format bpp (color depth) is less than 32-bpp then the unused
510 * upper bits of the return value can safely be ignored (e.g., with a 16-bpp
511 * format the return value can be assigned to a Uint16, and similarly a Uint8
512 * for an 8-bpp format).
513 *
514 * \param format an SDL_PixelFormat structure describing the pixel format
515 * \param r the red component of the pixel in the range 0-255
516 * \param g the green component of the pixel in the range 0-255
517 * \param b the blue component of the pixel in the range 0-255
518 * \returns a pixel value
519 *
520 * \since This function is available since SDL 3.0.0.
521 *
522 * \sa SDL_GetRGB
523 * \sa SDL_GetRGBA
524 * \sa SDL_MapRGBA
525 */
526extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format,
527 Uint8 r, Uint8 g, Uint8 b);
528
529/**
530 * Map an RGBA quadruple to a pixel value for a given pixel format.
531 *
532 * This function maps the RGBA color value to the specified pixel format and
533 * returns the pixel value best approximating the given RGBA color value for
534 * the given pixel format.
535 *
536 * If the specified pixel format has no alpha component the alpha value will
537 * be ignored (as it will be in formats with a palette).
538 *
539 * If the format has a palette (8-bit) the index of the closest matching color
540 * in the palette will be returned.
541 *
542 * If the pixel format bpp (color depth) is less than 32-bpp then the unused
543 * upper bits of the return value can safely be ignored (e.g., with a 16-bpp
544 * format the return value can be assigned to a Uint16, and similarly a Uint8
545 * for an 8-bpp format).
546 *
547 * \param format an SDL_PixelFormat structure describing the format of the
548 * pixel
549 * \param r the red component of the pixel in the range 0-255
550 * \param g the green component of the pixel in the range 0-255
551 * \param b the blue component of the pixel in the range 0-255
552 * \param a the alpha component of the pixel in the range 0-255
553 * \returns a pixel value
554 *
555 * \since This function is available since SDL 3.0.0.
556 *
557 * \sa SDL_GetRGB
558 * \sa SDL_GetRGBA
559 * \sa SDL_MapRGB
560 */
561extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format,
562 Uint8 r, Uint8 g, Uint8 b,
563 Uint8 a);
564
565/**
566 * Get RGB values from a pixel in the specified format.
567 *
568 * This function uses the entire 8-bit [0..255] range when converting color
569 * components from pixel formats with less than 8-bits per RGB component
570 * (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff,
571 * 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).
572 *
573 * \param pixel a pixel value
574 * \param format an SDL_PixelFormat structure describing the format of the
575 * pixel
576 * \param r a pointer filled in with the red component
577 * \param g a pointer filled in with the green component
578 * \param b a pointer filled in with the blue component
579 *
580 * \since This function is available since SDL 3.0.0.
581 *
582 * \sa SDL_GetRGBA
583 * \sa SDL_MapRGB
584 * \sa SDL_MapRGBA
585 */
586extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel,
587 const SDL_PixelFormat * format,
588 Uint8 * r, Uint8 * g, Uint8 * b);
589
590/**
591 * Get RGBA values from a pixel in the specified format.
592 *
593 * This function uses the entire 8-bit [0..255] range when converting color
594 * components from pixel formats with less than 8-bits per RGB component
595 * (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff,
596 * 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).
597 *
598 * If the surface has no alpha component, the alpha will be returned as 0xff
599 * (100% opaque).
600 *
601 * \param pixel a pixel value
602 * \param format an SDL_PixelFormat structure describing the format of the
603 * pixel
604 * \param r a pointer filled in with the red component
605 * \param g a pointer filled in with the green component
606 * \param b a pointer filled in with the blue component
607 * \param a a pointer filled in with the alpha component
608 *
609 * \since This function is available since SDL 3.0.0.
610 *
611 * \sa SDL_GetRGB
612 * \sa SDL_MapRGB
613 * \sa SDL_MapRGBA
614 */
615extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel,
616 const SDL_PixelFormat * format,
617 Uint8 * r, Uint8 * g, Uint8 * b,
618 Uint8 * a);
619
620
621/* Ends C function definitions when using C++ */
622#ifdef __cplusplus
623}
624#endif
625#include <SDL3/SDL_close_code.h>
626
627#endif /* SDL_pixels_h_ */
Functions for reading and writing endian-specific values.
int SDL_SetPaletteColors(SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors)
SDL_bool SDL_GetMasksForPixelFormatEnum(Uint32 format, int *bpp, Uint32 *Rmask, Uint32 *Gmask, Uint32 *Bmask, Uint32 *Amask)
int SDL_SetPixelFormatPalette(SDL_PixelFormat *format, SDL_Palette *palette)
SDL_PixelType
Definition: SDL_pixels.h:52
@ SDL_PIXELTYPE_UNKNOWN
Definition: SDL_pixels.h:53
@ SDL_PIXELTYPE_ARRAYU16
Definition: SDL_pixels.h:61
@ SDL_PIXELTYPE_PACKED32
Definition: SDL_pixels.h:59
@ SDL_PIXELTYPE_ARRAYU8
Definition: SDL_pixels.h:60
@ SDL_PIXELTYPE_INDEX4
Definition: SDL_pixels.h:55
@ SDL_PIXELTYPE_PACKED8
Definition: SDL_pixels.h:57
@ SDL_PIXELTYPE_ARRAYF16
Definition: SDL_pixels.h:63
@ SDL_PIXELTYPE_ARRAYU32
Definition: SDL_pixels.h:62
@ SDL_PIXELTYPE_INDEX1
Definition: SDL_pixels.h:54
@ SDL_PIXELTYPE_ARRAYF32
Definition: SDL_pixels.h:64
@ SDL_PIXELTYPE_INDEX8
Definition: SDL_pixels.h:56
@ SDL_PIXELTYPE_PACKED16
Definition: SDL_pixels.h:58
const char * SDL_GetPixelFormatName(Uint32 format)
void SDL_DestroyPixelFormat(SDL_PixelFormat *format)
Uint32 SDL_MapRGBA(const SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b, Uint8 a)
SDL_PackedLayout
Definition: SDL_pixels.h:101
@ SDL_PACKEDLAYOUT_NONE
Definition: SDL_pixels.h:102
@ SDL_PACKEDLAYOUT_8888
Definition: SDL_pixels.h:108
@ SDL_PACKEDLAYOUT_1010102
Definition: SDL_pixels.h:110
@ SDL_PACKEDLAYOUT_565
Definition: SDL_pixels.h:107
@ SDL_PACKEDLAYOUT_332
Definition: SDL_pixels.h:103
@ SDL_PACKEDLAYOUT_5551
Definition: SDL_pixels.h:106
@ SDL_PACKEDLAYOUT_1555
Definition: SDL_pixels.h:105
@ SDL_PACKEDLAYOUT_4444
Definition: SDL_pixels.h:104
@ SDL_PACKEDLAYOUT_2101010
Definition: SDL_pixels.h:109
SDL_Palette * SDL_CreatePalette(int ncolors)
SDL_BitmapOrder
Definition: SDL_pixels.h:69
@ SDL_BITMAPORDER_1234
Definition: SDL_pixels.h:72
@ SDL_BITMAPORDER_NONE
Definition: SDL_pixels.h:70
@ SDL_BITMAPORDER_4321
Definition: SDL_pixels.h:71
Uint32 SDL_MapRGB(const SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b)
void SDL_DestroyPalette(SDL_Palette *palette)
#define SDL_DEFINE_PIXELFOURCC(A, B, C, D)
Definition: SDL_pixels.h:113
SDL_ArrayOrder
Definition: SDL_pixels.h:91
@ SDL_ARRAYORDER_RGB
Definition: SDL_pixels.h:93
@ SDL_ARRAYORDER_UNUSED1
Definition: SDL_pixels.h:94
@ SDL_ARRAYORDER_NONE
Definition: SDL_pixels.h:92
@ SDL_ARRAYORDER_BGR
Definition: SDL_pixels.h:96
@ SDL_ARRAYORDER_UNUSED2
Definition: SDL_pixels.h:95
SDL_PixelFormat * SDL_CreatePixelFormat(Uint32 pixel_format)
SDL_PixelFormatEnum
Definition: SDL_pixels.h:163
@ SDL_PIXELFORMAT_BGR565
Definition: SDL_pixels.h:225
@ SDL_PIXELFORMAT_EXTERNAL_OES
Definition: SDL_pixels.h:297
@ SDL_PIXELFORMAT_YVYU
Definition: SDL_pixels.h:291
@ SDL_PIXELFORMAT_RGB332
Definition: SDL_pixels.h:179
@ SDL_PIXELFORMAT_INDEX1LSB
Definition: SDL_pixels.h:165
@ SDL_PIXELFORMAT_BGR444
Definition: SDL_pixels.h:189
@ SDL_PIXELFORMAT_RGBX32
Definition: SDL_pixels.h:268
@ SDL_PIXELFORMAT_ABGR4444
Definition: SDL_pixels.h:204
@ SDL_PIXELFORMAT_BGRA4444
Definition: SDL_pixels.h:207
@ SDL_PIXELFORMAT_BGR24
Definition: SDL_pixels.h:231
@ SDL_PIXELFORMAT_INDEX4MSB
Definition: SDL_pixels.h:174
@ SDL_PIXELFORMAT_BGRA32
Definition: SDL_pixels.h:266
@ SDL_PIXELFORMAT_RGB555
Definition: SDL_pixels.h:193
@ SDL_PIXELFORMAT_RGB444
Definition: SDL_pixels.h:185
@ SDL_PIXELFORMAT_RGBA8888
Definition: SDL_pixels.h:249
@ SDL_PIXELFORMAT_RGBA5551
Definition: SDL_pixels.h:213
@ SDL_PIXELFORMAT_ARGB1555
Definition: SDL_pixels.h:210
@ SDL_PIXELFORMAT_XBGR4444
Definition: SDL_pixels.h:186
@ SDL_PIXELFORMAT_INDEX8
Definition: SDL_pixels.h:177
@ SDL_PIXELFORMAT_XRGB8888
Definition: SDL_pixels.h:234
@ SDL_PIXELFORMAT_UYVY
Definition: SDL_pixels.h:289
@ SDL_PIXELFORMAT_BGRX32
Definition: SDL_pixels.h:270
@ SDL_PIXELFORMAT_YV12
Definition: SDL_pixels.h:283
@ SDL_PIXELFORMAT_ABGR32
Definition: SDL_pixels.h:267
@ SDL_PIXELFORMAT_BGRX8888
Definition: SDL_pixels.h:243
@ SDL_PIXELFORMAT_RGB24
Definition: SDL_pixels.h:228
@ SDL_PIXELFORMAT_ABGR8888
Definition: SDL_pixels.h:252
@ SDL_PIXELFORMAT_YUY2
Definition: SDL_pixels.h:287
@ SDL_PIXELFORMAT_XBGR32
Definition: SDL_pixels.h:271
@ SDL_PIXELFORMAT_NV12
Definition: SDL_pixels.h:293
@ SDL_PIXELFORMAT_BGRA8888
Definition: SDL_pixels.h:255
@ SDL_PIXELFORMAT_ARGB32
Definition: SDL_pixels.h:265
@ SDL_PIXELFORMAT_ABGR1555
Definition: SDL_pixels.h:216
@ SDL_PIXELFORMAT_NV21
Definition: SDL_pixels.h:295
@ SDL_PIXELFORMAT_IYUV
Definition: SDL_pixels.h:285
@ SDL_PIXELFORMAT_ARGB8888
Definition: SDL_pixels.h:246
@ SDL_PIXELFORMAT_XRGB32
Definition: SDL_pixels.h:269
@ SDL_PIXELFORMAT_XBGR1555
Definition: SDL_pixels.h:194
@ SDL_PIXELFORMAT_XRGB4444
Definition: SDL_pixels.h:182
@ SDL_PIXELFORMAT_ARGB4444
Definition: SDL_pixels.h:198
@ SDL_PIXELFORMAT_RGBA32
Definition: SDL_pixels.h:264
@ SDL_PIXELFORMAT_INDEX1MSB
Definition: SDL_pixels.h:168
@ SDL_PIXELFORMAT_INDEX4LSB
Definition: SDL_pixels.h:171
@ SDL_PIXELFORMAT_RGBX8888
Definition: SDL_pixels.h:237
@ SDL_PIXELFORMAT_BGRA5551
Definition: SDL_pixels.h:219
@ SDL_PIXELFORMAT_XRGB1555
Definition: SDL_pixels.h:190
@ SDL_PIXELFORMAT_RGB565
Definition: SDL_pixels.h:222
@ SDL_PIXELFORMAT_XBGR8888
Definition: SDL_pixels.h:240
@ SDL_PIXELFORMAT_ARGB2101010
Definition: SDL_pixels.h:258
@ SDL_PIXELFORMAT_BGR555
Definition: SDL_pixels.h:197
@ SDL_PIXELFORMAT_UNKNOWN
Definition: SDL_pixels.h:164
@ SDL_PIXELFORMAT_RGBA4444
Definition: SDL_pixels.h:201
#define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes)
Definition: SDL_pixels.h:115
void SDL_GetRGBA(Uint32 pixel, const SDL_PixelFormat *format, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)
SDL_PackedOrder
Definition: SDL_pixels.h:77
@ SDL_PACKEDORDER_NONE
Definition: SDL_pixels.h:78
@ SDL_PACKEDORDER_RGBX
Definition: SDL_pixels.h:80
@ SDL_PACKEDORDER_BGRX
Definition: SDL_pixels.h:84
@ SDL_PACKEDORDER_XBGR
Definition: SDL_pixels.h:83
@ SDL_PACKEDORDER_RGBA
Definition: SDL_pixels.h:82
@ SDL_PACKEDORDER_ABGR
Definition: SDL_pixels.h:85
@ SDL_PACKEDORDER_BGRA
Definition: SDL_pixels.h:86
@ SDL_PACKEDORDER_XRGB
Definition: SDL_pixels.h:79
@ SDL_PACKEDORDER_ARGB
Definition: SDL_pixels.h:81
void SDL_GetRGB(Uint32 pixel, const SDL_PixelFormat *format, Uint8 *r, Uint8 *g, Uint8 *b)
Uint32 SDL_GetPixelFormatEnumForMasks(int bpp, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)
This is a general header that includes C language support.
uint8_t Uint8
Definition: SDL_stdinc.h:147
SDL_bool
Definition: SDL_stdinc.h:130
uint32_t Uint32
Definition: SDL_stdinc.h:171
Uint8 r
Definition: SDL_pixels.h:308
Uint8 b
Definition: SDL_pixels.h:310
Uint8 a
Definition: SDL_pixels.h:311
Uint8 g
Definition: SDL_pixels.h:309
Uint32 version
Definition: SDL_pixels.h:319
SDL_Color * colors
Definition: SDL_pixels.h:318
struct SDL_PixelFormat * next
Definition: SDL_pixels.h:346
Uint8 padding[2]
Definition: SDL_pixels.h:332
Uint8 BytesPerPixel
Definition: SDL_pixels.h:331
Uint8 BitsPerPixel
Definition: SDL_pixels.h:330
SDL_Palette * palette
Definition: SDL_pixels.h:329