Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | Related Pages

ZBufferMode Class Reference

#include <material.h>

List of all members.


Detailed Description

Data describing a Z buffer mode.

Author:
Mattias Jansson (mattias@realityrift.com)


Public Types

enum  ZTESTFUNC {
  LESS = 0x00000000, LEQUAL = 0x00000001, EQUAL = 0x00000002, GEQUAL = 0x00000003,
  GREATER = 0x00000004, ALWAYSPASS = 0x00000005, FUNCBITS = 0x00000007
}
 Z buffer test functions. More...

enum  ZWRITEMODE { ENABLED = 0x00000000, DISABLED = 0x00000010, MODEBITS = 0x00000010 }
 Z buffer write modes. More...

enum  ZBUFFERMODE {
  NORMAL = ( LEQUAL | ENABLED ), LESSWRITE = ( LESS | ENABLED ), LEQUALWRITE = ( LEQUAL | ENABLED ), EQUALWRITE = ( EQUAL | ENABLED ),
  GEQUALWRITE = ( GEQUAL | ENABLED ), GREATERWRITE = ( GREATER | ENABLED ), ALWAYSWRITE = ( ALWAYSPASS | ENABLED ), LESSNOWRITE = ( LESS | DISABLED ),
  LEQUALNOWRITE = ( LEQUAL | DISABLED ), EQUALNOWRITE = ( EQUAL | DISABLED ), GEQUALNOWRITE = ( GEQUAL | DISABLED ), GREATERNOWRITE = ( GREATER | DISABLED ),
  ALWAYSNOWRITE = ( ALWAYSPASS | DISABLED ), BITS = ( FUNCBITS | MODEBITS )
}
 Combined Z buffer modes (test and write). More...


Public Member Functions

 ZBufferMode ()
 ZBufferMode (const ZBufferMode &rkMode)
void Set (unsigned int uiZTest, unsigned int uiZWrite)
void Set (unsigned int uiMode)
int Get () const
ZBufferModeoperator= (const ZBufferMode &rkMode)

Static Public Member Functions

std::string GetWriteModeAsString (unsigned int uiMode)
std::string GetTestFuncAsString (unsigned int uiMode)
unsigned int GetWriteModeFromString (const std::string &rstrMode)
unsigned int GetTestFuncFromString (const std::string &rstrFunc)

Protected Attributes

unsigned int m_uiMode


Member Enumeration Documentation

enum ZTESTFUNC
 

Z buffer test functions.

Enumeration values:
LESS  Pass if z value less than buffer
LEQUAL  Pass if z value less than or equal than buffer
EQUAL  Pass if z value equal to buffer
GEQUAL  Pass if z value greater than or equal tp buffer
GREATER  Pass if z value greater than buffer
ALWAYSPASS  Always pass (no test)
FUNCBITS  Bitmask for bits used by Z buffer test identifiers

enum ZWRITEMODE
 

Z buffer write modes.

Enumeration values:
ENABLED  Update Z buffer
DISABLED  Do not update > buffer
MODEBITS  Bitmaks for bits used by Z buffer write mode identifiers

enum ZBUFFERMODE
 

Combined Z buffer modes (test and write).

Enumeration values:
NORMAL  Pass if z value less than or equal than buffer, update buffer
LESSWRITE  Pass if z value less than buffer, update buffer
LEQUALWRITE  Pass if z value less than or equal to buffer, update buffer
EQUALWRITE  Pass if z value equal to buffer, update buffer
GEQUALWRITE  Pass if z value greater than or equal to buffer, update buffer
GREATERWRITE  Pass if z value greater than buffer, update buffer
ALWAYSWRITE  Always pass (no test), update buffer
LESSNOWRITE  Pass if z value less than buffer, do not update buffer
LEQUALNOWRITE  Pass if z value less than or equal to buffer, do not update buffer
EQUALNOWRITE  Pass if z value equal to buffer, do not update buffer
GEQUALNOWRITE  Pass if z value greater than or equal to buffer, do not update buffer
GREATERNOWRITE  Pass if z value greater than buffer, do not update buffer
ALWAYSNOWRITE  Always pass (no test), do not update buffer
BITS  Bitmask for bits used by combined Z buffer test/write mode identifiers


Constructor & Destructor Documentation

ZBufferMode  )  [inline]
 

ZBufferMode const ZBufferMode rkMode  )  [inline]
 

Parameters:
rkMode Reference mode


Member Function Documentation

void Set unsigned int  uiZTest,
unsigned int  uiZWrite
[inline]
 

Set Z buffer mode

Parameters:
uiZTest Test func
uiZWrite Write mode

void Set unsigned int  uiMode  )  [inline]
 

Set from predefined constant

Parameters:
uiMode Z buffer mode

int Get  )  const [inline]
 

Access mode as integer

Returns:
Z buffer mode

std::string GetWriteModeAsString unsigned int  uiMode  )  [static]
 

Get write mode as string

Parameters:
uiMode Mode identifier
Returns:
Write mode

std::string GetTestFuncAsString unsigned int  uiMode  )  [static]
 

Get test mode as string

Parameters:
uiMode Mode identifier
Returns:
Test mode

unsigned int GetWriteModeFromString const std::string &  rstrMode  )  [static]
 

Get write mode from string

Parameters:
rstrMode Mode name string
Returns:
Write mode

unsigned int GetTestFuncFromString const std::string &  rstrFunc  )  [static]
 

Get test func from string

Parameters:
rstrFunc Func name string
Returns:
Test mode

ZBufferMode& operator= const ZBufferMode rkMode  )  [inline]
 

Copy

Parameters:
rkMode Values to copy
Returns:
ref to resulting Z buffer mode (this)


Member Data Documentation

unsigned int m_uiMode [protected]
 

Z buffer mode


The documentation for this class was generated from the following file:
Generated on Wed Jan 21 14:21:12 2004 for NeoEngine by doxygen 1.3.5