Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class ColorMode

java.lang.Object

java.lang.Enum<ColorMode>

org.freedesktop.cairo.ColorMode

All Implemented Interfaces:

Serializable, Comparable<ColorMode>, Constable

public enum ColorMode
extends Enum<ColorMode>

Specifies if color fonts are to be rendered using the color glyphs or outline glyphs. Glyphs that do not have a color presentation, and non-color fonts are not affected by this font option.

Since:

1.18

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLOR	Enable rendering color glyphs.
DEFAULT	Use the default color mode for font backend and target device
NO_COLOR	Disable rendering color glyphs.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Return the value of this enum
static ColorMode	of(int ordinal)	Returns the enum constant for the given ordinal (its position in the enum declaration).
static ColorMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ColorMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final ColorMode DEFAULT

Use the default color mode for font backend and target device

Since:

1.18

NO_COLOR

public static final ColorMode NO_COLOR

Disable rendering color glyphs. Glyphs are always rendered as outline glyphs

Since:

1.18

COLOR

public static final ColorMode COLOR

Enable rendering color glyphs. If the font contains a color presentation for a glyph, and when supported by the font backend, the glyph will be rendered in color

Since:

1.18

Method Details

values

public static ColorMode[] 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 ColorMode 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

getValue

public int getValue()

Return the value of this enum

Returns:

the value

of

public static ColorMode of(int ordinal)

Returns the enum constant for the given ordinal (its position in the enum declaration).

Parameters:

ordinal - the position in the enum declaration, starting from zero

Returns:

the enum constant for the given ordinal