Top Description Inners Fields Constructors Methods
com.jogamp.opencl

public Class CLException

extends RuntimeException
Class Inheritance
Known Direct Subclasses
com.jogamp.opencl.CLException.CLDeviceNotFoundException, com.jogamp.opencl.CLException.CLDeviceNotAvailableException, com.jogamp.opencl.CLException.CLCompilerNotAvailableException, com.jogamp.opencl.CLException.CLMemObjectAllocationFailureException, com.jogamp.opencl.CLException.CLOutOfResourcesException, com.jogamp.opencl.CLException.CLOutOfHostMemoryException, com.jogamp.opencl.CLException.CLProfilingInfoNotAvailableException, com.jogamp.opencl.CLException.CLMemCopyOverlapException, com.jogamp.opencl.CLException.CLImageFormatMismatchException, com.jogamp.opencl.CLException.CLImageFormatNotSupportedException, com.jogamp.opencl.CLException.CLBuildProgramFailureException, com.jogamp.opencl.CLException.CLMapFailureException, com.jogamp.opencl.CLException.CLInvalidValueException, com.jogamp.opencl.CLException.CLInvalidDeviceTypeException, com.jogamp.opencl.CLException.CLInvalidPlatformException, com.jogamp.opencl.CLException.CLInvalidDeviceException, com.jogamp.opencl.CLException.CLInvalidContextException, com.jogamp.opencl.CLException.CLInvalidQueuePropertiesException, com.jogamp.opencl.CLException.CLInvalidCommandQueueException, com.jogamp.opencl.CLException.CLInvalidHostPtrException, com.jogamp.opencl.CLException.CLInvalidMemObjectException, com.jogamp.opencl.CLException.CLInvalidImageFormatDescriptorException, com.jogamp.opencl.CLException.CLInvalidImageSizeException, com.jogamp.opencl.CLException.CLInvalidSamplerException, com.jogamp.opencl.CLException.CLInvalidBinaryException, com.jogamp.opencl.CLException.CLInvalidBuildOptionsException, com.jogamp.opencl.CLException.CLInvalidProgramException, com.jogamp.opencl.CLException.CLInvalidProgramExecutableException, com.jogamp.opencl.CLException.CLInvalidKernelNameException, com.jogamp.opencl.CLException.CLInvalidKernelDefinitionException, com.jogamp.opencl.CLException.CLInvalidKernelException, com.jogamp.opencl.CLException.CLInvalidArgIndexException, com.jogamp.opencl.CLException.CLInvalidArgValueException, com.jogamp.opencl.CLException.CLInvalidArgSizeException, com.jogamp.opencl.CLException.CLInvalidKernelArgsException, com.jogamp.opencl.CLException.CLInvalidWorkDimensionException, com.jogamp.opencl.CLException.CLInvalidWorkGroupSizeException, com.jogamp.opencl.CLException.CLInvalidWorkItemSizeException, com.jogamp.opencl.CLException.CLInvalidGlobalOffsetException, com.jogamp.opencl.CLException.CLInvalidEventWaitListException, com.jogamp.opencl.CLException.CLInvalidEventException, com.jogamp.opencl.CLException.CLInvalidOperationException, com.jogamp.opencl.CLException.CLInvalidGLObjectException, com.jogamp.opencl.CLException.CLInvalidBufferSizeException, com.jogamp.opencl.CLException.CLInvalidMipLevelException, com.jogamp.opencl.CLException.CLInvalidGlobalWorkSizeException, com.jogamp.opencl.CLException.CLInvalidPropertyException, com.jogamp.opencl.CLException.CLInvalidGLSharegroupReferenceKhrException, com.jogamp.opencl.CLException.CLPlatformNotFoundKhrException, com.jogamp.opencl.CLException.CLMisalignedSubBufferOffsetException, com.jogamp.opencl.CLException.CLExecStatusErrorForEventsInWaitListException
Imports
com.jogamp.opencl.llb.gl.CLGL, com.jogamp.opencl.llb.CL, .CLDeviceBinding, .CLImageBinding, .CLMemObjBinding, .CLPlatformBinding, .CLProgramBinding

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CLException.CLBuildProgramFailureException

