JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
com.jogamp.opencl.CLDevice Class Reference

This object represents an OpenCL device. More...

Inheritance diagram for com.jogamp.opencl.CLDevice:
Collaboration diagram for com.jogamp.opencl.CLDevice:

Classes

enum  Capabilities
 Enumeration for the execution capabilities of the device. More...
 
enum  FPConfig
 Describes floating-point capability of the device. More...
 
enum  GlobalMemCacheType
 Type of global memory cache supported. More...
 
enum  LocalMemType
 Type of local memory cache supported. More...
 
enum  Type
 Enumeration for the type of a device. More...
 

Public Member Functions

CLCommandQueue createCommandQueue ()
 
CLCommandQueue createCommandQueue (final CLCommandQueue.Mode property)
 
CLCommandQueue createCommandQueue (final CLCommandQueue.Mode... properties)
 
CLCommandQueue createCommandQueue (final long properties)
 
CLPlatform getPlatform ()
 Returns the platform for this OpenCL object. More...
 
String getName ()
 Returns the name of this device. More...
 
String getProfile ()
 Returns the OpenCL profile of this device. More...
 
String getVendor ()
 Returns the vendor of this device. More...
 
long getVendorID ()
 Returns the vendor id of this device. More...
 
CLVersion getVersion ()
 Returns the OpenCL version supported by the device. More...
 
CLVersion getCVersion ()
 Returns the OpenCL-C version supported by the device. More...
 
String getDriverVersion ()
 Returns OpenCL software driver version string in the form major_number.minor_number. More...
 
Type getType ()
 Returns the type of this device. More...
 
int getAddressBits ()
 The default compute device address space size specified in bits. More...
 
int getPreferredShortVectorWidth ()
 Preferred native vector width size for built-in short vectors. More...
 
int getPreferredCharVectorWidth ()
 Preferred native vector width size for built-in char vectors. More...
 
int getPreferredIntVectorWidth ()
 Preferred native vector width size for built-in int vectors. More...
 
int getPreferredLongVectorWidth ()
 Preferred native vector width size for built-in long vectors. More...
 
int getPreferredFloatVectorWidth ()
 Preferred native vector width size for built-in float vectors. More...
 
int getPreferredDoubleVectorWidth ()
 Preferred native vector width size for built-in double vectors. More...
 
int getNativeCharVectorWidth ()
 Native vector width size for built-in char vectors. More...
 
int getNativeShortVectorWidth ()
 Native vector width size for built-in short vectors. More...
 
int getNativeIntVectorWidth ()
 Native vector width size for built-in int vectors. More...
 
int getNativeLongVectorWidth ()
 Native vector width size for built-in long vectors. More...
 
int getNativeHalfVectorWidth ()
 Native vector width size for built-in half vectors. More...
 
int getNativeFloatVectorWidth ()
 Native vector width size for built-in float vectors. More...
 
int getNativeDoubleVectorWidth ()
 Native vector width size for built-in double vectors. More...
 
int getMaxComputeUnits ()
 Returns the number of parallel compute cores on the OpenCL device. More...
 
int getMaxWorkGroupSize ()
 Returns the maximum number of work-items in a work-group executing a kernel using the data parallel execution model. More...
 
int getMaxClockFrequency ()
 Returns the maximum configured clock frequency of the device in MHz. More...
 
int getMaxWorkItemDimensions ()
 Returns the maximum dimensions that specify the global and local work-item IDs used by the data parallel execution model. More...
 
int[] getMaxWorkItemSizes ()
 Returns the maximum number of work-items that can be specified in each dimension of the work-group. More...
 
long getMaxParameterSize ()
 Returns the max size in bytes of the arguments that can be passed to a kernel. More...
 
long getMaxMemAllocSize ()
 Returns the largest allocatable size of a CLBuffer on this device. More...
 
long getMemBaseAddrAlign ()
 Returns the uint32_t memory base address alignment value reinterpreted as a long value. More...
 
