Enum Class MaskMode

java.lang.Object

java.lang.Enum<MaskMode>

org.gnome.gsk.MaskMode

All Implemented Interfaces:

Serializable, Comparable<MaskMode>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum MaskMode
extends Enum<MaskMode>
implements Enumeration

The mask modes available for mask nodes.

Since:

4.10

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALPHA	Use the alpha channel of the mask
INVERTED_ALPHA	Use the inverted alpha channel of the mask
INVERTED_LUMINANCE	Use the inverted luminance of the mask, multiplied by mask alpha
LUMINANCE	Use the luminance of the mask, multiplied by mask alpha

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the MaskMode class.
int	getValue()	Get the numeric value of this enum
static MaskMode	of(int value)	Create a new MaskMode for the provided value
static MaskMode	of(MemorySegment address)	Create a new MaskMode for the value in the provided memory address.
static MaskMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MaskMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALPHA

public static final MaskMode ALPHA

Use the alpha channel of the mask

INVERTED_ALPHA

public static final MaskMode INVERTED_ALPHA

Use the inverted alpha channel of the mask

LUMINANCE

public static final MaskMode LUMINANCE

Use the luminance of the mask, multiplied by mask alpha

INVERTED_LUMINANCE

public static final MaskMode INVERTED_LUMINANCE

Use the inverted luminance of the mask, multiplied by mask alpha

Method Details

values

public static MaskMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MaskMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

of

public static MaskMode of(int value)

Create a new MaskMode for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static MaskMode of(MemorySegment address)

Create a new MaskMode for the value in the provided memory address.

Parameters:

address - the memory address holding a enum value

Returns:

the enum for the value in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the MaskMode class.

Returns:

the GType