CLException thrown on CL.CL_BUILD_PROGRAM_FAILURE errors.

public static class
CLException.CLCompilerNotAvailableException

CLException thrown on CL.CL_COMPILER_NOT_AVAILABLE errors.

public static class
CLException.CLDeviceNotAvailableException

CLException thrown on CL.CL_DEVICE_NOT_AVAILABLE errors.

public static class
CLException.CLDeviceNotFoundException

CLException thrown on CL.CL_DEVICE_NOT_FOUND errors.

public static class
CLException.CLExecStatusErrorForEventsInWaitListException

CLException thrown on CL.CL_EXEC_STATUS_ERROR_FOR_EVENTS_IN_WAIT_LIST errors.

public static class
CLException.CLImageFormatMismatchException

CLException thrown on CL.CL_IMAGE_FORMAT_MISMATCH errors.

public static class
CLException.CLImageFormatNotSupportedException

CLException thrown on CL.CL_IMAGE_FORMAT_NOT_SUPPORTED errors.

public static class
CLException.CLInvalidArgIndexException

CLException thrown on CL.CL_INVALID_ARG_INDEX errors.

public static class
CLException.CLInvalidArgSizeException

CLException thrown on CL.CL_INVALID_ARG_SIZE errors.

public static class
CLException.CLInvalidArgValueException

CLException thrown on CL.CL_INVALID_ARG_VALUE errors.

public static class
CLException.CLInvalidBinaryException

CLException thrown on CL.CL_INVALID_BINARY errors.

public static class
CLException.CLInvalidBufferSizeException

CLException thrown on CL.CL_INVALID_BUFFER_SIZE errors.

public static class
CLException.CLInvalidBuildOptionsException

CLException thrown on CL.CL_INVALID_BUILD_OPTIONS errors.

public static class
CLException.CLInvalidCommandQueueException

CLException thrown on CL.CL_INVALID_COMMAND_QUEUE errors.

public static class
CLException.CLInvalidContextException

CLException thrown on CL.CL_INVALID_CONTEXT errors.

public static class
CLException.CLInvalidDeviceException

CLException thrown on CL.CL_INVALID_DEVICE errors.

public static class
CLException.CLInvalidDeviceTypeException

CLException thrown on CL.CL_INVALID_DEVICE_TYPE errors.

public static class
CLException.CLInvalidEventException

CLException thrown on CL.CL_INVALID_EVENT errors.

public static class
CLException.CLInvalidEventWaitListException

CLException thrown on CL.CL_INVALID_EVENT_WAIT_LIST errors.

public static class
CLException.CLInvalidGlobalOffsetException

CLException thrown on CL.CL_INVALID_GLOBAL_OFFSET errors.

public static class
CLException.CLInvalidGlobalWorkSizeException

CLException thrown on CL.CL_INVALID_GLOBAL_WORK_SIZE errors.

public static class
CLException.CLInvalidGLObjectException

CLException thrown on CL.CL_INVALID_GL_OBJECT errors.

public static class
CLException.CLInvalidGLSharegroupReferenceKhrException

CLException thrown on CL.CL_INVALID_GL_SHAREGROUP_REFERENCE_KHR errors.

public static class
CLException.CLInvalidHostPtrException

CLException thrown on CL.CL_INVALID_HOST_PTR errors.

public static class
CLException.CLInvalidImageFormatDescriptorException

CLException thrown on CL.CL_INVALID_IMAGE_FORMAT_DESCRIPTOR errors.

public static class
CLException.CLInvalidImageSizeException

CLException thrown on CL.CL_INVALID_IMAGE_SIZE errors.

public static class
CLException.CLInvalidKernelArgsException

