Module notzed.zcl
Package au.notzed.zcl

Enum CLChannelOrder

java.lang.Object
java.lang.Enum<CLChannelOrder>
au.notzed.zcl.CLChannelOrder
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CLChannelOrder>, java.lang.constant.Constable
public enum CLChannelOrder
extends java.lang.Enum<CLChannelOrder>
Enum for wrapping the cl_channel_order constants from cl.h. This is mostly useful for printing them out.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    CL_A  
    CL_ABGR  
    CL_ARGB  
    CL_BGRA  
    CL_DEPTH  
    CL_DEPTH_STENCIL  
    CL_INTENSITY  
    CL_LUMINANCE  
    CL_R  
    CL_RA  
    CL_RG  
    CL_RGB  
    CL_RGBA  
    CL_RGBx  
    CL_RGx  
    CL_Rx  
    CL_sBGRA  
    CL_sRGB  
    CL_sRGBA  
    CL_sRGBx  

  • Method Summary

    Modifier and Type Method Description
    static CLChannelOrder fromC​(int id)
    Converts an OpenCL channel order constant into the corresponding CLChannelOrder enumeration.
    static CLChannelOrder valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static CLChannelOrder[] 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, 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

  • Method Details

    • values

      public static CLChannelOrder[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static CLChannelOrder valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • fromC

      public static CLChannelOrder fromC​(int id)
      Converts an OpenCL channel order constant into the corresponding CLChannelOrder enumeration.
      Parameters:
      id -
      Returns:
      Throws:
      java.lang.EnumConstantNotPresentException - if id is not a channel order.