SDL_pixels.h File Reference

#include "SDL_stdinc.h"
#include "SDL_endian.h"
#include "begin_code.h"
#include "close_code.h"

Go to the source code of this file.

Classes
struct	SDL_Color
struct	SDL_Palette
struct	SDL_PixelFormat

Macros
#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_FOURCC(format)   ((format) && (SDL_PIXELFLAG(format) != 1))
#define	SDL_Colour   SDL_Color
Transparency definitions
These define alpha as the opacity of a surface.
#define	SDL_ALPHA_OPAQUE   255
#define	SDL_ALPHA_TRANSPARENT   0

Typedefs
typedef struct SDL_Color	SDL_Color
typedef struct SDL_Palette	SDL_Palette
typedef struct SDL_PixelFormat	SDL_PixelFormat

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 }
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_INDEX4LSB,   SDL_PIXELFORMAT_INDEX4MSB, SDL_PIXELFORMAT_INDEX8, SDL_PIXELFORMAT_RGB332, SDL_PIXELFORMAT_RGB444,   SDL_PIXELFORMAT_RGB555, 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_RGB888, SDL_PIXELFORMAT_RGBX8888,   SDL_PIXELFORMAT_BGR888, SDL_PIXELFORMAT_BGRX8888, SDL_PIXELFORMAT_ARGB8888, SDL_PIXELFORMAT_RGBA8888,   SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_BGRA8888, SDL_PIXELFORMAT_ARGB2101010, SDL_PIXELFORMAT_RGBA32 = SDL_PIXELFORMAT_ABGR8888,   SDL_PIXELFORMAT_ARGB32 = SDL_PIXELFORMAT_BGRA8888, SDL_PIXELFORMAT_BGRA32 = SDL_PIXELFORMAT_ARGB8888, SDL_PIXELFORMAT_ABGR32 = SDL_PIXELFORMAT_RGBA8888, 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 = }

Functions
DECLSPEC const char *SDLCALL	SDL_GetPixelFormatName (Uint32 format)
	Get the human readable name of a pixel format. More...
DECLSPEC SDL_bool SDLCALL	SDL_PixelFormatEnumToMasks (Uint32 format, int *bpp, Uint32 *Rmask, Uint32 *Gmask, Uint32 *Bmask, Uint32 *Amask)
	Convert one of the enumerated pixel formats to a bpp and RGBA masks. More...
DECLSPEC Uint32 SDLCALL	SDL_MasksToPixelFormatEnum (int bpp, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)
	Convert a bpp and RGBA masks to an enumerated pixel format. More...
DECLSPEC SDL_PixelFormat *SDLCALL	SDL_AllocFormat (Uint32 pixel_format)
	Create an SDL_PixelFormat structure from a pixel format enum. More...
DECLSPEC void SDLCALL	SDL_FreeFormat (SDL_PixelFormat *format)
	Free an SDL_PixelFormat structure. More...
DECLSPEC SDL_Palette *SDLCALL	SDL_AllocPalette (int ncolors)
	Create a palette structure with the specified number of color entries. More...
DECLSPEC int SDLCALL	SDL_SetPixelFormatPalette (SDL_PixelFormat *format, SDL_Palette *palette)
	Set the palette for a pixel format structure. More...
DECLSPEC int SDLCALL	SDL_SetPaletteColors (SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors)
	Set a range of colors in a palette. More...
DECLSPEC void SDLCALL	SDL_FreePalette (SDL_Palette *palette)
	Free a palette created with SDL_AllocPalette(). More...
DECLSPEC Uint32 SDLCALL	SDL_MapRGB (const SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b)
	Maps an RGB triple to an opaque pixel value for a given pixel format. More...
DECLSPEC Uint32 SDLCALL	SDL_MapRGBA (const SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b, Uint8 a)
	Maps an RGBA quadruple to a pixel value for a given pixel format. More...
DECLSPEC void SDLCALL	SDL_GetRGB (Uint32 pixel, const SDL_PixelFormat *format, Uint8 *r, Uint8 *g, Uint8 *b)
	Get the RGB components from a pixel of the specified format. More...
DECLSPEC void SDLCALL	SDL_GetRGBA (Uint32 pixel, const SDL_PixelFormat *format, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)
	Get the RGBA components from a pixel of the specified format. More...
DECLSPEC void SDLCALL	SDL_CalculateGammaRamp (float gamma, Uint16 *ramp)
	Calculate a 256 entry gamma ramp for a gamma value. More...

