Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class Extend

java.lang.Object

java.lang.Enum<Extend>

org.freedesktop.cairo.Extend

All Implemented Interfaces:

Serializable, Comparable<Extend>, Constable

public enum Extend
extends Enum<Extend>

Extend is used to describe how pattern color/alpha will be determined for areas "outside" the pattern's natural area, (for example, outside the surface bounds or outside the gradient geometry).

Mesh patterns are not affected by the extend mode.

The default extend mode is NONE for surface patterns and PAD for gradient patterns.

New entries may be added in future versions.

Since:

1.0

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
NONE	pixels outside of the source pattern are fully transparent
PAD	pixels outside of the pattern copy the closest pixel from the source
REFLECT	the pattern is tiled by reflecting at the edges
REPEAT	the pattern is tiled by repeating

Method Summary

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

pixels outside of the source pattern are fully transparent

Since:

1.0

REPEAT

public static final Extend REPEAT

the pattern is tiled by repeating

Since:

1.0

REFLECT

public static final Extend REFLECT

the pattern is tiled by reflecting at the edges

Since:

1.0; but only implemented for surface patterns since 1.6

PAD

public static final Extend PAD

pixels outside of the pattern copy the closest pixel from the source

Since:

1.2; but only implemented for surface patterns since 1.6

Method Details

values

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

getType

public static org.gnome.glib.Type getType()

Get the CairoExtend GType

Returns:

the GType