SDL 3.0
SDL_pixels.h File Reference
+ Include dependency graph for SDL_pixels.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SDL_Color
 
struct  SDL_FColor
 
struct  SDL_Palette
 
struct  SDL_PixelFormat
 

Transparency definitions

These define alpha as the opacity of a surface.

#define SDL_ALPHA_OPAQUE   255
 
#define SDL_ALPHA_TRANSPARENT   0
 
#define SDL_DEFINE_PIXELFOURCC(A, B, C, D)   SDL_FOURCC(A, B, C, D)
 
#define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes)
 
#define SDL_PIXELFLAG(X)   (((X) >> 28) & 0x0F)
 
#define SDL_PIXELTYPE(X)   (((X) >> 24) & 0x0F)
 
#define SDL_PIXELORDER(X)   (((X) >> 20) & 0x0F)
 
#define SDL_PIXELLAYOUT(X)   (((X) >> 16) & 0x0F)
 
#define SDL_BITSPERPIXEL(X)   (((X) >> 8) & 0xFF)
 
#define SDL_BYTESPERPIXEL(X)
 
#define SDL_ISPIXELFORMAT_INDEXED(format)
 
#define SDL_ISPIXELFORMAT_PACKED(format)
 
#define SDL_ISPIXELFORMAT_ARRAY(format)
 
#define SDL_ISPIXELFORMAT_ALPHA(format)
 
#define SDL_ISPIXELFORMAT_10BIT(format)
 
#define SDL_ISPIXELFORMAT_FLOAT(format)
 
#define SDL_ISPIXELFORMAT_FOURCC(format)    ((format) && (SDL_PIXELFLAG(format) != 1))
 
#define SDL_DEFINE_COLORSPACE(type, range, primaries, transfer, matrix, chroma)
 
#define SDL_COLORSPACETYPE(X)   (SDL_ColorType)(((X) >> 28) & 0x0F)
 
#define SDL_COLORSPACERANGE(X)   (SDL_ColorRange)(((X) >> 24) & 0x0F)
 
#define SDL_COLORSPACECHROMA(X)   (SDL_ChromaLocation)(((X) >> 20) & 0x0F)
 
#define SDL_COLORSPACEPRIMARIES(X)   (SDL_ColorPrimaries)(((X) >> 10) & 0x1F)
 
#define SDL_COLORSPACETRANSFER(X)   (SDL_TransferCharacteristics)(((X) >> 5) & 0x1F)
 
#define SDL_COLORSPACEMATRIX(X)   (SDL_MatrixCoefficients)((X) & 0x1F)
 
#define SDL_Colour   SDL_Color
 
#define SDL_FColour   SDL_FColor
 
enum  SDL_PixelType {
  SDL_PIXELTYPE_UNKNOWN ,
  SDL_PIXELTYPE_INDEX1 ,
  SDL_PIXELTYPE_INDEX4 ,
  SDL_PIXELTYPE_INDEX8 ,
  SDL_PIXELTYPE_PACKED8 ,
  SDL_PIXELTYPE_PACKED16 ,
  SDL_PIXELTYPE_PACKED32 ,
  SDL_PIXELTYPE_ARRAYU8 ,
  SDL_PIXELTYPE_ARRAYU16 ,
  SDL_PIXELTYPE_ARRAYU32 ,
  SDL_PIXELTYPE_ARRAYF16 ,
  SDL_PIXELTYPE_ARRAYF32 ,
  SDL_PIXELTYPE_INDEX2
}
 
enum  SDL_BitmapOrder {
  SDL_BITMAPORDER_NONE ,
  SDL_BITMAPORDER_4321 ,
  SDL_BITMAPORDER_1234
}
 
enum  SDL_PackedOrder {
  SDL_PACKEDORDER_NONE ,
  SDL_PACKEDORDER_XRGB ,
  SDL_PACKEDORDER_RGBX ,
  SDL_PACKEDORDER_ARGB ,
  SDL_PACKEDORDER_RGBA ,
  SDL_PACKEDORDER_XBGR ,
  SDL_PACKEDORDER_BGRX ,
  SDL_PACKEDORDER_ABGR ,
  SDL_PACKEDORDER_BGRA
}
 
enum  SDL_ArrayOrder {
  SDL_ARRAYORDER_NONE ,
  SDL_ARRAYORDER_RGB ,
  SDL_ARRAYORDER_RGBA ,
  SDL_ARRAYORDER_ARGB ,
  SDL_ARRAYORDER_BGR ,
  SDL_ARRAYORDER_BGRA ,
  SDL_ARRAYORDER_ABGR
}
 
enum  SDL_PackedLayout {
  SDL_PACKEDLAYOUT_NONE ,
  SDL_PACKEDLAYOUT_332 ,
  SDL_PACKEDLAYOUT_4444 ,
  SDL_PACKEDLAYOUT_1555 ,
  SDL_PACKEDLAYOUT_5551 ,
  SDL_PACKEDLAYOUT_565 ,
  SDL_PACKEDLAYOUT_8888 ,
  SDL_PACKEDLAYOUT_2101010 ,
  SDL_PACKEDLAYOUT_1010102
}
 
enum  SDL_PixelFormatEnum {
  SDL_PIXELFORMAT_UNKNOWN ,
  SDL_PIXELFORMAT_INDEX1LSB ,
  SDL_PIXELFORMAT_INDEX1MSB ,
  SDL_PIXELFORMAT_INDEX2LSB ,
  SDL_PIXELFORMAT_INDEX2MSB ,
  SDL_PIXELFORMAT_INDEX4LSB ,
  SDL_PIXELFORMAT_INDEX4MSB ,
  SDL_PIXELFORMAT_INDEX8 ,
  SDL_PIXELFORMAT_RGB332 ,
  SDL_PIXELFORMAT_XRGB4444 ,
  SDL_PIXELFORMAT_RGB444 = SDL_PIXELFORMAT_XRGB4444 ,
  SDL_PIXELFORMAT_XBGR4444 ,
  SDL_PIXELFORMAT_BGR444 = SDL_PIXELFORMAT_XBGR4444 ,
  SDL_PIXELFORMAT_XRGB1555 ,
  SDL_PIXELFORMAT_RGB555 = SDL_PIXELFORMAT_XRGB1555 ,
  SDL_PIXELFORMAT_XBGR1555 ,
  SDL_PIXELFORMAT_BGR555 = SDL_PIXELFORMAT_XBGR1555 ,
  SDL_PIXELFORMAT_ARGB4444 ,
  SDL_PIXELFORMAT_RGBA4444 ,
  SDL_PIXELFORMAT_ABGR4444 ,
  SDL_PIXELFORMAT_BGRA4444 ,
  SDL_PIXELFORMAT_ARGB1555 ,
  SDL_PIXELFORMAT_RGBA5551 ,
  SDL_PIXELFORMAT_ABGR1555 ,
  SDL_PIXELFORMAT_BGRA5551 ,
  SDL_PIXELFORMAT_RGB565 ,
  SDL_PIXELFORMAT_BGR565 ,
  SDL_PIXELFORMAT_RGB24 ,
  SDL_PIXELFORMAT_BGR24 ,
  SDL_PIXELFORMAT_XRGB8888 ,
  SDL_PIXELFORMAT_RGBX8888 ,
  SDL_PIXELFORMAT_XBGR8888 ,
  SDL_PIXELFORMAT_BGRX8888 ,
  SDL_PIXELFORMAT_ARGB8888 ,
  SDL_PIXELFORMAT_RGBA8888 ,
  SDL_PIXELFORMAT_ABGR8888 ,
  SDL_PIXELFORMAT_BGRA8888 ,
  SDL_PIXELFORMAT_XRGB2101010 ,
  SDL_PIXELFORMAT_XBGR2101010 ,
  SDL_PIXELFORMAT_ARGB2101010 ,
  SDL_PIXELFORMAT_ABGR2101010 ,
  SDL_PIXELFORMAT_RGB48 ,
  SDL_PIXELFORMAT_BGR48 ,
  SDL_PIXELFORMAT_RGBA64 ,
  SDL_PIXELFORMAT_ARGB64 ,
  SDL_PIXELFORMAT_BGRA64 ,
  SDL_PIXELFORMAT_ABGR64 ,
  SDL_PIXELFORMAT_RGB48_FLOAT ,
  SDL_PIXELFORMAT_BGR48_FLOAT ,
  SDL_PIXELFORMAT_RGBA64_FLOAT ,
  SDL_PIXELFORMAT_ARGB64_FLOAT ,
  SDL_PIXELFORMAT_BGRA64_FLOAT ,
  SDL_PIXELFORMAT_ABGR64_FLOAT ,
  SDL_PIXELFORMAT_RGB96_FLOAT ,
  SDL_PIXELFORMAT_BGR96_FLOAT ,
  SDL_PIXELFORMAT_RGBA128_FLOAT ,
  SDL_PIXELFORMAT_ARGB128_FLOAT ,
  SDL_PIXELFORMAT_BGRA128_FLOAT ,
  SDL_PIXELFORMAT_ABGR128_FLOAT ,
  SDL_PIXELFORMAT_RGBA32 = SDL_PIXELFORMAT_RGBA8888 ,
  SDL_PIXELFORMAT_ARGB32 = SDL_PIXELFORMAT_ARGB8888 ,
  SDL_PIXELFORMAT_BGRA32 = SDL_PIXELFORMAT_BGRA8888 ,
  SDL_PIXELFORMAT_ABGR32 = SDL_PIXELFORMAT_ABGR8888 ,
  SDL_PIXELFORMAT_RGBX32 = SDL_PIXELFORMAT_RGBX8888 ,
  SDL_PIXELFORMAT_XRGB32 = SDL_PIXELFORMAT_XRGB8888 ,
  SDL_PIXELFORMAT_BGRX32 = SDL_PIXELFORMAT_BGRX8888 ,
  SDL_PIXELFORMAT_XBGR32 = SDL_PIXELFORMAT_XBGR8888 ,
  SDL_PIXELFORMAT_YV12 ,
  SDL_PIXELFORMAT_IYUV ,
  SDL_PIXELFORMAT_YUY2 ,
  SDL_PIXELFORMAT_UYVY ,
  SDL_PIXELFORMAT_YVYU ,
  SDL_PIXELFORMAT_NV12 ,
  SDL_PIXELFORMAT_NV21 ,
  SDL_PIXELFORMAT_EXTERNAL_OES =
}
 
