OGRE  1.8
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Image
+ Collaboration diagram for Image:

Classes

class  Ogre::DDSCodec
 Codec specialized in loading DDS (Direct Draw Surface) images. More...
 
class  Ogre::FreeImageCodec
 Codec specialized in images loaded using FreeImage. More...
 
class  Ogre::Image
 Class representing an image file. More...
 
class  Ogre::ImageCodec
 Codec specialized in images. More...
 
struct  Ogre::LinearResampler
 
struct  Ogre::LinearResampler_Byte< channels >
 
struct  Ogre::LinearResampler_Float32
 
struct  Ogre::NearestResampler< elemsize >
 
class  Ogre::PixelBox
 A primitive describing a volume (3D), image (2D) or line (1D) of pixels in memory. More...
 
class  Ogre::PixelUtil
 Some utility functions for packing and unpacking pixel data. More...
 
class  Ogre::PVRTCCodec
 Codec specialized in loading PVRTC (PowerVR) images. More...
 

Typedefs

typedef vector< const Image * >
::type 
Ogre::ConstImagePtrList
 
typedef vector< Image * >::type Ogre::ImagePtrList
 
typedef vector< PixelFormat >::type Ogre::PixelFormatList
 

Enumerations

enum  Ogre::ImageFlags { Ogre::IF_COMPRESSED = 0x00000001, Ogre::IF_CUBEMAP = 0x00000002, Ogre::IF_3D_TEXTURE = 0x00000004 }
 
enum  Ogre::PixelComponentType {
  Ogre::PCT_BYTE = 0, Ogre::PCT_SHORT = 1, Ogre::PCT_FLOAT16 = 2, Ogre::PCT_FLOAT32 = 3,
  Ogre::PCT_COUNT = 4
}
 Pixel component format. More...
 
enum  Ogre::PixelFormat {
  Ogre::PF_UNKNOWN = 0, Ogre::PF_L8 = 1, Ogre::PF_BYTE_L = PF_L8, Ogre::PF_L16 = 2,
  Ogre::PF_SHORT_L = PF_L16, Ogre::PF_A8 = 3, Ogre::PF_BYTE_A = PF_A8, Ogre::PF_A4L4 = 4,
  Ogre::PF_BYTE_LA = 5, Ogre::PF_R5G6B5 = 6, Ogre::PF_B5G6R5 = 7, Ogre::PF_R3G3B2 = 31,
  Ogre::PF_A4R4G4B4 = 8, Ogre::PF_A1R5G5B5 = 9, Ogre::PF_R8G8B8 = 10, Ogre::PF_B8G8R8 = 11,
  Ogre::PF_A8R8G8B8 = 12, Ogre::PF_A8B8G8R8 = 13, Ogre::PF_B8G8R8A8 = 14, Ogre::PF_R8G8B8A8 = 28,
  Ogre::PF_X8R8G8B8 = 26, Ogre::PF_X8B8G8R8 = 27, Ogre::PF_BYTE_RGB = PF_B8G8R8, Ogre::PF_BYTE_BGR = PF_R8G8B8,
  Ogre::PF_BYTE_BGRA = PF_A8R8G8B8, Ogre::PF_BYTE_RGBA = PF_A8B8G8R8, Ogre::PF_A2R10G10B10 = 15, Ogre::PF_A2B10G10R10 = 16,
  Ogre::PF_DXT1 = 17, Ogre::PF_DXT2 = 18, Ogre::PF_DXT3 = 19, Ogre::PF_DXT4 = 20,
  Ogre::PF_DXT5 = 21, Ogre::PF_FLOAT16_R = 32, Ogre::PF_FLOAT16_RGB = 22, Ogre::PF_FLOAT16_RGBA = 23,
  Ogre::PF_FLOAT32_R = 33, Ogre::PF_FLOAT32_RGB = 24, Ogre::PF_FLOAT32_RGBA = 25, Ogre::PF_FLOAT16_GR = 35,
  Ogre::PF_FLOAT32_GR = 36, Ogre::PF_DEPTH = 29, Ogre::PF_SHORT_RGBA = 30, Ogre::PF_SHORT_GR = 34,
  Ogre::PF_SHORT_RGB = 37, Ogre::PF_PVRTC_RGB2 = 38, Ogre::PF_PVRTC_RGBA2 = 39, Ogre::PF_PVRTC_RGB4 = 40,
  Ogre::PF_PVRTC_RGBA4 = 41, Ogre::PF_R8 = 42, Ogre::PF_RG8 = 43, Ogre::PF_COUNT = 44
}
 The pixel format used for images, textures, and render surfaces. More...
 
enum  Ogre::PixelFormatFlags {
  Ogre::PFF_HASALPHA = 0x00000001, Ogre::PFF_COMPRESSED = 0x00000002, Ogre::PFF_FLOAT = 0x00000004, Ogre::PFF_DEPTH = 0x00000008,
  Ogre::PFF_NATIVEENDIAN = 0x00000010, Ogre::PFF_LUMINANCE = 0x00000020
}
 Flags defining some on/off properties of pixel formats. More...
 

Detailed Description

Typedef Documentation

typedef vector<const Image*>::type Ogre::ConstImagePtrList

Definition at line 503 of file OgreImage.h.

typedef vector<Image*>::type Ogre::ImagePtrList

Definition at line 502 of file OgreImage.h.

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

Definition at line 160 of file OgrePixelFormat.h.

Enumeration Type Documentation

Enumerator
IF_COMPRESSED 
IF_CUBEMAP 
IF_3D_TEXTURE 

Definition at line 44 of file OgreImage.h.

Pixel component format.

Enumerator
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 184 of file OgrePixelFormat.h.

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

Enumerator
PF_UNKNOWN 

Unknown pixel format.

PF_L8 

8-bit pixel format, all bits luminance.

PF_BYTE_L 
PF_L16 

16-bit pixel format, all bits luminance.

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_PVRTC_RGB2 

PVRTC (PowerVR) RGB 2 bpp.

PF_PVRTC_RGBA2 

PVRTC (PowerVR) RGBA 2 bpp.

PF_PVRTC_RGB4 

PVRTC (PowerVR) RGB 4 bpp.

PF_PVRTC_RGBA4 

PVRTC (PowerVR) RGBA 4 bpp.

PF_R8 

8-bit pixel format, all bits red.

PF_RG8 

16-bit pixel format, 8 bits red, 8 bits green.

PF_COUNT 

Definition at line 43 of file OgrePixelFormat.h.

Flags defining some on/off properties of pixel formats.

Enumerator
PFF_HASALPHA 
PFF_COMPRESSED 
PFF_FLOAT 
PFF_DEPTH 
PFF_NATIVEENDIAN 
PFF_LUMINANCE 

Definition at line 165 of file OgrePixelFormat.h.