Kanzi  3.9.9
Kanzi Engine Java API
MaskEffect2DEnums.Channel Enum Reference

Defines the mask texture channels that you can use as the mask. More...

Inheritance diagram for MaskEffect2DEnums.Channel:
[legend]

Public Member Functions

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

Public Attributes

 Alpha =(0)
 Uses the alpha channel as the mask.
 
 Blue =(3)
 Uses the blue color channel as the mask.
 
 Green =(2)
 Uses the green color channel as the mask.
 
 Luminance =(4)
 Uses the luminance calculated from the red, green, and blue color channels as the mask.
 
 Red =(1)
 Uses the red color channel as the mask.
 

Detailed Description

Defines the mask texture channels that you can use as the mask.

Constructor & Destructor Documentation

Channel ( int  value)

Constructs a Channel of an integer value.

Parameters
valueInteger value to convert to enumeration constant.
Channel ( Channel  enum_)

Constructs a copy of a Channel object.

Parameters
enum_Channel to be copy constructed.

Member Function Documentation

int getValue ( )

Returns the integer value of the enumeration constant.

Returns
Integer value.

Implements Enum.

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