long getGlobalMemSize ()
 Returns the global memory size in bytes. More...
 
long getLocalMemSize ()
 Returns the local memory size in bytes. More...
 
boolean isMemoryUnified ()
 Returns true if the device and the host have a unified memory subsystem. More...
 
long getMaxConstantBufferSize ()
 Returns the max size in bytes of a constant buffer allocation. More...
 
long getGlobalMemCachelineSize ()
 Returns the size of global memory cache line in bytes. More...
 
long getGlobalMemCacheSize ()
 Returns the size of global memory cache in bytes. More...
 
long getMaxConstantArgs ()
 Returns the max number of arguments declared with the constant qualifier in a kernel. More...
 
boolean isImageSupportAvailable ()
 Returns true if images are supported by the OpenCL device and false otherwise. More...
 
int getMaxReadImageArgs ()
 Returns the max number of simultaneous image objects that can be read by a kernel. More...
 
int getMaxWriteImageArgs ()
 Returns the max number of simultaneous image objects that can be written by a kernel. More...
 
int getMaxImage2dWidth ()
 Returns the max width of 2D image in pixels. More...
 
int getMaxImage2dHeight ()
 Returns the max height of 2D image in pixels. More...
 
int getMaxImage3dWidth ()
 Returns the max width of 3D image in pixels. More...
 
int getMaxImage3dHeight ()
 Returns the max height of 3D image in pixels. More...
 
int getMaxImage3dDepth ()
 Returns the max depth of 3D image in pixels. More...
 
int getMaxSamplers ()
 Returns the maximum number of samplers that can be used in a kernel. More...
 
long getProfilingTimerResolution ()
 Returns the resolution of device timer. More...
 
EnumSet< CapabilitiesgetExecutionCapabilities ()
 Returns the execution capabilities as EnumSet. More...
 
EnumSet< FPConfiggetHalfFPConfig ()
 Returns the optional half precision floating-point capability of the device. More...
 
EnumSet< FPConfiggetSingleFPConfig ()
 Returns the single precision floating-point capability of the device. More...
 
EnumSet< FPConfiggetDoubleFPConfig ()
 Returns the optional double precision floating-point capability of the device. More...
 
LocalMemType getLocalMemType ()
 Returns the local memory type. More...
 
GlobalMemCacheType getGlobalMemCacheType ()
 Returns the type of global memory cache supported. More...
 
EnumSet< CLCommandQueue.Mode > getQueueProperties ()
 Returns the command-queue properties supported by the device. More...
 
boolean isAvailable ()
 Returns true if this device is available. More...
 
boolean isCompilerAvailable ()
 Returns false if the implementation does not have a compiler available to compile the program source. More...
 
boolean isLittleEndian ()
 Returns true if the OpenCL device is a little endian device and false otherwise. More...
 
boolean isErrorCorrectionSupported ()
 Returns true if the device implements error correction for the memories, caches, registers etc. More...
 
boolean isHalfFPAvailable ()
 Returns isExtensionAvailable("cl_khr_fp16"). More...
 
boolean isDoubleFPAvailable ()
 Returns isExtensionAvailable("cl_khr_fp64"). More...
 
boolean isICDAvailable ()
 Returns isExtensionAvailable("cl_khr_icd"). More...
 
boolean isGLMemorySharingSupported ()
 Returns isExtensionAvailable("cl_khr_gl_sharing") || isExtensionAvailable("cl_APPLE_gl_sharing"). More...
 
boolean isExtensionAvailable (final String extension)
 Returns true if the extension is supported on this device. More...
 
ByteOrder getByteOrder ()
 Returns ByteOrder#LITTLE_ENDIAN or ByteOrder#BIG_ENDIAN. More...
 
Set< String > getExtensions ()
 Returns all device extension names as unmodifiable Set. More...
 
Map< String, String > getProperties ()
 Returns a Map of device properties with the enum names as keys. More...
 
