org.jocl.utils
Class DeviceInfos

java.lang.Object
  org.jocl.utils.DeviceInfos

public class DeviceInfos
extends java.lang.Object

Utility methods for obtaining information about cl_device_id objects

Method Summary

static int	getAddressBits(org.jocl.cl_device_id device) The default compute device address space size bits
static boolean	getAvailable(org.jocl.cl_device_id device) Whether the device is available
static boolean	getCompilerAvailable(org.jocl.cl_device_id device) Whether the implementation does have a compiler
static java.lang.String	getDeviceVersion(org.jocl.cl_device_id device) OpenCL version string
static java.lang.String	getDriverVersion(org.jocl.cl_device_id device) OpenCL software driver version string
static boolean	getEndianLittle(org.jocl.cl_device_id device) Whether the OpenCL device is a little endian device
static boolean	getErrorCorrectionSupport(org.jocl.cl_device_id device) Whether the device implements error correction
static long	getExecutionCapabilities(org.jocl.cl_device_id device) Describes the execution capabilities of the device
static java.lang.String	getExecutionCapabilitiesString(org.jocl.cl_device_id device) Describes the execution capabilities of the device as a String
static java.lang.String	getExtensions(org.jocl.cl_device_id device) A space-separated list of extension names
static int	getGlobalMemCachelineSize(org.jocl.cl_device_id device) Size of global memory cache line in bytes
static long	getGlobalMemCacheSize(org.jocl.cl_device_id device) Size of global memory cache in bytes
static long	getGlobalMemCacheType(org.jocl.cl_device_id device) Type of global memory cache supported
static long	getGlobalMemSize(org.jocl.cl_device_id device) Size of global device memory in bytes
static boolean	getHostUnifiedMemory(org.jocl.cl_device_id device) Whether device and host have a unified memory subsystem
static long	getImage2dMaxHeight(org.jocl.cl_device_id device) Max height of 2D image in pixels
static long	getImage2dMaxWidth(org.jocl.cl_device_id device) Max width of 2D image in pixels
static long	getImage3dMaxDepth(org.jocl.cl_device_id device) Max depth of 3D image in pixels
static long	getImage3dMaxHeight(org.jocl.cl_device_id device) Max height of 3D image in pixels
static long	getImage3dMaxWidth(org.jocl.cl_device_id device) Max width of 3D image in pixels
static boolean	getImageSupport(org.jocl.cl_device_id device) Whether images are supported by the OpenCL device
static long	getLocalMemSize(org.jocl.cl_device_id device) Size of local memory arena in bytes
static long	getLocalMemType(org.jocl.cl_device_id device) Type of local memory supported
static java.lang.String	getLocalMemTypeString(org.jocl.cl_device_id device) Type of local memory supported as a String
static int	getMaxClockFrequency(org.jocl.cl_device_id device) Maximum configured clock frequency in MHz
static int	getMaxComputeUnits(org.jocl.cl_device_id device) The number of parallel compute cores
static int	getMaxConstantArgs(org.jocl.cl_device_id device) Max number of __constant kernel arguments
static long	getMaxConstantBufferSize(org.jocl.cl_device_id device) Max size in bytes of a constant buffer allocation
static long	getMaxMemAllocSize(org.jocl.cl_device_id device) Max size of memory object allocation in bytes
static long	getMaxParameterSize(org.jocl.cl_device_id device) Max size in bytes of the kernel arguments
static int	getMaxReadImageArgs(org.jocl.cl_device_id device) Max number of simultaneous image objects that can be read by a kernel
static int	getMaxSamplers(org.jocl.cl_device_id device) Maximum number of samplers that can be used in a kernel
static long	getMaxWorkGroupSize(org.jocl.cl_device_id device) Maximum number of work-items in a work-group
static int	getMaxWorkItemDimensions(org.jocl.cl_device_id device) Maximum dimensions that specify the global and local work-item IDs
static long[]	getMaxWorkItemSizes(org.jocl.cl_device_id device) Maximum number of work-items for each dimension
static int	getMaxWriteImageArgs(org.jocl.cl_device_id device) Max number of simultaneous image objects that can be written to by a kernel
static int	getMemBaseAddrAlign(org.jocl.cl_device_id device) Describes the alignment in bits of memory objects
static int	getMinDataTypeAlignSize(org.jocl.cl_device_id device) The smallest alignment in bytes which can be used for any data type
static java.lang.String	getName(org.jocl.cl_device_id device) Device name string
static int	getNativeVectorWidthChar(org.jocl.cl_device_id device) Native ISA vector width (char)
static int	getNativeVectorWidthDouble(org.jocl.cl_device_id device) Native ISA vector width (double)
static int	getNativeVectorWidthFloat(org.jocl.cl_device_id device) Native ISA vector width (float)
static int	getNativeVectorWidthHalf(org.jocl.cl_device_id device) Native ISA vector width (half)
static int	getNativeVectorWidthInt(org.jocl.cl_device_id device) Native ISA vector width (int)
static int	getNativeVectorWidthLong(org.jocl.cl_device_id device) Native ISA vector width (long)
static int	getNativeVectorWidthShort(org.jocl.cl_device_id device) Native ISA vector width (short)
static java.lang.String	getOpenclCVersion(org.jocl.cl_device_id device) The highest OpenCL C version supported by the compiler
static int	getPreferredVectorWidthChar(org.jocl.cl_device_id device) Preferred native vector width (char)
static int	getPreferredVectorWidthDouble(org.jocl.cl_device_id device) Preferred native vector width (double)
static int	getPreferredVectorWidthFloat(org.jocl.cl_device_id device) Preferred native vector width (float)
static int	getPreferredVectorWidthHalf(org.jocl.cl_device_id device) Preferred native vector width (half)
static int	getPreferredVectorWidthInt(org.jocl.cl_device_id device) Preferred native vector width (int)
static int	getPreferredVectorWidthLong(org.jocl.cl_device_id device) Preferred native vector width (long)
static int	getPreferredVectorWidthShort(org.jocl.cl_device_id device) Preferred native vector width (short)
static java.lang.String	getProfile(org.jocl.cl_device_id device) OpenCL profile string
static long	getProfilingTimerResolution(org.jocl.cl_device_id device) The resolution of device timer in nanoseconds
static long	getQueueProperties(org.jocl.cl_device_id device) The supported command-queue properties
static java.lang.String	getQueuePropertiesString(org.jocl.cl_device_id device) The supported command-queue properties as a String
static long	getSingleFpConfig(org.jocl.cl_device_id device) Single precision floating-point capability
static java.lang.String	getSingleFpConfigString(org.jocl.cl_device_id device) Single precision floating-point capability as a String
static long	getType(org.jocl.cl_device_id device) The OpenCL device type
static java.lang.String	getTypeString(org.jocl.cl_device_id device) The OpenCL device type as a String
static java.lang.String	getVendor(org.jocl.cl_device_id device) Vendor name string
static int	getVendorId(org.jocl.cl_device_id device) A unique device vendor identifier

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public static java.lang.String getName(org.jocl.cl_device_id device)

