Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class Dither

java.lang.Object

java.lang.Enum<Dither>

org.freedesktop.cairo.Dither

All Implemented Interfaces:

Serializable, Comparable<Dither>, Constable

public enum Dither
extends Enum<Dither>

Dither is an intentionally applied form of noise used to randomize quantization error, preventing large-scale patterns such as color banding in images (e.g. for gradients). Ordered dithering applies a precomputed threshold matrix to spread the errors smoothly.

Dither is modeled on pixman dithering algorithm choice. As of Pixman 0.40, FAST corresponds to a 8x8 ordered bayer noise and GOOD and BEST use an ordered 64x64 precomputed blue noise.

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
BEST	Best algorithm available in the backend
DEFAULT	Default choice at cairo compile time.
FAST	Fastest dithering algorithm supported by the backend
GOOD	An algorithm with smoother dithering than FAST
NONE	No dithering.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Return the value of this enum
static Dither	of(int ordinal)	Returns the enum constant for the given ordinal (its position in the enum declaration).
static Dither	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Dither[]	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

NONE

public static final Dither NONE

No dithering.

Since:

1.18

DEFAULT

public static final Dither DEFAULT

Default choice at cairo compile time. Currently NONE.

Since:

1.18

FAST

public static final Dither FAST

Fastest dithering algorithm supported by the backend

Since:

1.18

GOOD

public static final Dither GOOD

An algorithm with smoother dithering than FAST

Since:

1.18

BEST

public static final Dither BEST

Best algorithm available in the backend

Since:

1.18

Method Details

values

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