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

Main Exception type for runtime OpenCL errors and failed function calls (e.g. More...

Inherits RuntimeException.

Inherited by com.jogamp.opencl.CLException.CLBuildProgramFailureException, com.jogamp.opencl.CLException.CLCompilerNotAvailableException, com.jogamp.opencl.CLException.CLDeviceNotAvailableException, com.jogamp.opencl.CLException.CLDeviceNotFoundException, com.jogamp.opencl.CLException.CLExecStatusErrorForEventsInWaitListException, com.jogamp.opencl.CLException.CLImageFormatMismatchException, com.jogamp.opencl.CLException.CLImageFormatNotSupportedException, com.jogamp.opencl.CLException.CLInvalidArgIndexException, com.jogamp.opencl.CLException.CLInvalidArgSizeException, com.jogamp.opencl.CLException.CLInvalidArgValueException, com.jogamp.opencl.CLException.CLInvalidBinaryException, com.jogamp.opencl.CLException.CLInvalidBufferSizeException, com.jogamp.opencl.CLException.CLInvalidBuildOptionsException, com.jogamp.opencl.CLException.CLInvalidCommandQueueException, com.jogamp.opencl.CLException.CLInvalidContextException, com.jogamp.opencl.CLException.CLInvalidDeviceException, com.jogamp.opencl.CLException.CLInvalidDeviceTypeException, com.jogamp.opencl.CLException.CLInvalidEventException, com.jogamp.opencl.CLException.CLInvalidEventWaitListException, com.jogamp.opencl.CLException.CLInvalidGLObjectException, com.jogamp.opencl.CLException.CLInvalidGLSharegroupReferenceKhrException, com.jogamp.opencl.CLException.CLInvalidGlobalOffsetException, com.jogamp.opencl.CLException.CLInvalidGlobalWorkSizeException, com.jogamp.opencl.CLException.CLInvalidHostPtrException, com.jogamp.opencl.CLException.CLInvalidImageFormatDescriptorException, com.jogamp.opencl.CLException.CLInvalidImageSizeException, com.jogamp.opencl.CLException.CLInvalidKernelArgsException, com.jogamp.opencl.CLException.CLInvalidKernelDefinitionException, com.jogamp.opencl.CLException.CLInvalidKernelException, com.jogamp.opencl.CLException.CLInvalidKernelNameException, com.jogamp.opencl.CLException.CLInvalidMemObjectException, com.jogamp.opencl.CLException.CLInvalidMipLevelException, com.jogamp.opencl.CLException.CLInvalidOperationException, com.jogamp.opencl.CLException.CLInvalidPlatformException, com.jogamp.opencl.CLException.CLInvalidProgramException, com.jogamp.opencl.CLException.CLInvalidProgramExecutableException, com.jogamp.opencl.CLException.CLInvalidPropertyException, com.jogamp.opencl.CLException.CLInvalidQueuePropertiesException, com.jogamp.opencl.CLException.CLInvalidSamplerException, com.jogamp.opencl.CLException.CLInvalidValueException, com.jogamp.opencl.CLException.CLInvalidWorkDimensionException, com.jogamp.opencl.CLException.CLInvalidWorkGroupSizeException, com.jogamp.opencl.CLException.CLInvalidWorkItemSizeException, com.jogamp.opencl.CLException.CLMapFailureException, com.jogamp.opencl.CLException.CLMemCopyOverlapException, com.jogamp.opencl.CLException.CLMemObjectAllocationFailureException, com.jogamp.opencl.CLException.CLMisalignedSubBufferOffsetException, com.jogamp.opencl.CLException.CLOutOfHostMemoryException, com.jogamp.opencl.CLException.CLOutOfResourcesException, com.jogamp.opencl.CLException.CLPlatformNotFoundKhrException, and com.jogamp.opencl.CLException.CLProfilingInfoNotAvailableException.

Collaboration diagram for com.jogamp.opencl.CLException:

Classes

class  CLBuildProgramFailureException
 CLException thrown on CL.CL_BUILD_PROGRAM_FAILURE errors. More...
 
class  CLCompilerNotAvailableException
 CLException thrown on CL.CL_COMPILER_NOT_AVAILABLE errors. More...
 
class  CLDeviceNotAvailableException
 CLException thrown on CL.CL_DEVICE_NOT_AVAILABLE errors. More...
 
class  CLDeviceNotFoundException
 CLException thrown on CL.CL_DEVICE_NOT_FOUND errors. More...
 
class  CLExecStatusErrorForEventsInWaitListException
 CLException thrown on CL.CL_EXEC_STATUS_ERROR_FOR_EVENTS_IN_WAIT_LIST errors. More...
 
class  CLImageFormatMismatchException
 CLException thrown on CL.CL_IMAGE_FORMAT_MISMATCH errors. More...
 
class  CLImageFormatNotSupportedException
 CLException thrown on CL.CL_IMAGE_FORMAT_NOT_SUPPORTED errors. More...
 
class  CLInvalidArgIndexException
 CLException thrown on CL.CL_INVALID_ARG_INDEX errors. More...
 
class  CLInvalidArgSizeException
 CLException thrown on CL.CL_INVALID_ARG_SIZE errors. More...
 
class  CLInvalidArgValueException
 CLException thrown on CL.CL_INVALID_ARG_VALUE errors. More...
 
class  CLInvalidBinaryException
 CLException thrown on CL.CL_INVALID_BINARY errors. More...
 
class  CLInvalidBufferSizeException
 CLException thrown on CL.CL_INVALID_BUFFER_SIZE errors. More...
 
class  CLInvalidBuildOptionsException
 CLException thrown on CL.CL_INVALID_BUILD_OPTIONS errors. More...
 
class  CLInvalidCommandQueueException
 CLException thrown on CL.CL_INVALID_COMMAND_QUEUE errors. More...
 
class  CLInvalidContextException
 CLException thrown on CL.CL_INVALID_CONTEXT errors. More...
 
class  CLInvalidDeviceException
 CLException thrown on CL.CL_INVALID_DEVICE errors. More...
 
class  CLInvalidDeviceTypeException
 CLException thrown on CL.CL_INVALID_DEVICE_TYPE errors. More...
 
class  CLInvalidEventException
 CLException thrown on CL.CL_INVALID_EVENT errors. More...
 
class  CLInvalidEventWaitListException
 CLException thrown on CL.CL_INVALID_EVENT_WAIT_LIST errors. More...
 
class  CLInvalidGlobalOffsetException
 CLException thrown on CL.CL_INVALID_GLOBAL_OFFSET errors. More...
 
class  CLInvalidGlobalWorkSizeException
 CLException thrown on CL.CL_INVALID_GLOBAL_WORK_SIZE errors. More...
 
class  CLInvalidGLObjectException
 CLException thrown on CL.CL_INVALID_GL_OBJECT errors. More...
 
class  CLInvalidGLSharegroupReferenceKhrException
 CLException thrown on CL.CL_INVALID_GL_SHAREGROUP_REFERENCE_KHR errors. More...
 
class  CLInvalidHostPtrException
 CLException thrown on CL.CL_INVALID_HOST_PTR errors. More...
 
class  CLInvalidImageFormatDescriptorException
 CLException thrown on CL.CL_INVALID_IMAGE_FORMAT_DESCRIPTOR errors. More...
 
class  CLInvalidImageSizeException
 CLException thrown on CL.CL_INVALID_IMAGE_SIZE errors. More...
 
class  CLInvalidKernelArgsException
 CLException thrown on CL.CL_INVALID_KERNEL_ARGS errors. More...
 
class  CLInvalidKernelDefinitionException
 CLException thrown on CL.CL_INVALID_KERNEL_DEFINITION errors. More...
 
class  CLInvalidKernelException
 CLException thrown on CL.CL_INVALID_KERNEL errors. More...
 
class  CLInvalidKernelNameException
 CLException thrown on CL.CL_INVALID_KERNEL_NAME errors. More...
 
class  CLInvalidMemObjectException
 CLException thrown on CL.CL_INVALID_MEM_OBJECT errors. More...
 
class  CLInvalidMipLevelException
 CLException thrown on CL.CL_INVALID_MIP_LEVEL errors. More...
 
class  CLInvalidOperationException
 CLException thrown on CL.CL_INVALID_OPERATION errors. More...
 
class  CLInvalidPlatformException
 CLException thrown on CL.CL_INVALID_PLATFORM errors. More...
 
class  CLInvalidProgramException
 CLException thrown on CL.CL_INVALID_PROGRAM errors. More...
 
class  CLInvalidProgramExecutableException
 CLException thrown on CL.CL_INVALID_PROGRAM_EXECUTABLE errors. More...
 
class  CLInvalidPropertyException
 CLException thrown on CL.CL_INVALID_PROPERTY errors. More...
 
class  CLInvalidQueuePropertiesException
 CLException thrown on CL.CL_INVALID_QUEUE_PROPERTIES errors. More...
 
class  CLInvalidSamplerException
 CLException thrown on CL.CL_INVALID_SAMPLER errors. More...
 
class  CLInvalidValueException
 CLException thrown on CL.CL_INVALID_VALUE errors. More...
 
class  CLInvalidWorkDimensionException
 CLException thrown on CL.CL_INVALID_WORK_DIMENSION errors. More...
 
class  CLInvalidWorkGroupSizeException
 CLException thrown on CL.CL_INVALID_WORK_GROUP_SIZE errors. More...
 
class  CLInvalidWorkItemSizeException
 CLException thrown on CL.CL_INVALID_WORK_ITEM_SIZE errors. More...
 
class  CLMapFailureException
 CLException thrown on CL.CL_MAP_FAILURE errors. More...
 
class  CLMemCopyOverlapException
 CLException thrown on CL.CL_MEM_COPY_OVERLAP errors. More...
 
class  CLMemObjectAllocationFailureException
 CLException thrown on CL.CL_MEM_OBJECT_ALLOCATION_FAILURE errors. More...
 
class  CLMisalignedSubBufferOffsetException
 CLException thrown on CL.CL_MISALIGNED_SUB_BUFFER_OFFSET errors. More...
 
class  CLOutOfHostMemoryException
 CLException thrown on CL.CL_OUT_OF_HOST_MEMORY errors. More...
 
class  CLOutOfResourcesException
 CLException thrown on CL.CL_OUT_OF_RESOURCES errors. More...
 
class  CLPlatformNotFoundKhrException
 CLException thrown on CL.CL_PLATFORM_NOT_FOUND_KHR errors. More...
 
class  CLProfilingInfoNotAvailableException
 CLException thrown on CL.CL_PROFILING_INFO_NOT_AVAILABLE errors. More...
 

Public Member Functions

 CLException (final String message)
 
String getCLErrorString ()
 Returns a human readable String for the OpenCL error code. More...
 

Static Public Member Functions

static void checkForError (final int status, final String message)
 Throws a CLException when status != CL_SUCCESS. More...
 
static CLException newException (final int status, final String message)
 Returns a CLException specific to the error code. More...
 
static String resolveErrorCode (final int error)
 Returns a human readable String for the OpenCL error code or null if not known. More...
 

Public Attributes

final int errorcode
 
final String error
 

Detailed Description

Main Exception type for runtime OpenCL errors and failed function calls (e.g.

returning not CL_SUCCESS).

Author
Michael Bien

Definition at line 37 of file CLException.java.

Constructor & Destructor Documentation

◆ CLException()

com.jogamp.opencl.CLException.CLException ( final String  message)

Definition at line 49 of file CLException.java.

Here is the caller graph for this function:

Member Function Documentation

◆ checkForError()

static void com.jogamp.opencl.CLException.checkForError ( final int  status,
final String  message 
)
static

Throws a CLException when status != CL_SUCCESS.

Definition at line 64 of file CLException.java.

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

◆ getCLErrorString()

String com.jogamp.opencl.CLException.getCLErrorString ( )

Returns a human readable String for the OpenCL error code.

Definition at line 87 of file CLException.java.

Here is the caller graph for this function:

◆ newException()

static CLException com.jogamp.opencl.CLException.newException ( final int  status,
final String  message 
)
static

Returns a CLException specific to the error code.

Definition at line 75 of file CLException.java.

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

◆ resolveErrorCode()

static String com.jogamp.opencl.CLException.resolveErrorCode ( final int  error)
static

Returns a human readable String for the OpenCL error code or null if not known.

Definition at line 97 of file CLException.java.

Here is the caller graph for this function:

Member Data Documentation

◆ error

final String com.jogamp.opencl.CLException.error

Definition at line 43 of file CLException.java.

◆ errorcode

final int com.jogamp.opencl.CLException.errorcode

Definition at line 42 of file CLException.java.


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