Device name string

Parameters:

device - The device

Returns:

The value

getVendor

public static java.lang.String getVendor(org.jocl.cl_device_id device)

Vendor name string

Parameters:

device - The device

Returns:

The value

getVendorId

public static int getVendorId(org.jocl.cl_device_id device)

A unique device vendor identifier

Parameters:

device - The device

Returns:

The value

getType

public static long getType(org.jocl.cl_device_id device)

The OpenCL device type

Parameters:

device - The device

Returns:

The value

getTypeString

public static java.lang.String getTypeString(org.jocl.cl_device_id device)

The OpenCL device type as a String

Parameters:

device - The device

Returns:

The value

getDeviceVersion

public static java.lang.String getDeviceVersion(org.jocl.cl_device_id device)

OpenCL version string

Parameters:

device - The device

Returns:

The value

getDriverVersion

public static java.lang.String getDriverVersion(org.jocl.cl_device_id device)

OpenCL software driver version string

Parameters:

device - The device

Returns:

The value

getProfile

public static java.lang.String getProfile(org.jocl.cl_device_id device)

OpenCL profile string

Parameters:

device - The device

Returns:

The value

getMaxClockFrequency

public static int getMaxClockFrequency(org.jocl.cl_device_id device)

Maximum configured clock frequency in MHz

Parameters:

device - The device

Returns:

The value

getMaxComputeUnits

public static int getMaxComputeUnits(org.jocl.cl_device_id device)

The number of parallel compute cores

Parameters:

device - The device

Returns:

The value

getAvailable

public static boolean getAvailable(org.jocl.cl_device_id device)

Whether the device is available

Parameters:

device - The device

Returns:

The value

getAddressBits

public static int getAddressBits(org.jocl.cl_device_id device)

The default compute device address space size bits

Parameters:

device - The device

Returns:

The value

getEndianLittle

public static boolean getEndianLittle(org.jocl.cl_device_id device)

Whether the OpenCL device is a little endian device

Parameters:

device - The device

Returns:

The value

getCompilerAvailable

public static boolean getCompilerAvailable(org.jocl.cl_device_id device)

Whether the implementation does have a compiler

Parameters:

device - The device

Returns:

The value

getOpenclCVersion

public static java.lang.String getOpenclCVersion(org.jocl.cl_device_id device)

