Kanzi 3.9.10
MaskEffect2DEnums.Stretch Enum Reference

Defines the stretch modes. More...

Inheritance diagram for MaskEffect2DEnums.Stretch:
[legend]

Public Member Functions

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

Public Attributes

 Count =(5)
 The number of stretch modes.
 
 Fill =(1)
 Stretches the mask to fill the node.
 
 None =(0)
 Does not stretch the mask.
 
 Repeat =(4)
 Does not stretch the mask, and allows the mask to repeat outside of its area based on the mask texture wrap mode.
 
 Uniform =(2)
 Stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires smaller scale.
 
 UniformToFill =(3)
 Stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires larger scale.
 

Detailed Description

Defines the stretch modes.

Constructor & Destructor Documentation

◆ Stretch() [1/2]

Stretch ( int value)

Constructs a Stretch of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ Stretch() [2/2]

Stretch ( Stretch enum_)

Constructs a copy of a Stretch object.

Parameters
enum_Stretch 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 Stretch 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 Stretch 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.