Detailed Description

Header for the enumerated pixel format definitions.

Definition in file SDL_pixels.h.

Macro Definition Documentation

SDL_ALPHA_OPAQUE

#define SDL_ALPHA_OPAQUE   255

Definition at line 46 of file SDL_pixels.h.

SDL_ALPHA_TRANSPARENT

#define SDL_ALPHA_TRANSPARENT   0

Definition at line 47 of file SDL_pixels.h.

SDL_BITSPERPIXEL

#define SDL_BITSPERPIXEL

(

X

)

(((X) >> 8) & 0xFF)

Definition at line 127 of file SDL_pixels.h.

SDL_BYTESPERPIXEL

#define SDL_BYTESPERPIXEL

(

X

)

Value:

(SDL_ISPIXELFORMAT_FOURCC(X) ? \
        ((((X) == SDL_PIXELFORMAT_YUY2) || \
          ((X) == SDL_PIXELFORMAT_UYVY) || \
          ((X) == SDL_PIXELFORMAT_YVYU)) ? 2 : 1) : (((X) >> 0) & 0xFF))

Definition at line 128 of file SDL_pixels.h.

SDL_Colour

#define SDL_Colour   SDL_Color

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

SDL_DEFINE_PIXELFOURCC

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

Definition at line 117 of file SDL_pixels.h.

SDL_ISPIXELFORMAT_ALPHA

#define SDL_ISPIXELFORMAT_ALPHA

(

format

)

Value:

((SDL_ISPIXELFORMAT_PACKED(format) && \
     ((SDL_PIXELORDER(format) == SDL_PACKEDORDER_ARGB) || \
      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_RGBA) || \
      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_ABGR) || \
      (SDL_PIXELORDER(format) == SDL_PACKEDORDER_BGRA))) || \
    (SDL_ISPIXELFORMAT_ARRAY(format) && \
     ((SDL_PIXELORDER(format) == SDL_ARRAYORDER_ARGB) || \
      (SDL_PIXELORDER(format) == SDL_ARRAYORDER_RGBA) || \
      (SDL_PIXELORDER(format) == SDL_ARRAYORDER_ABGR) || \
      (SDL_PIXELORDER(format) == SDL_ARRAYORDER_BGRA))))

Definition at line 154 of file SDL_pixels.h.

SDL_ISPIXELFORMAT_ARRAY

#define SDL_ISPIXELFORMAT_ARRAY

(

format

)

Value:

(!SDL_ISPIXELFORMAT_FOURCC(format) && \
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU8) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU16) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU32) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF16) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF32)))

Definition at line 146 of file SDL_pixels.h.

SDL_ISPIXELFORMAT_FOURCC

#define SDL_ISPIXELFORMAT_FOURCC

(

format

)

((format) && (SDL_PIXELFLAG(format) != 1))

Definition at line 167 of file SDL_pixels.h.

SDL_ISPIXELFORMAT_INDEXED

#define SDL_ISPIXELFORMAT_INDEXED

(

format

)

Value:

(!SDL_ISPIXELFORMAT_FOURCC(format) && \
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8)))

Definition at line 134 of file SDL_pixels.h.

SDL_ISPIXELFORMAT_PACKED

#define SDL_ISPIXELFORMAT_PACKED

(

format

)

Value:

(!SDL_ISPIXELFORMAT_FOURCC(format) && \
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED8) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED16) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED32)))

Definition at line 140 of file SDL_pixels.h.

SDL_PIXELFLAG

#define SDL_PIXELFLAG

(

X

)

(((X) >> 28) & 0x0F)

Definition at line 123 of file SDL_pixels.h.

SDL_PIXELLAYOUT

#define SDL_PIXELLAYOUT

(

X

)

(((X) >> 16) & 0x0F)

Definition at line 126 of file SDL_pixels.h.

SDL_PIXELORDER

#define SDL_PIXELORDER

(

X

)

(((X) >> 20) & 0x0F)

Definition at line 125 of file SDL_pixels.h.

SDL_PIXELTYPE

#define SDL_PIXELTYPE

(

X

)

(((X) >> 24) & 0x0F)

Definition at line 124 of file SDL_pixels.h.

Typedef Documentation

SDL_Color

typedef struct SDL_Color SDL_Color

SDL_Palette