final CLInfoAccessor getCLAccessor ()
 
String toString ()
 
boolean equals (final Object obj)
 
int hashCode ()
 
- Public Member Functions inherited from com.jogamp.opencl.CLObject
CLContext getContext ()
 Returns the context for this OpenCL object. More...
 
CLPlatform getPlatform ()
 Returns the platform for this OpenCL object. More...
 
long getID ()
 Returns the OpenCL object handle. More...
 
String toString ()
 

Protected Member Functions

 CLDevice (final CLPlatform platform, final long id)
 
 CLDevice (final CLContext context, final long id)
 

Additional Inherited Members

- Public Attributes inherited from com.jogamp.opencl.CLObject
final long ID
 The OpenCL object handle. More...
 
- Protected Attributes inherited from com.jogamp.opencl.CLObject
CLContext context
 

Detailed Description

Constructor & Destructor Documentation

◆ CLDevice() [1/2]

com.jogamp.opencl.CLDevice.CLDevice ( final CLPlatform  platform,
final long  id 
)
protected

Definition at line 60 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CLDevice() [2/2]

com.jogamp.opencl.CLDevice.CLDevice ( final CLContext  context,
final long  id 
)
protected

Definition at line 66 of file CLDevice.java.

Here is the call graph for this function:

Member Function Documentation

◆ createCommandQueue() [1/4]

CLCommandQueue com.jogamp.opencl.CLDevice.createCommandQueue ( )

Definition at line 72 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ createCommandQueue() [2/4]

CLCommandQueue com.jogamp.opencl.CLDevice.createCommandQueue ( final CLCommandQueue.Mode  property)

Definition at line 76 of file CLDevice.java.

Here is the call graph for this function:

◆ createCommandQueue() [3/4]

CLCommandQueue com.jogamp.opencl.CLDevice.createCommandQueue ( final CLCommandQueue.Mode...  properties)

Definition at line 80 of file CLDevice.java.

Here is the call graph for this function:

◆ createCommandQueue() [4/4]

CLCommandQueue com.jogamp.opencl.CLDevice.createCommandQueue ( final long  properties)

Definition at line 90 of file CLDevice.java.

◆ equals()

boolean com.jogamp.opencl.CLDevice.equals ( final Object  obj)

Definition at line 725 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAddressBits()

int com.jogamp.opencl.CLDevice.getAddressBits ( )

The default compute device address space size specified in bits.

Currently supported values are 32 or 64 bits.

Definition at line 175 of file CLDevice.java.

Here is the call graph for this function:

◆ getByteOrder()

ByteOrder com.jogamp.opencl.CLDevice.getByteOrder ( )

Returns ByteOrder#LITTLE_ENDIAN or ByteOrder#BIG_ENDIAN.

Definition at line 676 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getCLAccessor()

final CLInfoAccessor com.jogamp.opencl.CLDevice.getCLAccessor ( )

Definition at line 712 of file CLDevice.java.

◆ getCVersion()

CLVersion com.jogamp.opencl.CLDevice.getCVersion ( )

Returns the OpenCL-C version supported by the device.

Definition at line 150 of file CLDevice.java.

Here is the call graph for this function:

◆ getDoubleFPConfig()

EnumSet< FPConfig > com.jogamp.opencl.CLDevice.getDoubleFPConfig ( )

Returns the optional double precision floating-point capability of the device.

The mandated minimum double precision floating-point capabilities are FPConfig#FMA, FPConfig#ROUND_TO_NEAREST, FPConfig#ROUND_TO_ZERO, FPConfig#ROUND_TO_INF, FPConfig#INF_NAN, and FPConfig#DENORM.

Returns
An EnumSet containing the extensions, never null.

Definition at line 561 of file CLDevice.java.

Here is the call graph for this function:

◆ getDriverVersion()

String com.jogamp.opencl.CLDevice.getDriverVersion ( )

