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_PixelFormatDetails
 

Macros

#define SDL_ALPHA_OPAQUE   255
 
#define SDL_ALPHA_OPAQUE_FLOAT   1.0f
 
#define SDL_ALPHA_TRANSPARENT   0
 
#define SDL_ALPHA_TRANSPARENT_FLOAT   0.0f
 
#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)    (SDL_ISPIXELFORMAT_FOURCC(X) ? 0 : (((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_ISCOLORSPACE_MATRIX_BT601(X)   (SDL_COLORSPACEMATRIX(X) == SDL_MATRIX_COEFFICIENTS_BT601 || SDL_COLORSPACEMATRIX(X) == SDL_MATRIX_COEFFICIENTS_BT470BG)
 
#define SDL_ISCOLORSPACE_MATRIX_BT709(X)   (SDL_COLORSPACEMATRIX(X) == SDL_MATRIX_COEFFICIENTS_BT709)
 
#define SDL_ISCOLORSPACE_MATRIX_BT2020_NCL(X)   (SDL_COLORSPACEMATRIX(X) == SDL_MATRIX_COEFFICIENTS_BT2020_NCL)
 
#define SDL_ISCOLORSPACE_LIMITED_RANGE(X)   (SDL_COLORSPACERANGE(X) != SDL_COLOR_RANGE_FULL)
 
#define SDL_ISCOLORSPACE_FULL_RANGE(X)   (SDL_COLORSPACERANGE(X) == SDL_COLOR_RANGE_FULL)
 

Enumerations

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_PixelFormat {
  SDL_PIXELFORMAT_UNKNOWN = 0 ,
  SDL_PIXELFORMAT_INDEX1LSB = 0x11100100u ,
  SDL_PIXELFORMAT_INDEX1MSB = 0x11200100u ,
  SDL_PIXELFORMAT_INDEX2LSB = 0x1c100200u ,
  SDL_PIXELFORMAT_INDEX2MSB = 0x1c200200u ,
  SDL_PIXELFORMAT_INDEX4LSB = 0x12100400u ,
  SDL_PIXELFORMAT_INDEX4MSB = 0x12200400u ,
  SDL_PIXELFORMAT_INDEX8 = 0x13000801u ,
  SDL_PIXELFORMAT_RGB332 = 0x14110801u ,
  SDL_PIXELFORMAT_XRGB4444 = 0x15120c02u ,
  SDL_PIXELFORMAT_XBGR4444 = 0x15520c02u ,
  SDL_PIXELFORMAT_XRGB1555 = 0x15130f02u ,
  SDL_PIXELFORMAT_XBGR1555 = 0x15530f02u ,
  SDL_PIXELFORMAT_ARGB4444 = 0x15321002u ,
  SDL_PIXELFORMAT_RGBA4444 = 0x15421002u ,
  SDL_PIXELFORMAT_ABGR4444 = 0x15721002u ,
  SDL_PIXELFORMAT_BGRA4444 = 0x15821002u ,
  SDL_PIXELFORMAT_ARGB1555 = 0x15331002u ,
  SDL_PIXELFORMAT_RGBA5551 = 0x15441002u ,
  SDL_PIXELFORMAT_ABGR1555 = 0x15731002u ,
  SDL_PIXELFORMAT_BGRA5551 = 0x15841002u ,
  SDL_PIXELFORMAT_RGB565 = 0x15151002u ,
  SDL_PIXELFORMAT_BGR565 = 0x15551002u ,
  SDL_PIXELFORMAT_RGB24 = 0x17101803u ,
  SDL_PIXELFORMAT_BGR24 = 0x17401803u ,
  SDL_PIXELFORMAT_XRGB8888 = 0x16161804u ,
  SDL_PIXELFORMAT_RGBX8888 = 0x16261804u ,
  SDL_PIXELFORMAT_XBGR8888 = 0x16561804u ,
  SDL_PIXELFORMAT_BGRX8888 = 0x16661804u ,
  SDL_PIXELFORMAT_ARGB8888 = 0x16362004u ,
  SDL_PIXELFORMAT_RGBA8888 = 0x16462004u ,
  SDL_PIXELFORMAT_ABGR8888 = 0x16762004u ,
  SDL_PIXELFORMAT_BGRA8888 = 0x16862004u ,
  SDL_PIXELFORMAT_XRGB2101010 = 0x16172004u ,
  SDL_PIXELFORMAT_XBGR2101010 = 0x16572004u ,
  SDL_PIXELFORMAT_ARGB2101010 = 0x16372004u ,
  SDL_PIXELFORMAT_ABGR2101010 = 0x16772004u ,
  SDL_PIXELFORMAT_RGB48 = 0x18103006u ,
  SDL_PIXELFORMAT_BGR48 = 0x18403006u ,
  SDL_PIXELFORMAT_RGBA64 = 0x18204008u ,
  SDL_PIXELFORMAT_ARGB64 = 0x18304008u ,
  SDL_PIXELFORMAT_BGRA64 = 0x18504008u ,
  SDL_PIXELFORMAT_ABGR64 = 0x18604008u ,
  SDL_PIXELFORMAT_RGB48_FLOAT = 0x1a103006u ,
  SDL_PIXELFORMAT_BGR48_FLOAT = 0x1a403006u ,
  SDL_PIXELFORMAT_RGBA64_FLOAT = 0x1a204008u ,
  SDL_PIXELFORMAT_ARGB64_FLOAT = 0x1a304008u ,
  SDL_PIXELFORMAT_BGRA64_FLOAT = 0x1a504008u ,
  SDL_PIXELFORMAT_ABGR64_FLOAT = 0x1a604008u ,
  SDL_PIXELFORMAT_RGB96_FLOAT = 0x1b10600cu ,
  SDL_PIXELFORMAT_BGR96_FLOAT = 0x1b40600cu ,
  SDL_PIXELFORMAT_RGBA128_FLOAT = 0x1b208010u ,
  SDL_PIXELFORMAT_ARGB128_FLOAT = 0x1b308010u ,
  SDL_PIXELFORMAT_BGRA128_FLOAT = 0x1b508010u ,
  SDL_PIXELFORMAT_ABGR128_FLOAT = 0x1b608010u ,
  SDL_PIXELFORMAT_YV12 = 0x32315659u ,
  SDL_PIXELFORMAT_IYUV = 0x56555949u ,
  SDL_PIXELFORMAT_YUY2 = 0x32595559u ,
  SDL_PIXELFORMAT_UYVY = 0x59565955u ,
  SDL_PIXELFORMAT_YVYU = 0x55595659u ,
  SDL_PIXELFORMAT_NV12 = 0x3231564eu ,
  SDL_PIXELFORMAT_NV21 = 0x3132564eu ,
  SDL_PIXELFORMAT_P010 = 0x30313050u ,
  SDL_PIXELFORMAT_EXTERNAL_OES = 0x2053454fu ,
  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
}
 
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 = 0 ,
  SDL_COLORSPACE_SRGB = 0x120005a0u ,
  SDL_COLORSPACE_SRGB_LINEAR = 0x12000500u ,
  SDL_COLORSPACE_HDR10 = 0x12002600u ,
  SDL_COLORSPACE_JPEG = 0x220004c6u ,
  SDL_COLORSPACE_BT601_LIMITED = 0x211018c6u ,
  SDL_COLORSPACE_BT601_FULL = 0x221018c6u ,
  SDL_COLORSPACE_BT709_LIMITED = 0x21100421u ,
  SDL_COLORSPACE_BT709_FULL = 0x22100421u ,
  SDL_COLORSPACE_BT2020_LIMITED = 0x21102609u ,
  SDL_COLORSPACE_BT2020_FULL = 0x22102609u ,
  SDL_COLORSPACE_RGB_DEFAULT = SDL_COLORSPACE_SRGB ,
  SDL_COLORSPACE_YUV_DEFAULT = SDL_COLORSPACE_JPEG
}
 

Functions

const char * SDL_GetPixelFormatName (SDL_PixelFormat format)
 
bool SDL_GetMasksForPixelFormat (SDL_PixelFormat format, int *bpp, Uint32 *Rmask, Uint32 *Gmask, Uint32 *Bmask, Uint32 *Amask)
 
SDL_PixelFormat SDL_GetPixelFormatForMasks (int bpp, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)
 
const SDL_PixelFormatDetailsSDL_GetPixelFormatDetails (SDL_PixelFormat format)
 
SDL_PaletteSDL_CreatePalette (int ncolors)
 