typedef struct SDL_Palette SDL_Palette

SDL_PixelFormat

typedef struct SDL_PixelFormat SDL_PixelFormat

Note

Everything in the pixel format structure is read-only.

Enumeration Type Documentation

SDL_ArrayOrder

enum 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 92 of file SDL_pixels.h.

{
    SDL_ARRAYORDER_NONE,
    SDL_ARRAYORDER_RGB,
    SDL_ARRAYORDER_RGBA,
    SDL_ARRAYORDER_ARGB,
    SDL_ARRAYORDER_BGR,
    SDL_ARRAYORDER_BGRA,
    SDL_ARRAYORDER_ABGR
} SDL_ArrayOrder;

SDL_BitmapOrder

enum SDL_BitmapOrder

Bitmap pixel order, high bit -> low bit.

Enumerator
SDL_BITMAPORDER_NONE
SDL_BITMAPORDER_4321
SDL_BITMAPORDER_1234

Definition at line 68 of file SDL_pixels.h.

{
    SDL_BITMAPORDER_NONE,
    SDL_BITMAPORDER_4321,
    SDL_BITMAPORDER_1234
} SDL_BitmapOrder;

SDL_PackedLayout

enum 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 104 of file SDL_pixels.h.

{
    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
} SDL_PackedLayout;

SDL_PackedOrder

enum 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 76 of file SDL_pixels.h.

{
    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
} SDL_PackedOrder;

SDL_PixelFormatEnum

enum SDL_PixelFormatEnum

Enumerator
SDL_PIXELFORMAT_UNKNOWN
SDL_PIXELFORMAT_INDEX1LSB
SDL_PIXELFORMAT_INDEX1MSB
SDL_PIXELFORMAT_INDEX4LSB
SDL_PIXELFORMAT_INDEX4MSB
SDL_PIXELFORMAT_INDEX8
SDL_PIXELFORMAT_RGB332
SDL_PIXELFORMAT_RGB444
SDL_PIXELFORMAT_RGB555
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_RGB888
SDL_PIXELFORMAT_RGBX8888
SDL_PIXELFORMAT_BGR888
SDL_PIXELFORMAT_BGRX8888
SDL_PIXELFORMAT_ARGB8888
SDL_PIXELFORMAT_RGBA8888
SDL_PIXELFORMAT_ABGR8888
SDL_PIXELFORMAT_BGRA8888
SDL_PIXELFORMAT_ARGB2101010
SDL_PIXELFORMAT_RGBA32
SDL_PIXELFORMAT_ARGB32
SDL_PIXELFORMAT_BGRA32
SDL_PIXELFORMAT_ABGR32
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 171 of file SDL_pixels.h.

