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


G3D::WrapMode Class Reference

Describes the behavior of G3D::Texture, G3D::Map2D, G3D::Image3, etc. More...

#include <WrapMode.h>

List of all members.

Public Types

enum  Value {
  CLAMP, TILE, ZERO, IGNORE,
  ERROR
}

Public Member Functions

 G3D_DECLARE_ENUM_CLASS_METHODS (WrapMode)


Detailed Description

Describes the behavior of G3D::Texture, G3D::Map2D, G3D::Image3, etc.

when accessing an out-of-bounds pixel. Not all classes support all modes.

Refer to these as scoped enums, e.g., WrapMode m = WrapMode::CLAMP;.

WrapMode::IGNORE silently discards attempts to write to out of bounds locations and returns an undefined value for reading from out of bounds locations.

WrapMode::ERROR generates an error when the pixel indices are out of bounds

WrapMode::CLAMP makes out of bounds pixels equal to the last in-range pixel along that dimension.

WrapMode::TILE computes out of bounds pixels modulo the dimension

WrapMode::ZERO treats out of bounds values as the zero value, which varies in definition according to the class used. For example, with a G3D::Texture, ZERO = Color4(0,0,0,0).

Uses the "Intelligent Enum" design pattern http://www.codeguru.com/cpp/cpp/cpp_mfc/article.php/c4001/


Member Enumeration Documentation

Don't use this enum; use WrapMode instances instead.

Enumerator:
CLAMP 
TILE 
ZERO 
IGNORE 
ERROR 


Member Function Documentation

G3D::WrapMode::G3D_DECLARE_ENUM_CLASS_METHODS ( WrapMode   ) 


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