enum  SDL_ColorType {
  SDL_COLOR_TYPE_UNKNOWN = 0 ,
  SDL_COLOR_TYPE_RGB = 1 ,
  SDL_COLOR_TYPE_YCBCR = 2
}
 
enum  SDL_ColorRange {
  SDL_COLOR_RANGE_UNKNOWN = 0 ,
  SDL_COLOR_RANGE_LIMITED = 1 ,
  SDL_COLOR_RANGE_FULL = 2
}
 
enum  SDL_ColorPrimaries {
  SDL_COLOR_PRIMARIES_UNKNOWN = 0 ,
  SDL_COLOR_PRIMARIES_BT709 = 1 ,
  SDL_COLOR_PRIMARIES_UNSPECIFIED = 2 ,
  SDL_COLOR_PRIMARIES_BT470M = 4 ,
  SDL_COLOR_PRIMARIES_BT470BG = 5 ,
  SDL_COLOR_PRIMARIES_BT601 = 6 ,
  SDL_COLOR_PRIMARIES_SMPTE240 = 7 ,
  SDL_COLOR_PRIMARIES_GENERIC_FILM = 8 ,
  SDL_COLOR_PRIMARIES_BT2020 = 9 ,
  SDL_COLOR_PRIMARIES_XYZ = 10 ,
  SDL_COLOR_PRIMARIES_SMPTE431 = 11 ,
  SDL_COLOR_PRIMARIES_SMPTE432 = 12 ,
  SDL_COLOR_PRIMARIES_EBU3213 = 22 ,
  SDL_COLOR_PRIMARIES_CUSTOM = 31
}
 
enum  SDL_TransferCharacteristics {
  SDL_TRANSFER_CHARACTERISTICS_UNKNOWN = 0 ,
  SDL_TRANSFER_CHARACTERISTICS_BT709 = 1 ,
  SDL_TRANSFER_CHARACTERISTICS_UNSPECIFIED = 2 ,
  SDL_TRANSFER_CHARACTERISTICS_GAMMA22 = 4 ,
  SDL_TRANSFER_CHARACTERISTICS_GAMMA28 = 5 ,
  SDL_TRANSFER_CHARACTERISTICS_BT601 = 6 ,
  SDL_TRANSFER_CHARACTERISTICS_SMPTE240 = 7 ,
  SDL_TRANSFER_CHARACTERISTICS_LINEAR = 8 ,
  SDL_TRANSFER_CHARACTERISTICS_LOG100 = 9 ,
  SDL_TRANSFER_CHARACTERISTICS_LOG100_SQRT10 = 10 ,
  SDL_TRANSFER_CHARACTERISTICS_IEC61966 = 11 ,
  SDL_TRANSFER_CHARACTERISTICS_BT1361 = 12 ,
  SDL_TRANSFER_CHARACTERISTICS_SRGB = 13 ,
  SDL_TRANSFER_CHARACTERISTICS_BT2020_10BIT = 14 ,
  SDL_TRANSFER_CHARACTERISTICS_BT2020_12BIT = 15 ,
  SDL_TRANSFER_CHARACTERISTICS_PQ = 16 ,
  SDL_TRANSFER_CHARACTERISTICS_SMPTE428 = 17 ,
  SDL_TRANSFER_CHARACTERISTICS_HLG = 18 ,
  SDL_TRANSFER_CHARACTERISTICS_CUSTOM = 31
}
 
enum  SDL_MatrixCoefficients {
  SDL_MATRIX_COEFFICIENTS_IDENTITY = 0 ,
  SDL_MATRIX_COEFFICIENTS_BT709 = 1 ,
  SDL_MATRIX_COEFFICIENTS_UNSPECIFIED = 2 ,
  SDL_MATRIX_COEFFICIENTS_FCC = 4 ,
  SDL_MATRIX_COEFFICIENTS_BT470BG = 5 ,
  SDL_MATRIX_COEFFICIENTS_BT601 = 6 ,
  SDL_MATRIX_COEFFICIENTS_SMPTE240 = 7 ,
  SDL_MATRIX_COEFFICIENTS_YCGCO = 8 ,
  SDL_MATRIX_COEFFICIENTS_BT2020_NCL = 9 ,
  SDL_MATRIX_COEFFICIENTS_BT2020_CL = 10 ,
  SDL_MATRIX_COEFFICIENTS_SMPTE2085 = 11 ,
  SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_NCL = 12 ,
  SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_CL = 13 ,
  SDL_MATRIX_COEFFICIENTS_ICTCP = 14 ,
  SDL_MATRIX_COEFFICIENTS_CUSTOM = 31
}
 
enum  SDL_ChromaLocation {
  SDL_CHROMA_LOCATION_NONE = 0 ,
  SDL_CHROMA_LOCATION_LEFT = 1 ,
  SDL_CHROMA_LOCATION_CENTER = 2 ,
  SDL_CHROMA_LOCATION_TOPLEFT = 3
}
 
enum  SDL_Colorspace {
  SDL_COLORSPACE_UNKNOWN ,
  SDL_COLORSPACE_SRGB ,
  SDL_COLORSPACE_SCRGB ,
  SDL_COLORSPACE_HDR10 ,
  SDL_COLORSPACE_BT601_LIMITED ,
  SDL_COLORSPACE_BT601_FULL ,
  SDL_COLORSPACE_BT709_LIMITED ,
  SDL_COLORSPACE_BT709_FULL ,
  SDL_COLORSPACE_RGB_DEFAULT = SDL_COLORSPACE_SRGB
}
 
const char * SDL_GetPixelFormatName (Uint32 format)
 
SDL_bool SDL_GetMasksForPixelFormatEnum (Uint32 format, int *bpp, Uint32 *Rmask, Uint32 *Gmask, Uint32 *Bmask, Uint32 *Amask)
 
Uint32 SDL_GetPixelFormatEnumForMasks (int bpp, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)
 
SDL_PixelFormatSDL_CreatePixelFormat (Uint32 pixel_format)
 
void SDL_DestroyPixelFormat (SDL_PixelFormat *format)
 
SDL_PaletteSDL_CreatePalette (int ncolors)
 
int SDL_SetPixelFormatPalette (SDL_PixelFormat *format, SDL_Palette *palette)
 
int SDL_SetPaletteColors (SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors)
 
void SDL_DestroyPalette (SDL_Palette *palette)
 
Uint32 SDL_MapRGB (const SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b)
 
Uint32 SDL_MapRGBA (const SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b, Uint8 a)
 
void SDL_GetRGB (Uint32 pixel, const SDL_PixelFormat *format, Uint8 *r, Uint8 *g, Uint8 *b)
 
void SDL_GetRGBA (Uint32 pixel, const SDL_PixelFormat *format, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)
 

Detailed Description

Header for the enumerated pixel format definitions.

SDL's pixel formats have the following naming convention:

* Names with a list of components and a single bit count, such as
  RGB24 and ABGR32, define a platform-independent encoding into
  bytes in the order specified. For example, in RGB24 data, each
  pixel is encoded in 3 bytes (red, green, blue) in that order,
  and in ABGR32 data, each pixel is encoded in 4 bytes
  (alpha, blue, green, red) in that order. Use these names if the
  property of a format that is important to you is the order of
  the bytes in memory or on disk.

* Names with a bit count per component, such as ARGB8888 and
  XRGB1555, are "packed" into an appropriately-sized integer in
  the platform's native endianness. For example, ARGB8888 is
  a sequence of 32-bit integers; in each integer, the most
  significant bits are alpha, and the least significant bits are
  blue. On a little-endian CPU such as x86, the least significant
  bits of each integer are arranged first in memory, but on a
  big-endian CPU such as s390x, the most significant bits are
  arranged first. Use these names if the property of a format that
  is important to you is the meaning of each bit position within a
  native-endianness integer.

* In indexed formats such as INDEX4LSB, each pixel is represented
  by encoding an index into the palette into the indicated number
  of bits, with multiple pixels packed into each byte if appropriate.
  In LSB formats, the first (leftmost) pixel is stored in the
  least-significant bits of the byte; in MSB formats, it's stored
  in the most-significant bits. INDEX8 does not need LSB/MSB
  variants, because each pixel exactly fills one byte.

