Om  1.0.0
A universal framework for multimedia simulation
Public Types | Public Member Functions | List of all members
om::graphics::textures::TextureWrapType Class Reference

A class that specifies how a texture should repeat for texture coordinates outside the range (0,1). More...

#include <omGraphicsTextureWrapType.h>

Public Types

enum  Enum { CLAMP, REPEAT, MIRRORED_REPEAT, UNDEFINED }
 An enum type which represents the different texture wrap types. More...
 

Public Member Functions

 TextureWrapType (Enum newType)
 Create a new texture wrap type with the specified wrap type enum value. More...
 
 operator Enum () const
 Convert this texture wrap type to an enum value. More...
 
String toString () const
 Return a string representation of the texture wrap type. More...
 
 operator String () const
 Convert this texture wrap type into a string representation. More...
 

Detailed Description

A class that specifies how a texture should repeat for texture coordinates outside the range (0,1).

Textures can repeat, be clamped, or repeat in a mirrored fashion. Different wrap types are suitable for tiling textures or for textures that should not tile.

Member Enumeration Documentation

An enum type which represents the different texture wrap types.

Enumerator
CLAMP 

The texture uses the outer pixel edge for all texels outside the range (0,1).

REPEAT 

The texture repeats normally. Coordinates outside (0,1) are mod-ed to be in that range.

MIRRORED_REPEAT 

The texture repeats in a mirrored fashion, producing seamless tiling for all images.

UNDEFINED 

An undefined texture wrap type.

Constructor & Destructor Documentation

om::graphics::textures::TextureWrapType::TextureWrapType ( Enum  newType)
inline

Create a new texture wrap type with the specified wrap type enum value.

Member Function Documentation

om::graphics::textures::TextureWrapType::operator Enum ( ) const
inline

Convert this texture wrap type to an enum value.

String om::graphics::textures::TextureWrapType::toString ( ) const

Return a string representation of the texture wrap type.

om::graphics::textures::TextureWrapType::operator String ( ) const
inline

Convert this texture wrap type into a string representation.


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