bool SDL_SetPaletteColors (SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors)
 
void SDL_DestroyPalette (SDL_Palette *palette)
 
Uint32 SDL_MapRGB (const SDL_PixelFormatDetails *format, const SDL_Palette *palette, Uint8 r, Uint8 g, Uint8 b)
 
Uint32 SDL_MapRGBA (const SDL_PixelFormatDetails *format, const SDL_Palette *palette, Uint8 r, Uint8 g, Uint8 b, Uint8 a)
 
void SDL_GetRGB (Uint32 pixel, const SDL_PixelFormatDetails *format, const SDL_Palette *palette, Uint8 *r, Uint8 *g, Uint8 *b)
 
void SDL_GetRGBA (Uint32 pixel, const SDL_PixelFormatDetails *format, const SDL_Palette *palette, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)
 

Macro Definition Documentation

◆ SDL_ALPHA_OPAQUE

#define SDL_ALPHA_OPAQUE   255

CategoryPixels

Pixel management. A fully opaque 8-bit alpha value.

Since
This macro is available since SDL 3.1.3.
See also
SDL_ALPHA_TRANSPARENT

Definition at line 48 of file SDL_pixels.h.

◆ SDL_ALPHA_OPAQUE_FLOAT

#define SDL_ALPHA_OPAQUE_FLOAT   1.0f

A fully opaque floating point alpha value.

Since
This macro is available since SDL 3.1.3.
See also
SDL_ALPHA_TRANSPARENT_FLOAT

Definition at line 57 of file SDL_pixels.h.

◆ SDL_ALPHA_TRANSPARENT

#define SDL_ALPHA_TRANSPARENT   0

A fully transparent 8-bit alpha value.

Since
This macro is available since SDL 3.1.3.
See also
SDL_ALPHA_OPAQUE

Definition at line 66 of file SDL_pixels.h.

◆ SDL_ALPHA_TRANSPARENT_FLOAT

#define SDL_ALPHA_TRANSPARENT_FLOAT   0.0f

A fully transparent floating point alpha value.

Since
This macro is available since SDL 3.1.3.
See also
SDL_ALPHA_OPAQUE_FLOAT

Definition at line 75 of file SDL_pixels.h.

◆ SDL_BITSPERPIXEL

#define SDL_BITSPERPIXEL (   X)     (SDL_ISPIXELFORMAT_FOURCC(X) ? 0 : (((X) >> 8) & 0xFF))

Definition at line 174 of file SDL_pixels.h.

◆ SDL_BYTESPERPIXEL

#define SDL_BYTESPERPIXEL (   X)
Value:
((((X) == SDL_PIXELFORMAT_YUY2) || \
((X) == SDL_PIXELFORMAT_UYVY) || \
((X) == SDL_PIXELFORMAT_YVYU) || \
((X) == SDL_PIXELFORMAT_P010)) ? 2 : 1) : (((X) >> 0) & 0xFF))
@ SDL_PIXELFORMAT_P010
Definition: SDL_pixels.h:390
@ SDL_PIXELFORMAT_YVYU
Definition: SDL_pixels.h:384
@ SDL_PIXELFORMAT_UYVY
Definition: SDL_pixels.h:382
@ SDL_PIXELFORMAT_YUY2
Definition: SDL_pixels.h:380
#define SDL_ISPIXELFORMAT_FOURCC(format)
Definition: SDL_pixels.h:222

Definition at line 176 of file SDL_pixels.h.

◆ SDL_COLORSPACECHROMA

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

Definition at line 567 of file SDL_pixels.h.

◆ SDL_COLORSPACEMATRIX

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

Definition at line 570 of file SDL_pixels.h.

◆ SDL_COLORSPACEPRIMARIES

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

Definition at line 568 of file SDL_pixels.h.

◆ SDL_COLORSPACERANGE

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

Definition at line 566 of file SDL_pixels.h.

◆ SDL_COLORSPACETRANSFER

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

Definition at line 569 of file SDL_pixels.h.

◆ SDL_COLORSPACETYPE

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

Definition at line 565 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:370

Definition at line 561 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 166 of file SDL_pixels.h.

◆ SDL_DEFINE_PIXELFOURCC

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

Definition at line 164 of file SDL_pixels.h.

◆ SDL_ISCOLORSPACE_FULL_RANGE

#define SDL_ISCOLORSPACE_FULL_RANGE (   X)    (SDL_COLORSPACERANGE(X) == SDL_COLOR_RANGE_FULL)

Definition at line 576 of file SDL_pixels.h.

◆ SDL_ISCOLORSPACE_LIMITED_RANGE

#define SDL_ISCOLORSPACE_LIMITED_RANGE (   X)    (SDL_COLORSPACERANGE(X) != SDL_COLOR_RANGE_FULL)

Definition at line 575 of file SDL_pixels.h.

◆ SDL_ISCOLORSPACE_MATRIX_BT2020_NCL

#define SDL_ISCOLORSPACE_MATRIX_BT2020_NCL (   X)    (SDL_COLORSPACEMATRIX(X) == SDL_MATRIX_COEFFICIENTS_BT2020_NCL)

Definition at line 574 of file SDL_pixels.h.

◆ SDL_ISCOLORSPACE_MATRIX_BT601

#define SDL_ISCOLORSPACE_MATRIX_BT601 (   X)    (SDL_COLORSPACEMATRIX(X) == SDL_MATRIX_COEFFICIENTS_BT601 || SDL_COLORSPACEMATRIX(X) == SDL_MATRIX_COEFFICIENTS_BT470BG)

Definition at line 572 of file SDL_pixels.h.

◆ SDL_ISCOLORSPACE_MATRIX_BT709

#define SDL_ISCOLORSPACE_MATRIX_BT709 (   X)    (SDL_COLORSPACEMATRIX(X) == SDL_MATRIX_COEFFICIENTS_BT709)

Definition at line 573 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:90
@ SDL_PACKEDLAYOUT_2101010
Definition: SDL_pixels.h:160
#define SDL_PIXELLAYOUT(X)
Definition: SDL_pixels.h:173
#define SDL_PIXELTYPE(X)
Definition: SDL_pixels.h:171

Definition at line 211 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:190
#define SDL_PIXELORDER(X)
Definition: SDL_pixels.h:172
@ SDL_PACKEDORDER_RGBA
Definition: SDL_pixels.h:123
@ SDL_PACKEDORDER_ABGR
Definition: SDL_pixels.h:126
@ SDL_PACKEDORDER_BGRA
Definition: SDL_pixels.h:127
@ SDL_PACKEDORDER_ARGB
Definition: SDL_pixels.h:122

Definition at line 204 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:92
@ SDL_PIXELTYPE_ARRAYU8
Definition: SDL_pixels.h:91
@ SDL_PIXELTYPE_ARRAYF16
Definition: SDL_pixels.h:94
@ SDL_PIXELTYPE_ARRAYU32
Definition: SDL_pixels.h:93
@ SDL_PIXELTYPE_ARRAYF32
Definition: SDL_pixels.h:95

Definition at line 196 of file SDL_pixels.h.

◆ SDL_ISPIXELFORMAT_FLOAT

#define SDL_ISPIXELFORMAT_FLOAT (   format)
Value:

Definition at line 216 of file SDL_pixels.h.

◆ SDL_ISPIXELFORMAT_FOURCC

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

Definition at line 222 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:97
@ SDL_PIXELTYPE_INDEX4
Definition: SDL_pixels.h:86
@ SDL_PIXELTYPE_INDEX1
Definition: SDL_pixels.h:85
@ SDL_PIXELTYPE_INDEX8
Definition: SDL_pixels.h:87

Definition at line 183 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:88
@ SDL_PIXELTYPE_PACKED16
Definition: SDL_pixels.h:89

Definition at line 190 of file SDL_pixels.h.

◆ SDL_PIXELFLAG

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

Definition at line 170 of file SDL_pixels.h.

◆ SDL_PIXELLAYOUT

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

Definition at line 173 of file SDL_pixels.h.

◆ SDL_PIXELORDER

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

Definition at line 172 of file SDL_pixels.h.

◆ SDL_PIXELTYPE

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

Definition at line 171 of file SDL_pixels.h.

Enumeration Type Documentation

◆ SDL_ArrayOrder

Array component order, low byte -> high byte.

Since
This enum is available since SDL 3.1.3.
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 135 of file SDL_pixels.h.

