All Classes (JOCL API)

All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
Class	Description
AutoCloseable	import of JDK7's ARM interface allowing JDK6 backwards compatibility.
BuildProgramCallback	A callback an application can register to be called when the program executable has been built (successfully or unsuccessfully). Note1: registering a build callback can make `CL.clBuildProgram(long, int, com.jogamp.common.nio.PointerBuffer, java.lang.String, com.jogamp.opencl.llb.impl.BuildProgramCallback)` non blocking (OpenCL implementation dependent). Note2: the thread which calls this method is unspecified.
CL	Java bindings to OpenCL, the Open Computing Language.
CL11
CL12
CL20
CLAccessorFactory	Implementations of this interface are factories responsible for creating CLAccessors.
CLBuffer<B extends Buffer>	OpenCL buffer object wrapping an optional NIO buffer.
CLBuildConfiguration	Configuration representing everything needed to build an OpenCL program.
CLBuildListener	A callback an application can register to be called when the program executable has been built (successfully or unsuccessfully). Note1: registering a build callback can make `CL.clBuildProgram(long, int, com.jogamp.common.nio.PointerBuffer, java.lang.String, com.jogamp.opencl.llb.impl.BuildProgramCallback)` non blocking (OpenCL implementation dependent). Note2: the thread which calls this method is unspecified.
CLCommandQueue	The command queue is used to queue a set of operations for a specific `CLDevice`.
CLCommandQueue.Mode	Enumeration for the command-queue settings.
CLCommandQueuePool<C extends CLQueueContext>	A multithreaded, fixed size pool of OpenCL command queues.
CLCommandQueuePool.FinishAction	The action executed after a task completes.
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.
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.
CLDeviceFilters	Pre-defined filters.
CLDynamicLibraryBundleInfo
CLErrorHandler	Experimental: the api may change in future, feedback appreciated. Note: the thread which calls `onError` is unspecified.
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.
CLEvent.CommandType
CLEvent.ExecutionStatus
CLEvent.ProfilingCommand
CLEventCallback	A callback for a specific command execution status.
CLEventList	Fixed size list for storing CLEvents.
CLEventListener	A callback for a specific command execution status.
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.
CLGLBuffer<B extends Buffer>	Shared buffer between OpenGL and OpenCL contexts.
CLGLContext	OpenCL Context supporting JOGL-JOCL interoperablity.
CLGLImage2d<B extends Buffer>	2D OpenCL image representing an OpenGL renderbuffer.
CLGLObject
CLGLTexture2d<B extends Buffer>	2D OpenCL image representing an 2D OpenGL texture.
CLGLTexture3d<B extends Buffer>	3D OpenCL image representing an 3D OpenGL texture.
CLImage<B extends Buffer>
CLImage.CLImageInfoAccessor
CLImage2d<B extends Buffer>
CLImage3d<B extends Buffer>
CLImageDescImpl	Struct accessor for cl_image_desc.
CLImageFormat	Represents the OpenCL image format with its channeltype and order.
CLImageFormat.ChannelOrder	Specifies the number of channels and the channel layout i.e.
CLImageFormat.ChannelType	Describes the size of the channel data type.
CLImageFormatImpl	Struct accessor for cl_image_format.
CLImpl11	Java bindings to OpenCL, the Open Computing Language (generated).
CLImpl12	Java bindings to OpenCL, the Open Computing Language (generated).
CLImpl20	Java bindings to OpenCL, the Open Computing Language (generated).
CLInfo	Prints out diagnostic properties about the OpenCL installation and the runtime environment of the host application.
CLInfoAccessor	Internal utility for common OpenCL clGetFooInfo calls.
CLKernel	High level abstraction for an OpenCL Kernel.
CLMemObjectDestructorCallback	A callback which is invoked by the OpenCL implementation when the memory object is deleted and its resources freed.
CLMemObjectListener	A callback which is invoked by the OpenCL implementation when the memory object is deleted and its resources freed.
CLMemory<B extends Buffer>	Common superclass for all OpenCL memory types.
CLMemory.GLObjectType
CLMemory.Map	Configures the mapping process.
CLMemory.Mem	Memory settings for configuring CLMemory.
CLMultiContext	Utility for organizing multiple `CLContext`s.
CLObject	Common superclass for all OpenCL objects.
CLPlatform	CLPlatfrorm representing a OpenCL implementation (e.g.
CLPlatformFilters	Pre-defined filters.
CLPlatformInfoAccessor
CLProcAddressTable11	This table is a cache of pointers to the dynamically-linkable C library.
CLProcAddressTable12	This table is a cache of pointers to the dynamically-linkable C library.
CLProcAddressTable20	This table is a cache of pointers to the dynamically-linkable C library.
CLProgram	Represents a OpenCL program executed on one or more `CLDevice`s.
CLProgram.CompilerOptions	Common compiler options for the OpenCL compiler.
CLProgram.Status
CLProgramBuilder	CLProgramBuilder is a helper for building programs with more complex configurations or building multiple programs with similar configurations.
CLProgramConfiguration	Configuration representing everything needed to build an OpenCL program (program included).
CLProperty	OpenCL property.
CLQueueContext	Superclass for all per-queue contexts as used in `CLCommandQueuePool`s.
CLQueueContext.CLSimpleQueueContext	A simple queue context holding a precompiled program and its kernels.
CLQueueContextFactory<C extends CLQueueContext>	Creates `CLQueueContext`s.
CLQueueContextFactory.CLSimpleContextFactory	Creates `CLQueueContext.CLSimpleQueueContext`s containing a precompiled program.
CLResource	Releasable OpenCL resource.
CLSampler	Object representing an OpenCL sampler.
CLSampler.AddressingMode
CLSampler.FilteringMode
CLSubBuffer<B extends Buffer>	A sub buffer of a CLBuffer.
CLTask<C extends CLQueueContext,R>	A task executed on a command queue.
CLTLAccessorFactory
CLTLInfoAccessor	Internal utility for common OpenCL clGetFooInfo calls.
CLUserEvent	Custom, user controlled event.
CLUtil
CLVersion	Version of an OpenCL Implementation.
Debug	Helper routines for logging and debugging.
Filter<I>
JoclVersion
JOCLVersion	Deprecated. Use `JoclVersion`
MultiQueueBarrier	An utility for synchronizing multiple concurrent `CLCommandQueue`s.