Kanzi  3.9.9
Kanzi Engine Java API
GraphicsCompareFunction Enum Reference

Renderer stencil modes. More...

Inheritance diagram for GraphicsCompareFunction:
[legend]

Public Member Functions

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

Static Public Member Functions

static GraphicsCompareFunction swigToEnum (int swigValue)
 Converts an integer value to the matching enumeration constant. More...
 
static GraphicsCompareFunction toEnum (int value)
 Converts an integer value to the matching enumeration constant. More...
 

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 ( int  value)

Constructs a GraphicsCompareFunction of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

Constructs a copy of a GraphicsCompareFunction object.

Parameters
enum_GraphicsCompareFunction to be copy constructed.

Member Function Documentation

int getValue ( )

Returns the integer value of the enumeration constant.

Returns
Integer value.

Implements Enum.

static GraphicsCompareFunction swigToEnum ( int  swigValue)
static

Converts an integer value to the matching enumeration constant.

Used internally by SWIG generated code.

Parameters
swigValueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.
final int swigValue ( )

Returns the integer value of the enumeration constant.

Used internally by SWIG generated code.

Returns
Integer value.
static GraphicsCompareFunction toEnum ( int  value)
static

Converts an integer value to the matching enumeration constant.

Parameters
valueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.