CLDevice (JavaCL Core / BridJ 1.0.0-RC4 API)

java.lang.Object
- com.nativelibs4java.opencl.CLDevice

```
public class CLDevice
extends Object
```
OpenCL device (CPU, GPU...).
Devices are retrieved from a CLPlatform through CLPlatform.listDevices(CLDevice.Type, boolean), CLPlatform.listAllDevices(boolean), CLPlatform.listCPUDevices(boolean), CLPlatform.listGPUDevices(boolean)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CLDevice.AffinityDomain` Enums values for cl_device_affinity_domain
`static class`	`CLDevice.ExecutionCapability` Bit values for CL_DEVICE_EXECUTION_CAPABILITIES
`static class`	`CLDevice.FpConfig` Floating-point config of a device.
`static class`	`CLDevice.GlobalMemCacheType` Values for CL_DEVICE_GLOBAL_MEM_CACHE_TYPE
`static class`	`CLDevice.LocalMemType` Values for CL_DEVICE_LOCAL_MEM_TYPE
`static class`	`CLDevice.PartitionType` Device partition types.
`static class`	`CLDevice.QueueProperties` Bit values for CL_DEVICE_QUEUE_PROPERTIES
`static class`	`CLDevice.Type` Bit values for CL_DEVICE_TYPE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CLQueue`	`createOutOfOrderQueue(CLContext context)`
`CLQueue`	`createProfilingQueue(CLContext context)`
`CLQueue`	`createQueue(CLContext context, CLDevice.QueueProperties... queueProperties)` Calls clCreateCommandQueue.
`CLQueue`	`createQueue(EnumSet<CLDevice.QueueProperties> queueProperties, CLContext context)` Deprecated.
`String`	`createSignature()`
`CLDevice[]`	`createSubDevicesByAffinity(CLDevice.AffinityDomain affinityDomain)` Creates an array of sub-devices that each reference a non-intersecting set of compute units within this device.
`CLDevice[]`	`createSubDevicesByCounts(long... computeUnitsForEachSubDevice)` Creates an array of sub-devices that each reference a non-intersecting set of compute units within this device.
`CLDevice[]`	`createSubDevicesEqually(int computeUnitsForEverySubDevice)` Creates an array of sub-devices that each reference a non-intersecting set of compute units within this device.
`boolean`	`equals(Object obj)` Underyling implementation pointer-based equality test
`int`	`getAddressBits()` The default compute device address space size specified as an unsigned integer value in bits.
`String[]`	`getBuiltInKernels()` List of built-in kernels supported by the device.
`ByteOrder`	`getByteOrder()`
`static Map<String,List<CLDevice>>`	`getDevicesBySignature(List<CLDevice> devices)`
`EnumSet<CLDevice.FpConfig>`	`getDoubleFpConfig()` TODO
`String`	`getDriverVersion()` OpenCL software driver version string in the form major_number.minor_number.
`static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E>`	`getEntities(A[] objects, Pointer<E> out)`
`EnumSet<CLDevice.ExecutionCapability>`	`getExecutionCapabilities()` Describes the execution capabilities of the device.
`String[]`	`getExtensions()` List of extension names supported by the device.
`int`	`getGlobalMemCachelineSize()` Size of global memory cache line in bytes.
`long`	`getGlobalMemCacheSize()` Size of global memory cache in bytes.
`CLDevice.GlobalMemCacheType`	`getGlobalMemCacheType()` Type of global memory cache supported.
`long`	`getGlobalMemSize()` Size of global device memory in bytes.
`EnumSet<CLDevice.FpConfig>`	`getHalfFpConfig()` TODO
`long`	`getImage2DMaxHeight()` Max height of 2D image in pixels.
`long`	`getImage2DMaxWidth()` Max width of 2D image in pixels.
`long`	`getImage3DMaxDepth()` Max depth of 3D image in pixels.
`long`	`getImage3DMaxHeight()` Max height of 3D image in pixels.
`long`	`getImage3DMaxWidth()` Max width of 3D image in pixels.
`long`	`getImageMaxArraySize()` TODO
`long`	`getImageMaxBufferSize()` TODO
`ByteOrder`	`getKernelsDefaultByteOrder()` Deprecated. Use `getByteOrder()`
`long`	`getLocalMemSize()` Size of local memory arena in bytes.
`CLDevice.LocalMemType`	`getLocalMemType()` Type of local memory supported.
`int`	`getMaxClockFrequency()` Maximum configured clock frequency of the device in MHz.
`int`	`getMaxComputeUnits()` The number of parallel compute cores on the OpenCL device.
`int`	`getMaxConstantArgs()` Max number of arguments declared with the __constant qualifier in a kernel.
`long`	`getMaxConstantBufferSize()` Max size in bytes of a constant buffer allocation.
`long`	`getMaxMemAllocSize()` Max size of memory object allocation in bytes.
`long`	`getMaxParameterSize()` Max size in bytes of the arguments that can be passed to a kernel.
`int`	`getMaxReadImageArgs()` Max number of simultaneous image objects that can be read by a kernel.
`int`	`getMaxSamplers()` Maximum number of samplers that can be used in a kernel.
`long`	`getMaxWorkGroupSize()` Maximum number of work-items in a work-group executing a kernel using the data parallel execution model.
`int`	`getMaxWorkItemDimensions()` Maximum dimensions that specify the global and local work-item IDs used by the data parallel execution model.
`long[]`	`getMaxWorkItemSizes()` Maximum number of work-items that can be specified in each dimension of the work-group to clEnqueueNDRangeKernel.
`int`	`getMaxWriteImageArgs()` Max number of simultaneous image objects that can be written to by a kernel.
`int`	`getMemBaseAddrAlign()` Describes the alignment in bits of the base address of any allocated memory object.
`int`	`getMinDataTypeAlign()` The smallest alignment in bytes which can be used for any data type.
`String`	`getName()` Device name string.
`int`	`getNativeVectorWidthChar()` Returns the native ISA vector width.
`int`	`getNativeVectorWidthDouble()` Returns the native ISA vector width.
`int`	`getNativeVectorWidthFloat()` Returns the native ISA vector width.
`long`	`getNativeVectorWidthHalf()` TODO
`int`	`getNativeVectorWidthInt()` Returns the native ISA vector width.
`int`	`getNativeVectorWidthLong()` Returns the native ISA vector width.
`int`	`getNativeVectorWidthShort()` Returns the native ISA vector width.
`String`	`getOpenCLCVersion()` OpenCL C version string.
`String`	`getOpenCLVersion()` Deprecated. Legacy typo, use getOpenCLCVersion() instead.
`CLDevice`	`getParent()` Returns the cl_device_id of the parent device to which this sub-device belongs.
`CLDevice.AffinityDomain`	`getPartitionAffinityDomain()` Affinity domain specified in `createSubDevicesByAffinity(AffinityDomain)`, or null if the device is not a sub-device or wasn't split by affinity.
`EnumSet<CLDevice.PartitionType>`	`getPartitionProperties()` TODO
`CLPlatform`	`getPlatform()`
`int`	`getPreferredVectorWidthChar()` Preferred native vector width size for built-in scalar types that can be put into vectors.
`int`	`getPreferredVectorWidthDouble()` Preferred native vector width size for built-in scalar types that can be put into vectors.
`int`	`getPreferredVectorWidthFloat()` Preferred native vector width size for built-in scalar types that can be put into vectors.
`long`	`getPreferredVectorWidthHalf()` TODO
`int`	`getPreferredVectorWidthInt()` Preferred native vector width size for built-in scalar types that can be put into vectors.
`int`	`getPreferredVectorWidthLong()` Preferred native vector width size for built-in scalar types that can be put into vectors.
`int`	`getPreferredVectorWidthShort()` Preferred native vector width size for built-in scalar types that can be put into vectors.
`long`	`getPrintfBufferSize()` Maximum size of the internal buffer that holds the output of printf calls from a kernel.
`String`	`getProfile()` OpenCL profile string.
`long`	`getProfilingTimerResolution()` Describes the resolution of device timer.
`EnumSet<CLDevice.QueueProperties>`	`getQueueProperties()` Describes the command-queue properties supported by the device.
`long`	`getReferenceCount()` TODO
`EnumSet<CLDevice.FpConfig>`	`getSingleFPConfig()` Describes single precision floating- point capability of the device.
`EnumSet<CLDevice.Type>`	`getType()` The OpenCL device type.
`String`	`getVendor()` Vendor name string.
`int`	`getVendorId()` A unique device vendor identifier.
`String`	`getVersion()` OpenCL version string.
`boolean`	`hasErrorCorrectionSupport()` Is CL_TRUE if the device implements error correction for the memories, caches, registers etc. in the device.
`boolean`	`hasExtension(String name)`
`int`	`hashCode()` Underyling implementation pointer-based hashCode computation
`boolean`	`hasImageSupport()` Is CL_TRUE if images are supported by the OpenCL device and CL_FALSE otherwise.
`boolean`	`hasOutOfOrderQueueSupport()`
`boolean`	`isAvailable()` Is CL_TRUE if the device is available and CL_FALSE if the device is not available.
`boolean`	`isByteAddressableStoreSupported()` Whether this device supports the cl_khr_byte_addressable_store extension.
`boolean`	`isCompilerAvailable()` Is CL_FALSE if the implementation does not have a compiler available to compile the program source.
`boolean`	`isDoubleSupported()` Whether this device support any double-precision number extension (cl_khr_fp64 or cl_amd_fp64)
`boolean`	`isDoubleSupportedAMD()` Whether this device supports the cl_amd_fp64 double-precision number extension
`boolean`	`isDoubleSupportedKHR()` Whether this device support the cl_khr_fp64 double-precision number extension
`boolean`	`isEndianLittle()` Is CL_TRUE if the OpenCL device is a little endian device and CL_FALSE otherwise.
`boolean`	`isGlobalInt32BaseAtomicsSupported()` Whether this device supports the cl_khr_global_int32_base_atomics extension.
`boolean`	`isGlobalInt32ExtendedAtomicsSupported()` Whether this device supports the cl_khr_global_int32_extended_atomics extension.
`boolean`	`isGLSharingSupported()` Whether this device supports any OpenGL sharing extension (cl_khr_gl_sharing or cl_APPLE_gl_sharing)
`boolean`	`isHalfSupported()` Whether this device supports the cl_khr_fp16 extension.
`boolean`	`isHostUnifiedMemory()` Whether the device and the host have a unified memory subsystem.
`boolean`	`isLinkerAvailable()` TODO
`boolean`	`isLocalInt32BaseAtomicsSupported()` Whether this device supports the cl_khr_local_int32_base_atomics extension.
`boolean`	`isLocalInt32ExtendedAtomicsSupported()` Whether this device supports the cl_khr_local_int32_extended_atomics extension.
`boolean`	`isPreferredInteropUserSync()` Is CL_TRUE if the device’s preference is for the user to be responsible for synchronization, when sharing memory objects between OpenCL and other APIs such as DirectX, CL_FALSE if the device / implementation has a performant path for performing synchronization of memory object shared between OpenCL and other APIs such as DirectX.
`void`	`release()` Manual release of the OpenCL resources represented by this object.
`String`	`replaceDoubleExtensionByExtensionActuallyAvailable(String kernelSource)` If this device supports the extension cl_amd_fp64 but not cl_khr_fp64, replace any OpenCL source code pragma of the style `#pragma OPENCL EXTENSION cl_khr_fp64 : enable` by `#pragma OPENCL EXTENSION cl_amd_fp64 : enable`.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getPlatform
```
public CLPlatform getPlatform()
```
  - createSignature
