Package com.jogamp.opencl

Enum CLImageFormat.ChannelOrder

java.lang.Object

java.lang.Enum<CLImageFormat.ChannelOrder>

com.jogamp.opencl.CLImageFormat.ChannelOrder

All Implemented Interfaces:

Serializable, Comparable<CLImageFormat.ChannelOrder>

Enclosing class:

CLImageFormat

public static enum CLImageFormat.ChannelOrder
extends Enum<CLImageFormat.ChannelOrder>

Specifies the number of channels and the channel layout i.e. the memory layout in which channels are stored in the image.

Enum Constant Summary

Enum Constants

Enum Constant	Description
A
ARGB	This format can only be used if channel data type is one of the following values: CLImageFormat.ChannelType.UNORM_INT8, CLImageFormat.ChannelType.SNORM_INT8, CLImageFormat.ChannelType.SIGNED_INT8 or CLImageFormat.ChannelType.UNSIGNED_INT8.
BGRA
INTENSITY	This format can only be used if channel data type is one of the following values: CLImageFormat.ChannelType.UNORM_INT8, CLImageFormat.ChannelType.UNORM_INT16, CLImageFormat.ChannelType.SNORM_INT8, CLImageFormat.ChannelType.SNORM_INT16, CLImageFormat.ChannelType.HALF_FLOAT, or CLImageFormat.ChannelType.FLOAT.
LUMINANCE	This format can only be used if channel data type is one of the following values: CLImageFormat.ChannelType.UNORM_INT8, CLImageFormat.ChannelType.UNORM_INT16, CLImageFormat.ChannelType.SNORM_INT8, CLImageFormat.ChannelType.SNORM_INT16, CLImageFormat.ChannelType.HALF_FLOAT, or CLImageFormat.ChannelType.FLOAT.
R
RA
RG
RGB	This format can only be used if channel data type is one of the following values: CLImageFormat.ChannelType.UNORM_SHORT_565, CLImageFormat.ChannelType.UNORM_SHORT_555 or CLImageFormat.ChannelType.UNORM_INT_101010.
RGBA
RGBx
RGx
Rx

Field Summary

Fields

Modifier and Type	Field	Description
int	ORDER	Value of wrapped OpenCL flag.

Method Summary

Modifier and Type	Method	Description
static CLImageFormat.ChannelOrder	valueOf(int orderFlag)	Returns the enum constant of this type with the specified name.
static CLImageFormat.ChannelOrder	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CLImageFormat.ChannelOrder[]	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

Enum Constant Detail

R

public static final CLImageFormat.ChannelOrder R

Rx

public static final CLImageFormat.ChannelOrder Rx

A

public static final CLImageFormat.ChannelOrder A

RG

public static final CLImageFormat.ChannelOrder RG

RGx

public static final CLImageFormat.ChannelOrder RGx

RA

public static final CLImageFormat.ChannelOrder RA

RGB

public static final CLImageFormat.ChannelOrder RGB

This format can only be used if channel data type is one of the following values: CLImageFormat.ChannelType.UNORM_SHORT_565, CLImageFormat.ChannelType.UNORM_SHORT_555 or CLImageFormat.ChannelType.UNORM_INT_101010.

RGBx

public static final CLImageFormat.ChannelOrder RGBx

RGBA

public static final CLImageFormat.ChannelOrder RGBA

ARGB

public static final CLImageFormat.ChannelOrder ARGB

This format can only be used if channel data type is one of the following values: CLImageFormat.ChannelType.UNORM_INT8, CLImageFormat.ChannelType.SNORM_INT8, CLImageFormat.ChannelType.SIGNED_INT8 or CLImageFormat.ChannelType.UNSIGNED_INT8.

BGRA

public static final CLImageFormat.ChannelOrder BGRA

See Also:

ARGB

INTENSITY

public static final CLImageFormat.ChannelOrder INTENSITY

This format can only be used if channel data type is one of the following values: CLImageFormat.ChannelType.UNORM_INT8, CLImageFormat.ChannelType.UNORM_INT16, CLImageFormat.ChannelType.SNORM_INT8, CLImageFormat.ChannelType.SNORM_INT16, CLImageFormat.ChannelType.HALF_FLOAT, or CLImageFormat.ChannelType.FLOAT.

LUMINANCE

public static final CLImageFormat.ChannelOrder LUMINANCE

This format can only be used if channel data type is one of the following values: CLImageFormat.ChannelType.UNORM_INT8, CLImageFormat.ChannelType.UNORM_INT16, CLImageFormat.ChannelType.SNORM_INT8, CLImageFormat.ChannelType.SNORM_INT16, CLImageFormat.ChannelType.HALF_FLOAT, or CLImageFormat.ChannelType.FLOAT.

Field Detail

ORDER

public final int ORDER

Value of wrapped OpenCL flag.

Method Detail

values

public static CLImageFormat.ChannelOrder[] 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 (CLImageFormat.ChannelOrder c : CLImageFormat.ChannelOrder.values())
    System.out.println(c);

Returns:

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

valueOf

public static CLImageFormat.ChannelOrder 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

valueOf

public static CLImageFormat.ChannelOrder valueOf(int orderFlag)

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:

orderFlag - 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