G3D::ImageFormat Class Reference

Information about common image formats. More...

Classes
class	BayerAlgorithm
	For use with ImageFormat::convert. More...

Public Types
enum	BayerPattern {   BAYER_PATTERN_NONE,   BAYER_PATTERN_RGGB,   BAYER_PATTERN_GRBG,   BAYER_PATTERN_GBRG,   BAYER_PATTERN_BGGR }
enum	Code {   CODE_AUTO = -2,   CODE_NONE = -1,   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_R11G11B10F,   CODE_RGB9E5F,   CODE_RGB8I,   CODE_RGB8UI,   CODE_RGBA8I,   CODE_RGBA8UI,   CODE_RGB8_SNORM,   CODE_RGBA8_SNORM,   CODE_RGB16_SNORM,   CODE_RGBA16_SNORM,   CODE_ARGB8,   CODE_BGR8,   CODE_BGRA8,   CODE_R8,   CODE_R8I,   CODE_R8UI,   CODE_R16,   CODE_R16I,   CODE_R16UI,   CODE_RG8,   CODE_RG8I,   CODE_RG8UI,   CODE_R16F,   CODE_RG16F,   CODE_R32F,   CODE_RG32F,   CODE_RGBA8,   CODE_RGBA16,   CODE_RGBA16F,   CODE_RGBA32F,   CODE_RGB32I,   CODE_RGB32UI,   CODE_RGBA32I,   CODE_RGBA32UI,   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_YUV420_PLANAR,   CODE_YUV422,   CODE_YUV444,   CODE_RGB_DXT1,   CODE_RGBA_DXT1,   CODE_RGBA_DXT3,   CODE_RGBA_DXT5,   CODE_SRGB8,   CODE_SRGBA8,   CODE_SL8,   CODE_SLA8,   CODE_SRGB_DXT1,   CODE_SRGBA_DXT1,   CODE_SRGBA_DXT3,   CODE_SRGBA_DXT5,   CODE_DEPTH16,   CODE_DEPTH24,   CODE_DEPTH32,   CODE_DEPTH32F,   CODE_STENCIL1,   CODE_STENCIL4,   CODE_STENCIL8,   CODE_STENCIL16,   CODE_DEPTH24_STENCIL8,   CODE_NUM }
enum	ColorSpace {   COLOR_SPACE_NONE,   COLOR_SPACE_RGB,   COLOR_SPACE_HSV,   COLOR_SPACE_YUV,   COLOR_SPACE_SRGB }
enum	NumberFormat {   FLOATING_POINT_FORMAT,   INTEGER_FORMAT,   NORMALIZED_FIXED_POINT_FORMAT,   OTHER }

Public Member Functions
bool	canInterpretAs (const ImageFormat *otherFormat) const
	True if data in otherFormat is binary compatible.
Color4	channelMask () const
	Returns a Color4 that masks off unused components in the format, given in RGBA For example, the mask for R32F is (1,0,0,0), for A32F is (0,0,0,1), for RGB32F is (1,1,1,0).
bool	isIntegerFormat () const
const std::string &	name () const
	Human readable name of this format.
bool	representableAsColor1unorm8 () const
	Does this contain exactly one unorm8 component?
bool	representableAsColor2unorm8 () const
	Does this contain exactly two unorm8 components?
bool	representableAsColor3unorm8 () const
	Does this contain exactly three unorm8 components?
bool	representableAsColor4unorm8 () const
	Does this contain exactly four unorm8 components?
bool	sameComponents (const ImageFormat *other) const
	Returns true if these formats have the same components (possibly in different NumberFormats or sizes)

Static Public Member Functions
static const ImageFormat *	A16 ()
static const ImageFormat *	A16F ()
static const ImageFormat *	A32F ()
static const ImageFormat *	A8 ()
static const ImageFormat *	AUTO ()
	NULL pointer; indicates that the G3D::Texture class should choose either RGBA8 or RGB8 depending on the presence of an alpha channel in the input.
static const ImageFormat *	BGR8 ()
static const ImageFormat *	BGRA8 ()
static bool	conversionAvailable (const ImageFormat *srcFormat, int srcRowPadBits, const ImageFormat *dstFormat, int dstRowPadBits, bool invertY=false)
	Checks if a conversion between two formats is available.
