Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class Format

java.lang.Object

java.lang.Enum<Format>

org.freedesktop.cairo.Format

All Implemented Interfaces:

Serializable, Comparable<Format>, Constable

public enum Format
extends Enum<Format>

Used to identify the memory format of image data.

New entries may be added in future versions.

See Also:

• Surface

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
A1	each pixel is a 1-bit quantity holding an alpha value.
A8	each pixel is a 8-bit quantity holding an alpha value.
ARGB32	each pixel is a 32-bit quantity, with alpha in the upper 8 bits, then red, then green, then blue.
INVALID	no such format exists or is supported.
RGB16_565	each pixel is a 16-bit quantity with red in the upper 5 bits, then green in the middle 6 bits, and blue in the lower 5 bits.
RGB24	each pixel is a 32-bit quantity, with the upper 8 bits unused.
RGB30	like RGB24 but with 10bpc.
RGB96F	3 floats, R, G, B.
RGBA128F	4 floats, R, G, B, A.

Method Summary

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

INVALID

public static final Format INVALID

no such format exists or is supported.

ARGB32

public static final Format ARGB32

each pixel is a 32-bit quantity, with alpha in the upper 8 bits, then red, then green, then blue. The 32-bit quantities are stored native-endian. Pre-multiplied alpha is used. (That is, 50% transparent red is 0x80800000, not 0x80ff0000.)

Since:

1.0

RGB24

public static final Format RGB24

each pixel is a 32-bit quantity, with the upper 8 bits unused. Red, Green, and Blue are stored in the remaining 24 bits in that order.

Since:

1.0

A8

public static final Format A8

each pixel is a 8-bit quantity holding an alpha value.

Since:

1.0

A1

public static final Format A1

each pixel is a 1-bit quantity holding an alpha value. Pixels are packed together into 32-bit quantities. The ordering of the bits matches the endianness of the platform. On a big-endian machine, the first pixel is in the uppermost bit, on a little-endian machine the first pixel is in the least-significant bit.

Since:

1.0

RGB16_565

public static final Format RGB16_565

each pixel is a 16-bit quantity with red in the upper 5 bits, then green in the middle 6 bits, and blue in the lower 5 bits.

Since:

1.2

RGB30

public static final Format RGB30

like RGB24 but with 10bpc.

Since:

1.12

RGB96F

public static final Format RGB96F

3 floats, R, G, B.

Since:

1.17.2

RGBA128F

public static final Format RGBA128F

4 floats, R, G, B, A.

Since:

1.17.2

Method Details

values

public static Format[] 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 Format 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 Format of(int value)

Returns the enum member for the given value.

Parameters:

value - the value of the enum member

Returns:

the enum member for the given value

getType

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

Get the CairoFormat GType

Returns:

the GType