The highest OpenCL C version supported by the compiler

Parameters:

device - The device

Returns:

The value

getErrorCorrectionSupport

public static boolean getErrorCorrectionSupport(org.jocl.cl_device_id device)

Whether the device implements error correction

Parameters:

device - The device

Returns:

The value

getExecutionCapabilities

public static long getExecutionCapabilities(org.jocl.cl_device_id device)

Describes the execution capabilities of the device

Parameters:

device - The device

Returns:

The value

getExecutionCapabilitiesString

public static java.lang.String getExecutionCapabilitiesString(org.jocl.cl_device_id device)

Describes the execution capabilities of the device as a String

Parameters:

device - The device

Returns:

The value

getExtensions

public static java.lang.String getExtensions(org.jocl.cl_device_id device)

A space-separated list of extension names

Parameters:

device - The device

Returns:

The value

getHostUnifiedMemory

public static boolean getHostUnifiedMemory(org.jocl.cl_device_id device)

Whether device and host have a unified memory subsystem

Parameters:

device - The device

Returns:

The value

getProfilingTimerResolution

public static long getProfilingTimerResolution(org.jocl.cl_device_id device)

The resolution of device timer in nanoseconds

Parameters:

device - The device

Returns:

The value

getQueueProperties

public static long getQueueProperties(org.jocl.cl_device_id device)

The supported command-queue properties

Parameters:

device - The device

Returns:

The value

getQueuePropertiesString

public static java.lang.String getQueuePropertiesString(org.jocl.cl_device_id device)

The supported command-queue properties as a String

Parameters:

device - The device

Returns:

The value

getSingleFpConfig

public static long getSingleFpConfig(org.jocl.cl_device_id device)

Single precision floating-point capability

Parameters:

device - The device

Returns:

The value

getSingleFpConfigString

public static java.lang.String getSingleFpConfigString(org.jocl.cl_device_id device)

Single precision floating-point capability as a String

Parameters:

device - The device

Returns:

The value

getGlobalMemCacheSize

public static long getGlobalMemCacheSize(org.jocl.cl_device_id device)

Size of global memory cache in bytes

Parameters:

device - The device

Returns:

The value

getGlobalMemCacheType

public static long getGlobalMemCacheType(org.jocl.cl_device_id device)

Type of global memory cache supported

Parameters:

device - The device

Returns:

The value

getGlobalMemCachelineSize

public static int getGlobalMemCachelineSize(org.jocl.cl_device_id device)

Size of global memory cache line in bytes

Parameters:

device - The device

Returns:

The value

getGlobalMemSize

public static long getGlobalMemSize(org.jocl.cl_device_id device)

Size of global device memory in bytes

Parameters:

device - The device

Returns:

The value

getImageSupport

public static boolean getImageSupport(org.jocl.cl_device_id device)

Whether images are supported by the OpenCL device

Parameters:

device - The device

Returns:

The value

getImage2dMaxHeight

public static long getImage2dMaxHeight(org.jocl.cl_device_id device)

Max height of 2D image in pixels

Parameters:

device - The device

Returns:

The value

getImage2dMaxWidth

public static long getImage2dMaxWidth(org.jocl.cl_device_id device)

Max width of 2D image in pixels

Parameters:

device - The device

Returns:

The value

getImage3dMaxDepth

public static long getImage3dMaxDepth(org.jocl.cl_device_id device)

Max depth of 3D image in pixels

Parameters:

device - The device

Returns:

The value

getImage3dMaxHeight

public static long getImage3dMaxHeight(org.jocl.cl_device_id device)

Max height of 3D image in pixels

Parameters:

device - The device

Returns:

The value

getImage3dMaxWidth

public static long getImage3dMaxWidth(org.jocl.cl_device_id device)

Max width of 3D image in pixels

Parameters:

device - The device

Returns:

The value

getLocalMemSize

public static long getLocalMemSize(org.jocl.cl_device_id device)

Size of local memory arena in bytes

Parameters:

device - The device

Returns:

The value

getLocalMemType

public static long getLocalMemType(org.jocl.cl_device_id device)

Type of local memory supported

Parameters:

device - The device

Returns:

The value

getLocalMemTypeString

public static java.lang.String getLocalMemTypeString(org.jocl.cl_device_id device)

Type of local memory supported as a String

Parameters:

device - The device

Returns:

The value

getMaxConstantArgs

public static int getMaxConstantArgs(org.jocl.cl_device_id device)

Max number of __constant kernel arguments

Parameters:

device - The device

Returns:

The value

getMaxConstantBufferSize

public static long getMaxConstantBufferSize(org.jocl.cl_device_id device)

Max size in bytes of a constant buffer allocation

Parameters:

device - The device

Returns:

The value

