CLImageFormat.ChannelOrder (JavaCL Core / BridJ 1.0.0-RC4 API)

java.lang.Object
- java.lang.Enum<CLImageFormat.ChannelOrder>
- - com.nativelibs4java.opencl.CLImageFormat.ChannelOrder

All Implemented Interfaces:

ValuedEnum, Serializable, Comparable<CLImageFormat.ChannelOrder>

Enclosing class:

CLImageFormat
```
public static enum CLImageFormat.ChannelOrder
extends Enum<CLImageFormat.ChannelOrder>
implements ValuedEnum
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`A` components of channel data: (0.0, 0.0, 0.0, a)
`ARGB` components of channel data: (r, g, b, a)
`BGRA` components of channel data: (r, g, b, a) This format can only be used if channel data type = CL_UNORM_INT8, CL_SNORM_INT8, CL_SIGNED_INT8 or CL_UNSIGNED_INT8.
`INTENSITY` components of channel data: (I, I, I, I) This format can only be used if channel data type = CL_UNORM_INT8, CL_UNORM_INT16, CL_SNORM_INT8, CL_SNORM_INT16, CL_HALF_FLOAT or CL_FLOAT.
`LUMINANCE` components of channel data: (L, L, L, 1.0) This format can only be used if channel data type = CL_UNORM_INT8, CL_UNORM_INT16, CL_SNORM_INT8, CL_SNORM_INT16, CL_HALF_FLOAT or CL_FLOAT.
`R` components of channel data: (r, 0.0, 0.0, 1.0)
`RA` components of channel data: (r, 0.0, 0.0, a)
`RG` components of channel data: (r, g, 0.0, 1.0)
`RGB` components of channel data: (r, g, b, 1.0) This format can only be used if channel data type = CL_UNORM_SHORT_565, CL_UNORM_SHORT_555 or CL_UNORM_INT101010.
`RGBA` components of channel data: (r, g, b, a)
`RGBx` components of channel data: (r, g, b, 1.0) This format can only be used if channel data type = CL_UNORM_SHORT_565, CL_UNORM_SHORT_555 or CL_UNORM_INT101010.
`RGx` components of channel data: (r, g, 0.0, 1.0)
`Rx` components of channel data: (r, 0.0, 0.0, 1.0)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CLImageFormat.ChannelOrder`	`getEnum(long v)`
`long`	`value()`
`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
compareTo, equals, 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
```
    components of channel data: (r, 0.0, 0.0, 1.0)
  - Rx
```
public static final CLImageFormat.ChannelOrder Rx
```
    components of channel data: (r, 0.0, 0.0, 1.0)
    
    Since:
    
    OpenCL 1.1
  - A
```
public static final CLImageFormat.ChannelOrder A
```
    components of channel data: (0.0, 0.0, 0.0, a)
  - INTENSITY
```
public static final CLImageFormat.ChannelOrder INTENSITY
```
    components of channel data: (I, I, I, I)
    This format can only be used if channel data type = CL_UNORM_INT8, CL_UNORM_INT16, CL_SNORM_INT8, CL_SNORM_INT16, CL_HALF_FLOAT or CL_FLOAT.
  - LUMINANCE
```
public static final CLImageFormat.ChannelOrder LUMINANCE
```
    components of channel data: (L, L, L, 1.0)
    This format can only be used if channel data type = CL_UNORM_INT8, CL_UNORM_INT16, CL_SNORM_INT8, CL_SNORM_INT16, CL_HALF_FLOAT or CL_FLOAT.
  - RG
```
public static final CLImageFormat.ChannelOrder RG
```
    components of channel data: (r, g, 0.0, 1.0)
  - RGx
```
public static final CLImageFormat.ChannelOrder RGx
```
    components of channel data: (r, g, 0.0, 1.0)
    
    Since:
    
    OpenCL 1.1
  - RA
```
public static final CLImageFormat.ChannelOrder RA
```
    components of channel data: (r, 0.0, 0.0, a)
  - RGB
```
public static final CLImageFormat.ChannelOrder RGB
```
    components of channel data: (r, g, b, 1.0)
    This format can only be used if channel data type = CL_UNORM_SHORT_565, CL_UNORM_SHORT_555 or CL_UNORM_INT101010.
  - RGBx
```
public static final CLImageFormat.ChannelOrder RGBx
```
    components of channel data: (r, g, b, 1.0)
    This format can only be used if channel data type = CL_UNORM_SHORT_565, CL_UNORM_SHORT_555 or CL_UNORM_INT101010.
    
    Since:
    
    OpenCL 1.1
  - RGBA
```
public static final CLImageFormat.ChannelOrder RGBA
```
    components of channel data: (r, g, b, a)
  - ARGB
```
public static final CLImageFormat.ChannelOrder ARGB
```
    components of channel data: (r, g, b, a)
  - BGRA
```
public static final CLImageFormat.ChannelOrder BGRA
```
    components of channel data: (r, g, b, a)
    This format can only be used if channel data type = CL_UNORM_INT8, CL_SNORM_INT8, CL_SIGNED_INT8 or CL_UNSIGNED_INT8.
- 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
  - value
```
public long value()
```
    Specified by:
    
    value in interface ValuedEnum
  - getEnum
```
public static CLImageFormat.ChannelOrder getEnum(long v)
```

Enum CLImageFormat.ChannelOrder

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

R

Rx

A

INTENSITY

LUMINANCE

RG

RGx

RA

RGB

RGBx

RGBA

ARGB

BGRA

Method Detail

values

valueOf

value

getEnum