{
    SDL_PIXELFORMAT_UNKNOWN,
    SDL_PIXELFORMAT_INDEX1LSB =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_4321, 0,
                               1, 0),
    SDL_PIXELFORMAT_INDEX1MSB =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
                               1, 0),
    SDL_PIXELFORMAT_INDEX4LSB =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
                               4, 0),
    SDL_PIXELFORMAT_INDEX4MSB =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_1234, 0,
                               4, 0),
    SDL_PIXELFORMAT_INDEX8 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX8, 0, 0, 8, 1),
    SDL_PIXELFORMAT_RGB332 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED8, SDL_PACKEDORDER_XRGB,
                               SDL_PACKEDLAYOUT_332, 8, 1),
    SDL_PIXELFORMAT_RGB444 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
                               SDL_PACKEDLAYOUT_4444, 12, 2),
    SDL_PIXELFORMAT_RGB555 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
                               SDL_PACKEDLAYOUT_1555, 15, 2),
    SDL_PIXELFORMAT_BGR555 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
                               SDL_PACKEDLAYOUT_1555, 15, 2),
    SDL_PIXELFORMAT_ARGB4444 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
                               SDL_PACKEDLAYOUT_4444, 16, 2),
    SDL_PIXELFORMAT_RGBA4444 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
                               SDL_PACKEDLAYOUT_4444, 16, 2),
    SDL_PIXELFORMAT_ABGR4444 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
                               SDL_PACKEDLAYOUT_4444, 16, 2),
    SDL_PIXELFORMAT_BGRA4444 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
                               SDL_PACKEDLAYOUT_4444, 16, 2),
    SDL_PIXELFORMAT_ARGB1555 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ARGB,
                               SDL_PACKEDLAYOUT_1555, 16, 2),
    SDL_PIXELFORMAT_RGBA5551 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_RGBA,
                               SDL_PACKEDLAYOUT_5551, 16, 2),
    SDL_PIXELFORMAT_ABGR1555 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_ABGR,
                               SDL_PACKEDLAYOUT_1555, 16, 2),
    SDL_PIXELFORMAT_BGRA5551 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_BGRA,
                               SDL_PACKEDLAYOUT_5551, 16, 2),
    SDL_PIXELFORMAT_RGB565 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XRGB,
                               SDL_PACKEDLAYOUT_565, 16, 2),
    SDL_PIXELFORMAT_BGR565 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED16, SDL_PACKEDORDER_XBGR,
                               SDL_PACKEDLAYOUT_565, 16, 2),
    SDL_PIXELFORMAT_RGB24 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_RGB, 0,
                               24, 3),
    SDL_PIXELFORMAT_BGR24 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_ARRAYU8, SDL_ARRAYORDER_BGR, 0,
                               24, 3),
    SDL_PIXELFORMAT_RGB888 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XRGB,
                               SDL_PACKEDLAYOUT_8888, 24, 4),
    SDL_PIXELFORMAT_RGBX8888 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBX,
                               SDL_PACKEDLAYOUT_8888, 24, 4),
    SDL_PIXELFORMAT_BGR888 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_XBGR,
                               SDL_PACKEDLAYOUT_8888, 24, 4),
    SDL_PIXELFORMAT_BGRX8888 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRX,
                               SDL_PACKEDLAYOUT_8888, 24, 4),
    SDL_PIXELFORMAT_ARGB8888 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
                               SDL_PACKEDLAYOUT_8888, 32, 4),
    SDL_PIXELFORMAT_RGBA8888 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_RGBA,
                               SDL_PACKEDLAYOUT_8888, 32, 4),
    SDL_PIXELFORMAT_ABGR8888 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ABGR,
                               SDL_PACKEDLAYOUT_8888, 32, 4),
    SDL_PIXELFORMAT_BGRA8888 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_BGRA,
                               SDL_PACKEDLAYOUT_8888, 32, 4),
    SDL_PIXELFORMAT_ARGB2101010 =
        SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_PACKED32, SDL_PACKEDORDER_ARGB,
                               SDL_PACKEDLAYOUT_2101010, 32, 4),

    /* Aliases for RGBA byte arrays of color data, for the current platform */
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
    SDL_PIXELFORMAT_RGBA32 = SDL_PIXELFORMAT_RGBA8888,
    SDL_PIXELFORMAT_ARGB32 = SDL_PIXELFORMAT_ARGB8888,
    SDL_PIXELFORMAT_BGRA32 = SDL_PIXELFORMAT_BGRA8888,
    SDL_PIXELFORMAT_ABGR32 = SDL_PIXELFORMAT_ABGR8888,
#else
    SDL_PIXELFORMAT_RGBA32 = SDL_PIXELFORMAT_ABGR8888,
    SDL_PIXELFORMAT_ARGB32 = SDL_PIXELFORMAT_BGRA8888,
    SDL_PIXELFORMAT_BGRA32 = SDL_PIXELFORMAT_ARGB8888,
    SDL_PIXELFORMAT_ABGR32 = SDL_PIXELFORMAT_RGBA8888,
#endif

    SDL_PIXELFORMAT_YV12 =      
        SDL_DEFINE_PIXELFOURCC('Y', 'V', '1', '2'),
    SDL_PIXELFORMAT_IYUV =      
        SDL_DEFINE_PIXELFOURCC('I', 'Y', 'U', 'V'),
    SDL_PIXELFORMAT_YUY2 =      
        SDL_DEFINE_PIXELFOURCC('Y', 'U', 'Y', '2'),
    SDL_PIXELFORMAT_UYVY =      
        SDL_DEFINE_PIXELFOURCC('U', 'Y', 'V', 'Y'),
    SDL_PIXELFORMAT_YVYU =      
        SDL_DEFINE_PIXELFOURCC('Y', 'V', 'Y', 'U'),
    SDL_PIXELFORMAT_NV12 =      
        SDL_DEFINE_PIXELFOURCC('N', 'V', '1', '2'),
    SDL_PIXELFORMAT_NV21 =      
        SDL_DEFINE_PIXELFOURCC('N', 'V', '2', '1'),
    SDL_PIXELFORMAT_EXTERNAL_OES =      
        SDL_DEFINE_PIXELFOURCC('O', 'E', 'S', ' ')
} SDL_PixelFormatEnum;