```
public String createSignature()
```
  - getDevicesBySignature
```
public static Map<String,List<CLDevice>> getDevicesBySignature(List<CLDevice> devices)
```
  - getByteOrder
```
public ByteOrder getByteOrder()
```
  - getKernelsDefaultByteOrder
```
@Deprecated
public ByteOrder getKernelsDefaultByteOrder()
```
    Deprecated. Use getByteOrder()
  - getExecutionCapabilities
```
public EnumSet<CLDevice.ExecutionCapability> getExecutionCapabilities()
```
    Describes the execution capabilities of the device.
    The mandated minimum capability is: Kernel.
  - getType
```
public EnumSet<CLDevice.Type> getType()
```
    The OpenCL device type.
  - getVendorId
```
public int getVendorId()
```
    A unique device vendor identifier.
    An example of a unique device identifier could be the PCIe ID.
  - getMaxComputeUnits
```
public int getMaxComputeUnits()
```
    The number of parallel compute cores on the OpenCL device.
    The minimum value is 1.
  - getMaxWorkItemDimensions
```
public int getMaxWorkItemDimensions()
```
    Maximum dimensions that specify the global and local work-item IDs used by the data parallel execution model.
    (Refer to clEnqueueNDRangeKernel).
    The minimum value is 3.
  - getMaxWorkItemSizes