The 32-bit byte-array encodings such as RGBA32 are aliases for the appropriate 8888 encoding for the current platform. For example, RGBA32 is an alias for ABGR8888 on little-endian CPUs like x86, or an alias for RGBA8888 on big-endian CPUs.

Definition in file SDL_pixels.h.

Macro Definition Documentation

◆ SDL_ALPHA_OPAQUE

#define SDL_ALPHA_OPAQUE   255

Definition at line 82 of file SDL_pixels.h.

◆ SDL_ALPHA_TRANSPARENT

#define SDL_ALPHA_TRANSPARENT   0

Definition at line 83 of file SDL_pixels.h.

◆ SDL_BITSPERPIXEL

#define SDL_BITSPERPIXEL (   X)    (((X) >> 8) & 0xFF)

Definition at line 163 of file SDL_pixels.h.

◆ SDL_BYTESPERPIXEL

#define SDL_BYTESPERPIXEL (   X)
Value:
((((X) == SDL_PIXELFORMAT_YUY2) || \
((X) == SDL_PIXELFORMAT_UYVY) || \
((X) == SDL_PIXELFORMAT_YVYU)) ? 2 : 1) : (((X) >> 0) & 0xFF))
@ SDL_PIXELFORMAT_YVYU
Definition SDL_pixels.h:411
@ SDL_PIXELFORMAT_UYVY
Definition SDL_pixels.h:409
@ SDL_PIXELFORMAT_YUY2
Definition SDL_pixels.h:407
#define SDL_ISPIXELFORMAT_FOURCC(format)
Definition SDL_pixels.h:209

Definition at line 164 of file SDL_pixels.h.

168 : 1) : (((X) >> 0) & 0xFF))

◆ SDL_COLORSPACECHROMA

#define SDL_COLORSPACECHROMA (   X)    (SDL_ChromaLocation)(((X) >> 20) & 0x0F)

Definition at line 553 of file SDL_pixels.h.

◆ SDL_COLORSPACEMATRIX

#define SDL_COLORSPACEMATRIX (   X)    (SDL_MatrixCoefficients)((X) & 0x1F)

Definition at line 556 of file SDL_pixels.h.

◆ SDL_COLORSPACEPRIMARIES

#define SDL_COLORSPACEPRIMARIES (   X)    (SDL_ColorPrimaries)(((X) >> 10) & 0x1F)

Definition at line 554 of file SDL_pixels.h.

◆ SDL_COLORSPACERANGE

#define SDL_COLORSPACERANGE (   X)    (SDL_ColorRange)(((X) >> 24) & 0x0F)

Definition at line 552 of file SDL_pixels.h.

◆ SDL_COLORSPACETRANSFER

#define SDL_COLORSPACETRANSFER (   X)    (SDL_TransferCharacteristics)(((X) >> 5) & 0x1F)

Definition at line 555 of file SDL_pixels.h.

◆ SDL_COLORSPACETYPE

#define SDL_COLORSPACETYPE (   X)    (SDL_ColorType)(((X) >> 28) & 0x0F)

Definition at line 551 of file SDL_pixels.h.

◆ SDL_Colour

#define SDL_Colour   SDL_Color

Definition at line 627 of file SDL_pixels.h.

◆ SDL_DEFINE_COLORSPACE

#define SDL_DEFINE_COLORSPACE (   type,
  range,
  primaries,
  transfer,
  matrix,
  chroma 
)
Value:
(((Uint32)(type) << 28) | ((Uint32)(range) << 24) | ((Uint32)(chroma) << 20) | \
((Uint32)(primaries) << 10) | ((Uint32)(transfer) << 5) | ((Uint32)(matrix) << 0))
uint32_t Uint32
Definition SDL_stdinc.h:174

Definition at line 547 of file SDL_pixels.h.

◆ SDL_DEFINE_PIXELFORMAT

#define SDL_DEFINE_PIXELFORMAT (   type,
  order,
  layout,
  bits,
  bytes 
)
Value:
((1 << 28) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \
((bits) << 8) | ((bytes) << 0))

Definition at line 155 of file SDL_pixels.h.

◆ SDL_DEFINE_PIXELFOURCC

#define SDL_DEFINE_PIXELFOURCC (   A,
  B,
  C,
 
)    SDL_FOURCC(A, B, C, D)

Definition at line 153 of file SDL_pixels.h.

◆ SDL_FColour

#define SDL_FColour   SDL_FColor

Definition at line 640 of file SDL_pixels.h.

◆ SDL_ISPIXELFORMAT_10BIT