getMaxMemAllocSize

public static long getMaxMemAllocSize(org.jocl.cl_device_id device)

Max size of memory object allocation in bytes

Parameters:

device - The device

Returns:

The value

getMaxParameterSize

public static long getMaxParameterSize(org.jocl.cl_device_id device)

Max size in bytes of the kernel arguments

Parameters:

device - The device

Returns:

The value

getMaxReadImageArgs

public static int getMaxReadImageArgs(org.jocl.cl_device_id device)

Max number of simultaneous image objects that can be read by a kernel

Parameters:

device - The device

Returns:

The value

getMaxSamplers

public static int getMaxSamplers(org.jocl.cl_device_id device)

Maximum number of samplers that can be used in a kernel

Parameters:

device - The device

Returns:

The value

getMaxWorkGroupSize

public static long getMaxWorkGroupSize(org.jocl.cl_device_id device)

Maximum number of work-items in a work-group

Parameters:

device - The device

Returns:

The value

getMaxWorkItemDimensions

public static int getMaxWorkItemDimensions(org.jocl.cl_device_id device)

Maximum dimensions that specify the global and local work-item IDs

Parameters:

device - The device

Returns:

The value

getMaxWorkItemSizes

public static long[] getMaxWorkItemSizes(org.jocl.cl_device_id device)

Maximum number of work-items for each dimension

Parameters:

device - The device

Returns:

The value

getMaxWriteImageArgs

public static int getMaxWriteImageArgs(org.jocl.cl_device_id device)

Max number of simultaneous image objects that can be written to by a kernel

Parameters:

device - The device

Returns:

The value

getMemBaseAddrAlign

public static int getMemBaseAddrAlign(org.jocl.cl_device_id device)

Describes the alignment in bits of memory objects

Parameters:

device - The device

Returns:

The value

getMinDataTypeAlignSize

public static int getMinDataTypeAlignSize(org.jocl.cl_device_id device)

The smallest alignment in bytes which can be used for any data type

Parameters:

device - The device

Returns:

The value

getNativeVectorWidthChar

public static int getNativeVectorWidthChar(org.jocl.cl_device_id device)

Native ISA vector width (char)

Parameters:

device - The device

Returns:

The value

getNativeVectorWidthShort

public static int getNativeVectorWidthShort(org.jocl.cl_device_id device)

Native ISA vector width (short)

Parameters:

device - The device

Returns:

The value

getNativeVectorWidthInt

public static int getNativeVectorWidthInt(org.jocl.cl_device_id device)

Native ISA vector width (int)

Parameters:

device - The device

Returns:

The value

getNativeVectorWidthLong

public static int getNativeVectorWidthLong(org.jocl.cl_device_id device)

Native ISA vector width (long)

Parameters:

device - The device

Returns:

The value

getNativeVectorWidthFloat

public static int getNativeVectorWidthFloat(org.jocl.cl_device_id device)

Native ISA vector width (float)

Parameters:

device - The device

Returns:

The value

getNativeVectorWidthDouble

public static int getNativeVectorWidthDouble(org.jocl.cl_device_id device)

Native ISA vector width (double)

Parameters:

device - The device

Returns:

The value

getNativeVectorWidthHalf

public static int getNativeVectorWidthHalf(org.jocl.cl_device_id device)

Native ISA vector width (half)

Parameters:

device - The device

Returns:

The value

getPreferredVectorWidthChar

public static int getPreferredVectorWidthChar(org.jocl.cl_device_id device)

Preferred native vector width (char)

Parameters:

device - The device

Returns:

The value

getPreferredVectorWidthShort

public static int getPreferredVectorWidthShort(org.jocl.cl_device_id device)

Preferred native vector width (short)

Parameters:

device - The device

Returns:

The value

getPreferredVectorWidthInt

public static int getPreferredVectorWidthInt(org.jocl.cl_device_id device)

Preferred native vector width (int)

Parameters:

device - The device

Returns:

The value

getPreferredVectorWidthLong

public static int getPreferredVectorWidthLong(org.jocl.cl_device_id device)

Preferred native vector width (long)

Parameters:

device - The device

Returns:

The value

getPreferredVectorWidthFloat

public static int getPreferredVectorWidthFloat(org.jocl.cl_device_id device)

Preferred native vector width (float)

Parameters:

device - The device

Returns:

The value

getPreferredVectorWidthDouble

public static int getPreferredVectorWidthDouble(org.jocl.cl_device_id device)

Preferred native vector width (double)

Parameters:

device - The device

Returns:

The value

getPreferredVectorWidthHalf

public static int getPreferredVectorWidthHalf(org.jocl.cl_device_id device)

Preferred native vector width (half)

Parameters:

device - The device

Returns:

The value