Package com.jogamp.opencl

Interface Summary
CL Java bindings to OpenCL, the Open Computing Language.
CLErrorHandler Experimental: the api may change in future, feedback appreciated.
Note: the thread which calls onError is unspecified.
CLEventListener A callback for a specific command execution status.
CLMemObjectListener A callback which is invoked by the OpenCL implementation when the memory object is deleted and its resources freed.
CLProgram.CompilerOptions Common compiler options for the OpenCL compiler.
CLResource Releasable OpenCL resource.
 

Class Summary
CLBuffer<B extends Buffer> OpenCL buffer object wrapping an optional NIO buffer.
CLCommandQueue The command queue is used to queue a set of operations for a specific CLDevice.
CLContext CLContext is responsible for managing objects such as command-queues, memory, program and kernel objects and for executing kernels on one or more devices specified in the context.
CLContext.ErrorDispatcher  
CLDevice This object represents an OpenCL device.
CLEvent Event objects can be used for synchronizing command queues, e.g you can wait until a event occurs or they can also be used to capture profiling information that measure execution time of a command.
CLEventList Fixed size list for storing CLEvents.
CLImage<B extends Buffer>  
CLImage.CLImageInfoAccessor  
CLImage2d<B extends Buffer>  
CLImage3d<B extends Buffer>  
CLImageFormat Represents the OpenCL image format with its channeltype and order.
CLKernel High level abstraction for an OpenCL Kernel.
CLMemory<B extends Buffer> Common superclass for all OpenCL memory types.
CLPlatform CLPlatfrorm representing a OpenCL implementation (e.g.
CLProgram Represents a OpenCL program executed on one or more CLDevices.
CLProgramBuilder CLProgramBuilder is a helper for building programs with more complex configurations or building multiple programs with similar configurations.
CLSampler Object representing an OpenCL sampler.
CLSubBuffer<B extends Buffer> A sub buffer of a CLBuffer.
CLUserEvent Custom, user controlled event.
CLVersion Version of an OpenCL Implementation.
 

Enum Summary
CLCommandQueue.Mode Enumeration for the command-queue settings.
CLDevice.Capabilities Enumeration for the execution capabilities of the device.
CLDevice.FPConfig Describes floating-point capability of the device.
CLDevice.GlobalMemCacheType Type of global memory cache supported.
CLDevice.LocalMemType Type of local memory cache supported.
CLDevice.Type Enumeration for the type of a device.
CLEvent.CommandType  
CLEvent.ExecutionStatus  
CLEvent.ProfilingCommand  
CLImageFormat.ChannelOrder Specifies the number of channels and the channel layout i.e.
CLImageFormat.ChannelType Describes the size of the channel data type.
CLMemory.GLObjectType  
CLMemory.Map Configures the mapping process.
CLMemory.Mem Memory settings for configuring CLMemory.
CLProgram.Status  
CLSampler.AddressingMode  
CLSampler.FilteringMode  
 

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

Annotation Types Summary
CLProperty OpenCL property.