static bool	convert (const Array< const void * > &srcBytes, int srcWidth, int srcHeight, const ImageFormat *srcFormat, int srcRowPadBits, const Array< void * > &dstBytes, const ImageFormat *dstFormat, int dstRowPadBits, bool invertY=false, BayerAlgorithm bayerAlg=BayerAlgorithm::MHC)
	Converts between arbitrary formats on the CPU.
static const ImageFormat *	depth (int depthBits=24)
	Returns DEPTH16, DEPTH24, or DEPTH32 according to the bits specified.
static const ImageFormat *	DEPTH16 ()
static const ImageFormat *	DEPTH24 ()
static const ImageFormat *	DEPTH24_STENCIL8 ()
static const ImageFormat *	DEPTH32 ()
static const ImageFormat *	DEPTH32F ()
static const ImageFormat *	fromCode (ImageFormat::Code code)
	Returns the matching ImageFormat* identified by the Code.
static const ImageFormat *	fromString (const std::string &s)
	Takes the same values that name() returns.
static const ImageFormat *	getFormatWithAlpha (const ImageFormat *otherFormat)
	Returns ImageFormat representing the same channels as otherFormat plus an alpha channel, all with at least the same precision as otherFormat, or returns NULL if an equivalent format is unavailable.
static const ImageFormat *	getSRGBFormat (const ImageFormat *otherFormat)
static const ImageFormat *	L16 ()
static const ImageFormat *	L16F ()
static const ImageFormat *	L32F ()
static const ImageFormat *	L8 ()
static const ImageFormat *	LA16 ()
static const ImageFormat *	LA16F ()
static const ImageFormat *	LA32F ()
static const ImageFormat *	LA4 ()
static const ImageFormat *	LA8 ()
static const ImageFormat *	R11G11B10F ()
static const ImageFormat *	R16 ()
static const ImageFormat *	R16F ()
static const ImageFormat *	R16I ()
static const ImageFormat *	R16UI ()
static const ImageFormat *	R32F ()
static const ImageFormat *	R8 ()
static const ImageFormat *	R8I ()
static const ImageFormat *	R8UI ()
static const ImageFormat *	RG16F ()
static const ImageFormat *	RG32F ()
static const ImageFormat *	RG8 ()
static const ImageFormat *	RG8I ()
static const ImageFormat *	RG8UI ()
static const ImageFormat *	RGB10 ()
static const ImageFormat *	RGB10A2 ()
static const ImageFormat *	RGB16 ()
static const ImageFormat *	RGB16_SNORM ()
static const ImageFormat *	RGB16F ()
static const ImageFormat *	RGB32F ()
static const ImageFormat *	RGB32I ()
static const ImageFormat *	RGB32UI ()
static const ImageFormat *	RGB5 ()
static const ImageFormat *	RGB5A1 ()
static const ImageFormat *	RGB8 ()
static const ImageFormat *	RGB8_SNORM ()
static const ImageFormat *	RGB8I ()
static const ImageFormat *	RGB8UI ()
static const ImageFormat *	RGB9E5F ()
static const ImageFormat *	RGB_DXT1 ()
static const ImageFormat *	RGBA16 ()
static const ImageFormat *	RGBA16_SNORM ()
static const ImageFormat *	RGBA16F ()
static const ImageFormat *	RGBA32F ()
static const ImageFormat *	RGBA32I ()
static const ImageFormat *	RGBA32UI ()
static const ImageFormat *	RGBA8 ()
static const ImageFormat *	RGBA8_SNORM ()
static const ImageFormat *	RGBA8I ()
static const ImageFormat *	RGBA8UI ()
static const ImageFormat *	RGBA_DXT1 ()
static const ImageFormat *	RGBA_DXT3 ()
static const ImageFormat *	RGBA_DXT5 ()
static const ImageFormat *	SL8 ()
static const ImageFormat *	SLA8 ()
static const ImageFormat *	SRGB8 ()
static const ImageFormat *	SRGB_DXT1 ()
static const ImageFormat *	SRGBA8 ()
static const ImageFormat *	SRGBA_DXT1 ()
static const ImageFormat *	SRGBA_DXT3 ()
static const ImageFormat *	SRGBA_DXT5 ()
static const ImageFormat *	stencil (int bits=8)
	Returns STENCIL1, STENCIL4, STENCIL8 or STENCIL16 according to the bits specified.