```
public long[] getMaxWorkItemSizes()
```
    Maximum number of work-items that can be specified in each dimension of the work-group to clEnqueueNDRangeKernel.
  - getMaxWorkGroupSize
```
public long getMaxWorkGroupSize()
```
    Maximum number of work-items in a work-group executing a kernel using the data parallel execution model. (Refer to clEnqueueNDRangeKernel).
    The minimum value is 1.
  - getMaxClockFrequency
```
public int getMaxClockFrequency()
```
    Maximum configured clock frequency of the device in MHz.
  - getAddressBits
```
public int getAddressBits()
```
    The default compute device address space size specified as an unsigned integer value in bits. Currently supported values are 32 or 64 bits..
    Size of size_t type in OpenCL kernels can be obtained with getAddressBits() / 8.
  - getMaxMemAllocSize
```
public long getMaxMemAllocSize()
```
    Max size of memory object allocation in bytes. The minimum value is max (1/4th of CL_DEVICE_GLOBAL_MEM_SIZE , 128*1024*1024)
  - hasImageSupport
```
public boolean hasImageSupport()
```
    Is CL_TRUE if images are supported by the OpenCL device and CL_FALSE otherwise.
  - getMaxReadImageArgs
```
public int getMaxReadImageArgs()
```
    Max number of simultaneous image objects that can be read by a kernel.
    The minimum value is 128 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE (@see hasImageSupport()).
  - getMaxWriteImageArgs