136{
SDL_ArrayOrder
Definition: SDL_pixels.h:136
@ SDL_ARRAYORDER_RGB
Definition: SDL_pixels.h:138
@ SDL_ARRAYORDER_NONE
Definition: SDL_pixels.h:137
@ SDL_ARRAYORDER_ARGB
Definition: SDL_pixels.h:140
@ SDL_ARRAYORDER_BGRA
Definition: SDL_pixels.h:142
@ SDL_ARRAYORDER_ABGR
Definition: SDL_pixels.h:143
@ SDL_ARRAYORDER_RGBA
Definition: SDL_pixels.h:139
@ SDL_ARRAYORDER_BGR
Definition: SDL_pixels.h:141

◆ SDL_BitmapOrder

Bitmap pixel order, high bit -> low bit.

Since
This enum is available since SDL 3.1.3.
Enumerator
SDL_BITMAPORDER_NONE 
SDL_BITMAPORDER_4321 
SDL_BITMAPORDER_1234 

Definition at line 105 of file SDL_pixels.h.

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

◆ SDL_ChromaLocation

Colorspace chroma sample location.

Since
This enum is available since SDL 3.1.3.
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 2x2 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 the 2x2 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 551 of file SDL_pixels.h.

552{
553 SDL_CHROMA_LOCATION_NONE = 0, /**< RGB, no chroma sampling */
554 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 2x2 square. In other words, they have the same horizontal location as the top-left pixel, but is shifted one-half pixel down vertically. */
555 SDL_CHROMA_LOCATION_CENTER = 2, /**< In JPEG/JFIF, H.261, and MPEG-1, Cb and Cr are taken at the center of the 2x2 square. In other words, they are offset one-half pixel to the right and one-half pixel down compared to the top-left pixel. */
556 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:552
@ SDL_CHROMA_LOCATION_NONE
Definition: SDL_pixels.h:553
@ SDL_CHROMA_LOCATION_TOPLEFT
Definition: SDL_pixels.h:556
@ SDL_CHROMA_LOCATION_CENTER
Definition: SDL_pixels.h:555
@ SDL_CHROMA_LOCATION_LEFT
Definition: SDL_pixels.h:554

◆ SDL_ColorPrimaries

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

Since
This enum is available since SDL 3.1.3.
Enumerator
SDL_COLOR_PRIMARIES_UNKNOWN 
SDL_COLOR_PRIMARIES_BT709 

ITU-R BT.709-6

SDL_COLOR_PRIMARIES_UNSPECIFIED 
SDL_COLOR_PRIMARIES_BT470M 

ITU-R BT.470-6 System M

SDL_COLOR_PRIMARIES_BT470BG 

ITU-R BT.470-6 System B, G / ITU-R BT.601-7 625

SDL_COLOR_PRIMARIES_BT601 

ITU-R BT.601-7 525, SMPTE 170M

SDL_COLOR_PRIMARIES_SMPTE240 

SMPTE 240M, functionally the same as SDL_COLOR_PRIMARIES_BT601

SDL_COLOR_PRIMARIES_GENERIC_FILM 

Generic film (color filters using Illuminant C)

SDL_COLOR_PRIMARIES_BT2020 

ITU-R BT.2020-2 / ITU-R BT.2100-0

SDL_COLOR_PRIMARIES_XYZ 

SMPTE ST 428-1

SDL_COLOR_PRIMARIES_SMPTE431 

SMPTE RP 431-2

SDL_COLOR_PRIMARIES_SMPTE432 

SMPTE EG 432-1 / DCI P3

SDL_COLOR_PRIMARIES_EBU3213 

EBU Tech. 3213-E

SDL_COLOR_PRIMARIES_CUSTOM 

Definition at line 472 of file SDL_pixels.h.

473{
475 SDL_COLOR_PRIMARIES_BT709 = 1, /**< ITU-R BT.709-6 */
477 SDL_COLOR_PRIMARIES_BT470M = 4, /**< ITU-R BT.470-6 System M */
478 SDL_COLOR_PRIMARIES_BT470BG = 5, /**< ITU-R BT.470-6 System B, G / ITU-R BT.601-7 625 */
479 SDL_COLOR_PRIMARIES_BT601 = 6, /**< ITU-R BT.601-7 525, SMPTE 170M */
480 SDL_COLOR_PRIMARIES_SMPTE240 = 7, /**< SMPTE 240M, functionally the same as SDL_COLOR_PRIMARIES_BT601 */
481 SDL_COLOR_PRIMARIES_GENERIC_FILM = 8, /**< Generic film (color filters using Illuminant C) */
482 SDL_COLOR_PRIMARIES_BT2020 = 9, /**< ITU-R BT.2020-2 / ITU-R BT.2100-0 */
483 SDL_COLOR_PRIMARIES_XYZ = 10, /**< SMPTE ST 428-1 */
484 SDL_COLOR_PRIMARIES_SMPTE431 = 11, /**< SMPTE RP 431-2 */
485 SDL_COLOR_PRIMARIES_SMPTE432 = 12, /**< SMPTE EG 432-1 / DCI P3 */
486 SDL_COLOR_PRIMARIES_EBU3213 = 22, /**< EBU Tech. 3213-E */
SDL_ColorPrimaries
Definition: SDL_pixels.h:473
@ SDL_COLOR_PRIMARIES_SMPTE431
Definition: SDL_pixels.h:484
@ SDL_COLOR_PRIMARIES_CUSTOM
Definition: SDL_pixels.h:487
@ SDL_COLOR_PRIMARIES_EBU3213
Definition: SDL_pixels.h:486
@ SDL_COLOR_PRIMARIES_GENERIC_FILM
Definition: SDL_pixels.h:481
@ SDL_COLOR_PRIMARIES_BT601
Definition: SDL_pixels.h:479
@ SDL_COLOR_PRIMARIES_UNSPECIFIED
Definition: SDL_pixels.h:476
@ SDL_COLOR_PRIMARIES_SMPTE240
Definition: SDL_pixels.h:480
@ SDL_COLOR_PRIMARIES_XYZ
Definition: SDL_pixels.h:483
@ SDL_COLOR_PRIMARIES_UNKNOWN
Definition: SDL_pixels.h:474
@ SDL_COLOR_PRIMARIES_SMPTE432
Definition: SDL_pixels.h:485
@ SDL_COLOR_PRIMARIES_BT2020
Definition: SDL_pixels.h:482
@ SDL_COLOR_PRIMARIES_BT470BG
Definition: SDL_pixels.h:478
@ SDL_COLOR_PRIMARIES_BT709
Definition: SDL_pixels.h:475
@ SDL_COLOR_PRIMARIES_BT470M
Definition: SDL_pixels.h:477

◆ SDL_ColorRange

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

Since
This enum is available since SDL 3.1.3.
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 459 of file SDL_pixels.h.

460{
462 SDL_COLOR_RANGE_LIMITED = 1, /**< Narrow range, e.g. 16-235 for 8-bit RGB and luma, and 16-240 for 8-bit chroma */
463 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:460
@ SDL_COLOR_RANGE_LIMITED
Definition: SDL_pixels.h:462
@ SDL_COLOR_RANGE_FULL
Definition: SDL_pixels.h:463
@ SDL_COLOR_RANGE_UNKNOWN
Definition: SDL_pixels.h:461

◆ SDL_Colorspace

Colorspace definitions.

Since similar colorspaces may vary in their details (matrix, transfer function, etc.), this is not an exhaustive list, but rather a representative sample of the kinds of colorspaces supported in SDL.

Since
This enum is available since SDL 3.1.3.
See also
SDL_ColorPrimaries
SDL_ColorRange
SDL_ColorType
SDL_MatrixCoefficients
SDL_TransferCharacteristics
Enumerator
SDL_COLORSPACE_UNKNOWN 
SDL_COLORSPACE_SRGB 

Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P709

SDL_COLORSPACE_SRGB_LINEAR 

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_JPEG 

Equivalent to DXGI_COLOR_SPACE_YCBCR_FULL_G22_NONE_P709_X601

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_BT2020_LIMITED 

Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P2020

SDL_COLORSPACE_BT2020_FULL 

Equivalent to DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P2020

SDL_COLORSPACE_RGB_DEFAULT 

The default colorspace for RGB surfaces if no colorspace is specified

SDL_COLORSPACE_YUV_DEFAULT 

The default colorspace for YUV surfaces if no colorspace is specified

Definition at line 593 of file SDL_pixels.h.

594{
596
597 /* sRGB is a gamma corrected colorspace, and the default colorspace for SDL rendering and 8-bit RGB surfaces */
598 SDL_COLORSPACE_SRGB = 0x120005a0u, /**< Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P709 */
599 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_RGB,
600 SDL_COLOR_RANGE_FULL,
601 SDL_COLOR_PRIMARIES_BT709,
602 SDL_TRANSFER_CHARACTERISTICS_SRGB,
603 SDL_MATRIX_COEFFICIENTS_IDENTITY,
604 SDL_CHROMA_LOCATION_NONE), */
605
606 /* This is a linear colorspace and the default colorspace for floating point surfaces. On Windows this is the scRGB colorspace, and on Apple platforms this is kCGColorSpaceExtendedLinearSRGB for EDR content */
607 SDL_COLORSPACE_SRGB_LINEAR = 0x12000500u, /**< Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G10_NONE_P709 */
608 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_RGB,
609 SDL_COLOR_RANGE_FULL,
610 SDL_COLOR_PRIMARIES_BT709,
611 SDL_TRANSFER_CHARACTERISTICS_LINEAR,
612 SDL_MATRIX_COEFFICIENTS_IDENTITY,
613 SDL_CHROMA_LOCATION_NONE), */
614
615 /* HDR10 is a non-linear HDR colorspace and the default colorspace for 10-bit surfaces */
616 SDL_COLORSPACE_HDR10 = 0x12002600u, /**< Equivalent to DXGI_COLOR_SPACE_RGB_FULL_G2084_NONE_P2020 */
617 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_RGB,
618 SDL_COLOR_RANGE_FULL,
619 SDL_COLOR_PRIMARIES_BT2020,
620 SDL_TRANSFER_CHARACTERISTICS_PQ,
621 SDL_MATRIX_COEFFICIENTS_IDENTITY,
622 SDL_CHROMA_LOCATION_NONE), */
623
624 SDL_COLORSPACE_JPEG = 0x220004c6u, /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_FULL_G22_NONE_P709_X601 */
625 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_YCBCR,
626 SDL_COLOR_RANGE_FULL,
627 SDL_COLOR_PRIMARIES_BT709,
628 SDL_TRANSFER_CHARACTERISTICS_BT601,
629 SDL_MATRIX_COEFFICIENTS_BT601,
630 SDL_CHROMA_LOCATION_NONE), */
631
632 SDL_COLORSPACE_BT601_LIMITED = 0x211018c6u, /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601 */
633 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_YCBCR,
634 SDL_COLOR_RANGE_LIMITED,
635 SDL_COLOR_PRIMARIES_BT601,
636 SDL_TRANSFER_CHARACTERISTICS_BT601,
637 SDL_MATRIX_COEFFICIENTS_BT601,
638 SDL_CHROMA_LOCATION_LEFT), */
639
640 SDL_COLORSPACE_BT601_FULL = 0x221018c6u, /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601 */
641 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_YCBCR,
642 SDL_COLOR_RANGE_FULL,
643 SDL_COLOR_PRIMARIES_BT601,
644 SDL_TRANSFER_CHARACTERISTICS_BT601,
645 SDL_MATRIX_COEFFICIENTS_BT601,
646 SDL_CHROMA_LOCATION_LEFT), */
647
648 SDL_COLORSPACE_BT709_LIMITED = 0x21100421u, /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709 */
649 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_YCBCR,
650 SDL_COLOR_RANGE_LIMITED,
651 SDL_COLOR_PRIMARIES_BT709,
652 SDL_TRANSFER_CHARACTERISTICS_BT709,
653 SDL_MATRIX_COEFFICIENTS_BT709,
654 SDL_CHROMA_LOCATION_LEFT), */
655
656 SDL_COLORSPACE_BT709_FULL = 0x22100421u, /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709 */
657 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_YCBCR,
658 SDL_COLOR_RANGE_FULL,
659 SDL_COLOR_PRIMARIES_BT709,
660 SDL_TRANSFER_CHARACTERISTICS_BT709,
661 SDL_MATRIX_COEFFICIENTS_BT709,
662 SDL_CHROMA_LOCATION_LEFT), */
663
664 SDL_COLORSPACE_BT2020_LIMITED = 0x21102609u, /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P2020 */
665 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_YCBCR,
666 SDL_COLOR_RANGE_LIMITED,
667 SDL_COLOR_PRIMARIES_BT2020,
668 SDL_TRANSFER_CHARACTERISTICS_PQ,
669 SDL_MATRIX_COEFFICIENTS_BT2020_NCL,
670 SDL_CHROMA_LOCATION_LEFT), */
671
672 SDL_COLORSPACE_BT2020_FULL = 0x22102609u, /**< Equivalent to DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P2020 */
673 /* SDL_DEFINE_COLORSPACE(SDL_COLOR_TYPE_YCBCR,
674 SDL_COLOR_RANGE_FULL,
675 SDL_COLOR_PRIMARIES_BT2020,
676 SDL_TRANSFER_CHARACTERISTICS_PQ,
677 SDL_MATRIX_COEFFICIENTS_BT2020_NCL,
678 SDL_CHROMA_LOCATION_LEFT), */
679
680 SDL_COLORSPACE_RGB_DEFAULT = SDL_COLORSPACE_SRGB, /**< The default colorspace for RGB surfaces if no colorspace is specified */
681 SDL_COLORSPACE_YUV_DEFAULT = SDL_COLORSPACE_JPEG /**< The default colorspace for YUV surfaces if no colorspace is specified */
SDL_Colorspace
Definition: SDL_pixels.h:594
@ SDL_COLORSPACE_BT2020_LIMITED
Definition: SDL_pixels.h:664
@ SDL_COLORSPACE_BT601_LIMITED
Definition: SDL_pixels.h:632
@ SDL_COLORSPACE_BT709_FULL
Definition: SDL_pixels.h:656
@ SDL_COLORSPACE_HDR10
Definition: SDL_pixels.h:616
@ SDL_COLORSPACE_BT601_FULL
Definition: SDL_pixels.h:640
@ SDL_COLORSPACE_UNKNOWN
Definition: SDL_pixels.h:595
@ SDL_COLORSPACE_BT2020_FULL
Definition: SDL_pixels.h:672
@ SDL_COLORSPACE_JPEG
Definition: SDL_pixels.h:624
@ SDL_COLORSPACE_BT709_LIMITED
Definition: SDL_pixels.h:648
@ SDL_COLORSPACE_SRGB_LINEAR
Definition: SDL_pixels.h:607
@ SDL_COLORSPACE_SRGB
Definition: SDL_pixels.h:598
@ SDL_COLORSPACE_RGB_DEFAULT
Definition: SDL_pixels.h:680
@ SDL_COLORSPACE_YUV_DEFAULT
Definition: SDL_pixels.h:681

