SDL_PixelFormat Struct Reference

`#include <SDL_pixels.h>`

Collaboration diagram for SDL_PixelFormat:
[legend]

## Data Fields

Uint32 | format
SDL_Palette * | palette
Uint8 | BitsPerPixel
Uint8 | BytesPerPixel
Uint8 | padding [2]
Uint32 | Rmask
Uint32 | Gmask
Uint32 | Bmask
Uint32 | Amask
Uint8 | Rloss
Uint8 | Gloss
Uint8 | Bloss
Uint8 | Aloss
Uint8 | Rshift
Uint8 | Gshift
Uint8 | Bshift
Uint8 | Ashift
int | refcount
struct SDL_PixelFormat * | next

## Detailed Description

A structure that contains pixel format information.

Everything in the pixel format structure is read-only.

A pixel format has either a palette or masks. If a palette is used Rmask, Gmask, Bmask, and Amask will be 0.

An SDL_PixelFormat describes the format of the pixel data stored at the pixels field of an SDL_Surface. Every surface stores an SDL_PixelFormat in the format field.

If you wish to do pixel level modifications on a surface, then understanding how SDL stores its color information is essential.

For information on modern pixel color spaces, see the following Wikipedia article: http://en.wikipedia.org/wiki/RGBA_color_space

See also
  SDL_ConvertSurface
  SDL_GetRGB
  SDL_GetRGBA
  SDL_MapRGB
  SDL_MapRGBA
  SDL_AllocFormat
  SDL_FreeFormat

Definition at line 371 of file SDL_pixels.h.

## Field Documentation

## Aloss

Uint8 SDL_PixelFormat::Aloss

Definition at line 385 of file SDL_pixels.h.

## Amask

Uint32 SDL_PixelFormat::Amask

Definition at line 381 of file SDL_pixels.h.

## Ashift

Uint8 SDL_PixelFormat::Ashift

Definition at line 389 of file SDL_pixels.h.

## BitsPerPixel

Uint8 SDL_PixelFormat::BitsPerPixel

Definition at line 375 of file SDL_pixels.h.

## Bloss

Uint8 SDL_PixelFormat::Bloss

Definition at line 384 of file SDL_pixels.h.

## Bmask

Uint32 SDL_PixelFormat::Bmask

Definition at line 380 of file SDL_pixels.h.

## Bshift

Uint8 SDL_PixelFormat::Bshift

Definition at line 388 of file SDL_pixels.h.

## BytesPerPixel

Uint8 SDL_PixelFormat::BytesPerPixel

Definition at line 376 of file SDL_pixels.h.

## format

Uint32 SDL_PixelFormat::format

Definition at line 373 of file SDL_pixels.h.

## Gloss

Uint8 SDL_PixelFormat::Gloss

Definition at line 383 of file SDL_pixels.h.

## Gmask

Uint32 SDL_PixelFormat::Gmask

Definition at line 379 of file SDL_pixels.h.

## Gshift

Uint8 SDL_PixelFormat::Gshift

Definition at line 387 of file SDL_pixels.h.

## next

struct SDL_PixelFormat* SDL_PixelFormat::next

Definition at line 391 of file SDL_pixels.h.

## padding

Uint8 SDL_PixelFormat::padding[2]

Definition at line 377 of file SDL_pixels.h.

## palette

SDL_Palette* SDL_PixelFormat::palette

Definition at line 374 of file SDL_pixels.h.

## refcount

int SDL_PixelFormat::refcount

Definition at line 390 of file SDL_pixels.h.

## Rloss

Uint8 SDL_PixelFormat::Rloss

Definition at line 382 of file SDL_pixels.h.

## Rmask

Uint32 SDL_PixelFormat::Rmask

Definition at line 378 of file SDL_pixels.h.

## Rshift

Uint8 SDL_PixelFormat::Rshift

Definition at line 386 of file SDL_pixels.h.

The documentation for this struct was generated from the following file:

- SDL_pixels.h