Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class Operator

java.lang.Object

java.lang.Enum<Operator>

org.freedesktop.cairo.Operator

All Implemented Interfaces:

Serializable, Comparable<Operator>, Constable

public enum Operator
extends Enum<Operator>

cairo_operator_t is used to set the compositing operator for all cairo drawing operations.

The default operator is CAIRO_OPERATOR_OVER.

The operators marked as unbounded modify their destination even outside of the mask layer (that is, their effect is not bound by the mask layer). However, their effect can still be limited by way of clipping.

To keep things simple, the operator descriptions here document the behavior for when both source and destination are either fully transparent or fully opaque. The actual implementation works for translucent layers too. For a more detailed explanation of the effects of each operator, including the mathematical definitions, see https://cairographics.org/operators/ .

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
ADD	source and destination layers are accumulated
ATOP	draw source on top of destination content and only there
CLEAR	clear destination layer (bounded)
COLOR_BURN	darkens the destination color to reflect the source color.
COLOR_DODGE	brightens the destination color to reflect the source color.
DARKEN	replaces the destination with the source if it is darker, otherwise keeps the source.
DEST	ignore the source
DEST_ATOP	leave destination on top of source content and only there (unbounded)
DEST_IN	leave destination only where there was source content (unbounded)
DEST_OUT	leave destination only where there was no source content
DEST_OVER	draw destination on top of source
DIFFERENCE	Takes the difference of the source and destination color.
EXCLUSION	Produces an effect similar to difference, but with lower contrast.
HARD_LIGHT	Multiplies or screens, dependent on source color.
HSL_COLOR	Creates a color with the hue and saturation of the source and the luminosity of the target.
HSL_HUE	Creates a color with the hue of the source and the saturation and luminosity of the target.
HSL_LUMINOSITY	Creates a color with the luminosity of the source and the hue and saturation of the target.
HSL_SATURATION	Creates a color with the saturation of the source and the hue and luminosity of the target.
IN	draw source where there was destination content (unbounded)
LIGHTEN	replaces the destination with the source if it is lighter, otherwise keeps the source.
MULTIPLY	source and destination layers are multiplied.
OUT	draw source where there was no destination content (unbounded)
OVER	draw source layer on top of destination layer (bounded)
OVERLAY	multiplies or screens, depending on the lightness of the destination color.
SATURATE	like over, but assuming source and dest are disjoint geometries
SCREEN	source and destination are complemented and multiplied.
SOFT_LIGHT	Darkens or lightens, dependent on source color.
SOURCE	replace destination layer (bounded)
XOR	source and destination are shown where there is only one of them

Method Summary

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

CLEAR

public static final Operator CLEAR

clear destination layer (bounded)

Since:

1.0

SOURCE

public static final Operator SOURCE

replace destination layer (bounded)

Since:

1.0

OVER

public static final Operator OVER

draw source layer on top of destination layer (bounded)

Since:

1.0

IN

public static final Operator IN

draw source where there was destination content (unbounded)

Since:

1.0

OUT

public static final Operator OUT

draw source where there was no destination content (unbounded)

Since:

1.0

ATOP

public static final Operator ATOP

draw source on top of destination content and only there

Since:

1.0

DEST

public static final Operator DEST

ignore the source

Since:

1.0

DEST_OVER

public static final Operator DEST_OVER

draw destination on top of source

Since:

1.0

DEST_IN

public static final Operator DEST_IN

leave destination only where there was source content (unbounded)

Since:

1.0

DEST_OUT

public static final Operator DEST_OUT

leave destination only where there was no source content

Since:

1.0

DEST_ATOP

public static final Operator DEST_ATOP

leave destination on top of source content and only there (unbounded)

Since:

1.0

XOR

public static final Operator XOR

source and destination are shown where there is only one of them

Since:

1.0

ADD

public static final Operator ADD

source and destination layers are accumulated

Since:

1.0

SATURATE

public static final Operator SATURATE

like over, but assuming source and dest are disjoint geometries

Since:

1.0

MULTIPLY

public static final Operator MULTIPLY

source and destination layers are multiplied. This causes the result to be at least as dark as the darker inputs.

Since:

1.10

SCREEN

public static final Operator SCREEN

source and destination are complemented and multiplied. This causes the result to be at least as light as the lighter inputs.

Since:

1.10

OVERLAY

public static final Operator OVERLAY

multiplies or screens, depending on the lightness of the destination color.

Since:

1.10

DARKEN

public static final Operator DARKEN

replaces the destination with the source if it is darker, otherwise keeps the source.

Since:

1.10

LIGHTEN

public static final Operator LIGHTEN

replaces the destination with the source if it is lighter, otherwise keeps the source.

Since:

1.10

COLOR_DODGE

public static final Operator COLOR_DODGE

brightens the destination color to reflect the source color.

Since:

1.10

COLOR_BURN

public static final Operator COLOR_BURN

darkens the destination color to reflect the source color.

Since:

1.10

HARD_LIGHT

public static final Operator HARD_LIGHT

Multiplies or screens, dependent on source color.

Since:

1.10

SOFT_LIGHT

public static final Operator SOFT_LIGHT

Darkens or lightens, dependent on source color.

Since:

1.10

DIFFERENCE

public static final Operator DIFFERENCE

Takes the difference of the source and destination color.

Since:

1.10

EXCLUSION

public static final Operator EXCLUSION

Produces an effect similar to difference, but with lower contrast.

Since:

1.10

HSL_HUE

public static final Operator HSL_HUE

Creates a color with the hue of the source and the saturation and luminosity of the target.

Since:

1.0

HSL_SATURATION

public static final Operator HSL_SATURATION

Creates a color with the saturation of the source and the hue and luminosity of the target. Painting with this mode onto a gray area produces no change.

Since:

1.10

HSL_COLOR

public static final Operator HSL_COLOR

Creates a color with the hue and saturation of the source and the luminosity of the target. This preserves the gray levels of the target and is useful for coloring monochrome images or tinting color images.

Since:

1.10

HSL_LUMINOSITY

public static final Operator HSL_LUMINOSITY

Creates a color with the luminosity of the source and the hue and saturation of the target. This produces an inverse effect to HSL_COLOR.

Since:

1.10

Method Details

values

public static Operator[] 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 Operator 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 Operator 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 CairoOperator GType

Returns:

the GType