```
public int getMaxWriteImageArgs()
```
    Max number of simultaneous image objects that can be written to by a kernel.
    The minimum value is 8 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE (@see hasImageSupport()).
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - createQueue
```
public CLQueue createQueue(CLContext context,
                           CLDevice.QueueProperties... queueProperties)
```
    Calls clCreateCommandQueue.
    Create an OpenCL execution queue on this device for the specified context.
    
    Parameters:
    
    context - context of the queue to create
    
    Returns:
    
    new OpenCL queue object
  - createQueue
```
@Deprecated
public CLQueue createQueue(EnumSet<CLDevice.QueueProperties> queueProperties,
                                       CLContext context)
```
    Deprecated.
    
    Calls clCreateCommandQueue.
  - createOutOfOrderQueue
```
public CLQueue createOutOfOrderQueue(CLContext context)
```
  - createProfilingQueue
```
public CLQueue createProfilingQueue(CLContext context)
```
  - getImage2DMaxWidth
```
public long getImage2DMaxWidth()
```
    Max width of 2D image in pixels.
    The minimum value is 8192 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.
  - getImage2DMaxHeight
```
public long getImage2DMaxHeight()
```
    Max height of 2D image in pixels.
    The minimum value is 8192 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.
  - getImage3DMaxWidth
```
public long getImage3DMaxWidth()
```
    Max width of 3D image in pixels.
    The minimum value is 2048 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.
  - getImage3DMaxHeight
```
public long getImage3DMaxHeight()
```
    Max height of 3D image in pixels.
    The minimum value is 2048 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.
  - getImage3DMaxDepth
```
public long getImage3DMaxDepth()
```
    Max depth of 3D image in pixels.
    The minimum value is 2048 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.
  - getMaxSamplers
```
public int getMaxSamplers()
```
    Maximum number of samplers that can be used in a kernel.
    Refer to section 6.11.8 for a detailed description on samplers.
    The minimum value is 16 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.
  - getMaxParameterSize
```
public long getMaxParameterSize()
```
    Max size in bytes of the arguments that can be passed to a kernel.
    The minimum value is 256.
  - getMemBaseAddrAlign
```
public int getMemBaseAddrAlign()
```
    Describes the alignment in bits of the base address of any allocated memory object.
  - getMinDataTypeAlign
```
public int getMinDataTypeAlign()
```
    The smallest alignment in bytes which can be used for any data type.
  - getSingleFPConfig
```
public EnumSet<CLDevice.FpConfig> getSingleFPConfig()
```
    Describes single precision floating- point capability of the device.
    The mandated minimum floating-point capability is: RoundToNearest and InfNaN.
  - getGlobalMemCacheType
```
public CLDevice.GlobalMemCacheType getGlobalMemCacheType()
```
    Type of global memory cache supported.
  - getGlobalMemCachelineSize