CLException thrown on CL.CL_INVALID_KERNEL_ARGS errors.

public static class
CLException.CLInvalidKernelDefinitionException

CLException thrown on CL.CL_INVALID_KERNEL_DEFINITION errors.

public static class
CLException.CLInvalidKernelException

CLException thrown on CL.CL_INVALID_KERNEL errors.

public static class
CLException.CLInvalidKernelNameException

CLException thrown on CL.CL_INVALID_KERNEL_NAME errors.

public static class
CLException.CLInvalidMemObjectException

CLException thrown on CL.CL_INVALID_MEM_OBJECT errors.

public static class
CLException.CLInvalidMipLevelException

CLException thrown on CL.CL_INVALID_MIP_LEVEL errors.

public static class
CLException.CLInvalidOperationException

CLException thrown on CL.CL_INVALID_OPERATION errors.

public static class
CLException.CLInvalidPlatformException

CLException thrown on CL.CL_INVALID_PLATFORM errors.

public static class
CLException.CLInvalidProgramException

CLException thrown on CL.CL_INVALID_PROGRAM errors.

public static class
CLException.CLInvalidProgramExecutableException

CLException thrown on CL.CL_INVALID_PROGRAM_EXECUTABLE errors.

public static class
CLException.CLInvalidPropertyException

CLException thrown on CL.CL_INVALID_PROPERTY errors.

public static class
CLException.CLInvalidQueuePropertiesException

CLException thrown on CL.CL_INVALID_QUEUE_PROPERTIES errors.

public static class
CLException.CLInvalidSamplerException

CLException thrown on CL.CL_INVALID_SAMPLER errors.

public static class
CLException.CLInvalidValueException

CLException thrown on CL.CL_INVALID_VALUE errors.

public static class
CLException.CLInvalidWorkDimensionException

CLException thrown on CL.CL_INVALID_WORK_DIMENSION errors.

public static class
CLException.CLInvalidWorkGroupSizeException

CLException thrown on CL.CL_INVALID_WORK_GROUP_SIZE errors.

public static class
CLException.CLInvalidWorkItemSizeException

CLException thrown on CL.CL_INVALID_WORK_ITEM_SIZE errors.

public static class
CLException.CLMapFailureException

CLException thrown on CL.CL_MAP_FAILURE errors.

public static class
CLException.CLMemCopyOverlapException

CLException thrown on CL.CL_MEM_COPY_OVERLAP errors.

public static class
CLException.CLMemObjectAllocationFailureException

CLException thrown on CL.CL_MEM_OBJECT_ALLOCATION_FAILURE errors.

public static class
CLException.CLMisalignedSubBufferOffsetException

CLException thrown on CL.CL_MISALIGNED_SUB_BUFFER_OFFSET errors.

public static class
CLException.CLOutOfHostMemoryException

CLException thrown on CL.CL_OUT_OF_HOST_MEMORY errors.

public static class
CLException.CLOutOfResourcesException

CLException thrown on CL.CL_OUT_OF_RESOURCES errors.

public static class
CLException.CLPlatformNotFoundKhrException

CLException thrown on CL.CL_PLATFORM_NOT_FOUND_KHR errors.

public static class
CLException.CLProfilingInfoNotAvailableException

CLException thrown on CL.CL_PROFILING_INFO_NOT_AVAILABLE errors.

Field Summary

Modifier and TypeField and Description
public final String
public final int
private static final long

Constructor Summary

AccessConstructor and Description
public
CLException(final String message)

private
CLException(final int errorcode, final String errorStr, final String message)

Method Summary

Modifier and TypeMethod and Description
public static void
checkForError(final int status, final String message)

Throws a CLException when status != CL_SUCCESS.

private static CLException
createSpecificException(final int error, final String message)

public String
getCLErrorString()

Returns a human readable String for the OpenCL error code.

public static CLException
newException(final int status, final String message)

Returns a CLException specific to the error code.

public static String
resolveErrorCode(final int error)

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