MaskEffect2DEnums.Channel Enum Reference

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

Inheritance diagram for MaskEffect2DEnums.Channel:

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

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() [1/2]

Channel

(

int

value

)

Constructs a Channel of an integer value.

Parameters

value

Integer value to convert to enumeration constant.

Channel() [2/2]

Channel

(

Channel

enum_

)

Constructs a copy of a Channel object.

Parameters

enum_

Channel 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 Channel swigToEnum ( int swigValue )

static

Converts an integer value to the matching enumeration constant.

Used internally by SWIG generated code.

Parameters

swigValue

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

static

Converts an integer value to the matching enumeration constant.

Parameters

value

Integer value to convert to enumeration constant.

Returns

Enumeration constant matching the integer value.