G3D::WrapMode Class Reference

#include <WrapMode.h>

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

Public Member Functions
	G3D_DECLARE_ENUM_CLASS_METHODS (WrapMode)

Static Public Member Functions
static const char *	toString (int i, Value &v)

Public Attributes
enum G3D::WrapMode::Value	value

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

enum G3D::WrapMode::Value

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

Enumerator
CLAMP
TILE
ZERO
IGNORE
ERROR

 {
 CLAMP, 
 TILE, 
 ZERO,
 IGNORE, 
 ERROR
 } value;

Member Function Documentation

G3D::WrapMode::G3D_DECLARE_ENUM_CLASS_METHODS

(

WrapMode

)

static const char* G3D::WrapMode::toString ( int  i, Value &  v  )

inlinestatic

 {
 static const char* str[] = {"CLAMP", "TILE", "ZERO", "IGNORE", "ERROR", NULL}; 
 static const Value val[] = {CLAMP, TILE, ZERO, IGNORE, ERROR};
 const char* s = str[i];
 if (s) {
 v = val[i];
 }
 return s;
 }

Member Data Documentation

enum G3D::WrapMode::Value G3D::WrapMode::value

---

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

• dep/g3dlite/include/G3D/WrapMode.h