#define SDL_ISPIXELFORMAT_10BIT (   format)
Value:
(!SDL_ISPIXELFORMAT_FOURCC(format) && \
@ SDL_PIXELTYPE_PACKED32
Definition SDL_pixels.h:95
@ SDL_PACKEDLAYOUT_2101010
Definition SDL_pixels.h:149
#define SDL_PIXELLAYOUT(X)
Definition SDL_pixels.h:162
#define SDL_PIXELTYPE(X)
Definition SDL_pixels.h:160

Definition at line 198 of file SDL_pixels.h.

◆ SDL_ISPIXELFORMAT_ALPHA

#define SDL_ISPIXELFORMAT_ALPHA (   format)
Value:
((SDL_ISPIXELFORMAT_PACKED(format) && \
#define SDL_ISPIXELFORMAT_PACKED(format)
Definition SDL_pixels.h:177
#define SDL_PIXELORDER(X)
Definition SDL_pixels.h:161
@ SDL_PACKEDORDER_RGBA
Definition SDL_pixels.h:120
@ SDL_PACKEDORDER_ABGR
Definition SDL_pixels.h:123
@ SDL_PACKEDORDER_BGRA
Definition SDL_pixels.h:124
@ SDL_PACKEDORDER_ARGB
Definition SDL_pixels.h:119

Definition at line 191 of file SDL_pixels.h.

◆ SDL_ISPIXELFORMAT_ARRAY

#define SDL_ISPIXELFORMAT_ARRAY (   format)
Value:
(!SDL_ISPIXELFORMAT_FOURCC(format) && \
@ SDL_PIXELTYPE_ARRAYU16
Definition SDL_pixels.h:97
@ SDL_PIXELTYPE_ARRAYU8
Definition SDL_pixels.h:96
@ SDL_PIXELTYPE_ARRAYF16
Definition SDL_pixels.h:99
@ SDL_PIXELTYPE_ARRAYU32
Definition SDL_pixels.h:98
@ SDL_PIXELTYPE_ARRAYF32
Definition SDL_pixels.h:100

Definition at line 183 of file SDL_pixels.h.

◆ SDL_ISPIXELFORMAT_FLOAT

#define SDL_ISPIXELFORMAT_FLOAT (   format)
Value:

Definition at line 203 of file SDL_pixels.h.

◆ SDL_ISPIXELFORMAT_FOURCC

#define SDL_ISPIXELFORMAT_FOURCC (   format)     ((format) && (SDL_PIXELFLAG(format) != 1))

Definition at line 209 of file SDL_pixels.h.

◆ SDL_ISPIXELFORMAT_INDEXED

#define SDL_ISPIXELFORMAT_INDEXED (   format)
Value:
(!SDL_ISPIXELFORMAT_FOURCC(format) && \
@ SDL_PIXELTYPE_INDEX2
Definition SDL_pixels.h:102
@ SDL_PIXELTYPE_INDEX4
Definition SDL_pixels.h:91
@ SDL_PIXELTYPE_INDEX1
Definition SDL_pixels.h:90
@ SDL_PIXELTYPE_INDEX8
Definition SDL_pixels.h:92

Definition at line 170 of file SDL_pixels.h.

◆ SDL_ISPIXELFORMAT_PACKED

#define SDL_ISPIXELFORMAT_PACKED (   format)
Value:
(!SDL_ISPIXELFORMAT_FOURCC(format) && \
@ SDL_PIXELTYPE_PACKED8
Definition SDL_pixels.h:93
@ SDL_PIXELTYPE_PACKED16
Definition SDL_pixels.h:94

Definition at line 177 of file SDL_pixels.h.

◆ SDL_PIXELFLAG

#define SDL_PIXELFLAG (   X)    (((X) >> 28) & 0x0F)

Definition at line 159 of file SDL_pixels.h.

◆ SDL_PIXELLAYOUT

#define SDL_PIXELLAYOUT (   X)    (((X) >> 16) & 0x0F)

Definition at line 162 of file SDL_pixels.h.

◆ SDL_PIXELORDER

#define SDL_PIXELORDER (   X)    (((X) >> 20) & 0x0F)

Definition at line 161 of file SDL_pixels.h.

◆ SDL_PIXELTYPE

#define SDL_PIXELTYPE (   X)    (((X) >> 24) & 0x0F)

Definition at line 160 of file SDL_pixels.h.

Enumeration Type Documentation

◆ SDL_ArrayOrder

Array component order, low byte -> high byte.

Enumerator
SDL_ARRAYORDER_NONE 
SDL_ARRAYORDER_RGB 
SDL_ARRAYORDER_RGBA 
SDL_ARRAYORDER_ARGB 
SDL_ARRAYORDER_BGR 
SDL_ARRAYORDER_BGRA 
SDL_ARRAYORDER_ABGR 

Definition at line 128 of file SDL_pixels.h.

129{
SDL_ArrayOrder
Definition SDL_pixels.h:129
@ SDL_ARRAYORDER_RGB
Definition SDL_pixels.h:131
@ SDL_ARRAYORDER_NONE
Definition SDL_pixels.h:130
@ SDL_ARRAYORDER_ARGB
Definition SDL_pixels.h:133
@ SDL_ARRAYORDER_BGRA
Definition SDL_pixels.h:135
@ SDL_ARRAYORDER_ABGR
Definition SDL_pixels.h:136
@ SDL_ARRAYORDER_RGBA
Definition SDL_pixels.h:132
@ SDL_ARRAYORDER_BGR
Definition SDL_pixels.h:134

◆ SDL_BitmapOrder

Bitmap pixel order, high bit -> low bit.

Enumerator
SDL_BITMAPORDER_NONE 
SDL_BITMAPORDER_4321 
SDL_BITMAPORDER_1234 

Definition at line 106 of file SDL_pixels.h.

107{
SDL_BitmapOrder
Definition SDL_pixels.h:107
@ SDL_BITMAPORDER_1234
Definition SDL_pixels.h:110
@ SDL_BITMAPORDER_NONE
Definition SDL_pixels.h:108
@ SDL_BITMAPORDER_4321
Definition SDL_pixels.h:109

◆ SDL_ChromaLocation

The chroma sample location

Enumerator
SDL_CHROMA_LOCATION_NONE 

RGB, no chroma sampling

SDL_CHROMA_LOCATION_LEFT 

In MPEG-2, MPEG-4, and AVC, Cb and Cr are taken on midpoint of the left-edge of the 2×2 square. In other words, they have the same horizontal location as the top-left pixel, but is shifted one-half pixel down vertically.

SDL_CHROMA_LOCATION_CENTER 

In JPEG/JFIF, H.261, and MPEG-1, Cb and Cr are taken at the center of 2×2 the square. In other words, they are offset one-half pixel to the right and one-half pixel down compared to the top-left pixel.

SDL_CHROMA_LOCATION_TOPLEFT 

In HEVC for BT.2020 and BT.2100 content (in particular on Blu-rays), Cb and Cr are sampled at the same location as the group's top-left Y pixel ("co-sited", "co-located").

Definition at line 537 of file SDL_pixels.h.

538{
539 SDL_CHROMA_LOCATION_NONE = 0, /**< RGB, no chroma sampling */
540 SDL_CHROMA_LOCATION_LEFT = 1, /**< In MPEG-2, MPEG-4, and AVC, Cb and Cr are taken on midpoint of the left-edge of the 2×2 square. In other words, they have the same horizontal location as the top-left pixel, but is shifted one-half pixel down vertically. */
541 SDL_CHROMA_LOCATION_CENTER = 2, /**< In JPEG/JFIF, H.261, and MPEG-1, Cb and Cr are taken at the center of 2×2 the square. In other words, they are offset one-half pixel to the right and one-half pixel down compared to the top-left pixel. */
542 SDL_CHROMA_LOCATION_TOPLEFT = 3 /**< In HEVC for BT.2020 and BT.2100 content (in particular on Blu-rays), Cb and Cr are sampled at the same location as the group's top-left Y pixel ("co-sited", "co-located"). */
SDL_ChromaLocation
Definition SDL_pixels.h:538
@ SDL_CHROMA_LOCATION_NONE
Definition SDL_pixels.h:539
@ SDL_CHROMA_LOCATION_TOPLEFT
Definition SDL_pixels.h:542
@ SDL_CHROMA_LOCATION_CENTER
Definition SDL_pixels.h:541
@ SDL_CHROMA_LOCATION_LEFT
Definition SDL_pixels.h:540

◆ SDL_ColorPrimaries

The color primaries, as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en

Enumerator
SDL_COLOR_PRIMARIES_UNKNOWN 
SDL_COLOR_PRIMARIES_BT709 
SDL_COLOR_PRIMARIES_UNSPECIFIED 
SDL_COLOR_PRIMARIES_BT470M 
SDL_COLOR_PRIMARIES_BT470BG 
SDL_COLOR_PRIMARIES_BT601 
SDL_COLOR_PRIMARIES_SMPTE240 
SDL_COLOR_PRIMARIES_GENERIC_FILM 
SDL_COLOR_PRIMARIES_BT2020 
SDL_COLOR_PRIMARIES_XYZ 
SDL_COLOR_PRIMARIES_SMPTE431 
SDL_COLOR_PRIMARIES_SMPTE432 
SDL_COLOR_PRIMARIES_EBU3213 
SDL_COLOR_PRIMARIES_CUSTOM 

Definition at line 468 of file SDL_pixels.h.

469{
481 SDL_COLOR_PRIMARIES_SMPTE432 = 12, /* DCI P3 */
SDL_ColorPrimaries
Definition SDL_pixels.h:469
@ SDL_COLOR_PRIMARIES_SMPTE431
Definition SDL_pixels.h:480
@ SDL_COLOR_PRIMARIES_CUSTOM
Definition SDL_pixels.h:483
@ SDL_COLOR_PRIMARIES_EBU3213
Definition SDL_pixels.h:482
@ SDL_COLOR_PRIMARIES_GENERIC_FILM
Definition SDL_pixels.h:477
@ SDL_COLOR_PRIMARIES_BT601
Definition SDL_pixels.h:475
@ SDL_COLOR_PRIMARIES_UNSPECIFIED
Definition SDL_pixels.h:472
@ SDL_COLOR_PRIMARIES_SMPTE240
Definition SDL_pixels.h:476
@ SDL_COLOR_PRIMARIES_XYZ
Definition SDL_pixels.h:479
@ SDL_COLOR_PRIMARIES_UNKNOWN
Definition SDL_pixels.h:470
@ SDL_COLOR_PRIMARIES_SMPTE432
Definition SDL_pixels.h:481
@ SDL_COLOR_PRIMARIES_BT2020
Definition SDL_pixels.h:478
@ SDL_COLOR_PRIMARIES_BT470BG
Definition SDL_pixels.h:474
@ SDL_COLOR_PRIMARIES_BT709
Definition SDL_pixels.h:471
@ SDL_COLOR_PRIMARIES_BT470M
Definition SDL_pixels.h:473

◆ SDL_ColorRange

The color range, as described by https://www.itu.int/rec/R-REC-BT.2100-2-201807-I/en

Enumerator
SDL_COLOR_RANGE_UNKNOWN 
SDL_COLOR_RANGE_LIMITED 

Narrow range, e.g. 16-235 for 8-bit RGB and luma, and 16-240 for 8-bit chroma

SDL_COLOR_RANGE_FULL 

Full range, e.g. 0-255 for 8-bit RGB and luma, and 1-255 for 8-bit chroma

Definition at line 458 of file SDL_pixels.h.

459{
461 SDL_COLOR_RANGE_LIMITED = 1, /**< Narrow range, e.g. 16-235 for 8-bit RGB and luma, and 16-240 for 8-bit chroma */
462 SDL_COLOR_RANGE_FULL = 2 /**< Full range, e.g. 0-255 for 8-bit RGB and luma, and 1-255 for 8-bit chroma */
SDL_ColorRange
Definition SDL_pixels.h:459
@ SDL_COLOR_RANGE_LIMITED
Definition SDL_pixels.h:461
@ SDL_COLOR_RANGE_FULL
Definition SDL_pixels.h:462
@ SDL_COLOR_RANGE_UNKNOWN
Definition SDL_pixels.h:460

◆ SDL_Colorspace

Enumerator
SDL_COLORSPACE_UNKNOWN 
SDL_COLORSPACE_SRGB 

Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P709

SDL_COLORSPACE_SCRGB 

Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G10_NONE_P709

SDL_COLORSPACE_HDR10 

Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G2084_NONE_P2020

SDL_COLORSPACE_BT601_LIMITED 

Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601

SDL_COLORSPACE_BT601_FULL 

Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601

SDL_COLORSPACE_BT709_LIMITED 

Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709

SDL_COLORSPACE_BT709_FULL 

Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709

SDL_COLORSPACE_RGB_DEFAULT 

Definition at line 558 of file SDL_pixels.h.

559{
561 SDL_COLORSPACE_SRGB = /**< Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P709 */
568 SDL_COLORSPACE_SCRGB = /**< Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G10_NONE_P709 */
575 SDL_COLORSPACE_HDR10 = /**< Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G2084_NONE_P2020 */
582 SDL_COLORSPACE_BT601_LIMITED = /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601 */
589 SDL_COLORSPACE_BT601_FULL = /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601 */
596 SDL_COLORSPACE_BT709_LIMITED = /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709 */
603 SDL_COLORSPACE_BT709_FULL = /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709 */
610
611 /* The default colorspace for RGB surfaces if no colorspace is specified */
@ SDL_MATRIX_COEFFICIENTS_BT709
Definition SDL_pixels.h:518
@ SDL_MATRIX_COEFFICIENTS_BT601
Definition SDL_pixels.h:522
@ SDL_MATRIX_COEFFICIENTS_UNSPECIFIED
Definition SDL_pixels.h:519
#define SDL_DEFINE_COLORSPACE(type, range, primaries, transfer, matrix, chroma)
Definition SDL_pixels.h:547
@ SDL_COLOR_TYPE_RGB
Definition SDL_pixels.h:451
@ SDL_COLOR_TYPE_YCBCR
Definition SDL_pixels.h:452
@ SDL_TRANSFER_CHARACTERISTICS_BT709
Definition SDL_pixels.h:492
@ SDL_TRANSFER_CHARACTERISTICS_BT601
Definition SDL_pixels.h:496
@ SDL_TRANSFER_CHARACTERISTICS_SRGB
Definition SDL_pixels.h:503
@ SDL_TRANSFER_CHARACTERISTICS_PQ
Definition SDL_pixels.h:506
@ SDL_TRANSFER_CHARACTERISTICS_LINEAR
Definition SDL_pixels.h:498
SDL_Colorspace
Definition SDL_pixels.h:559
@ SDL_COLORSPACE_SCRGB
Definition SDL_pixels.h:568
@ SDL_COLORSPACE_BT601_LIMITED
Definition SDL_pixels.h:582
@ SDL_COLORSPACE_BT709_FULL
Definition SDL_pixels.h:603
@ SDL_COLORSPACE_HDR10
Definition SDL_pixels.h:575
@ SDL_COLORSPACE_BT601_FULL
Definition SDL_pixels.h:589
@ SDL_COLORSPACE_UNKNOWN
Definition SDL_pixels.h:560
@ SDL_COLORSPACE_BT709_LIMITED
Definition SDL_pixels.h:596
@ SDL_COLORSPACE_SRGB
Definition SDL_pixels.h:561
@ SDL_COLORSPACE_RGB_DEFAULT
Definition SDL_pixels.h:612

◆ SDL_ColorType

Pixels are a representation of a color in a particular color space.

The first characteristic of a color space is the color type. SDL understands two different color types, RGB and YCbCr, or in SDL also referred to as YUV.

RGB colors consist of red, green, and blue channels of color that are added together to represent the colors we see on the screen. https://en.wikipedia.org/wiki/RGB_color_model

YCbCr colors represent colors as a Y luma brightness component and red and blue chroma color offsets. This color representation takes advantage of the fact that the human eye is more sensitive to brightness than the color in an image. The Cb and Cr components are often compressed and have lower resolution than the luma component. https://en.wikipedia.org/wiki/YCbCr

When the color information in YCbCr is compressed, the Y pixels are left at full resolution and each Cr and Cb pixel represents an average of the color information in a block of Y pixels. The chroma location determines where in that block of pixels the color information is coming from.

The color range defines how much of the pixel to use when converting a pixel into a color on the display. When the full color range is used, the entire numeric range of the pixel bits is significant. When narrow color range is used, for historical reasons, the pixel uses only a portion of the numeric range to represent colors.

The color primaries and white point are a definition of the colors in the color space relative to the standard XYZ color space. https://en.wikipedia.org/wiki/CIE_1931_color_space

The transfer characteristic, or opto-electrical transfer function (OETF), is the way a color is converted from mathematically linear space into a non-linear output signals. https://en.wikipedia.org/wiki/Rec._709#Transfer_characteristics

The matrix coefficients are used to convert between YCbCr and RGB colors. The color type

Enumerator
SDL_COLOR_TYPE_UNKNOWN 
SDL_COLOR_TYPE_RGB 
SDL_COLOR_TYPE_YCBCR 

Definition at line 448 of file SDL_pixels.h.

449{
SDL_ColorType
Definition SDL_pixels.h:449
@ SDL_COLOR_TYPE_UNKNOWN
Definition SDL_pixels.h:450

◆ SDL_MatrixCoefficients

The matrix coefficients, as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en

Enumerator
SDL_MATRIX_COEFFICIENTS_IDENTITY 
SDL_MATRIX_COEFFICIENTS_BT709 
SDL_MATRIX_COEFFICIENTS_UNSPECIFIED 
SDL_MATRIX_COEFFICIENTS_FCC 
SDL_MATRIX_COEFFICIENTS_BT470BG 
SDL_MATRIX_COEFFICIENTS_BT601 
SDL_MATRIX_COEFFICIENTS_SMPTE240 
SDL_MATRIX_COEFFICIENTS_YCGCO 
SDL_MATRIX_COEFFICIENTS_BT2020_NCL 
SDL_MATRIX_COEFFICIENTS_BT2020_CL 
SDL_MATRIX_COEFFICIENTS_SMPTE2085 
SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_NCL 
SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_CL 
SDL_MATRIX_COEFFICIENTS_ICTCP 
SDL_MATRIX_COEFFICIENTS_CUSTOM 

Definition at line 515 of file SDL_pixels.h.

516{
SDL_MatrixCoefficients
Definition SDL_pixels.h:516
@ SDL_MATRIX_COEFFICIENTS_BT2020_CL
Definition SDL_pixels.h:526
@ SDL_MATRIX_COEFFICIENTS_BT2020_NCL
Definition SDL_pixels.h:525
@ SDL_MATRIX_COEFFICIENTS_SMPTE240
Definition SDL_pixels.h:523
@ SDL_MATRIX_COEFFICIENTS_YCGCO
Definition SDL_pixels.h:524
@ SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_NCL
Definition SDL_pixels.h:528
@ SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_CL
Definition SDL_pixels.h:529
@ SDL_MATRIX_COEFFICIENTS_CUSTOM
Definition SDL_pixels.h:531
@ SDL_MATRIX_COEFFICIENTS_ICTCP
Definition SDL_pixels.h:530
@ SDL_MATRIX_COEFFICIENTS_IDENTITY
Definition SDL_pixels.h:517
@ SDL_MATRIX_COEFFICIENTS_FCC
Definition SDL_pixels.h:520
@ SDL_MATRIX_COEFFICIENTS_BT470BG
Definition SDL_pixels.h:521
@ SDL_MATRIX_COEFFICIENTS_SMPTE2085
Definition SDL_pixels.h:527

◆ SDL_PackedLayout

Packed component layout.

Enumerator
SDL_PACKEDLAYOUT_NONE 
SDL_PACKEDLAYOUT_332 
SDL_PACKEDLAYOUT_4444 
SDL_PACKEDLAYOUT_1555 
SDL_PACKEDLAYOUT_5551 
SDL_PACKEDLAYOUT_565 
SDL_PACKEDLAYOUT_8888 
SDL_PACKEDLAYOUT_2101010 
SDL_PACKEDLAYOUT_1010102 

Definition at line 140 of file SDL_pixels.h.

141{
SDL_PackedLayout
Definition SDL_pixels.h:141
@ SDL_PACKEDLAYOUT_NONE
Definition SDL_pixels.h:142
@ SDL_PACKEDLAYOUT_8888
Definition SDL_pixels.h:148
@ SDL_PACKEDLAYOUT_1010102
Definition SDL_pixels.h:150
@ SDL_PACKEDLAYOUT_565
Definition SDL_pixels.h:147
@ SDL_PACKEDLAYOUT_332
Definition SDL_pixels.h:143
@ SDL_PACKEDLAYOUT_5551
Definition SDL_pixels.h:146
@ SDL_PACKEDLAYOUT_1555
Definition SDL_pixels.h:145
@ SDL_PACKEDLAYOUT_4444
Definition SDL_pixels.h:144

◆ SDL_PackedOrder

Packed component order, high bit -> low bit.

Enumerator
SDL_PACKEDORDER_NONE 
SDL_PACKEDORDER_XRGB 
SDL_PACKEDORDER_RGBX 
SDL_PACKEDORDER_ARGB 
SDL_PACKEDORDER_RGBA 
SDL_PACKEDORDER_XBGR 
SDL_PACKEDORDER_BGRX 
SDL_PACKEDORDER_ABGR 
SDL_PACKEDORDER_BGRA 

Definition at line 114 of file SDL_pixels.h.

◆ SDL_PixelFormatEnum

Enumerator
SDL_PIXELFORMAT_UNKNOWN 
SDL_PIXELFORMAT_INDEX1LSB 
SDL_PIXELFORMAT_INDEX1MSB 
SDL_PIXELFORMAT_INDEX2LSB 
SDL_PIXELFORMAT_INDEX2MSB 
SDL_PIXELFORMAT_INDEX4LSB 
SDL_PIXELFORMAT_INDEX4MSB 
SDL_PIXELFORMAT_INDEX8 
SDL_PIXELFORMAT_RGB332 
SDL_PIXELFORMAT_XRGB4444 
SDL_PIXELFORMAT_RGB444 
SDL_PIXELFORMAT_XBGR4444 
SDL_PIXELFORMAT_BGR444 
SDL_PIXELFORMAT_XRGB1555 
SDL_PIXELFORMAT_RGB555 
SDL_PIXELFORMAT_XBGR1555 
SDL_PIXELFORMAT_BGR555 
SDL_PIXELFORMAT_ARGB4444 
SDL_PIXELFORMAT_RGBA4444 
SDL_PIXELFORMAT_ABGR4444 
SDL_PIXELFORMAT_BGRA4444 
SDL_PIXELFORMAT_ARGB1555 
SDL_PIXELFORMAT_RGBA5551 
SDL_PIXELFORMAT_ABGR1555 
SDL_PIXELFORMAT_BGRA5551 
SDL_PIXELFORMAT_RGB565 
SDL_PIXELFORMAT_BGR565 
SDL_PIXELFORMAT_RGB24 
SDL_PIXELFORMAT_BGR24 
SDL_PIXELFORMAT_XRGB8888 
SDL_PIXELFORMAT_RGBX8888 
SDL_PIXELFORMAT_XBGR8888 
SDL_PIXELFORMAT_BGRX8888 
SDL_PIXELFORMAT_ARGB8888 
SDL_PIXELFORMAT_RGBA8888 
SDL_PIXELFORMAT_ABGR8888 
SDL_PIXELFORMAT_BGRA8888 
SDL_PIXELFORMAT_XRGB2101010 
SDL_PIXELFORMAT_XBGR2101010 
SDL_PIXELFORMAT_ARGB2101010 
SDL_PIXELFORMAT_ABGR2101010 
SDL_PIXELFORMAT_RGB48 
SDL_PIXELFORMAT_BGR48 
SDL_PIXELFORMAT_RGBA64 
SDL_PIXELFORMAT_ARGB64 
SDL_PIXELFORMAT_BGRA64 
SDL_PIXELFORMAT_ABGR64 
SDL_PIXELFORMAT_RGB48_FLOAT 
SDL_PIXELFORMAT_BGR48_FLOAT 
SDL_PIXELFORMAT_RGBA64_FLOAT 
SDL_PIXELFORMAT_ARGB64_FLOAT 
SDL_PIXELFORMAT_BGRA64_FLOAT 
SDL_PIXELFORMAT_ABGR64_FLOAT 
SDL_PIXELFORMAT_RGB96_FLOAT 
SDL_PIXELFORMAT_BGR96_FLOAT 
SDL_PIXELFORMAT_RGBA128_FLOAT 
SDL_PIXELFORMAT_ARGB128_FLOAT 
SDL_PIXELFORMAT_BGRA128_FLOAT 
SDL_PIXELFORMAT_ABGR128_FLOAT 
SDL_PIXELFORMAT_RGBA32 
SDL_PIXELFORMAT_ARGB32 
SDL_PIXELFORMAT_BGRA32 
SDL_PIXELFORMAT_ABGR32 
SDL_PIXELFORMAT_RGBX32 
SDL_PIXELFORMAT_XRGB32 
SDL_PIXELFORMAT_BGRX32 
SDL_PIXELFORMAT_XBGR32 
SDL_PIXELFORMAT_YV12 

Planar mode: Y + V + U (3 planes)

SDL_PIXELFORMAT_IYUV 

Planar mode: Y + U + V (3 planes)

SDL_PIXELFORMAT_YUY2 

Packed mode: Y0+U0+Y1+V0 (1 plane)

SDL_PIXELFORMAT_UYVY 

Packed mode: U0+Y0+V0+Y1 (1 plane)

SDL_PIXELFORMAT_YVYU 

Packed mode: Y0+V0+Y1+U0 (1 plane)

SDL_PIXELFORMAT_NV12 

Planar mode: Y + U/V interleaved (2 planes)

SDL_PIXELFORMAT_NV21 

Planar mode: Y + V/U interleaved (2 planes)

SDL_PIXELFORMAT_EXTERNAL_OES 

Android video texture format

Definition at line 213 of file SDL_pixels.h.

214{
218 1, 0),
221 1, 0),
224 2, 0),
227 2, 0),
230 4, 0),
233 4, 0),
241 SDL_PACKEDLAYOUT_4444, 12, 2),
245 SDL_PACKEDLAYOUT_4444, 12, 2),
249 SDL_PACKEDLAYOUT_1555, 15, 2),
253 SDL_PACKEDLAYOUT_1555, 15, 2),
257 SDL_PACKEDLAYOUT_4444, 16, 2),
260 SDL_PACKEDLAYOUT_4444, 16, 2),
263 SDL_PACKEDLAYOUT_4444, 16, 2),
266 SDL_PACKEDLAYOUT_4444, 16, 2),
269 SDL_PACKEDLAYOUT_1555, 16, 2),
272 SDL_PACKEDLAYOUT_5551, 16, 2),
275 SDL_PACKEDLAYOUT_1555, 16, 2),
278 SDL_PACKEDLAYOUT_5551, 16, 2),
281 SDL_PACKEDLAYOUT_565, 16, 2),
284 SDL_PACKEDLAYOUT_565, 16, 2),
287 24, 3),
290 24, 3),
293 SDL_PACKEDLAYOUT_8888, 24, 4),
296 SDL_PACKEDLAYOUT_8888, 24, 4),
299 SDL_PACKEDLAYOUT_8888, 24, 4),
302 SDL_PACKEDLAYOUT_8888, 24, 4),
305 SDL_PACKEDLAYOUT_8888, 32, 4),
308 SDL_PACKEDLAYOUT_8888, 32, 4),
311 SDL_PACKEDLAYOUT_8888, 32, 4),
314 SDL_PACKEDLAYOUT_8888, 32, 4),
329 48, 6),
332 48, 6),
335 64, 8),
338 64, 8),
341 64, 8),
344 64, 8),
347 48, 6),
350 48, 6),
353 64, 8),
356 64, 8),
359 64, 8),
362 64, 8),
365 96, 12),
368 96, 12),
371 128, 16),
374 128, 16),
377 128, 16),
380 128, 16),
381
382 /* Aliases for RGBA byte arrays of color data, for the current platform */
383#if SDL_BYTEORDER == SDL_BIG_ENDIAN
392#else
401#endif
402
403 SDL_PIXELFORMAT_YV12 = /**< Planar mode: Y + V + U (3 planes) */
404 SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
405 SDL_PIXELFORMAT_IYUV = /**< Planar mode: Y + U + V (3 planes) */
406 SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
407 SDL_PIXELFORMAT_YUY2 = /**< Packed mode: Y0+U0+Y1+V0 (1 plane) */
408 SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
409 SDL_PIXELFORMAT_UYVY = /**< Packed mode: U0+Y0+V0+Y1 (1 plane) */
410 SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
411 SDL_PIXELFORMAT_YVYU = /**< Packed mode: Y0+V0+Y1+U0 (1 plane) */
412 SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U'),
413 SDL_PIXELFORMAT_NV12 = /**< Planar mode: Y + U/V interleaved (2 planes) */
414 SDL_DEFINE_PIXELFOURCC('N', 'V', '1', '2'),
415 SDL_PIXELFORMAT_NV21 = /**< Planar mode: Y + V/U interleaved (2 planes) */
416 SDL_DEFINE_PIXELFOURCC('N', 'V', '2', '1'),
417 SDL_PIXELFORMAT_EXTERNAL_OES = /**< Android video texture format */
418 SDL_DEFINE_PIXELFOURCC('O', 'E', 'S', ' ')
#define SDL_DEFINE_PIXELFOURCC(A, B, C, D)
Definition SDL_pixels.h:153
SDL_PixelFormatEnum
Definition SDL_pixels.h:214
@ SDL_PIXELFORMAT_BGR48_FLOAT
Definition SDL_pixels.h:348
@ SDL_PIXELFORMAT_RGBA128_FLOAT
Definition SDL_pixels.h:369
@ SDL_PIXELFORMAT_BGR565
Definition SDL_pixels.h:282
@ SDL_PIXELFORMAT_EXTERNAL_OES
Definition SDL_pixels.h:417
@ SDL_PIXELFORMAT_ARGB64
Definition SDL_pixels.h:336
@ SDL_PIXELFORMAT_RGB332
Definition SDL_pixels.h:236
@ SDL_PIXELFORMAT_INDEX2LSB
Definition SDL_pixels.h:222
@ SDL_PIXELFORMAT_INDEX1LSB
Definition SDL_pixels.h:216
@ SDL_PIXELFORMAT_BGR444
Definition SDL_pixels.h:246
@ SDL_PIXELFORMAT_RGB96_FLOAT
Definition SDL_pixels.h:363
@ SDL_PIXELFORMAT_RGBX32
Definition SDL_pixels.h:388
@ SDL_PIXELFORMAT_ABGR4444
Definition SDL_pixels.h:261
@ SDL_PIXELFORMAT_BGRA4444
Definition SDL_pixels.h:264
@ SDL_PIXELFORMAT_BGR24
Definition SDL_pixels.h:288
@ SDL_PIXELFORMAT_INDEX4MSB
Definition SDL_pixels.h:231
@ SDL_PIXELFORMAT_ABGR2101010
Definition SDL_pixels.h:324
@ SDL_PIXELFORMAT_BGRA32
Definition SDL_pixels.h:386
@ SDL_PIXELFORMAT_RGB555
Definition SDL_pixels.h:250
@ SDL_PIXELFORMAT_RGB444
Definition SDL_pixels.h:242
@ SDL_PIXELFORMAT_XBGR2101010
Definition SDL_pixels.h:318
@ SDL_PIXELFORMAT_RGBA64_FLOAT
Definition SDL_pixels.h:351
@ SDL_PIXELFORMAT_INDEX2MSB
Definition SDL_pixels.h:225
@ SDL_PIXELFORMAT_BGRA64_FLOAT
Definition SDL_pixels.h:357
@ SDL_PIXELFORMAT_RGBA8888
Definition SDL_pixels.h:306
@ SDL_PIXELFORMAT_RGBA5551
Definition SDL_pixels.h:270
@ SDL_PIXELFORMAT_ARGB1555
Definition SDL_pixels.h:267
@ SDL_PIXELFORMAT_XBGR4444
Definition SDL_pixels.h:243
@ SDL_PIXELFORMAT_RGBA64
Definition SDL_pixels.h:333
@ SDL_PIXELFORMAT_INDEX8
Definition SDL_pixels.h:234
@ SDL_PIXELFORMAT_XRGB2101010
Definition SDL_pixels.h:315
@ SDL_PIXELFORMAT_XRGB8888
Definition SDL_pixels.h:291
@ SDL_PIXELFORMAT_BGRX32
Definition SDL_pixels.h:390
@ SDL_PIXELFORMAT_YV12
Definition SDL_pixels.h:403
@ SDL_PIXELFORMAT_ABGR32
Definition SDL_pixels.h:387
@ SDL_PIXELFORMAT_BGRX8888
Definition SDL_pixels.h:300
@ SDL_PIXELFORMAT_RGB24
Definition SDL_pixels.h:285
@ SDL_PIXELFORMAT_BGRA64
Definition SDL_pixels.h:339
@ SDL_PIXELFORMAT_ABGR8888
Definition SDL_pixels.h:309
@ SDL_PIXELFORMAT_XBGR32
Definition SDL_pixels.h:391
@ SDL_PIXELFORMAT_NV12
Definition SDL_pixels.h:413
@ SDL_PIXELFORMAT_BGRA8888
Definition SDL_pixels.h:312
@ SDL_PIXELFORMAT_ABGR128_FLOAT
Definition SDL_pixels.h:378
@ SDL_PIXELFORMAT_ARGB32
Definition SDL_pixels.h:385
@ SDL_PIXELFORMAT_ABGR1555
Definition SDL_pixels.h:273
@ SDL_PIXELFORMAT_NV21
Definition SDL_pixels.h:415
@ SDL_PIXELFORMAT_IYUV
Definition SDL_pixels.h:405
@ SDL_PIXELFORMAT_ARGB8888
Definition SDL_pixels.h:303
@ SDL_PIXELFORMAT_ABGR64_FLOAT
Definition SDL_pixels.h:360
@ SDL_PIXELFORMAT_ABGR64
Definition SDL_pixels.h:342
@ SDL_PIXELFORMAT_XRGB32
Definition SDL_pixels.h:389
@ SDL_PIXELFORMAT_XBGR1555
Definition SDL_pixels.h:251
@ SDL_PIXELFORMAT_RGB48
Definition SDL_pixels.h:327
@ SDL_PIXELFORMAT_XRGB4444
Definition SDL_pixels.h:239
@ SDL_PIXELFORMAT_BGR96_FLOAT
Definition SDL_pixels.h:366
@ SDL_PIXELFORMAT_ARGB4444
Definition SDL_pixels.h:255
@ SDL_PIXELFORMAT_RGB48_FLOAT
Definition SDL_pixels.h:345
@ SDL_PIXELFORMAT_BGR48
Definition SDL_pixels.h:330
@ SDL_PIXELFORMAT_RGBA32
Definition SDL_pixels.h:384
@ SDL_PIXELFORMAT_BGRA128_FLOAT
Definition SDL_pixels.h:375
@ SDL_PIXELFORMAT_ARGB64_FLOAT
Definition SDL_pixels.h:354
@ SDL_PIXELFORMAT_INDEX1MSB
Definition SDL_pixels.h:219
@ SDL_PIXELFORMAT_INDEX4LSB
Definition SDL_pixels.h:228
@ SDL_PIXELFORMAT_RGBX8888
Definition SDL_pixels.h:294
@ SDL_PIXELFORMAT_BGRA5551
Definition SDL_pixels.h:276
@ SDL_PIXELFORMAT_ARGB128_FLOAT
Definition SDL_pixels.h:372
@ SDL_PIXELFORMAT_XRGB1555
Definition SDL_pixels.h:247
@ SDL_PIXELFORMAT_RGB565
Definition SDL_pixels.h:279
@ SDL_PIXELFORMAT_XBGR8888
Definition SDL_pixels.h:297
@ SDL_PIXELFORMAT_ARGB2101010
Definition SDL_pixels.h:321
@ SDL_PIXELFORMAT_BGR555
Definition SDL_pixels.h:254
@ SDL_PIXELFORMAT_UNKNOWN
Definition SDL_pixels.h:215
@ SDL_PIXELFORMAT_RGBA4444
Definition SDL_pixels.h:258
#define SDL_DEFINE_PIXELFORMAT(type, order, layout, bits, bytes)
Definition SDL_pixels.h:155

