Contents User Forum Source Index APIs by Task APIs by Level Data


G3D::TextureFormat Class Reference

Used to describe texture formats to the G3D::Texture class. More...

#include <TextureFormat.h>

List of all members.

Public Types

enum  { SAME_AS_SCREEN = 0 }
enum  BayerPattern {
  BAYER_PATTERN_NONE, BAYER_PATTERN_RGGB, BAYER_PATTERN_GRBG, BAYER_PATTERN_GBRG,
  BAYER_PATTERN_BGGR
}
enum  Code {
  CODE_L8, CODE_L16, CODE_L16F, CODE_L32F,
  CODE_A8, CODE_A16, CODE_A16F, CODE_A32F,
  CODE_LA4, CODE_LA8, CODE_LA16, CODE_LA16F,
  CODE_LA32F, CODE_RGB5, CODE_RGB5A1, CODE_RGB8,
  CODE_RGB10, CODE_RGB10A2, CODE_RGB16, CODE_RGB16F,
  CODE_RGB32F, CODE_ARGB8, CODE_BGR8, CODE_RGBA8,
  CODE_RGBA16, CODE_RGBA16F, CODE_RGBA32F, CODE_BAYER_RGGB8,
  CODE_BAYER_GRBG8, CODE_BAYER_GBRG8, CODE_BAYER_BGGR8, CODE_BAYER_RGGB32F,
  CODE_BAYER_GRBG32F, CODE_BAYER_GBRG32F, CODE_BAYER_BGGR32F, CODE_HSV8,
  CODE_HSV32F, CODE_YUV8, CODE_YUV32F, CODE_RGB_DXT1,
  CODE_RGBA_DXT1, CODE_RGBA_DXT3, CODE_RGBA_DXT5, CODE_DEPTH16,
  CODE_DEPTH24, CODE_DEPTH32, CODE_DEPTH32F, CODE_STENCIL1,
  CODE_STENCIL4, CODE_STENCIL8, CODE_STENCIL16, CODE_DEPTH24_STENCIL8
}
enum  ColorSpace { COLOR_SPACE_NONE, COLOR_SPACE_RGB, COLOR_SPACE_HSV, COLOR_SPACE_YUV }

Static Public Member Functions

static const TextureFormatA16 ()
static const TextureFormatA16F ()
static const TextureFormatA32F ()
static const TextureFormatA8 ()
static const TextureFormatAUTO ()
static const TextureFormatdepth (int depthBits=SAME_AS_SCREEN)
static const TextureFormatDEPTH16 ()
static const TextureFormatDEPTH24 ()
static const TextureFormatDEPTH24_STENCIL8 ()
static const TextureFormatDEPTH32 ()
static const TextureFormatDEPTH32F ()
static const TextureFormatfromCode (TextureFormat::Code code)
static const TextureFormatL16 ()
static const TextureFormatL16F ()
static const TextureFormatL32F ()
static const TextureFormatL8 ()
static const TextureFormatLA16 ()
static const TextureFormatLA16F ()
static const TextureFormatLA32F ()
static const TextureFormatLA4 ()
static const TextureFormatLA8 ()
static const TextureFormatRGB10 ()
static const TextureFormatRGB10A2 ()
static const TextureFormatRGB16 ()
static const TextureFormatRGB16F ()
static const TextureFormatRGB32F ()
static const TextureFormatRGB5 ()
static const TextureFormatRGB5A1 ()
static const TextureFormatRGB8 ()
static const TextureFormatRGB_DXT1 ()
static const TextureFormatRGBA16 ()
static const TextureFormatRGBA16F ()
static const TextureFormatRGBA32F ()
static const TextureFormatRGBA8 ()
static const TextureFormatRGBA_DXT1 ()
static const TextureFormatRGBA_DXT3 ()
static const TextureFormatRGBA_DXT5 ()
static const TextureFormatstencil (int bits=SAME_AS_SCREEN)
static const TextureFormatSTENCIL1 ()
static const TextureFormatSTENCIL16 ()
static const TextureFormatSTENCIL4 ()
static const TextureFormatSTENCIL8 ()

Public Attributes

int alphaBits
BayerPattern bayerPattern
int blueBits
Code code
ColorSpace colorSpace
bool compressed
int depthBits
bool floatingPoint
int greenBits
int hardwareBitsPerTexel
int luminanceBits
int numComponents
bool opaque
GLenum openGLBaseFormat
GLenum openGLDataFormat
GLenum openGLFormat
int packedBitsPerTexel
int redBits
int stencilBits


Detailed Description

Used to describe texture formats to the G3D::Texture class.

Don't construct these; use the static constants provided.


Member Enumeration Documentation

anonymous enum

Default argument for TextureFormat::depth.

Enumerator:
SAME_AS_SCREEN 

Enumerator:
BAYER_PATTERN_NONE 
BAYER_PATTERN_RGGB 
BAYER_PATTERN_GRBG 
BAYER_PATTERN_GBRG 
BAYER_PATTERN_BGGR 