```
public int getGlobalMemCachelineSize()
```
    Size of global memory cache line in bytes.
  - getGlobalMemCacheSize
```
public long getGlobalMemCacheSize()
```
    Size of global memory cache in bytes.
  - getGlobalMemSize
```
public long getGlobalMemSize()
```
    Size of global device memory in bytes.
  - getMaxConstantBufferSize
```
public long getMaxConstantBufferSize()
```
    Max size in bytes of a constant buffer allocation.
    The minimum value is 64 KB.
  - getMaxConstantArgs
```
public int getMaxConstantArgs()
```
    Max number of arguments declared with the __constant qualifier in a kernel.
    The minimum value is 8.
  - getLocalMemType
```
public CLDevice.LocalMemType getLocalMemType()
```
    Type of local memory supported.
  - getLocalMemSize
```
public long getLocalMemSize()
```
    Size of local memory arena in bytes.
    The minimum value is 16 KB.
  - hasErrorCorrectionSupport
```
public boolean hasErrorCorrectionSupport()
```
    Is CL_TRUE if the device implements error correction for the memories, caches, registers etc. in the device.
    Is CL_FALSE if the device does not implement error correction.
    This can be a requirement for certain clients of OpenCL.
  - getPrintfBufferSize
```
public long getPrintfBufferSize()
```
    Maximum size of the internal buffer that holds the output of printf calls from a kernel. The minimum value for the FULL profile is 1 MB.
  - isPreferredInteropUserSync
```
public boolean isPreferredInteropUserSync()
```
    Is CL_TRUE if the device’s preference is for the user to be responsible for synchronization, when sharing memory objects between OpenCL and other APIs such as DirectX, CL_FALSE if the device / implementation has a performant path for performing synchronization of memory object shared between OpenCL and other APIs such as DirectX.
  - hasOutOfOrderQueueSupport
```
public boolean hasOutOfOrderQueueSupport()
```
  - getProfilingTimerResolution
```
public long getProfilingTimerResolution()
```
    Describes the resolution of device timer.
    This is measured in nanoseconds.
    Refer to section 5.9 for details.
  - isEndianLittle
```
public boolean isEndianLittle()
```
    Is CL_TRUE if the OpenCL device is a little endian device and CL_FALSE otherwise.
  - isAvailable
```
public boolean isAvailable()
```
    Is CL_TRUE if the device is available and CL_FALSE if the device is not available.
  - isCompilerAvailable
```
public boolean isCompilerAvailable()
```
    Is CL_FALSE if the implementation does not have a compiler available to compile the program source.
    Is CL_TRUE if the compiler is available.
    This can be CL_FALSE for the embededed platform profile only.
  - getName
```
public String getName()
```
    Device name string.
  - getOpenCLCVersion
```
public String getOpenCLCVersion()
```
    OpenCL C version string.
    Returns the highest OpenCL C version supported by the compiler for this device.
    This version string has the following format:
    OpenCL<space>C<space><major_version.minor_version><space><vendor-specific information>
    The major_version.minor_version value returned must be 1.1 if CL_DEVICE_VERSION is OpenCL 1.1.
    The major_version.minor_version value returned can be 1.0 or 1.1 if CL_DEVICE_VERSION is OpenCL 1.0.
    If OpenCL C 1.1 is returned, this implies that the language feature set defined in section 6 of the OpenCL 1.1 specification is supported by the OpenCL 1.0 device.
    
    Since:
    
    OpenCL 1.1
  - getOpenCLVersion
```
@Deprecated
public String getOpenCLVersion()
```
    Deprecated. Legacy typo, use getOpenCLCVersion() instead.
  - getVendor
```
public String getVendor()
```
    Vendor name string.
  - getDriverVersion
```
public String getDriverVersion()
```
    OpenCL software driver version string in the form major_number.minor_number.
  - getImageMaxArraySize
```
public long getImageMaxArraySize()
```
    TODO
  - getImageMaxBufferSize
```
public long getImageMaxBufferSize()
```
    TODO
  - getDoubleFpConfig
```
public EnumSet<CLDevice.FpConfig> getDoubleFpConfig()
```
    TODO
  - getHalfFpConfig
```
public EnumSet<CLDevice.FpConfig> getHalfFpConfig()
```
    TODO
  - isLinkerAvailable