◆ SDL_PixelType

Pixel type.

Enumerator
SDL_PIXELTYPE_UNKNOWN 
SDL_PIXELTYPE_INDEX1 
SDL_PIXELTYPE_INDEX4 
SDL_PIXELTYPE_INDEX8 
SDL_PIXELTYPE_PACKED8 
SDL_PIXELTYPE_PACKED16 
SDL_PIXELTYPE_PACKED32 
SDL_PIXELTYPE_ARRAYU8 
SDL_PIXELTYPE_ARRAYU16 
SDL_PIXELTYPE_ARRAYU32 
SDL_PIXELTYPE_ARRAYF16 
SDL_PIXELTYPE_ARRAYF32 
SDL_PIXELTYPE_INDEX2 

Definition at line 87 of file SDL_pixels.h.

◆ SDL_TransferCharacteristics

The transfer characteristics, as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en

Enumerator
SDL_TRANSFER_CHARACTERISTICS_UNKNOWN 
SDL_TRANSFER_CHARACTERISTICS_BT709 

ITU-R BT1361

SDL_TRANSFER_CHARACTERISTICS_UNSPECIFIED 
SDL_TRANSFER_CHARACTERISTICS_GAMMA22 

ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM

SDL_TRANSFER_CHARACTERISTICS_GAMMA28 