Returns OpenCL software driver version string in the form major_number.minor_number.

Definition at line 158 of file CLDevice.java.

Here is the call graph for this function:

◆ getExecutionCapabilities()

EnumSet< Capabilities > com.jogamp.opencl.CLDevice.getExecutionCapabilities ( )

Returns the execution capabilities as EnumSet.

Definition at line 523 of file CLDevice.java.

Here is the call graph for this function:

◆ getExtensions()

Set< String > com.jogamp.opencl.CLDevice.getExtensions ( )

Returns all device extension names as unmodifiable Set.

Definition at line 688 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getGlobalMemCachelineSize()

long com.jogamp.opencl.CLDevice.getGlobalMemCachelineSize ( )

Returns the size of global memory cache line in bytes.

Definition at line 410 of file CLDevice.java.

Here is the call graph for this function:

◆ getGlobalMemCacheSize()

long com.jogamp.opencl.CLDevice.getGlobalMemCacheSize ( )

Returns the size of global memory cache in bytes.

Definition at line 418 of file CLDevice.java.

Here is the call graph for this function:

◆ getGlobalMemCacheType()

GlobalMemCacheType com.jogamp.opencl.CLDevice.getGlobalMemCacheType ( )

Returns the type of global memory cache supported.

Definition at line 580 of file CLDevice.java.

Here is the call graph for this function:

◆ getGlobalMemSize()

long com.jogamp.opencl.CLDevice.getGlobalMemSize ( )

Returns the global memory size in bytes.

Definition at line 375 of file CLDevice.java.

Here is the call graph for this function:

◆ getHalfFPConfig()

EnumSet< FPConfig > com.jogamp.opencl.CLDevice.getHalfFPConfig ( )

Returns the optional half precision floating-point capability of the device.

The required minimum half precision floating-point capabilities as implemented by this extension are FPConfig#ROUND_TO_ZERO, FPConfig#ROUND_TO_INF and FPConfig#INF_NAN.

Returns
An EnumSet containing the extensions, never null.

Definition at line 535 of file CLDevice.java.

Here is the call graph for this function:

◆ getLocalMemSize()

long com.jogamp.opencl.CLDevice.getLocalMemSize ( )

Returns the local memory size in bytes.


The minimum OpenCL 1.0 value is 16 KB.
The minimum OpenCL 1.1 value is 32 KB.

Definition at line 385 of file CLDevice.java.

Here is the call graph for this function:

◆ getLocalMemType()

LocalMemType com.jogamp.opencl.CLDevice.getLocalMemType ( )

Returns the local memory type.

Definition at line 572 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxClockFrequency()

int com.jogamp.opencl.CLDevice.getMaxClockFrequency ( )

Returns the maximum configured clock frequency of the device in MHz.

Definition at line 319 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxComputeUnits()

int com.jogamp.opencl.CLDevice.getMaxComputeUnits ( )

Returns the number of parallel compute cores on the OpenCL device.

The minimum value is 1.

Definition at line 301 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxConstantArgs()

long com.jogamp.opencl.CLDevice.getMaxConstantArgs ( )

Returns the max number of arguments declared with the constant qualifier in a kernel.

The minimum value is 8.

Definition at line 427 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxConstantBufferSize()

long com.jogamp.opencl.CLDevice.getMaxConstantBufferSize ( )

Returns the max size in bytes of a constant buffer allocation.

The minimum value is 64 KB.

Definition at line 402 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxImage2dHeight()

int com.jogamp.opencl.CLDevice.getMaxImage2dHeight ( )

Returns the max height of 2D image in pixels.

The minimum value is 8192 if image support is available.

Definition at line 471 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxImage2dWidth()

int com.jogamp.opencl.CLDevice.getMaxImage2dWidth ( )

Returns the max width of 2D image in pixels.

The minimum value is 8192 if image support is available.

Definition at line 462 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxImage3dDepth()

int com.jogamp.opencl.CLDevice.getMaxImage3dDepth ( )