SDL_PixelType

enum 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

Definition at line 51 of file SDL_pixels.h.

{
    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;

Function Documentation

SDL_AllocFormat()

DECLSPEC SDL_PixelFormat* SDLCALL SDL_AllocFormat

(

Uint32

pixel_format

)

Create an SDL_PixelFormat structure from a pixel format enum.

SDL_AllocPalette()

DECLSPEC SDL_Palette* SDLCALL SDL_AllocPalette

(

int

ncolors

)

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

Returns

A new palette, or NULL if there wasn't enough memory.

Note

The palette entries are initialized to white.

See also

SDL_FreePalette()

SDL_CalculateGammaRamp()

DECLSPEC void SDLCALL SDL_CalculateGammaRamp	(	float	gamma,
		Uint16 *	ramp
	)

Calculate a 256 entry gamma ramp for a gamma value.

SDL_FreeFormat()

DECLSPEC void SDLCALL SDL_FreeFormat

(

SDL_PixelFormat *

format

)

Free an SDL_PixelFormat structure.

SDL_FreePalette()

DECLSPEC void SDLCALL SDL_FreePalette

(

SDL_Palette *

palette

)

Free a palette created with SDL_AllocPalette().

See also

SDL_AllocPalette()

SDL_GetPixelFormatName()

DECLSPEC const char* SDLCALL SDL_GetPixelFormatName

(

Uint32

format

)

Get the human readable name of a pixel format.

SDL_GetRGB()

DECLSPEC void SDLCALL SDL_GetRGB	(	Uint32	pixel,
		const SDL_PixelFormat *	format,
		Uint8 *	r,
		Uint8 *	g,
		Uint8 *	b
	)

Get the RGB components from a pixel of the specified format.

See also

SDL_GetRGBA

SDL_GetRGBA()

DECLSPEC void SDLCALL SDL_GetRGBA	(	Uint32	pixel,
		const SDL_PixelFormat *	format,
		Uint8 *	r,
		Uint8 *	g,
		Uint8 *	b,
		Uint8 *	a
	)

Get the RGBA components from a pixel of the specified format.

See also

SDL_GetRGB

SDL_MapRGB()

DECLSPEC Uint32 SDLCALL SDL_MapRGB	(	const SDL_PixelFormat *	format,
		Uint8	r,
		Uint8	g,
		Uint8	b
	)

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

See also

SDL_MapRGBA

SDL_MapRGBA()

DECLSPEC Uint32 SDLCALL SDL_MapRGBA	(	const SDL_PixelFormat *	format,
		Uint8	r,
		Uint8	g,
		Uint8	b,
		Uint8	a
	)

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

See also

SDL_MapRGB

SDL_MasksToPixelFormatEnum()

DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum	(	int	bpp,
		Uint32	Rmask,
		Uint32	Gmask,
		Uint32	Bmask,
		Uint32	Amask
	)

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

Returns

The pixel format, or SDL_PIXELFORMAT_UNKNOWN if the conversion wasn't possible.

See also

SDL_PixelFormatEnumToMasks()

SDL_PixelFormatEnumToMasks()

DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks	(	Uint32	format,
		int *	bpp,
		Uint32 *	Rmask,
		Uint32 *	Gmask,
		Uint32 *	Bmask,
		Uint32 *	Amask
	)

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

Returns

SDL_TRUE, or SDL_FALSE if the conversion wasn't possible.

See also

SDL_MasksToPixelFormatEnum()

SDL_SetPaletteColors()

DECLSPEC int SDLCALL SDL_SetPaletteColors	(	SDL_Palette *	palette,
		const SDL_Color *	colors,
		int	firstcolor,
		int	ncolors
	)

Set a range of colors in a palette.

Parameters

palette	The palette to modify.
colors	An array of colors to copy into the palette.
firstcolor	The index of the first palette entry to modify.
ncolors	The number of entries to modify.

Returns

0 on success, or -1 if not all of the colors could be set.

SDL_SetPixelFormatPalette()

DECLSPEC int SDLCALL SDL_SetPixelFormatPalette	(	SDL_PixelFormat *	format,
		SDL_Palette *	palette
	)

Set the palette for a pixel format structure.