ITU-R BT470BG

SDL_TRANSFER_CHARACTERISTICS_BT601 

SMPTE ST 170M

SDL_TRANSFER_CHARACTERISTICS_SMPTE240 

SMPTE ST 240M

SDL_TRANSFER_CHARACTERISTICS_LINEAR 
SDL_TRANSFER_CHARACTERISTICS_LOG100 
SDL_TRANSFER_CHARACTERISTICS_LOG100_SQRT10 
SDL_TRANSFER_CHARACTERISTICS_IEC61966 

IEC 61966-2-4

SDL_TRANSFER_CHARACTERISTICS_BT1361 

ITU-R BT1361 Extended Colour Gamut

SDL_TRANSFER_CHARACTERISTICS_SRGB 

IEC 61966-2-1 (sRGB or sYCC)

SDL_TRANSFER_CHARACTERISTICS_BT2020_10BIT 

ITU-R BT2020 for 10-bit system

SDL_TRANSFER_CHARACTERISTICS_BT2020_12BIT 

ITU-R BT2020 for 12-bit system

SDL_TRANSFER_CHARACTERISTICS_PQ 

SMPTE ST 2084 for 10-, 12-, 14- and 16-bit systems

SDL_TRANSFER_CHARACTERISTICS_SMPTE428 

