org.fujion.canvas.webgl

Enum PixelStorageParameter

java.lang.Object

java.lang.Enum<PixelStorageParameter>

org.fujion.canvas.webgl.PixelStorageParameter

All Implemented Interfaces:

Serializable, Comparable<PixelStorageParameter>, IEnumWithValue, IClientTransform

public enum PixelStorageParameter
extends Enum<PixelStorageParameter>
implements IEnumWithValue

Types of pixel storage parameters.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PACK_ALIGNMENT Packing of pixel data into memory.
PACK_ROW_LENGTH Number of pixels in a row.
PACK_SKIP_PIXELS Number of pixel locations skipped before the first pixel is written into memory.
PACK_SKIP_ROWS Number of rows of pixel locations skipped before the first pixel is written into memory.
UNPACK_ALIGNMENT Unpacking of pixel data from memory.
UNPACK_COLORSPACE_CONVERSION_WEBGL Default color space conversion or no color space conversion.
UNPACK_FLIP_Y_WEBGL Flips the source data along its vertical axis if true.
UNPACK_IMAGE_HEIGHT Image height used for reading pixel data from memory.
UNPACK_PREMULTIPLY_ALPHA_WEBGL Multiplies the alpha channel into the other color channels.
UNPACK_ROW_LENGTH Number of pixels in a row.
UNPACK_SKIP_IMAGES Number of pixel images skipped before the first pixel is read from memory.
UNPACK_SKIP_PIXELS Number of pixel images skipped before the first pixel is read from memory.
UNPACK_SKIP_ROWS Number of rows of pixel locations skipped before the first pixel is read from memory.

Method Summary

Modifier and Type	Method and Description
int	value()
static PixelStorageParameter	valueOf(String name) Returns the enum constant of this type with the specified name.
static PixelStorageParameter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.IEnumWithValue

fromValue, transformForClient

Enum Constant Detail

PACK_ALIGNMENT

public static final PixelStorageParameter PACK_ALIGNMENT

Packing of pixel data into memory.

PACK_ROW_LENGTH

public static final PixelStorageParameter PACK_ROW_LENGTH

Number of pixels in a row. (WebGL 2 only)

PACK_SKIP_PIXELS

public static final PixelStorageParameter PACK_SKIP_PIXELS

Number of pixel locations skipped before the first pixel is written into memory. (WebGL 2 only)

PACK_SKIP_ROWS

public static final PixelStorageParameter PACK_SKIP_ROWS

Number of rows of pixel locations skipped before the first pixel is written into memory. (WebGL 2 only)

UNPACK_ALIGNMENT

public static final PixelStorageParameter UNPACK_ALIGNMENT

Unpacking of pixel data from memory.

UNPACK_COLORSPACE_CONVERSION_WEBGL

public static final PixelStorageParameter UNPACK_COLORSPACE_CONVERSION_WEBGL

Default color space conversion or no color space conversion.

UNPACK_FLIP_Y_WEBGL

public static final PixelStorageParameter UNPACK_FLIP_Y_WEBGL

Flips the source data along its vertical axis if true.

UNPACK_IMAGE_HEIGHT

public static final PixelStorageParameter UNPACK_IMAGE_HEIGHT

Image height used for reading pixel data from memory. (WebGL 2 only)

UNPACK_PREMULTIPLY_ALPHA_WEBGL

public static final PixelStorageParameter UNPACK_PREMULTIPLY_ALPHA_WEBGL

Multiplies the alpha channel into the other color channels.

UNPACK_ROW_LENGTH

public static final PixelStorageParameter UNPACK_ROW_LENGTH

Number of pixels in a row. (WebGL 2 only)

UNPACK_SKIP_IMAGES

public static final PixelStorageParameter UNPACK_SKIP_IMAGES

Number of pixel images skipped before the first pixel is read from memory. (WebGL 2 only)

UNPACK_SKIP_PIXELS

public static final PixelStorageParameter UNPACK_SKIP_PIXELS

Number of pixel images skipped before the first pixel is read from memory. (WebGL 2 only)

UNPACK_SKIP_ROWS

public static final PixelStorageParameter UNPACK_SKIP_ROWS

Number of rows of pixel locations skipped before the first pixel is read from memory. (WebGL 2 only)

Method Detail

values

public static PixelStorageParameter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PixelStorageParameter c : PixelStorageParameter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PixelStorageParameter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

value

public int value()

Specified by:

value in interface IEnumWithValue