Returns the max depth of 3D image in pixels.

The minimum value is 2048 if image support is available.

Definition at line 498 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxImage3dHeight()

int com.jogamp.opencl.CLDevice.getMaxImage3dHeight ( )

Returns the max height of 3D image in pixels.

The minimum value is 2048 if image support is available.

Definition at line 489 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxImage3dWidth()

int com.jogamp.opencl.CLDevice.getMaxImage3dWidth ( )

Returns the max width of 3D image in pixels.

The minimum value is 2048 if image support is available.

Definition at line 480 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxMemAllocSize()

long com.jogamp.opencl.CLDevice.getMaxMemAllocSize ( )

Returns the largest allocatable size of a CLBuffer on this device.

Definition at line 358 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxParameterSize()

long com.jogamp.opencl.CLDevice.getMaxParameterSize ( )

Returns the max size in bytes of the arguments that can be passed to a kernel.


The minimum OpenCL 1.0 value is 256.
The minimum OpenCL 1.1 value is 1024.

Definition at line 350 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxReadImageArgs()

int com.jogamp.opencl.CLDevice.getMaxReadImageArgs ( )

Returns the max number of simultaneous image objects that can be read by a kernel.

The minimum value is 128 if image support is available.

Definition at line 444 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxSamplers()

int com.jogamp.opencl.CLDevice.getMaxSamplers ( )

Returns the maximum number of samplers that can be used in a kernel.

The minimum value is 16 if image support is available.

Definition at line 507 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxWorkGroupSize()

int com.jogamp.opencl.CLDevice.getMaxWorkGroupSize ( )

Returns the maximum number of work-items in a work-group executing a kernel using the data parallel execution model.

The minimum value is 1.

Definition at line 311 of file CLDevice.java.

Here is the call graph for this function:

◆ getMaxWorkItemDimensions()

int com.jogamp.opencl.CLDevice.getMaxWorkItemDimensions ( )

Returns the maximum dimensions that specify the global and local work-item IDs used by the data parallel execution model.

The minimum value is 3.

Definition at line 329 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getMaxWorkItemSizes()

int[] com.jogamp.opencl.CLDevice.getMaxWorkItemSizes ( )

Returns the maximum number of work-items that can be specified in each dimension of the work-group.

The minimum value is (1, 1, 1).

Definition at line 339 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getMaxWriteImageArgs()

int com.jogamp.opencl.CLDevice.getMaxWriteImageArgs ( )

Returns the max number of simultaneous image objects that can be written by a kernel.

The minimum value is 8 if image support is available.

Definition at line 453 of file CLDevice.java.

Here is the call graph for this function:

◆ getMemBaseAddrAlign()

long com.jogamp.opencl.CLDevice.getMemBaseAddrAlign ( )

Returns the uint32_t memory base address alignment value reinterpreted as a long value.

Definition at line 367 of file CLDevice.java.

Here is the call graph for this function:

◆ getName()

String com.jogamp.opencl.CLDevice.getName ( )

Returns the name of this device.

Definition at line 110 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getNativeCharVectorWidth()

int com.jogamp.opencl.CLDevice.getNativeCharVectorWidth ( )

Native vector width size for built-in char vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 238 of file CLDevice.java.

Here is the call graph for this function:

◆ getNativeDoubleVectorWidth()

int com.jogamp.opencl.CLDevice.getNativeDoubleVectorWidth ( )

Native vector width size for built-in double vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 292 of file CLDevice.java.

Here is the call graph for this function:

◆ getNativeFloatVectorWidth()

int com.jogamp.opencl.CLDevice.getNativeFloatVectorWidth ( )

Native vector width size for built-in float vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 283 of file CLDevice.java.

Here is the call graph for this function:

◆ getNativeHalfVectorWidth()

int com.jogamp.opencl.CLDevice.getNativeHalfVectorWidth ( )