SMPTE ST 428-1

SDL_TRANSFER_CHARACTERISTICS_HLG 

ARIB STD-B67, known as "Hybrid log-gamma"

SDL_TRANSFER_CHARACTERISTICS_CUSTOM 

Definition at line 489 of file SDL_pixels.h.

490{
492 SDL_TRANSFER_CHARACTERISTICS_BT709 = 1, /**< ITU-R BT1361 */
494 SDL_TRANSFER_CHARACTERISTICS_GAMMA22 = 4, /**< ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM */
495 SDL_TRANSFER_CHARACTERISTICS_GAMMA28 = 5, /**< ITU-R BT470BG */
496 SDL_TRANSFER_CHARACTERISTICS_BT601 = 6, /**< SMPTE ST 170M */
497 SDL_TRANSFER_CHARACTERISTICS_SMPTE240 = 7, /**< SMPTE ST 240M */
501 SDL_TRANSFER_CHARACTERISTICS_IEC61966 = 11, /**< IEC 61966-2-4 */
502 SDL_TRANSFER_CHARACTERISTICS_BT1361 = 12, /**< ITU-R BT1361 Extended Colour Gamut */
503 SDL_TRANSFER_CHARACTERISTICS_SRGB = 13, /**< IEC 61966-2-1 (sRGB or sYCC) */
504 SDL_TRANSFER_CHARACTERISTICS_BT2020_10BIT = 14, /**< ITU-R BT2020 for 10-bit system */
505 SDL_TRANSFER_CHARACTERISTICS_BT2020_12BIT = 15, /**< ITU-R BT2020 for 12-bit system */
506 SDL_TRANSFER_CHARACTERISTICS_PQ = 16, /**< SMPTE ST 2084 for 10-, 12-, 14- and 16-bit systems */
507 SDL_TRANSFER_CHARACTERISTICS_SMPTE428 = 17, /**< SMPTE ST 428-1 */
508 SDL_TRANSFER_CHARACTERISTICS_HLG = 18, /**< ARIB STD-B67, known as "Hybrid log-gamma" */
SDL_TransferCharacteristics
Definition SDL_pixels.h:490
@ SDL_TRANSFER_CHARACTERISTICS_BT1361
Definition SDL_pixels.h:502
@ SDL_TRANSFER_CHARACTERISTICS_CUSTOM
Definition SDL_pixels.h:509
@ SDL_TRANSFER_CHARACTERISTICS_HLG
Definition SDL_pixels.h:508
@ SDL_TRANSFER_CHARACTERISTICS_LOG100_SQRT10
Definition SDL_pixels.h:500
@ SDL_TRANSFER_CHARACTERISTICS_UNKNOWN
Definition SDL_pixels.h:491
@ SDL_TRANSFER_CHARACTERISTICS_IEC61966
Definition SDL_pixels.h:501
@ SDL_TRANSFER_CHARACTERISTICS_UNSPECIFIED
Definition SDL_pixels.h:493
@ SDL_TRANSFER_CHARACTERISTICS_SMPTE428
Definition SDL_pixels.h:507
@ SDL_TRANSFER_CHARACTERISTICS_LOG100
Definition SDL_pixels.h:499
@ SDL_TRANSFER_CHARACTERISTICS_GAMMA28
Definition SDL_pixels.h:495
@ SDL_TRANSFER_CHARACTERISTICS_SMPTE240
Definition SDL_pixels.h:497
@ SDL_TRANSFER_CHARACTERISTICS_BT2020_10BIT
Definition SDL_pixels.h:504
@ SDL_TRANSFER_CHARACTERISTICS_BT2020_12BIT
Definition SDL_pixels.h:505
@ SDL_TRANSFER_CHARACTERISTICS_GAMMA22
Definition SDL_pixels.h:494

Function Documentation

◆ SDL_CreatePalette()

SDL_Palette * SDL_CreatePalette ( int  ncolors)
extern

Create a palette structure with the specified number of color entries.

The palette entries are initialized to white.

Parameters
ncolorsrepresents the number of color entries in the color palette
Returns
a new SDL_Palette structure on success or NULL on failure (e.g. if there wasn't enough memory); call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_DestroyPalette

◆ SDL_CreatePixelFormat()

SDL_PixelFormat * SDL_CreatePixelFormat ( Uint32  pixel_format)
extern

Create an SDL_PixelFormat structure corresponding to a pixel format.

Returned structure may come from a shared global cache (i.e. not newly allocated), and hence should not be modified, especially the palette. Weird errors such as Blit combination not supported may occur.

Parameters
pixel_formatone of the SDL_PixelFormatEnum values
Returns
the new SDL_PixelFormat structure or NULL on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_DestroyPixelFormat

◆ SDL_DestroyPalette()

void SDL_DestroyPalette ( SDL_Palette palette)
extern

Free a palette created with SDL_CreatePalette().

Parameters
palettethe SDL_Palette structure to be freed
Since
This function is available since SDL 3.0.0.
See also
SDL_CreatePalette

◆ SDL_DestroyPixelFormat()

void SDL_DestroyPixelFormat ( SDL_PixelFormat format)
extern

Free an SDL_PixelFormat structure allocated by SDL_CreatePixelFormat().

Parameters
formatthe SDL_PixelFormat structure to free
Since
This function is available since SDL 3.0.0.
See also
SDL_CreatePixelFormat

◆ SDL_GetMasksForPixelFormatEnum()

SDL_bool SDL_GetMasksForPixelFormatEnum ( Uint32  format,
int *  bpp,
Uint32 Rmask,
Uint32 Gmask,
Uint32 Bmask,
Uint32 Amask 
)
extern

Convert one of the enumerated pixel formats to a bpp value and RGBA masks.

Parameters
formatone of the SDL_PixelFormatEnum values
bppa bits per pixel value; usually 15, 16, or 32
Rmaska pointer filled in with the red mask for the format
Gmaska pointer filled in with the green mask for the format
Bmaska pointer filled in with the blue mask for the format
Amaska pointer filled in with the alpha mask for the format
Returns
SDL_TRUE on success or SDL_FALSE if the conversion wasn't possible; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetPixelFormatEnumForMasks

◆ SDL_GetPixelFormatEnumForMasks()

Uint32 SDL_GetPixelFormatEnumForMasks ( int  bpp,
Uint32  Rmask,
Uint32  Gmask,
Uint32  Bmask,
Uint32  Amask 
)
extern

Convert a bpp value and RGBA masks to an enumerated pixel format.

This will return SDL_PIXELFORMAT_UNKNOWN if the conversion wasn't possible.

Parameters
bppa bits per pixel value; usually 15, 16, or 32
Rmaskthe red mask for the format
Gmaskthe green mask for the format
Bmaskthe blue mask for the format
Amaskthe alpha mask for the format
Returns
one of the SDL_PixelFormatEnum values
Since
This function is available since SDL 3.0.0.
See also
SDL_GetMasksForPixelFormatEnum

◆ SDL_GetPixelFormatName()

const char * SDL_GetPixelFormatName ( Uint32  format)
extern

Get the human readable name of a pixel format.

Parameters
formatthe pixel format to query
Returns
the human readable name of the specified pixel format or SDL_PIXELFORMAT_UNKNOWN if the format isn't recognized.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetRGB()

void SDL_GetRGB ( Uint32  pixel,
const SDL_PixelFormat format,
Uint8 r,
Uint8 g,
Uint8 b 
)
extern

Get RGB values from a pixel in the specified format.

This function uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).

Parameters
pixela pixel value
formatan SDL_PixelFormat structure describing the format of the pixel
ra pointer filled in with the red component
ga pointer filled in with the green component
ba pointer filled in with the blue component
Since
This function is available since SDL 3.0.0.
See also
SDL_GetRGBA
SDL_MapRGB
SDL_MapRGBA

◆ SDL_GetRGBA()

void SDL_GetRGBA ( Uint32  pixel,
const SDL_PixelFormat format,
Uint8 r,
Uint8 g,
Uint8 b,
Uint8 a 
)
extern

Get RGBA values from a pixel in the specified format.

This function uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).

