Kanzi 3.9.10
GraphicsStencilOperation Enum Reference

Renderer stencil operations. More...

Inheritance diagram for GraphicsStencilOperation:
[legend]

Public Member Functions

 GraphicsStencilOperation (GraphicsStencilOperation enum_)
 Constructs a copy of a GraphicsStencilOperation object.
 
 GraphicsStencilOperation (int value)
 Constructs a GraphicsStencilOperation 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 GraphicsStencilOperation swigToEnum (int swigValue)
 Converts an integer value to the matching enumeration constant.
 
static GraphicsStencilOperation toEnum (int value)
 Converts an integer value to the matching enumeration constant.
 

Public Attributes

 GraphicsStencilOperationDecrement =(5)
 Decreases current stencil buffer value.
 
 GraphicsStencilOperationDecrementWrap =(6)
 Decreases stencil buffer value, wraps to maximum - 1 when below 0.
 
 GraphicsStencilOperationIncrement =(3)
 Increases current stencil buffer value.
 
 GraphicsStencilOperationIncrementWrap =(4)
 Increases stencil buffer value, wraps to zero when reaching maximum.
 
 GraphicsStencilOperationInvert =(7)
 Inverts current stencil buffer value.
 
 GraphicsStencilOperationKeep =(0)
 Keeps the current stencil buffer value.
 
 GraphicsStencilOperationReplace =(2)
 Set stencil buffer value to reference value, specified by StencilFunction.
 
 GraphicsStencilOperationZero =(1)
 Sets stencil buffer value to zero.
 

Detailed Description

Renderer stencil operations.

Constructor & Destructor Documentation

◆ GraphicsStencilOperation() [1/2]

Constructs a GraphicsStencilOperation of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ GraphicsStencilOperation() [2/2]

Constructs a copy of a GraphicsStencilOperation object.

Parameters
enum_GraphicsStencilOperation 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 GraphicsStencilOperation 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.

◆ swigValue()

final int swigValue ( )

Returns the integer value of the enumeration constant.

Used internally by SWIG generated code.

Returns
Integer value.

◆ toEnum()

static GraphicsStencilOperation 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.