Native vector width size for built-in half vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 274 of file CLDevice.java.

Here is the call graph for this function:

◆ getNativeIntVectorWidth()

int com.jogamp.opencl.CLDevice.getNativeIntVectorWidth ( )

Native vector width size for built-in int vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 256 of file CLDevice.java.

Here is the call graph for this function:

◆ getNativeLongVectorWidth()

int com.jogamp.opencl.CLDevice.getNativeLongVectorWidth ( )

Native vector width size for built-in long vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 265 of file CLDevice.java.

Here is the call graph for this function:

◆ getNativeShortVectorWidth()

int com.jogamp.opencl.CLDevice.getNativeShortVectorWidth ( )

Native vector width size for built-in short vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 247 of file CLDevice.java.

Here is the call graph for this function:

◆ getPlatform()

CLPlatform com.jogamp.opencl.CLDevice.getPlatform ( )

Returns the platform for this OpenCL object.

Reimplemented from com.jogamp.opencl.CLObject.

Definition at line 102 of file CLDevice.java.

Here is the caller graph for this function:

◆ getPreferredCharVectorWidth()

int com.jogamp.opencl.CLDevice.getPreferredCharVectorWidth ( )

Preferred native vector width size for built-in char vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 193 of file CLDevice.java.

Here is the call graph for this function:

◆ getPreferredDoubleVectorWidth()

int com.jogamp.opencl.CLDevice.getPreferredDoubleVectorWidth ( )

Preferred native vector width size for built-in double vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 229 of file CLDevice.java.

Here is the call graph for this function:

◆ getPreferredFloatVectorWidth()

int com.jogamp.opencl.CLDevice.getPreferredFloatVectorWidth ( )

Preferred native vector width size for built-in float vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 220 of file CLDevice.java.

Here is the call graph for this function:

◆ getPreferredIntVectorWidth()

int com.jogamp.opencl.CLDevice.getPreferredIntVectorWidth ( )

Preferred native vector width size for built-in int vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 202 of file CLDevice.java.

Here is the call graph for this function:

◆ getPreferredLongVectorWidth()

int com.jogamp.opencl.CLDevice.getPreferredLongVectorWidth ( )

Preferred native vector width size for built-in long vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 211 of file CLDevice.java.

Here is the call graph for this function:

◆ getPreferredShortVectorWidth()

int com.jogamp.opencl.CLDevice.getPreferredShortVectorWidth ( )

Preferred native vector width size for built-in short vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.

Definition at line 184 of file CLDevice.java.

Here is the call graph for this function:

◆ getProfile()

String com.jogamp.opencl.CLDevice.getProfile ( )

Returns the OpenCL profile of this device.

Definition at line 118 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getProfilingTimerResolution()

long com.jogamp.opencl.CLDevice.getProfilingTimerResolution ( )

Returns the resolution of device timer.

This is measured in nanoseconds.

Definition at line 515 of file CLDevice.java.

Here is the call graph for this function:

◆ getProperties()

Map< String, String > com.jogamp.opencl.CLDevice.getProperties ( )

Returns a Map of device properties with the enum names as keys.

See also
CLUtil::obtainDeviceProperties(com.jogamp.opencl.CLDevice)

Definition at line 708 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getQueueProperties()

EnumSet< CLCommandQueue.Mode > com.jogamp.opencl.CLDevice.getQueueProperties ( )

Returns the command-queue properties supported by the device.

Definition at line 589 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getSingleFPConfig()

EnumSet< FPConfig > com.jogamp.opencl.CLDevice.getSingleFPConfig ( )

Returns the single precision floating-point capability of the device.

The mandated minimum floating-point capabilities are FPConfig#ROUND_TO_NEAREST and FPConfig#INF_NAN.

Returns
An EnumSet containing the extensions, never null.

Definition at line 549 of file CLDevice.java.

Here is the call graph for this function:

◆ getType()

Type com.jogamp.opencl.CLDevice.getType ( )