static const ImageFormat *	STENCIL1 ()
static const ImageFormat *	STENCIL16 ()
static const ImageFormat *	STENCIL4 ()
static const ImageFormat *	STENCIL8 ()
static const ImageFormat *	YUV420_PLANAR ()
static const ImageFormat *	YUV422 ()
static const ImageFormat *	YUV444 ()

Public Attributes
int	alphaBits
	Number of bits per pixel storage for alpha values; Zero for compressed textures and non-RGB.
BayerPattern	bayerPattern
	If this is a Bayer format, what is the pattern.
int	blueBits
	Number of bits per pixel storage for blue values; Zero for compressed textures and non-RGB.
Code	code
	Useful for serializing.
ColorSpace	colorSpace
bool	compressed
int	cpuBitsPerPixel
	Amount of CPU memory per pixel when packed into an array, discounting any end-of-row padding.
int	depthBits
	Number of depth bits (for depth textures; e.g.
bool	floatingPoint
	True if the bit depths specified are for float formats.
int	greenBits
	Number of bits per pixel storage for green values; Zero for compressed textures and non-RGB.
int	luminanceBits
NumberFormat	numberFormat
	Indicates whether this format treats numbers as integers, floating point, or normalized fixed point.
int	numComponents
	Number of channels (1 for a depth texture).
bool	opaque
	True if there is no alpha channel for this texture.
int	openGLBaseFormat
	The OpenGL base format equivalent to this one (e.g., GL_RGB, GL_ALPHA).
int	openGLBitsPerPixel
	Amount of GPU memory per pixel on most graphics cards, for formats supported by OpenGL.
int	openGLDataFormat
	The OpenGL bytes (type) format of the data buffer used with this texture format, e.g., GL_UNSIGNED_BYTE.
int	openGLFormat
	The OpenGL format equivalent to this one, e.g, GL_RGB8 Zero if there is no equivalent.
int	redBits
	Number of bits per pixel storage for red values; Zero for compressed textures and non-RGB.
int	stencilBits
	Number of bits per pixel.

Detailed Description

Information about common image formats.

Don't construct these; use the methods provided to access the const instances.

For most formats, the number indicates the number of bits per channel and a suffix of "F" indicates floating point (following OpenGL conventions). This does not hold for the YUV and DXT formats.

See Also

G3D::Image, G3D::Texture, G3D::ImageConvert

Member Enumeration Documentation

enum G3D::ImageFormat::BayerPattern

Enumerator:

BAYER_PATTERN_NONE
BAYER_PATTERN_RGGB
BAYER_PATTERN_GRBG
BAYER_PATTERN_GBRG
BAYER_PATTERN_BGGR

enum G3D::ImageFormat::Code

Enumerator:

CODE_AUTO
CODE_NONE
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_R11G11B10F
CODE_RGB9E5F
CODE_RGB8I
CODE_RGB8UI
CODE_RGBA8I
CODE_RGBA8UI
CODE_RGB8_SNORM
CODE_RGBA8_SNORM
CODE_RGB16_SNORM
CODE_RGBA16_SNORM
CODE_ARGB8
CODE_BGR8
CODE_BGRA8
CODE_R8
CODE_R8I
CODE_R8UI
CODE_R16
CODE_R16I
CODE_R16UI
CODE_RG8
CODE_RG8I
CODE_RG8UI
CODE_R16F
CODE_RG16F
CODE_R32F
CODE_RG32F
CODE_RGBA8
CODE_RGBA16
CODE_RGBA16F
CODE_RGBA32F
CODE_RGB32I
CODE_RGB32UI
CODE_RGBA32I
CODE_RGBA32UI
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_YUV420_PLANAR
CODE_YUV422
CODE_YUV444
CODE_RGB_DXT1
CODE_RGBA_DXT1
CODE_RGBA_DXT3
CODE_RGBA_DXT5
CODE_SRGB8
CODE_SRGBA8
CODE_SL8
CODE_SLA8
CODE_SRGB_DXT1
CODE_SRGBA_DXT1
CODE_SRGBA_DXT3
CODE_SRGBA_DXT5
CODE_DEPTH16
CODE_DEPTH24
CODE_DEPTH32
CODE_DEPTH32F
CODE_STENCIL1
CODE_STENCIL4
CODE_STENCIL8
CODE_STENCIL16
CODE_DEPTH24_STENCIL8
CODE_NUM

enum G3D::ImageFormat::ColorSpace

Enumerator:

COLOR_SPACE_NONE
COLOR_SPACE_RGB
COLOR_SPACE_HSV
COLOR_SPACE_YUV
COLOR_SPACE_SRGB

enum G3D::ImageFormat::NumberFormat

Enumerator:

FLOATING_POINT_FORMAT
INTEGER_FORMAT
NORMALIZED_FIXED_POINT_FORMAT
OTHER

Member Function Documentation

static const ImageFormat* G3D::ImageFormat::A16 ( )

static

static const ImageFormat* G3D::ImageFormat::A16F ( )

static

static const ImageFormat* G3D::ImageFormat::A32F ( )

static

static const ImageFormat* G3D::ImageFormat::A8 ( )

static

static const ImageFormat* G3D::ImageFormat::AUTO ( )

inlinestatic

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

static const ImageFormat* G3D::ImageFormat::BGR8 ( )

static

static const ImageFormat* G3D::ImageFormat::BGRA8 ( )

static

bool G3D::ImageFormat::canInterpretAs

(

const ImageFormat *

otherFormat

)

const

True if data in otherFormat is binary compatible.

Color4 G3D::ImageFormat::channelMask

(

)

const

Returns a Color4 that masks off unused components in the format, given in RGBA For example, the mask for R32F is (1,0,0,0), for A32F is (0,0,0,1), for RGB32F is (1,1,1,0).

(Note that luminance is interpreted as using only the R channel, even though RGB would make more sense to me...)

static bool G3D::ImageFormat::conversionAvailable ( const ImageFormat *  srcFormat, int  srcRowPadBits, const ImageFormat *  dstFormat, int  dstRowPadBits, bool  invertY = false  )

static

Checks if a conversion between two formats is available.

Deprecated:

See Also

G3D::ImageConvert

static bool G3D::ImageFormat::convert ( const Array< const void * > &  srcBytes, int  srcWidth, int  srcHeight, const ImageFormat *  srcFormat, int  srcRowPadBits, const Array< void * > &  dstBytes, const ImageFormat *  dstFormat, int  dstRowPadBits, bool  invertY = false, BayerAlgorithm  bayerAlg = BayerAlgorithm::MHC  )

static

Converts between arbitrary formats on the CPU.

Not all format conversions are supported or directly supported. Formats without direct conversions will attempt to convert through RGBA first.

A conversion routine might only support source or destination padding or y inversion or none. If support is needed and not available in any of the direct conversion routines, then no conversion is done.

YUV422 expects data in YUY2 format (Y, U, Y2, v). Most YUV formats require width and heights that are multiples of 2.

Returns true if a conversion was available, false if none occurred.

Deprecated:

See Also

G3D::ImageConvert

static const ImageFormat* G3D::ImageFormat::depth ( int  depthBits = 24 )

static

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

You can use "glGetInteger(GL_DEPTH_BITS)" to match the screen's format.

static const ImageFormat* G3D::ImageFormat::DEPTH16 ( )

static

Referenced by G3D::GApp::Settings::FilmSettings::FilmSettings().

static const ImageFormat* G3D::ImageFormat::DEPTH24 ( )

static

Referenced by G3D::GApp::Settings::FilmSettings::FilmSettings().

static const ImageFormat* G3D::ImageFormat::DEPTH24_STENCIL8 ( )

static

static const ImageFormat* G3D::ImageFormat::DEPTH32 ( )

static

Referenced by G3D::GApp::Settings::FilmSettings::FilmSettings().

static const ImageFormat* G3D::ImageFormat::DEPTH32F ( )

static

static const ImageFormat* G3D::ImageFormat::fromCode ( ImageFormat::Code  code )

static

Returns the matching ImageFormat* identified by the Code.

May return NULL if this format's code is reserved but not yet implemented by G3D.

static const ImageFormat* G3D::ImageFormat::fromString ( const std::string &  s )

static

Takes the same values that name() returns.

static const ImageFormat* G3D::ImageFormat::getFormatWithAlpha ( const ImageFormat *  otherFormat )

static

Returns ImageFormat representing the same channels as otherFormat plus an alpha channel, all with at least the same precision as otherFormat, or returns NULL if an equivalent format is unavailable.

Will return itself if already contains an alpha channel.

static const ImageFormat* G3D::ImageFormat::getSRGBFormat ( const ImageFormat *  otherFormat )

static

bool G3D::ImageFormat::isIntegerFormat ( ) const

inline

static const ImageFormat* G3D::ImageFormat::L16 ( )

static

static const ImageFormat* G3D::ImageFormat::L16F ( )

static

static const ImageFormat* G3D::ImageFormat::L32F ( )

static

static const ImageFormat* G3D::ImageFormat::L8 ( )

static

static const ImageFormat* G3D::ImageFormat::LA16 ( )

static

static const ImageFormat* G3D::ImageFormat::LA16F ( )

static

static const ImageFormat* G3D::ImageFormat::LA32F ( )

static

static const ImageFormat* G3D::ImageFormat::LA4 ( )

static

static const ImageFormat* G3D::ImageFormat::LA8 ( )

static

const std::string& G3D::ImageFormat::name

(

)

const

Human readable name of this format.

static const ImageFormat* G3D::ImageFormat::R11G11B10F ( )

static

Referenced by G3D::GApp::Settings::FilmSettings::FilmSettings().

static const ImageFormat* G3D::ImageFormat::R16 ( )

static

static const ImageFormat* G3D::ImageFormat::R16F ( )

static

static const ImageFormat* G3D::ImageFormat::R16I ( )

static

static const ImageFormat* G3D::ImageFormat::R16UI ( )

static

static const ImageFormat* G3D::ImageFormat::R32F ( )

static

static const ImageFormat* G3D::ImageFormat::R8 ( )

static

static const ImageFormat* G3D::ImageFormat::R8I ( )

static

static const ImageFormat* G3D::ImageFormat::R8UI ( )

static

bool G3D::ImageFormat::representableAsColor1unorm8

(

)

const

Does this contain exactly one unorm8 component?

bool G3D::ImageFormat::representableAsColor2unorm8

(

)

const

Does this contain exactly two unorm8 components?

bool G3D::ImageFormat::representableAsColor3unorm8

(

)

const

Does this contain exactly three unorm8 components?

bool G3D::ImageFormat::representableAsColor4unorm8

(

)

const

Does this contain exactly four unorm8 components?

static const ImageFormat* G3D::ImageFormat::RG16F ( )

static

static const ImageFormat* G3D::ImageFormat::RG32F ( )

static

static const ImageFormat* G3D::ImageFormat::RG8 ( )

static

static const ImageFormat* G3D::ImageFormat::RG8I ( )

static

static const ImageFormat* G3D::ImageFormat::RG8UI ( )

static

static const ImageFormat* G3D::ImageFormat::RGB10 ( )

static

static const ImageFormat* G3D::ImageFormat::RGB10A2 ( )

static

static const ImageFormat* G3D::ImageFormat::RGB16 ( )

static

static const ImageFormat* G3D::ImageFormat::RGB16_SNORM ( )

static

static const ImageFormat* G3D::ImageFormat::RGB16F ( )

static

Referenced by G3D::GApp::Settings::FilmSettings::FilmSettings().

static const ImageFormat* G3D::ImageFormat::RGB32F ( )

static

static const ImageFormat* G3D::ImageFormat::RGB32I ( )

static

static const ImageFormat* G3D::ImageFormat::RGB32UI ( )

static

static const ImageFormat* G3D::ImageFormat::RGB5 ( )

static

static const ImageFormat* G3D::ImageFormat::RGB5A1 ( )

static

static const ImageFormat* G3D::ImageFormat::RGB8 ( )

static

static const ImageFormat* G3D::ImageFormat::RGB8_SNORM ( )

static

static const ImageFormat* G3D::ImageFormat::RGB8I ( )

static

static const ImageFormat* G3D::ImageFormat::RGB8UI ( )

static

static const ImageFormat* G3D::ImageFormat::RGB9E5F ( )

static

static const ImageFormat* G3D::ImageFormat::RGB_DXT1 ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA16 ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA16_SNORM ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA16F ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA32F ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA32I ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA32UI ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA8 ( )

static

Referenced by G3D::GApp::Settings::FilmSettings::FilmSettings().

static const ImageFormat* G3D::ImageFormat::RGBA8_SNORM ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA8I ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA8UI ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA_DXT1 ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA_DXT3 ( )

static

static const ImageFormat* G3D::ImageFormat::RGBA_DXT5 ( )

static

bool G3D::ImageFormat::sameComponents

(

const ImageFormat *

other

)

const

Returns true if these formats have the same components (possibly in different NumberFormats or sizes)

static const ImageFormat* G3D::ImageFormat::SL8 ( )

static

static const ImageFormat* G3D::ImageFormat::SLA8 ( )

static

static const ImageFormat* G3D::ImageFormat::SRGB8 ( )

static

static const ImageFormat* G3D::ImageFormat::SRGB_DXT1 ( )

static

static const ImageFormat* G3D::ImageFormat::SRGBA8 ( )

static

static const ImageFormat* G3D::ImageFormat::SRGBA_DXT1 ( )

static

static const ImageFormat* G3D::ImageFormat::SRGBA_DXT3 ( )

static

static const ImageFormat* G3D::ImageFormat::SRGBA_DXT5 ( )

static

static const ImageFormat* G3D::ImageFormat::stencil ( int  bits = 8 )

static

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

You can use "glGetInteger(GL_STENCIL_BITS)" to match the screen's format.

static const ImageFormat* G3D::ImageFormat::STENCIL1 ( )

static

static const ImageFormat* G3D::ImageFormat::STENCIL16 ( )

static

static const ImageFormat* G3D::ImageFormat::STENCIL4 ( )

static

static const ImageFormat* G3D::ImageFormat::STENCIL8 ( )

static

static const ImageFormat* G3D::ImageFormat::YUV420_PLANAR ( )

static

static const ImageFormat* G3D::ImageFormat::YUV422 ( )

static

static const ImageFormat* G3D::ImageFormat::YUV444 ( )

static

Member Data Documentation

int G3D::ImageFormat::alphaBits

Number of bits per pixel storage for alpha values; Zero for compressed textures and non-RGB.

BayerPattern G3D::ImageFormat::bayerPattern

If this is a Bayer format, what is the pattern.

int G3D::ImageFormat::blueBits

Number of bits per pixel storage for blue values; Zero for compressed textures and non-RGB.

Code G3D::ImageFormat::code

Useful for serializing.

ColorSpace G3D::ImageFormat::colorSpace

bool G3D::ImageFormat::compressed

int G3D::ImageFormat::cpuBitsPerPixel

Amount of CPU memory per pixel when packed into an array, discounting any end-of-row padding.

int G3D::ImageFormat::depthBits

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

shadow maps)

bool G3D::ImageFormat::floatingPoint

True if the bit depths specified are for float formats.

TODO: Remove, replace with function keying off numberFormat

int G3D::ImageFormat::greenBits

Number of bits per pixel storage for green values; Zero for compressed textures and non-RGB.

int G3D::ImageFormat::luminanceBits

NumberFormat G3D::ImageFormat::numberFormat

Indicates whether this format treats numbers as integers, floating point, or normalized fixed point.

Referenced by isIntegerFormat().

int G3D::ImageFormat::numComponents

Number of channels (1 for a depth texture).

bool G3D::ImageFormat::opaque

True if there is no alpha channel for this texture.

int G3D::ImageFormat::openGLBaseFormat

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

Zero if there is no equivalent.

int G3D::ImageFormat::openGLBitsPerPixel

Amount of GPU memory per pixel on most graphics cards, for formats supported by OpenGL.

This is only an estimate–the actual amount of memory may be different on your actual card.

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.

int G3D::ImageFormat::openGLDataFormat

The OpenGL bytes (type) format of the data buffer used with this texture format, e.g., GL_UNSIGNED_BYTE.

int G3D::ImageFormat::openGLFormat

The OpenGL format equivalent to this one, e.g, GL_RGB8 Zero if there is no equivalent.

This is actually a GLenum

int G3D::ImageFormat::redBits

Number of bits per pixel storage for red values; Zero for compressed textures and non-RGB.

int G3D::ImageFormat::stencilBits

Number of bits per pixel.