# OgrePixelFormat.h File Reference

`#include "OgrePrerequisites.h"`
`#include "OgreCommon.h"`

Go to the source code of this file.

## Namespaces

namespace | Ogre

## Typedefs

typedef std::vector< PixelFormat > | PixelFormatList

## Enumerations

enum

PixelFormat {
PF_UNKNOWN = 0, PF_L8 = 1, PF_BYTE_L = PF_L8, PF_L16 = 2,
PF_SHORT_L = PF_L16, PF_A8 = 3, PF_BYTE_A = PF_A8, PF_A4L4 = 4,
PF_BYTE_LA = 5, PF_R5G6B5 = 6, PF_B5G6R5 = 7, PF_R3G3B2 = 31,
PF_A4R4G4B4 = 8, PF_A1R5G5B5 = 9, PF_R8G8B8 = 10, PF_B8G8R8 = 11,
PF_A8R8G8B8 = 12, PF_A8B8G8R8 = 13, PF_B8G8R8A8 = 14, PF_R8G8B8A8 = 28,
PF_X8R8G8B8 = 26, PF_X8B8G8R8 = 27, PF_BYTE_RGB = PF_B8G8R8, PF_BYTE_BGR = PF_R8G8B8,
PF_BYTE_BGRA = PF_A8R8G8B8, PF_BYTE_RGBA = PF_A8B8G8R8, PF_A2R10G10B10 = 15, PF_A2B10G10R10 = 16,
PF_DXT1 = 17, PF_DXT2 = 18, PF_DXT3 = 19, PF_DXT4 = 20,
PF_DXT5 = 21, PF_FLOAT16_R = 32, PF_FLOAT16_RGB = 22, PF_FLOAT16_RGBA = 23,
PF_FLOAT32_R = 33, PF_FLOAT32_RGB = 24, PF_FLOAT32_RGBA = 25, PF_FLOAT16_GR = 35,
PF_FLOAT32_GR = 36, PF_DEPTH = 29, PF_SHORT_RGBA = 30, PF_SHORT_GR = 34,
PF_SHORT_RGB = 37, PF_COUNT = 38
}

| The pixel format used for images, textures, and render surfaces. More...
enum | PixelFormatFlags { PFF_HASALPHA = 0x00000001, PFF_COMPRESSED = 0x00000002, PFF_FLOAT = 0x00000004, PFF_DEPTH = 0x00000008, PFF_NATIVEENDIAN = 0x00000010, PFF_LUMINANCE = 0x00000020 }
| Flags defining some on/off properties of pixel formats. More...
enum | PixelComponentType { PCT_BYTE = 0, PCT_SHORT = 1, PCT_FLOAT16 = 2, PCT_FLOAT32 = 3, PCT_COUNT = 4 }
| Pixel component format. More...

## Typedef Documentation

typedef std::vector<PixelFormat> Ogre::PixelFormatList

| Definition at line 142 of file OgrePixelFormat.h.

## Enumeration Type Documentation

enum Ogre::PixelComponentType

Pixel component format.

Enumeration values:

  PCT_BYTE |
  PCT_SHORT | Byte per component (8 bit fixed 0.0..1.0).
  PCT_FLOAT16 | Short per component (16 bit fixed 0.0..1.0)).
  PCT_FLOAT32 | 16 bit float per component
  PCT_COUNT | 32 bit float per component

Definition at line 166 of file OgrePixelFormat.h.

enum Ogre::PixelFormat

The pixel format used for images, textures, and render surfaces.

Enumeration values:

  PF_UNKNOWN | Unknown pixel format.
  PF_L8 | 8-bit pixel format, all bits luminace.
  PF_BYTE_L |
  PF_L16 | 16-bit pixel format, all bits luminace.
  PF_SHORT_L |
  PF_A8 | 8-bit pixel format, all bits alpha.
  PF_BYTE_A |
  PF_A4L4 | 8-bit pixel format, 4 bits alpha, 4 bits luminance.
  PF_BYTE_LA | 2 byte pixel format, 1 byte luminance, 1 byte alpha
  PF_R5G6B5 | 16-bit pixel format, 5 bits red, 6 bits green, 5 bits blue.
  PF_B5G6R5 | 16-bit pixel format, 5 bits red, 6 bits green, 5 bits blue.
  PF_R3G3B2 | 8-bit pixel format, 2 bits blue, 3 bits green, 3 bits red.
  PF_A4R4G4B4 | 16-bit pixel format, 4 bits for alpha, red, green and blue.
  PF_A1R5G5B5 | 16-bit pixel format, 5 bits for blue, green, red and 1 for alpha.
  PF_R8G8B8 | 24-bit pixel format, 8 bits for red, green and blue.
  PF_B8G8R8 | 24-bit pixel format, 8 bits for blue, green and red.
  PF_A8R8G8B8 | 32-bit pixel format, 8 bits for alpha, red, green and blue.
  PF_A8B8G8R8 | 32-bit pixel format, 8 bits for blue, green, red and alpha.
  PF_B8G8R8A8 | 32-bit pixel format, 8 bits for blue, green, red and alpha.
  PF_R8G8B8A8 | 32-bit pixel format, 8 bits for red, green, blue and alpha.
  PF_X8R8G8B8 | 32-bit pixel format, 8 bits for red, 8 bits for green, 8 bits for blue like PF_A8R8G8B8, but alpha will get discarded
  PF_X8B8G8R8 | 32-bit pixel format, 8 bits for blue, 8 bits for green, 8 bits for red like PF_A8B8G8R8, but alpha will get discarded
  PF_BYTE_RGB | 3 byte pixel format, 1 byte for red, 1 byte for green, 1 byte for blue
  PF_BYTE_BGR | 3 byte pixel format, 1 byte for blue, 1 byte for green, 1 byte for red
  PF_BYTE_BGRA | 4 byte pixel format, 1 byte for blue, 1 byte for green, 1 byte for red and one byte for alpha
  PF_BYTE_RGBA | 4 byte pixel format, 1 byte for red, 1 byte for green, 1 byte for blue, and one byte for alpha
  PF_A2R10G10B10 | 32-bit pixel format, 2 bits for alpha, 10 bits for red, green and blue.
  PF_A2B10G10R10 | 32-bit pixel format, 10 bits for blue, green and red, 2 bits for alpha.
  PF_DXT1 | DDS (DirectDraw Surface) DXT1 format.
  PF_DXT2 | DDS (DirectDraw Surface) DXT2 format.
  PF_DXT3 | DDS (DirectDraw Surface) DXT3 format.
  PF_DXT4 | DDS (DirectDraw Surface) DXT4 format.
  PF_DXT5 | DDS (DirectDraw Surface) DXT5 format.
  PF_FLOAT16_R |
  PF_FLOAT16_RGB |
  PF_FLOAT16_RGBA |
  PF_FLOAT32_R |
  PF_FLOAT32_RGB |
  PF_FLOAT32_RGBA |
  PF_FLOAT16_GR |
  PF_FLOAT32_GR |
  PF_DEPTH |
  PF_SHORT_RGBA |
  PF_SHORT_GR |
  PF_SHORT_RGB |
  PF_COUNT |

Definition at line 37 of file OgrePixelFormat.h.

enum Ogre::PixelFormatFlags

Flags defining some on/off properties of pixel formats.

Enumeration values:

  PFF_HASALPHA |
  PFF_COMPRESSED |
  PFF_FLOAT |
  PFF_DEPTH |
  PFF_NATIVEENDIAN |
  PFF_LUMINANCE |

Definition at line 147 of file OgrePixelFormat.h.

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat Apr 11 13:46:44 2009