```
public boolean isLinkerAvailable()
```
    TODO
  - getNativeVectorWidthHalf
```
public long getNativeVectorWidthHalf()
```
    TODO
  - getPartitionProperties
```
public EnumSet<CLDevice.PartitionType> getPartitionProperties()
```
    TODO
  - getPreferredVectorWidthHalf
```
public long getPreferredVectorWidthHalf()
```
    TODO
  - getReferenceCount
```
public long getReferenceCount()
```
    TODO
  - getPartitionAffinityDomain
```
public CLDevice.AffinityDomain getPartitionAffinityDomain()
```
    Affinity domain specified in createSubDevicesByAffinity(AffinityDomain), or null if the device is not a sub-device or wasn't split by affinity. This returns part of CL_DEVICE_PARTITION_TYPE.
  - getParent
```
public CLDevice getParent()
```
    Returns the cl_device_id of the parent device to which this sub-device belongs. If device is a root-level device, a NULL value is returned.
  - getProfile
```
public String getProfile()
```
    OpenCL profile string.
    Returns the profile name supported by the device.
    The profile name returned can be one of the following strings:
    - FULL_PROFILE if the device supports the OpenCL specification (functionality defined as part of the core specification and does not require any extensions to be supported).
    - EMBEDDED_PROFILE if the device supports the OpenCL embedded profile.
  - isHostUnifiedMemory
```
public boolean isHostUnifiedMemory()
```
    Whether the device and the host have a unified memory subsystem.
    
    Since:
    
    OpenCL 1.1
  - getPreferredVectorWidthChar
```
public int getPreferredVectorWidthChar()
```
    Preferred native vector width size for built-in scalar types that can be put into vectors.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_PREFERRED_VECTOR_WID TH_DOUBLE must return 0.
  - getPreferredVectorWidthShort
```
public int getPreferredVectorWidthShort()
```
    Preferred native vector width size for built-in scalar types that can be put into vectors.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_PREFERRED_VECTOR_WID TH_DOUBLE must return 0.
  - getPreferredVectorWidthInt
```
public int getPreferredVectorWidthInt()
```
    Preferred native vector width size for built-in scalar types that can be put into vectors.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_PREFERRED_VECTOR_WID TH_DOUBLE must return 0.
  - getPreferredVectorWidthLong
```
public int getPreferredVectorWidthLong()
```
    Preferred native vector width size for built-in scalar types that can be put into vectors.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_PREFERRED_VECTOR_WID TH_DOUBLE must return 0.
  - getPreferredVectorWidthFloat
```
public int getPreferredVectorWidthFloat()
```
    Preferred native vector width size for built-in scalar types that can be put into vectors.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_PREFERRED_VECTOR_WID TH_DOUBLE must return 0.
  - getPreferredVectorWidthDouble
```
public int getPreferredVectorWidthDouble()
```
    Preferred native vector width size for built-in scalar types that can be put into vectors.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_PREFERRED_VECTOR_WID TH_DOUBLE must return 0.
  - getNativeVectorWidthChar
```
public int getNativeVectorWidthChar()
```
    Returns the native ISA vector width.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_NATIVE_VECTOR_WID TH_DOUBLE must return 0.
  - getNativeVectorWidthShort
```
public int getNativeVectorWidthShort()
```
    Returns the native ISA vector width.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_NATIVE_VECTOR_WID TH_DOUBLE must return 0.
  - getNativeVectorWidthInt
```
public int getNativeVectorWidthInt()
```
    Returns the native ISA vector width.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_NATIVE_VECTOR_WID TH_DOUBLE must return 0.
  - getNativeVectorWidthLong
```
public int getNativeVectorWidthLong()
```
    Returns the native ISA vector width.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_NATIVE_VECTOR_WID TH_DOUBLE must return 0.
  - getNativeVectorWidthFloat
```
public int getNativeVectorWidthFloat()
```
    Returns the native ISA vector width.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_NATIVE_VECTOR_WID TH_DOUBLE must return 0.
  - getNativeVectorWidthDouble
```
public int getNativeVectorWidthDouble()
```
    Returns the native ISA vector width.
    The vector width is defined as the number of scalar elements that can be stored in the vector.
    If the cl_khr_fp64 extension is not supported, CL_DEVICE_NATIVE_VECTOR_WID TH_DOUBLE must return 0.
  - getVersion
