Kanzi 3.9.10
EffectStack2DEnums.StackingMode Enum Reference

Defines the stacking modes you can apply to child effects. More...

Inheritance diagram for EffectStack2DEnums.StackingMode:
[legend]

Public Member Functions

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

Public Attributes

 Chained =(0)
 Child effect uses as its input the result of a previous effect, the combined result of a sequence of layered effects, or the node content.
 
 Layered =(1)
 Child effect uses as its input either the result of a previous chained effect or the node content.
 

Detailed Description

Defines the stacking modes you can apply to child effects.

Constructor & Destructor Documentation

◆ StackingMode() [1/2]

StackingMode ( int value)

Constructs a StackingMode of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ StackingMode() [2/2]

Constructs a copy of a StackingMode object.

Parameters
enum_StackingMode 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 StackingMode 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 StackingMode 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.

Member Data Documentation

◆ Chained

Chained =(0)

Child effect uses as its input the result of a previous effect, the combined result of a sequence of layered effects, or the node content.

The next effect uses as its input the result of this effect.

◆ Layered

Layered =(1)

Child effect uses as its input either the result of a previous chained effect or the node content.

A sequence of layered effects are combined on top of each other in layers.