If the surface has no alpha component, the alpha will be returned as 0xff (100% opaque).

Parameters
pixela pixel value
formatan SDL_PixelFormat structure describing the format of the pixel
ra pointer filled in with the red component
ga pointer filled in with the green component
ba pointer filled in with the blue component
aa pointer filled in with the alpha component
Since
This function is available since SDL 3.0.0.
See also
SDL_GetRGB
SDL_MapRGB
SDL_MapRGBA

◆ SDL_MapRGB()

Uint32 SDL_MapRGB ( const SDL_PixelFormat format,
Uint8  r,
Uint8  g,
Uint8  b 
)
extern

Map an RGB triple to an opaque pixel value for a given pixel format.

This function maps the RGB color value to the specified pixel format and returns the pixel value best approximating the given RGB color value for the given pixel format.

If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned.

If the specified pixel format has an alpha component it will be returned as all 1 bits (fully opaque).

If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).

Parameters
formatan SDL_PixelFormat structure describing the pixel format
rthe red component of the pixel in the range 0-255
gthe green component of the pixel in the range 0-255
bthe blue component of the pixel in the range 0-255
Returns
a pixel value
Since
This function is available since SDL 3.0.0.
See also
SDL_GetRGB
SDL_GetRGBA
SDL_MapRGBA

◆ SDL_MapRGBA()

Uint32 SDL_MapRGBA ( const SDL_PixelFormat format,
Uint8  r,
Uint8  g,
Uint8  b,
Uint8  a 
)
extern

Map an RGBA quadruple to a pixel value for a given pixel format.

This function maps the RGBA color value to the specified pixel format and returns the pixel value best approximating the given RGBA color value for the given pixel format.

If the specified pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette).

If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned.

If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).

Parameters
formatan SDL_PixelFormat structure describing the format of the pixel
rthe red component of the pixel in the range 0-255
gthe green component of the pixel in the range 0-255
bthe blue component of the pixel in the range 0-255
athe alpha component of the pixel in the range 0-255
Returns
a pixel value
Since
This function is available since SDL 3.0.0.
See also
SDL_GetRGB
SDL_GetRGBA
SDL_MapRGB

◆ SDL_SetPaletteColors()

int SDL_SetPaletteColors ( SDL_Palette palette,
const SDL_Color colors,
int  firstcolor,
int  ncolors 
)
extern

Set a range of colors in a palette.

Parameters
palettethe SDL_Palette structure to modify
colorsan array of SDL_Color structures to copy into the palette
firstcolorthe index of the first palette entry to modify
ncolorsthe number of entries to modify
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_CreatePalette
SDL_CreateSurface

◆ SDL_SetPixelFormatPalette()

int SDL_SetPixelFormatPalette ( SDL_PixelFormat format,
SDL_Palette palette 
)
extern

Set the palette for a pixel format structure.

Parameters
formatthe SDL_PixelFormat structure that will use the palette
palettethe SDL_Palette structure that will be used
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_CreatePalette
SDL_DestroyPalette