Package com.jogamp.opencl

Class CLException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.jogamp.opencl.CLException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

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

public class CLException
extends RuntimeException

Main Exception type for runtime OpenCL errors and failed function calls (e.g. returning not CL_SUCCESS).

Author:

Michael Bien

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
String	error
int	errorcode

Constructor Summary

Constructors

Constructor	Description
CLException(String message)

Method Summary

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

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

errorcode

public final int errorcode

error

public final String error

Constructor Detail

CLException

public CLException(String message)

Method Detail

checkForError

public static void checkForError(int status,
                                 String message)

Throws a CLException when status != CL_SUCCESS.

newException

public static CLException newException(int status,
                                       String message)

Returns a CLException specific to the error code.

getCLErrorString

public String getCLErrorString()

Returns a human readable String for the OpenCL error code.

resolveErrorCode

public static String resolveErrorCode(int error)

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