GraphicsCompareFunction Enum Reference

Renderer stencil modes. More...

Inheritance diagram for GraphicsCompareFunction:

Public Member Functions
	GraphicsCompareFunction (GraphicsCompareFunction enum_)
	Constructs a copy of a GraphicsCompareFunction object.
	GraphicsCompareFunction (int value)
	Constructs a GraphicsCompareFunction of an integer value.
int	getValue ()
	Returns the integer value of the enumeration constant.
final int	swigValue ()
	Returns the integer value of the enumeration constant.

Static Public Member Functions
static GraphicsCompareFunction	swigToEnum (int swigValue)
	Converts an integer value to the matching enumeration constant.
static GraphicsCompareFunction	toEnum (int value)
	Converts an integer value to the matching enumeration constant.

Public Attributes
	GraphicsCompareFunctionAlways =(1)
	Always passes.
	GraphicsCompareFunctionDisabled =(8)
	Compare/test is disabled.
	GraphicsCompareFunctionEqual =(6)
	(Ref & mask) = (stencil & mask).
	GraphicsCompareFunctionGreater =(4)
	(Ref & mask) > (stencil & mask).
	GraphicsCompareFunctionGreaterOrEqual =(5)
	(Ref & mask) >= (stencil & mask).
	GraphicsCompareFunctionLess =(2)
	(Ref & mask) < (stencil & mask).
	GraphicsCompareFunctionLessOrEqual =(3)
	(Ref & mask) <= (stencil & mask).
	GraphicsCompareFunctionNever =(0)
	Always fails.
	GraphicsCompareFunctionNotEqual =(7)
	(Ref & mask) != (stencil & mask).

Detailed Description

Renderer stencil modes.

Constructor & Destructor Documentation

GraphicsCompareFunction() [1/2]

GraphicsCompareFunction

(

int

value

)

Constructs a GraphicsCompareFunction of an integer value.

Parameters

value

Integer value to convert to enumeration constant.

GraphicsCompareFunction() [2/2]

GraphicsCompareFunction

(

GraphicsCompareFunction

enum_

)

Constructs a copy of a GraphicsCompareFunction object.

Parameters

enum_

GraphicsCompareFunction to be copy constructed.

Member Function Documentation

getValue()

int getValue

(

)

Returns the integer value of the enumeration constant.

Returns

Integer value.

Implements Enum.

swigToEnum()

static GraphicsCompareFunction swigToEnum ( int swigValue )

static

Converts an integer value to the matching enumeration constant.

Used internally by SWIG generated code.

Parameters

swigValue

Integer value to convert to enumeration constant.

Returns

Enumeration constant matching the integer value.

swigValue()

final int swigValue

(

)

Returns the integer value of the enumeration constant.

Used internally by SWIG generated code.

Returns

Integer value.

toEnum()

static GraphicsCompareFunction toEnum ( int value )

static

Converts an integer value to the matching enumeration constant.

Parameters

value

Integer value to convert to enumeration constant.

Returns

Enumeration constant matching the integer value.