```
public String getVersion()
```
    OpenCL version string.
    Returns the OpenCL version supported by the device.
    This version string has the following format: OpenCL<space><major_version.min or_version><space><vendor-specific information> The major_version.minor_version value returned will be 1.0.
  - getExtensions
```
public String[] getExtensions()
```
    List of extension names supported by the device. The list of extension names returned can be vendor supported extension names and one or more of the following Khronos approved extension names: - cl_khr_int64_base_atomics - cl_khr_int64_extended_atomics - cl_khr_fp16 - cl_khr_gl_sharing - cl_khr_gl_event - cl_khr_d3d10_sharing - cl_khr_dx9_media_sharing - cl_khr_d3d11_sharing The following approved Khronos extension names must be returned by all device that support OpenCL C 1.2: - cl_khr_global_int32_base_atomics - cl_khr_global_int32_extended_atomics - cl_khr_local_int32_base_atomics - cl_khr_local_int32_extended_atomics - cl_khr_byte_addressable_store - cl_khr_fp64 (for backward compatibility if double precision is supported) Please refer to the OpenCL 1.2 Extension Specification for a detailed description of these extensions.
  - hasExtension
```
public boolean hasExtension(String name)
```
  - getBuiltInKernels
```
public String[] getBuiltInKernels()
```
    List of built-in kernels supported by the device.
  - isDoubleSupported
```
public boolean isDoubleSupported()
```
    Whether this device support any double-precision number extension (cl_khr_fp64 or cl_amd_fp64)
  - isDoubleSupportedKHR
```
public boolean isDoubleSupportedKHR()
```
    Whether this device support the cl_khr_fp64 double-precision number extension
  - isDoubleSupportedAMD
```
public boolean isDoubleSupportedAMD()
```
    Whether this device supports the cl_amd_fp64 double-precision number extension
  - replaceDoubleExtensionByExtensionActuallyAvailable
```
public String replaceDoubleExtensionByExtensionActuallyAvailable(String kernelSource)
```
    If this device supports the extension cl_amd_fp64 but not cl_khr_fp64, replace any OpenCL source code pragma of the style #pragma OPENCL EXTENSION cl_khr_fp64 : enable by #pragma OPENCL EXTENSION cl_amd_fp64 : enable.
    Also works the other way around (if the KHR extension is available but the source code refers to the AMD extension).
    This method is called automatically by CLProgram unless the javacl.adjustDoubleExtension property is set to false or the JAVACL_ADJUST_DOUBLE_EXTENSION is set to 0.
  - isHalfSupported
```
public boolean isHalfSupported()
```
    Whether this device supports the cl_khr_fp16 extension.
  - isByteAddressableStoreSupported
```
public boolean isByteAddressableStoreSupported()
```
    Whether this device supports the cl_khr_byte_addressable_store extension.
  - isGLSharingSupported
```
public boolean isGLSharingSupported()
```
    Whether this device supports any OpenGL sharing extension (cl_khr_gl_sharing or cl_APPLE_gl_sharing)
  - isGlobalInt32BaseAtomicsSupported
```
public boolean isGlobalInt32BaseAtomicsSupported()
```
    Whether this device supports the cl_khr_global_int32_base_atomics extension.
  - isGlobalInt32ExtendedAtomicsSupported
```
public boolean isGlobalInt32ExtendedAtomicsSupported()
```
    Whether this device supports the cl_khr_global_int32_extended_atomics extension.
  - isLocalInt32BaseAtomicsSupported
```
public boolean isLocalInt32BaseAtomicsSupported()
```
    Whether this device supports the cl_khr_local_int32_base_atomics extension.
  - isLocalInt32ExtendedAtomicsSupported
```
public boolean isLocalInt32ExtendedAtomicsSupported()
```
    Whether this device supports the cl_khr_local_int32_extended_atomics extension.
  - getQueueProperties
```
public EnumSet<CLDevice.QueueProperties> getQueueProperties()
```
    Describes the command-queue properties supported by the device.
    These properties are described in table 5.1.
    The mandated minimum capability is: ProfilingEnable.
  - createSubDevicesEqually