◆ 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. Colorspace color type.

Since
This enum is available since SDL 3.1.3.
Enumerator
SDL_COLOR_TYPE_UNKNOWN 
SDL_COLOR_TYPE_RGB 
SDL_COLOR_TYPE_YCBCR 

Definition at line 446 of file SDL_pixels.h.

447{
SDL_ColorType
Definition: SDL_pixels.h:447
@ SDL_COLOR_TYPE_RGB
Definition: SDL_pixels.h:449
@ SDL_COLOR_TYPE_YCBCR
Definition: SDL_pixels.h:450
@ SDL_COLOR_TYPE_UNKNOWN
Definition: SDL_pixels.h:448

◆ SDL_MatrixCoefficients

Colorspace matrix coefficients.

These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en

Since
This enum is available since SDL 3.1.3.
Enumerator
SDL_MATRIX_COEFFICIENTS_IDENTITY 
SDL_MATRIX_COEFFICIENTS_BT709 

ITU-R BT.709-6

SDL_MATRIX_COEFFICIENTS_UNSPECIFIED 
SDL_MATRIX_COEFFICIENTS_FCC 

US FCC Title 47

SDL_MATRIX_COEFFICIENTS_BT470BG 

ITU-R BT.470-6 System B, G / ITU-R BT.601-7 625, functionally the same as SDL_MATRIX_COEFFICIENTS_BT601

SDL_MATRIX_COEFFICIENTS_BT601 

ITU-R BT.601-7 525

SDL_MATRIX_COEFFICIENTS_SMPTE240 

SMPTE 240M

SDL_MATRIX_COEFFICIENTS_YCGCO 
SDL_MATRIX_COEFFICIENTS_BT2020_NCL 

ITU-R BT.2020-2 non-constant luminance

SDL_MATRIX_COEFFICIENTS_BT2020_CL 

ITU-R BT.2020-2 constant luminance

SDL_MATRIX_COEFFICIENTS_SMPTE2085 

SMPTE ST 2085

SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_NCL 
SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_CL 
SDL_MATRIX_COEFFICIENTS_ICTCP 

ITU-R BT.2100-0 ICTCP

SDL_MATRIX_COEFFICIENTS_CUSTOM 

Definition at line 527 of file SDL_pixels.h.

528{
530 SDL_MATRIX_COEFFICIENTS_BT709 = 1, /**< ITU-R BT.709-6 */
532 SDL_MATRIX_COEFFICIENTS_FCC = 4, /**< US FCC Title 47 */
533 SDL_MATRIX_COEFFICIENTS_BT470BG = 5, /**< ITU-R BT.470-6 System B, G / ITU-R BT.601-7 625, functionally the same as SDL_MATRIX_COEFFICIENTS_BT601 */
534 SDL_MATRIX_COEFFICIENTS_BT601 = 6, /**< ITU-R BT.601-7 525 */
535 SDL_MATRIX_COEFFICIENTS_SMPTE240 = 7, /**< SMPTE 240M */
537 SDL_MATRIX_COEFFICIENTS_BT2020_NCL = 9, /**< ITU-R BT.2020-2 non-constant luminance */
538 SDL_MATRIX_COEFFICIENTS_BT2020_CL = 10, /**< ITU-R BT.2020-2 constant luminance */
539 SDL_MATRIX_COEFFICIENTS_SMPTE2085 = 11, /**< SMPTE ST 2085 */
542 SDL_MATRIX_COEFFICIENTS_ICTCP = 14, /**< ITU-R BT.2100-0 ICTCP */
SDL_MatrixCoefficients
Definition: SDL_pixels.h:528
@ SDL_MATRIX_COEFFICIENTS_BT709
Definition: SDL_pixels.h:530
@ SDL_MATRIX_COEFFICIENTS_BT2020_CL
Definition: SDL_pixels.h:538
@ SDL_MATRIX_COEFFICIENTS_BT601
Definition: SDL_pixels.h:534
@ SDL_MATRIX_COEFFICIENTS_BT2020_NCL
Definition: SDL_pixels.h:537
@ SDL_MATRIX_COEFFICIENTS_SMPTE240
Definition: SDL_pixels.h:535
@ SDL_MATRIX_COEFFICIENTS_YCGCO
Definition: SDL_pixels.h:536
@ SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_NCL
Definition: SDL_pixels.h:540
@ SDL_MATRIX_COEFFICIENTS_CHROMA_DERIVED_CL
Definition: SDL_pixels.h:541
@ SDL_MATRIX_COEFFICIENTS_UNSPECIFIED
Definition: SDL_pixels.h:531
@ SDL_MATRIX_COEFFICIENTS_CUSTOM
Definition: SDL_pixels.h:543
@ SDL_MATRIX_COEFFICIENTS_ICTCP
Definition: SDL_pixels.h:542
@ SDL_MATRIX_COEFFICIENTS_IDENTITY
Definition: SDL_pixels.h:529
@ SDL_MATRIX_COEFFICIENTS_FCC
Definition: SDL_pixels.h:532
@ SDL_MATRIX_COEFFICIENTS_BT470BG
Definition: SDL_pixels.h:533
@ SDL_MATRIX_COEFFICIENTS_SMPTE2085
Definition: SDL_pixels.h:539

◆ SDL_PackedLayout

Packed component layout.

Since
This enum is available since SDL 3.1.3.
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 151 of file SDL_pixels.h.

152{
SDL_PackedLayout
Definition: SDL_pixels.h:152
@ SDL_PACKEDLAYOUT_NONE
Definition: SDL_pixels.h:153
@ SDL_PACKEDLAYOUT_8888
Definition: SDL_pixels.h:159
@ SDL_PACKEDLAYOUT_1010102
Definition: SDL_pixels.h:161
@ SDL_PACKEDLAYOUT_565
Definition: SDL_pixels.h:158
@ SDL_PACKEDLAYOUT_332
Definition: SDL_pixels.h:154
@ SDL_PACKEDLAYOUT_5551
Definition: SDL_pixels.h:157
@ SDL_PACKEDLAYOUT_1555
Definition: SDL_pixels.h:156
@ SDL_PACKEDLAYOUT_4444
Definition: SDL_pixels.h:155

◆ SDL_PackedOrder

Packed component order, high bit -> low bit.

Since
This enum is available since SDL 3.1.3.
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 117 of file SDL_pixels.h.

◆ SDL_PixelFormat

Pixel format.

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.

Since
This enum is available since SDL 3.1.3.
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_XBGR4444 
SDL_PIXELFORMAT_XRGB1555 
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_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_P010 

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

SDL_PIXELFORMAT_EXTERNAL_OES 

Android video texture format

SDL_PIXELFORMAT_RGBA32 
SDL_PIXELFORMAT_ARGB32 
SDL_PIXELFORMAT_BGRA32 
SDL_PIXELFORMAT_ABGR32 
SDL_PIXELFORMAT_RGBX32 
SDL_PIXELFORMAT_XRGB32 
SDL_PIXELFORMAT_BGRX32 
SDL_PIXELFORMAT_XBGR32 

Definition at line 264 of file SDL_pixels.h.

265{
267 SDL_PIXELFORMAT_INDEX1LSB = 0x11100100u,
268 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_4321, 0, 1, 0), */
269 SDL_PIXELFORMAT_INDEX1MSB = 0x11200100u,
270 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0, 1, 0), */
271 SDL_PIXELFORMAT_INDEX2LSB = 0x1c100200u,
272 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX2, SDL_BITMAPORDER_4321, 0, 2, 0), */
273 SDL_PIXELFORMAT_INDEX2MSB = 0x1c200200u,
274 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX2, SDL_BITMAPORDER_1234, 0, 2, 0), */
275 SDL_PIXELFORMAT_INDEX4LSB = 0x12100400u,
276 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0, 4, 0), */
277 SDL_PIXELFORMAT_INDEX4MSB = 0x12200400u,
278 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_1234, 0, 4, 0), */
279 SDL_PIXELFORMAT_INDEX8 = 0x13000801u,
280 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX8, 0, 0, 8, 1), */
281 SDL_PIXELFORMAT_RGB332 = 0x14110801u,
282 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED8, SDL_PACKEDORDER_XRGB, SDL_PACKEDLAYOUT_332, 8, 1), */
283 SDL_PIXELFORMAT_XRGB4444 = 0x15120c02u,
284 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB, SDL_PACKEDLAYOUT_4444, 12, 2), */
285 SDL_PIXELFORMAT_XBGR4444 = 0x15520c02u,
286 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR, SDL_PACKEDLAYOUT_4444, 12, 2), */
287 SDL_PIXELFORMAT_XRGB1555 = 0x15130f02u,
288 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB, SDL_PACKEDLAYOUT_1555, 15, 2), */
289 SDL_PIXELFORMAT_XBGR1555 = 0x15530f02u,
290 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR, SDL_PACKEDLAYOUT_1555, 15, 2), */
291 SDL_PIXELFORMAT_ARGB4444 = 0x15321002u,
292 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB, SDL_PACKEDLAYOUT_4444, 16, 2), */
293 SDL_PIXELFORMAT_RGBA4444 = 0x15421002u,
294 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA, SDL_PACKEDLAYOUT_4444, 16, 2), */
295 SDL_PIXELFORMAT_ABGR4444 = 0x15721002u,
296 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR, SDL_PACKEDLAYOUT_4444, 16, 2), */
297 SDL_PIXELFORMAT_BGRA4444 = 0x15821002u,
298 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA, SDL_PACKEDLAYOUT_4444, 16, 2), */
299 SDL_PIXELFORMAT_ARGB1555 = 0x15331002u,
300 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB, SDL_PACKEDLAYOUT_1555, 16, 2), */
301 SDL_PIXELFORMAT_RGBA5551 = 0x15441002u,
302 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA, SDL_PACKEDLAYOUT_5551, 16, 2), */
303 SDL_PIXELFORMAT_ABGR1555 = 0x15731002u,
304 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR, SDL_PACKEDLAYOUT_1555, 16, 2), */
305 SDL_PIXELFORMAT_BGRA5551 = 0x15841002u,
306 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA, SDL_PACKEDLAYOUT_5551, 16, 2), */
307 SDL_PIXELFORMAT_RGB565 = 0x15151002u,
308 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB, SDL_PACKEDLAYOUT_565, 16, 2), */
309 SDL_PIXELFORMAT_BGR565 = 0x15551002u,
310 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR, SDL_PACKEDLAYOUT_565, 16, 2), */
311 SDL_PIXELFORMAT_RGB24 = 0x17101803u,
312 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_RGB, 0, 24, 3), */
313 SDL_PIXELFORMAT_BGR24 = 0x17401803u,
314 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_BGR, 0, 24, 3), */
315 SDL_PIXELFORMAT_XRGB8888 = 0x16161804u,
316 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XRGB, SDL_PACKEDLAYOUT_8888, 24, 4), */
317 SDL_PIXELFORMAT_RGBX8888 = 0x16261804u,
318 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBX, SDL_PACKEDLAYOUT_8888, 24, 4), */
319 SDL_PIXELFORMAT_XBGR8888 = 0x16561804u,
320 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XBGR, SDL_PACKEDLAYOUT_8888, 24, 4), */
321 SDL_PIXELFORMAT_BGRX8888 = 0x16661804u,
322 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRX, SDL_PACKEDLAYOUT_8888, 24, 4), */
323 SDL_PIXELFORMAT_ARGB8888 = 0x16362004u,
324 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB, SDL_PACKEDLAYOUT_8888, 32, 4), */
325 SDL_PIXELFORMAT_RGBA8888 = 0x16462004u,
326 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBA, SDL_PACKEDLAYOUT_8888, 32, 4), */
327 SDL_PIXELFORMAT_ABGR8888 = 0x16762004u,
328 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ABGR, SDL_PACKEDLAYOUT_8888, 32, 4), */
329 SDL_PIXELFORMAT_BGRA8888 = 0x16862004u,
330 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRA, SDL_PACKEDLAYOUT_8888, 32, 4), */
331 SDL_PIXELFORMAT_XRGB2101010 = 0x16172004u,
332 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XRGB, SDL_PACKEDLAYOUT_2101010, 32, 4), */
333 SDL_PIXELFORMAT_XBGR2101010 = 0x16572004u,
334 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XBGR, SDL_PACKEDLAYOUT_2101010, 32, 4), */
335 SDL_PIXELFORMAT_ARGB2101010 = 0x16372004u,
336 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB, SDL_PACKEDLAYOUT_2101010, 32, 4), */
337 SDL_PIXELFORMAT_ABGR2101010 = 0x16772004u,
338 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ABGR, SDL_PACKEDLAYOUT_2101010, 32, 4), */
339 SDL_PIXELFORMAT_RGB48 = 0x18103006u,
340 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU16, SDL_ARRAYORDER_RGB, 0, 48, 6), */
341 SDL_PIXELFORMAT_BGR48 = 0x18403006u,
342 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU16, SDL_ARRAYORDER_BGR, 0, 48, 6), */
343 SDL_PIXELFORMAT_RGBA64 = 0x18204008u,
344 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU16, SDL_ARRAYORDER_RGBA, 0, 64, 8), */
345 SDL_PIXELFORMAT_ARGB64 = 0x18304008u,
346 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU16, SDL_ARRAYORDER_ARGB, 0, 64, 8), */
347 SDL_PIXELFORMAT_BGRA64 = 0x18504008u,
348 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU16, SDL_ARRAYORDER_BGRA, 0, 64, 8), */
349 SDL_PIXELFORMAT_ABGR64 = 0x18604008u,
350 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU16, SDL_ARRAYORDER_ABGR, 0, 64, 8), */
351 SDL_PIXELFORMAT_RGB48_FLOAT = 0x1a103006u,
352 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF16, SDL_ARRAYORDER_RGB, 0, 48, 6), */
353 SDL_PIXELFORMAT_BGR48_FLOAT = 0x1a403006u,
354 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF16, SDL_ARRAYORDER_BGR, 0, 48, 6), */
355 SDL_PIXELFORMAT_RGBA64_FLOAT = 0x1a204008u,
356 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF16, SDL_ARRAYORDER_RGBA, 0, 64, 8), */
357 SDL_PIXELFORMAT_ARGB64_FLOAT = 0x1a304008u,
358 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF16, SDL_ARRAYORDER_ARGB, 0, 64, 8), */
359 SDL_PIXELFORMAT_BGRA64_FLOAT = 0x1a504008u,
360 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF16, SDL_ARRAYORDER_BGRA, 0, 64, 8), */
361 SDL_PIXELFORMAT_ABGR64_FLOAT = 0x1a604008u,
362 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF16, SDL_ARRAYORDER_ABGR, 0, 64, 8), */
363 SDL_PIXELFORMAT_RGB96_FLOAT = 0x1b10600cu,
364 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF32, SDL_ARRAYORDER_RGB, 0, 96, 12), */
365 SDL_PIXELFORMAT_BGR96_FLOAT = 0x1b40600cu,
366 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF32, SDL_ARRAYORDER_BGR, 0, 96, 12), */
367 SDL_PIXELFORMAT_RGBA128_FLOAT = 0x1b208010u,
368 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF32, SDL_ARRAYORDER_RGBA, 0, 128, 16), */
369 SDL_PIXELFORMAT_ARGB128_FLOAT = 0x1b308010u,
370 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF32, SDL_ARRAYORDER_ARGB, 0, 128, 16), */
371 SDL_PIXELFORMAT_BGRA128_FLOAT = 0x1b508010u,
372 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF32, SDL_ARRAYORDER_BGRA, 0, 128, 16), */
373 SDL_PIXELFORMAT_ABGR128_FLOAT = 0x1b608010u,
374 /* SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYF32, SDL_ARRAYORDER_ABGR, 0, 128, 16), */
375
376 SDL_PIXELFORMAT_YV12 = 0x32315659u, /**< Planar mode: Y + V + U (3 planes) */
377 /* SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'), */
378 SDL_PIXELFORMAT_IYUV = 0x56555949u, /**< Planar mode: Y + U + V (3 planes) */
379 /* SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'), */
380 SDL_PIXELFORMAT_YUY2 = 0x32595559u, /**< Packed mode: Y0+U0+Y1+V0 (1 plane) */
381 /* SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'), */
382 SDL_PIXELFORMAT_UYVY = 0x59565955u, /**< Packed mode: U0+Y0+V0+Y1 (1 plane) */
383 /* SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'), */
384 SDL_PIXELFORMAT_YVYU = 0x55595659u, /**< Packed mode: Y0+V0+Y1+U0 (1 plane) */
385 /* SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U'), */
386 SDL_PIXELFORMAT_NV12 = 0x3231564eu, /**< Planar mode: Y + U/V interleaved (2 planes) */
387 /* SDL_DEFINE_PIXELFOURCC('N', 'V', '1', '2'), */
388 SDL_PIXELFORMAT_NV21 = 0x3132564eu, /**< Planar mode: Y + V/U interleaved (2 planes) */
389 /* SDL_DEFINE_PIXELFOURCC('N', 'V', '2', '1'), */
390 SDL_PIXELFORMAT_P010 = 0x30313050u, /**< Planar mode: Y + U/V interleaved (2 planes) */
391 /* SDL_DEFINE_PIXELFOURCC('P', '0', '1', '0'), */
392 SDL_PIXELFORMAT_EXTERNAL_OES = 0x2053454fu, /**< Android video texture format */
393 /* SDL_DEFINE_PIXELFOURCC('O', 'E', 'S', ' ') */
394
395 /* Aliases for RGBA byte arrays of color data, for the current platform */
396 #if SDL_BYTEORDER == SDL_BIG_ENDIAN
405 #else
414 #endif
SDL_PixelFormat
Definition: SDL_pixels.h:265
@ SDL_PIXELFORMAT_BGR48_FLOAT
Definition: SDL_pixels.h:353
@ SDL_PIXELFORMAT_RGBA128_FLOAT
Definition: SDL_pixels.h:367
@ SDL_PIXELFORMAT_BGR565
Definition: SDL_pixels.h:309
@ SDL_PIXELFORMAT_EXTERNAL_OES
Definition: SDL_pixels.h:392
@ SDL_PIXELFORMAT_ARGB64
Definition: SDL_pixels.h:345
@ SDL_PIXELFORMAT_RGB332
Definition: SDL_pixels.h:281
@ SDL_PIXELFORMAT_INDEX2LSB
Definition: SDL_pixels.h:271
@ SDL_PIXELFORMAT_INDEX1LSB
Definition: SDL_pixels.h:267
@ SDL_PIXELFORMAT_RGB96_FLOAT
Definition: SDL_pixels.h:363
@ SDL_PIXELFORMAT_RGBX32
Definition: SDL_pixels.h:401
@ SDL_PIXELFORMAT_ABGR4444
Definition: SDL_pixels.h:295
@ SDL_PIXELFORMAT_BGRA4444
Definition: SDL_pixels.h:297
@ SDL_PIXELFORMAT_BGR24
Definition: SDL_pixels.h:313
@ SDL_PIXELFORMAT_INDEX4MSB
Definition: SDL_pixels.h:277
@ SDL_PIXELFORMAT_ABGR2101010
Definition: SDL_pixels.h:337
@ SDL_PIXELFORMAT_BGRA32
Definition: SDL_pixels.h:399
@ SDL_PIXELFORMAT_XBGR2101010
Definition: SDL_pixels.h:333
@ SDL_PIXELFORMAT_RGBA64_FLOAT
Definition: SDL_pixels.h:355
@ SDL_PIXELFORMAT_INDEX2MSB
Definition: SDL_pixels.h:273
@ SDL_PIXELFORMAT_BGRA64_FLOAT
Definition: SDL_pixels.h:359
@ SDL_PIXELFORMAT_RGBA8888
Definition: SDL_pixels.h:325
@ SDL_PIXELFORMAT_RGBA5551
Definition: SDL_pixels.h:301
@ SDL_PIXELFORMAT_ARGB1555
Definition: SDL_pixels.h:299
@ SDL_PIXELFORMAT_XBGR4444
Definition: SDL_pixels.h:285
@ SDL_PIXELFORMAT_RGBA64
Definition: SDL_pixels.h:343
@ SDL_PIXELFORMAT_INDEX8
Definition: SDL_pixels.h:279
@ SDL_PIXELFORMAT_XRGB2101010
Definition: SDL_pixels.h:331
@ SDL_PIXELFORMAT_XRGB8888
Definition: SDL_pixels.h:315
@ SDL_PIXELFORMAT_BGRX32
Definition: SDL_pixels.h:403
@ SDL_PIXELFORMAT_YV12
Definition: SDL_pixels.h:376
@ SDL_PIXELFORMAT_ABGR32
Definition: SDL_pixels.h:400
@ SDL_PIXELFORMAT_BGRX8888
Definition: SDL_pixels.h:321
@ SDL_PIXELFORMAT_RGB24
Definition: SDL_pixels.h:311
@ SDL_PIXELFORMAT_BGRA64
Definition: SDL_pixels.h:347
@ SDL_PIXELFORMAT_ABGR8888
Definition: SDL_pixels.h:327
@ SDL_PIXELFORMAT_XBGR32
Definition: SDL_pixels.h:404
@ SDL_PIXELFORMAT_NV12
Definition: SDL_pixels.h:386
@ SDL_PIXELFORMAT_BGRA8888
Definition: SDL_pixels.h:329
@ SDL_PIXELFORMAT_ABGR128_FLOAT
Definition: SDL_pixels.h:373
@ SDL_PIXELFORMAT_ARGB32
Definition: SDL_pixels.h:398
@ SDL_PIXELFORMAT_ABGR1555
Definition: SDL_pixels.h:303
@ SDL_PIXELFORMAT_NV21
Definition: SDL_pixels.h:388
@ SDL_PIXELFORMAT_IYUV
Definition: SDL_pixels.h:378
@ SDL_PIXELFORMAT_ARGB8888
Definition: SDL_pixels.h:323
@ SDL_PIXELFORMAT_ABGR64_FLOAT
Definition: SDL_pixels.h:361
@ SDL_PIXELFORMAT_ABGR64
Definition: SDL_pixels.h:349
@ SDL_PIXELFORMAT_XRGB32
Definition: SDL_pixels.h:402
@ SDL_PIXELFORMAT_XBGR1555
Definition: SDL_pixels.h:289
@ SDL_PIXELFORMAT_RGB48
Definition: SDL_pixels.h:339
@ SDL_PIXELFORMAT_XRGB4444
Definition: SDL_pixels.h:283
@ SDL_PIXELFORMAT_BGR96_FLOAT
Definition: SDL_pixels.h:365
@ SDL_PIXELFORMAT_ARGB4444
Definition: SDL_pixels.h:291
@ SDL_PIXELFORMAT_RGB48_FLOAT
Definition: SDL_pixels.h:351
@ SDL_PIXELFORMAT_BGR48
Definition: SDL_pixels.h:341
@ SDL_PIXELFORMAT_RGBA32
Definition: SDL_pixels.h:397
@ SDL_PIXELFORMAT_BGRA128_FLOAT
Definition: SDL_pixels.h:371
@ SDL_PIXELFORMAT_ARGB64_FLOAT
Definition: SDL_pixels.h:357
@ SDL_PIXELFORMAT_INDEX1MSB
Definition: SDL_pixels.h:269
@ SDL_PIXELFORMAT_INDEX4LSB
Definition: SDL_pixels.h:275
@ SDL_PIXELFORMAT_RGBX8888
Definition: SDL_pixels.h:317
@ SDL_PIXELFORMAT_BGRA5551
Definition: SDL_pixels.h:305
@ SDL_PIXELFORMAT_ARGB128_FLOAT
Definition: SDL_pixels.h:369
@ SDL_PIXELFORMAT_XRGB1555
Definition: SDL_pixels.h:287
@ SDL_PIXELFORMAT_RGB565
Definition: SDL_pixels.h:307
@ SDL_PIXELFORMAT_XBGR8888
Definition: SDL_pixels.h:319
@ SDL_PIXELFORMAT_ARGB2101010
Definition: SDL_pixels.h:335
@ SDL_PIXELFORMAT_UNKNOWN
Definition: SDL_pixels.h:266
@ SDL_PIXELFORMAT_RGBA4444
Definition: SDL_pixels.h:293