Returns the type of this device.

Definition at line 166 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getVendor()

String com.jogamp.opencl.CLDevice.getVendor ( )

Returns the vendor of this device.

Definition at line 126 of file CLDevice.java.

Here is the call graph for this function:

◆ getVendorID()

long com.jogamp.opencl.CLDevice.getVendorID ( )

Returns the vendor id of this device.

Definition at line 134 of file CLDevice.java.

Here is the call graph for this function:

◆ getVersion()

CLVersion com.jogamp.opencl.CLDevice.getVersion ( )

Returns the OpenCL version supported by the device.

Definition at line 142 of file CLDevice.java.

Here is the call graph for this function:

◆ hashCode()

int com.jogamp.opencl.CLDevice.hashCode ( )

Definition at line 740 of file CLDevice.java.

Here is the caller graph for this function:

◆ isAvailable()

boolean com.jogamp.opencl.CLDevice.isAvailable ( )

Returns true if this device is available.

Definition at line 597 of file CLDevice.java.

Here is the call graph for this function:

◆ isCompilerAvailable()

boolean com.jogamp.opencl.CLDevice.isCompilerAvailable ( )

Returns false if the implementation does not have a compiler available to compile the program source.

Is true if the compiler is available. This can be false for the OpenCL ES profile only.

Definition at line 607 of file CLDevice.java.

Here is the call graph for this function:

◆ isDoubleFPAvailable()

boolean com.jogamp.opencl.CLDevice.isDoubleFPAvailable ( )

Returns isExtensionAvailable("cl_khr_fp64").

See also
getExtensions()

Definition at line 643 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isErrorCorrectionSupported()

boolean com.jogamp.opencl.CLDevice.isErrorCorrectionSupported ( )

Returns true if the device implements error correction for the memories, caches, registers etc.

in the device. Is false if the device does not implement error correction.

Definition at line 625 of file CLDevice.java.

Here is the call graph for this function:

◆ isExtensionAvailable()

boolean com.jogamp.opencl.CLDevice.isExtensionAvailable ( final String  extension)

Returns true if the extension is supported on this device.

See also
getExtensions()

Definition at line 669 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isGLMemorySharingSupported()

boolean com.jogamp.opencl.CLDevice.isGLMemorySharingSupported ( )

Returns isExtensionAvailable("cl_khr_gl_sharing") || isExtensionAvailable("cl_APPLE_gl_sharing").

See also
getExtensions()

Definition at line 661 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isHalfFPAvailable()

boolean com.jogamp.opencl.CLDevice.isHalfFPAvailable ( )

Returns isExtensionAvailable("cl_khr_fp16").

See also
getExtensions()

Definition at line 634 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isICDAvailable()

boolean com.jogamp.opencl.CLDevice.isICDAvailable ( )

Returns isExtensionAvailable("cl_khr_icd").

See also
getExtensions()

Definition at line 652 of file CLDevice.java.

Here is the call graph for this function:

◆ isImageSupportAvailable()

boolean com.jogamp.opencl.CLDevice.isImageSupportAvailable ( )

Returns true if images are supported by the OpenCL device and false otherwise.

Definition at line 435 of file CLDevice.java.

Here is the call graph for this function:

◆ isLittleEndian()

boolean com.jogamp.opencl.CLDevice.isLittleEndian ( )

Returns true if the OpenCL device is a little endian device and false otherwise.

Definition at line 615 of file CLDevice.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isMemoryUnified()

boolean com.jogamp.opencl.CLDevice.isMemoryUnified ( )

Returns true if the device and the host have a unified memory subsystem.

Definition at line 393 of file CLDevice.java.

Here is the call graph for this function:

◆ toString()

String com.jogamp.opencl.CLDevice.toString ( )

Reimplemented from com.jogamp.opencl.CLObject.

Definition at line 717 of file CLDevice.java.

Here is the call graph for this function:

The documentation for this class was generated from the following file: