om::graphics::textures::TextureType Class Reference

A class that specifies the high-level type of a texture. More...

#include <omGraphicsTextureType.h>

Public Member Functions
	TextureType ()
	Create an invalid texture type with no dimensions. More...
	TextureType (Size newNumDimensions)
	Create a texture type with the specified number of dimensions that is not a shadow or cube map. More...
	TextureType (Size newNumDimensions, Bool newIsDepthMap, Bool newIsACubeMap)
	Create a texture type with the specified number of dimensions and attributes. More...
Size	getDimensionCount () const
	Get the number of dimensions in this texture type (usually 1, 2, or 3). More...
Bool	isDepth () const
	Return whether or not this texture type represents a depth (e.g. shadow) map. More...
Bool	isCube () const
	Return whether or not this texture type represents a cube map. More...
Bool	operator== (const TextureType &other) const
	Return whether or not this texture type is exactly equal to another. More...
Bool	operator!= (const TextureType &other) const
	Return whether or not this texture type is not equal to another. More...

Static Public Attributes
static const TextureType	COLOR_1D
	A texture type representing a 1D color map. More...
static const TextureType	COLOR_2D
	A texture type representing a 2D color map. More...
static const TextureType	COLOR_3D
	A texture type representing a 3D color map. More...
static const TextureType	COLOR_CUBE
	A texture type representing a color cube map. More...
static const TextureType	DEPTH_2D
	A texture type representing a 2D depth (shadow) map. More...
static const TextureType	DEPTH_CUBE
	A texture type representing a cube depth (shadow) map. More...

Detailed Description

A class that specifies the high-level type of a texture.

A texture type consists of the dimensionality of the texture, whether or not it is a depth map (i.e. shadow map), and whether or not it is a cube map.

Constructor & Destructor Documentation

om::graphics::textures::TextureType::TextureType ( )

inline

Create an invalid texture type with no dimensions.

om::graphics::textures::TextureType::TextureType ( Size  newNumDimensions )

inline

Create a texture type with the specified number of dimensions that is not a shadow or cube map.

om::graphics::textures::TextureType::TextureType ( Size  newNumDimensions, Bool  newIsDepthMap, Bool  newIsACubeMap  )

inline

Create a texture type with the specified number of dimensions and attributes.

Member Function Documentation

Size om::graphics::textures::TextureType::getDimensionCount ( ) const

inline

Get the number of dimensions in this texture type (usually 1, 2, or 3).

Bool om::graphics::textures::TextureType::isDepth ( ) const

inline

Return whether or not this texture type represents a depth (e.g. shadow) map.

Bool om::graphics::textures::TextureType::isCube ( ) const

inline

Return whether or not this texture type represents a cube map.

Bool om::graphics::textures::TextureType::operator== ( const TextureType &  other ) const

inline

Return whether or not this texture type is exactly equal to another.

Bool om::graphics::textures::TextureType::operator!= ( const TextureType &  other ) const

inline

Return whether or not this texture type is not equal to another.

Member Data Documentation

const TextureType om::graphics::textures::TextureType::COLOR_1D

static

A texture type representing a 1D color map.

const TextureType om::graphics::textures::TextureType::COLOR_2D

static

A texture type representing a 2D color map.

const TextureType om::graphics::textures::TextureType::COLOR_3D

static

A texture type representing a 3D color map.

const TextureType om::graphics::textures::TextureType::COLOR_CUBE

static

A texture type representing a color cube map.

const TextureType om::graphics::textures::TextureType::DEPTH_2D

static

A texture type representing a 2D depth (shadow) map.

const TextureType om::graphics::textures::TextureType::DEPTH_CUBE

static

A texture type representing a cube depth (shadow) map.

---

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

• omGraphicsTextureType.h