◆ SDL_PixelType

Pixel type.

Since
This enum is available since SDL 3.1.3.
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 82 of file SDL_pixels.h.

◆ SDL_TransferCharacteristics

Colorspace transfer characteristics.

These are as described by https://www.itu.int/rec/T-REC-H.273-201612-S/en

Since
This enum is available since SDL 3.1.3.
Enumerator
SDL_TRANSFER_CHARACTERISTICS_UNKNOWN 
SDL_TRANSFER_CHARACTERISTICS_BT709 

Rec. ITU-R BT.709-6 / ITU-R BT1361

SDL_TRANSFER_CHARACTERISTICS_UNSPECIFIED 
SDL_TRANSFER_CHARACTERISTICS_GAMMA22 

ITU-R BT.470-6 System M / ITU-R BT1700 625 PAL & SECAM

SDL_TRANSFER_CHARACTERISTICS_GAMMA28 

ITU-R BT.470-6 System B, G

SDL_TRANSFER_CHARACTERISTICS_BT601 

SMPTE ST 170M / ITU-R BT.601-7 525 or 625

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" (HLG)

SDL_TRANSFER_CHARACTERISTICS_CUSTOM 

Definition at line 497 of file SDL_pixels.h.

498{
500 SDL_TRANSFER_CHARACTERISTICS_BT709 = 1, /**< Rec. ITU-R BT.709-6 / ITU-R BT1361 */
502 SDL_TRANSFER_CHARACTERISTICS_GAMMA22 = 4, /**< ITU-R BT.470-6 System M / ITU-R BT1700 625 PAL & SECAM */
503 SDL_TRANSFER_CHARACTERISTICS_GAMMA28 = 5, /**< ITU-R BT.470-6 System B, G */
504 SDL_TRANSFER_CHARACTERISTICS_BT601 = 6, /**< SMPTE ST 170M / ITU-R BT.601-7 525 or 625 */
505 SDL_TRANSFER_CHARACTERISTICS_SMPTE240 = 7, /**< SMPTE ST 240M */
509 SDL_TRANSFER_CHARACTERISTICS_IEC61966 = 11, /**< IEC 61966-2-4 */
510 SDL_TRANSFER_CHARACTERISTICS_BT1361 = 12, /**< ITU-R BT1361 Extended Colour Gamut */
511 SDL_TRANSFER_CHARACTERISTICS_SRGB = 13, /**< IEC 61966-2-1 (sRGB or sYCC) */
512 SDL_TRANSFER_CHARACTERISTICS_BT2020_10BIT = 14, /**< ITU-R BT2020 for 10-bit system */
513 SDL_TRANSFER_CHARACTERISTICS_BT2020_12BIT = 15, /**< ITU-R BT2020 for 12-bit system */
514 SDL_TRANSFER_CHARACTERISTICS_PQ = 16, /**< SMPTE ST 2084 for 10-, 12-, 14- and 16-bit systems */
515 SDL_TRANSFER_CHARACTERISTICS_SMPTE428 = 17, /**< SMPTE ST 428-1 */
516 SDL_TRANSFER_CHARACTERISTICS_HLG = 18, /**< ARIB STD-B67, known as "hybrid log-gamma" (HLG) */
SDL_TransferCharacteristics
Definition: SDL_pixels.h:498
@ SDL_TRANSFER_CHARACTERISTICS_BT709
Definition: SDL_pixels.h:500
@ SDL_TRANSFER_CHARACTERISTICS_BT1361
Definition: SDL_pixels.h:510
@ SDL_TRANSFER_CHARACTERISTICS_CUSTOM
Definition: SDL_pixels.h:517
@ SDL_TRANSFER_CHARACTERISTICS_HLG
Definition: SDL_pixels.h:516
@ SDL_TRANSFER_CHARACTERISTICS_LOG100_SQRT10
Definition: SDL_pixels.h:508
@ SDL_TRANSFER_CHARACTERISTICS_UNKNOWN
Definition: SDL_pixels.h:499
@ SDL_TRANSFER_CHARACTERISTICS_BT601
Definition: SDL_pixels.h:504
@ SDL_TRANSFER_CHARACTERISTICS_IEC61966
Definition: SDL_pixels.h:509
@ SDL_TRANSFER_CHARACTERISTICS_UNSPECIFIED
Definition: SDL_pixels.h:501
@ SDL_TRANSFER_CHARACTERISTICS_SMPTE428
Definition: SDL_pixels.h:515
@ SDL_TRANSFER_CHARACTERISTICS_LOG100
Definition: SDL_pixels.h:507
@ SDL_TRANSFER_CHARACTERISTICS_GAMMA28
Definition: SDL_pixels.h:503
@ SDL_TRANSFER_CHARACTERISTICS_SMPTE240
Definition: SDL_pixels.h:505
@ SDL_TRANSFER_CHARACTERISTICS_BT2020_10BIT
Definition: SDL_pixels.h:512
@ SDL_TRANSFER_CHARACTERISTICS_SRGB
Definition: SDL_pixels.h:511
@ SDL_TRANSFER_CHARACTERISTICS_PQ
Definition: SDL_pixels.h:514
@ SDL_TRANSFER_CHARACTERISTICS_LINEAR
Definition: SDL_pixels.h:506
@ SDL_TRANSFER_CHARACTERISTICS_BT2020_12BIT
Definition: SDL_pixels.h:513
@ SDL_TRANSFER_CHARACTERISTICS_GAMMA22
Definition: SDL_pixels.h:502

Function Documentation

◆ SDL_CreatePalette()

SDL_Palette * SDL_CreatePalette ( int  ncolors)

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.

\threadsafety It is safe to call this function from any thread.

Since
This function is available since SDL 3.1.3.
See also
SDL_DestroyPalette
SDL_SetPaletteColors
SDL_SetSurfacePalette

◆ SDL_DestroyPalette()

void SDL_DestroyPalette ( SDL_Palette palette)

Free a palette created with SDL_CreatePalette().

Parameters
palettethe SDL_Palette structure to be freed.

\threadsafety It is safe to call this function from any thread, as long as the palette is not modified or destroyed in another thread.

Since
This function is available since SDL 3.1.3.
See also
SDL_CreatePalette

◆ SDL_GetMasksForPixelFormat()

bool SDL_GetMasksForPixelFormat ( SDL_PixelFormat  format,
int *  bpp,
Uint32 Rmask,
Uint32 Gmask,
Uint32 Bmask,
Uint32 Amask 
)

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

Parameters
formatone of the SDL_PixelFormat 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
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety It is safe to call this function from any thread.

Since
This function is available since SDL 3.1.3.
See also
SDL_GetPixelFormatForMasks

◆ SDL_GetPixelFormatDetails()

const SDL_PixelFormatDetails * SDL_GetPixelFormatDetails ( SDL_PixelFormat  format)

Create an SDL_PixelFormatDetails 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
formatone of the SDL_PixelFormat values.
Returns
a pointer to a SDL_PixelFormatDetails structure or NULL on failure; call SDL_GetError() for more information.

\threadsafety It is safe to call this function from any thread.

Since
This function is available since SDL 3.1.3.

◆ SDL_GetPixelFormatForMasks()

SDL_PixelFormat SDL_GetPixelFormatForMasks ( int  bpp,
Uint32  Rmask,
Uint32  Gmask,
Uint32  Bmask,
Uint32  Amask 
)

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
the SDL_PixelFormat value corresponding to the format masks, or SDL_PIXELFORMAT_UNKNOWN if there isn't a match.

\threadsafety It is safe to call this function from any thread.

Since
This function is available since SDL 3.1.3.
See also
SDL_GetMasksForPixelFormat

◆ SDL_GetPixelFormatName()

const char * SDL_GetPixelFormatName ( SDL_PixelFormat  format)

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.

\threadsafety It is safe to call this function from any thread.

Since
This function is available since SDL 3.1.3.

◆ SDL_GetRGB()

void SDL_GetRGB ( Uint32  pixel,
const SDL_PixelFormatDetails format,
const SDL_Palette palette,
Uint8 r,
Uint8 g,
Uint8 b 
)

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.
formata pointer to SDL_PixelFormatDetails describing the pixel format.
palettean optional palette for indexed formats, may be NULL.
ra pointer filled in with the red component, may be NULL.
ga pointer filled in with the green component, may be NULL.
ba pointer filled in with the blue component, may be NULL.

\threadsafety It is safe to call this function from any thread, as long as the palette is not modified.

Since
This function is available since SDL 3.1.3.
See also
SDL_GetPixelFormatDetails
SDL_GetRGBA
SDL_MapRGB
SDL_MapRGBA

◆ SDL_GetRGBA()

void SDL_GetRGBA ( Uint32  pixel,
const SDL_PixelFormatDetails format,
const SDL_Palette palette,
Uint8 r,
Uint8 g,
Uint8 b,
Uint8 a 
)

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.
formata pointer to SDL_PixelFormatDetails describing the pixel format.
palettean optional palette for indexed formats, may be NULL.
ra pointer filled in with the red component, may be NULL.
ga pointer filled in with the green component, may be NULL.
ba pointer filled in with the blue component, may be NULL.
aa pointer filled in with the alpha component, may be NULL.

\threadsafety It is safe to call this function from any thread, as long as the palette is not modified.

Since
This function is available since SDL 3.1.3.
See also
SDL_GetPixelFormatDetails
SDL_GetRGB
SDL_MapRGB
SDL_MapRGBA

◆ SDL_MapRGB()

Uint32 SDL_MapRGB ( const SDL_PixelFormatDetails format,
const SDL_Palette palette,
Uint8  r,
Uint8  g,
Uint8  b 
)

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
formata pointer to SDL_PixelFormatDetails describing the pixel format.
palettean optional palette for indexed formats, may be NULL.
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.

\threadsafety It is safe to call this function from any thread, as long as the palette is not modified.

Since
This function is available since SDL 3.1.3.
See also
SDL_GetPixelFormatDetails
SDL_GetRGB
SDL_MapRGBA
SDL_MapSurfaceRGB

◆ SDL_MapRGBA()

Uint32 SDL_MapRGBA ( const SDL_PixelFormatDetails format,
const SDL_Palette palette,
Uint8  r,
Uint8  g,
Uint8  b,
Uint8  a 
)

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
formata pointer to SDL_PixelFormatDetails describing the pixel format.
palettean optional palette for indexed formats, may be NULL.
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.

\threadsafety It is safe to call this function from any thread, as long as the palette is not modified.

Since
This function is available since SDL 3.1.3.
See also
SDL_GetPixelFormatDetails
SDL_GetRGBA
SDL_MapRGB
SDL_MapSurfaceRGBA

◆ SDL_SetPaletteColors()

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

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
true on success or false on failure; call SDL_GetError() for more information.

\threadsafety It is safe to call this function from any thread, as long as the palette is not modified or destroyed in another thread.

Since
This function is available since SDL 3.1.3.