```
public CLDevice[] createSubDevicesEqually(int computeUnitsForEverySubDevice)
```
    Creates an array of sub-devices that each reference a non-intersecting set of compute units within this device. Split the aggregate device into as many smaller aggregate devices as can be created, each containing n compute units. The value n is passed as the value accompanying this property. If n does not divide evenly into CL_DEVICE_PARTITION_MAX_COMPUTE_UNITS, then the remaining compute units are not used. Calls clCreateSubDevices.
    
    Parameters:
    
    computeUnitsForEverySubDevice - Count of compute units for every subdevice.
  - createSubDevicesByCounts
```
public CLDevice[] createSubDevicesByCounts(long... computeUnitsForEachSubDevice)
```
    Creates an array of sub-devices that each reference a non-intersecting set of compute units within this device. For each nonzero count m in the list, a sub-device is created with m compute units in it. The number of non-zero count entries in the list may not exceed CL_DEVICE_PARTITION_MAX_SUB_DEVICES. The total number of compute units specified may not exceed CL_DEVICE_PARTITION_MAX_COMPUTE_UNITS. Calls clCreateSubDevices.
    
    Parameters:
    
    computeUnitsForEachSubDevice - List of counts of compute units for each subdevice.
  - createSubDevicesByAffinity
```
public CLDevice[] createSubDevicesByAffinity(CLDevice.AffinityDomain affinityDomain)
```
    Creates an array of sub-devices that each reference a non-intersecting set of compute units within this device. Split the device into smaller aggregate devices containing one or more compute units that all share part of a cache hierarchy. The user may determine what happened by calling clGetDeviceInfo (CL_DEVICE_PARTITION_TYPE) on the sub-devices. Calls clCreateSubDevices.
    
    Parameters:
    
    affinityDomain - Affinity domain along which devices should be split.
  - release
```
public void release()
```
    Manual release of the OpenCL resources represented by this object.
    Note that resources are automatically released by the garbage collector, so in general there's no need to call this method.
    In an environment with fast allocation/deallocation of large objects, it might be safer to call release() manually, though.
    Note that release() does not necessarily free the object immediately : OpenCL maintains a reference count for all its objects, and an object released on the Java side might still be pointed to by running kernels or queued operations.
  - getEntities
```
public static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E> getEntities(A[] objects,
                                                                                                                    Pointer<E> out)
```
  - hashCode
```
public int hashCode()
```
    Underyling implementation pointer-based hashCode computation
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Underyling implementation pointer-based equality test
    
    Overrides:
    
    equals in class Object

Class CLDevice

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getPlatform

createSignature

getDevicesBySignature

getByteOrder

getKernelsDefaultByteOrder

getExecutionCapabilities

getType

getVendorId

getMaxComputeUnits

getMaxWorkItemDimensions

getMaxWorkItemSizes

getMaxWorkGroupSize

getMaxClockFrequency

getAddressBits

getMaxMemAllocSize

hasImageSupport

getMaxReadImageArgs

getMaxWriteImageArgs

toString

createQueue

createQueue

createOutOfOrderQueue

createProfilingQueue

getImage2DMaxWidth

getImage2DMaxHeight

getImage3DMaxWidth

getImage3DMaxHeight

getImage3DMaxDepth

getMaxSamplers

getMaxParameterSize

getMemBaseAddrAlign

getMinDataTypeAlign

getSingleFPConfig

getGlobalMemCacheType

getGlobalMemCachelineSize

getGlobalMemCacheSize

getGlobalMemSize

getMaxConstantBufferSize

getMaxConstantArgs

getLocalMemType

getLocalMemSize

hasErrorCorrectionSupport

getPrintfBufferSize

isPreferredInteropUserSync

hasOutOfOrderQueueSupport

getProfilingTimerResolution

isEndianLittle

isAvailable

isCompilerAvailable

getName

getOpenCLCVersion

getOpenCLVersion

getVendor

getDriverVersion

getImageMaxArraySize

getImageMaxBufferSize

getDoubleFpConfig

getHalfFpConfig

isLinkerAvailable

getNativeVectorWidthHalf

getPartitionProperties

getPreferredVectorWidthHalf

getReferenceCount

getPartitionAffinityDomain

getParent

getProfile

isHostUnifiedMemory

getPreferredVectorWidthChar

getPreferredVectorWidthShort

getPreferredVectorWidthInt

getPreferredVectorWidthLong

getPreferredVectorWidthFloat

getPreferredVectorWidthDouble

getNativeVectorWidthChar

getNativeVectorWidthShort