Enumerator:
CODE_L8 
CODE_L16 
CODE_L16F 
CODE_L32F 
CODE_A8 
CODE_A16 
CODE_A16F 
CODE_A32F 
CODE_LA4 
CODE_LA8 
CODE_LA16 
CODE_LA16F 
CODE_LA32F 
CODE_RGB5 
CODE_RGB5A1 
CODE_RGB8 
CODE_RGB10 
CODE_RGB10A2 
CODE_RGB16 
CODE_RGB16F 
CODE_RGB32F 
CODE_ARGB8 
CODE_BGR8 
CODE_RGBA8 
CODE_RGBA16 
CODE_RGBA16F 
CODE_RGBA32F 
CODE_BAYER_RGGB8 
CODE_BAYER_GRBG8 
CODE_BAYER_GBRG8 
CODE_BAYER_BGGR8 
CODE_BAYER_RGGB32F 
CODE_BAYER_GRBG32F 
CODE_BAYER_GBRG32F 
CODE_BAYER_BGGR32F 
CODE_HSV8 
CODE_HSV32F 
CODE_YUV8 
CODE_YUV32F 
CODE_RGB_DXT1 
CODE_RGBA_DXT1 
CODE_RGBA_DXT3 
CODE_RGBA_DXT5 
CODE_DEPTH16 
CODE_DEPTH24 
CODE_DEPTH32 
CODE_DEPTH32F 
CODE_STENCIL1 
CODE_STENCIL4 
CODE_STENCIL8 
CODE_STENCIL16 
CODE_DEPTH24_STENCIL8 

Enumerator:
COLOR_SPACE_NONE 
COLOR_SPACE_RGB 
COLOR_SPACE_HSV 
COLOR_SPACE_YUV 


Member Function Documentation

static const TextureFormat* G3D::TextureFormat::A16 (  )  [static]

static const TextureFormat* G3D::TextureFormat::A16F (  )  [static]

static const TextureFormat* G3D::TextureFormat::A32F (  )  [static]

static const TextureFormat* G3D::TextureFormat::A8 (  )  [static]

static const TextureFormat* G3D::TextureFormat::AUTO (  )  [inline, static]

NULL pointer; indicates that the texture class should choose either RGBA8 or RGB8 depending on the presence of an alpha channel in the input.

static const TextureFormat* G3D::TextureFormat::depth ( int  depthBits = SAME_AS_SCREEN  )  [static]

Returns DEPTH16, DEPTH24, or DEPTH32 according to the bits specified.

static const TextureFormat* G3D::TextureFormat::DEPTH16 (  )  [static]

static const TextureFormat* G3D::TextureFormat::DEPTH24 (  )  [static]

static const TextureFormat* G3D::TextureFormat::DEPTH24_STENCIL8 (  )  [static]

static const TextureFormat* G3D::TextureFormat::DEPTH32 (  )  [static]

static const TextureFormat* G3D::TextureFormat::DEPTH32F (  )  [static]

static const TextureFormat* G3D::TextureFormat::fromCode ( TextureFormat::Code  code  )  [static]

Returns the matching TextureFormat* identified by the Code.

static const TextureFormat* G3D::TextureFormat::L16 (  )  [static]

static const TextureFormat* G3D::TextureFormat::L16F (  )  [static]

static const TextureFormat* G3D::TextureFormat::L32F (  )  [static]

static const TextureFormat* G3D::TextureFormat::L8 (  )  [static]

static const TextureFormat* G3D::TextureFormat::LA16 (  )  [static]

static const TextureFormat* G3D::TextureFormat::LA16F (  )  [static]

static const TextureFormat* G3D::TextureFormat::LA32F (  )  [static]

static const TextureFormat* G3D::TextureFormat::LA4 (  )  [static]

static const TextureFormat* G3D::TextureFormat::LA8 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGB10 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGB10A2 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGB16 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGB16F (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGB32F (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGB5 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGB5A1 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGB8 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGB_DXT1 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGBA16 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGBA16F (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGBA32F (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGBA8 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGBA_DXT1 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGBA_DXT3 (  )  [static]

static const TextureFormat* G3D::TextureFormat::RGBA_DXT5 (  )  [static]

static const TextureFormat* G3D::TextureFormat::stencil ( int  bits = SAME_AS_SCREEN  )  [static]

Returns STENCIL1, STENCIL4, STENCIL8 or STENCIL16 according to the bits specified.

static const TextureFormat* G3D::TextureFormat::STENCIL1 (  )  [static]

static const TextureFormat* G3D::TextureFormat::STENCIL16 (  )  [static]

static const TextureFormat* G3D::TextureFormat::STENCIL4 (  )  [static]

static const TextureFormat* G3D::TextureFormat::STENCIL8 (  )  [static]


Member Data Documentation

Number of bits per texel storage for alpha values; Zero for compressed textures.

Number of bits per texel storage for blue values; Zero for compressed textures.

Useful for serializing.

Number of depth bits (for depth textures; e.g.

shadow maps)

True if the bit depths specified are for float formats.

Number of bits per texel storage for green values; Zero for compressed textures.

This may be greater than the sum of the per-channel bits because graphics cards need to pad to the nearest 1, 2, or 4 bytes.

Number of channels (1 for a depth texture).

True if there is no alpha channel for this texture.

The GL base format equivalent to this one (e.g., GL_RGB, GL_ALPHA).

Zero if there is no equivalent.

The GL bytes format of the data buffer used with this texture format.

The GL format equivalent to this one.

Zero if there is no equivalent.

Sum of the per-channel bits, plus any additional bits required for alignment to the nearest byte boundary.

Number of bits per texel storage for red values; Zero for compressed textures.


The documentation for this class was generated from the following file:
Generated on Thu Aug 2 11:40:48 2007 for G3D by doxygen 1.5.2
Hosted by SourceForge.net Logo