Package com.nativelibs4java.opencl

Object-oriented wrappers around the OpenCL API (JavaCL, CLPlatform, CLContext, CLProgram, CLKernel, CLBuffer...)

See: Description

Interface Summary

Interface	Description
CLEvent.EventCallback
CLMem.DestructorCallback
CLQueue.NativeKernel

Class Summary

Class	Description
CLAbstractUserProgram
CLBuffer<T>	OpenCL Memory Buffer Object.
CLContext	OpenCL context.
CLDevice	OpenCL device (CPU, GPU...).
CLEvent	OpenCL event object.
CLImage	OpenCL Image Memory Object.
CLImage2D	OpenCL 2D Image Memory Object see CLContext.createImage2D(com.nativelibs4java.opencl.CLMem.Usage, java.awt.Image, boolean) see CLContext.createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long) see CLContext.createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long) see CLContext.createImage2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, java.nio.Buffer, boolean) see CLContext.createImage2DFromGLRenderBuffer(com.nativelibs4java.opencl.CLMem.Usage, int) see CLContext.createImage2DFromGLTexture2D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLContext.GLTextureTarget, int, int)
CLImage3D	OpenCL 3D Image Memory Object see CLContext.createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long) see CLContext.createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long) see CLContext.createImage3D(com.nativelibs4java.opencl.CLMem.Usage, com.nativelibs4java.opencl.CLImageFormat, long, long, long, long, long, java.nio.Buffer, boolean) see CLContext.createImage3DFromGLTexture3D(com.nativelibs4java.opencl.CLMem.Usage, int, int)
CLImageFormat	OpenCL Image Format see CLContext.getSupportedImageFormats(com.nativelibs4java.opencl.CLMem.Flags, com.nativelibs4java.opencl.CLMem.ObjectType)
CLKernel	OpenCL kernel.
CLMem	OpenCL memory object.
CLMem.GLObjectInfo
CLPlatform	OpenCL implementation entry point.
CLPlatform.DeviceComparator
CLProgram	OpenCL program.
CLQueue	OpenCL command queue.
CLSampler	OpenCL sampler object.
CLUserEvent
JavaCL	Entry point class for the OpenCL4Java Object-oriented wrappers around the OpenCL API.
JavaCL.OpenCLProbeLibrary
LocalSize	Size in bytes of a __local argument.

Enum Summary

Enum	Description
CLContext.GLTextureTarget
CLDevice.AffinityDomain	Enums values for cl_device_affinity_domain
CLDevice.ExecutionCapability	Bit values for CL_DEVICE_EXECUTION_CAPABILITIES
CLDevice.FpConfig	Floating-point config of a device.
CLDevice.GlobalMemCacheType	Values for CL_DEVICE_GLOBAL_MEM_CACHE_TYPE
CLDevice.LocalMemType	Values for CL_DEVICE_LOCAL_MEM_TYPE
CLDevice.PartitionType	Device partition types.
CLDevice.QueueProperties	Bit values for CL_DEVICE_QUEUE_PROPERTIES
CLDevice.Type	Bit values for CL_DEVICE_TYPE
CLEvent.CommandExecutionStatus	Values for CL_EVENT_COMMAND_EXECUTION_STATUS
CLEvent.CommandType	Values for CL_EVENT_COMMAND_TYPE
CLImageFormat.ChannelDataType	For example, to specify a normalized unsigned 8-bit / channel RGBA image, image_channel_order = CL_RGBA, and image_channel_data_type = CL_UNORM_INT8.
CLImageFormat.ChannelOrder
CLMem.Flags
CLMem.GLObjectType
CLMem.MapFlags
CLMem.Migration	Memory object migration options (see CLQueue#enqueueMigrateMemObjects(CLMem[], java.lang.EnumSet, CLEvent[])).
CLMem.ObjectType
CLMem.Usage	Memory Object Usage enum
CLPlatform.ContextProperties	Bit values for CL_CONTEXT_PROPERTIES
CLPlatform.DeviceFeature	Enums used to indicate how to choose the best CLDevice.
CLSampler.AddressingMode	Values for CL_SAMPLER_ADDRESSING_MODE How out-of-range image coordinates are handled when reading from an image
CLSampler.FilterMode	Values for CL_SAMPLER_FILTER_MODE Type of filter that must be applied when reading an image

Exception Summary

Exception	Description
CLBuildException	OpenCL program build exception
CLException	OpenCL error
CLException.BuildProgramFailure
CLException.CLTypedException
CLException.CLVersionException
CLException.CompileProgramFailure
CLException.CompilerNotAvailable
CLException.DeviceNotAvailable
CLException.DevicePartitionFailed
CLException.ExecStatusErrorForEventsInWaitList
CLException.ImageFormatMismatch
CLException.InvalidArgIndex
CLException.InvalidArgSize
CLException.InvalidArgValue
CLException.InvalidBinary
CLException.InvalidBufferSize
CLException.InvalidBuildOptions
CLException.InvalidCommandQueue
CLException.InvalidCompilerOptions
CLException.InvalidContext
CLException.InvalidDevice
CLException.InvalidDevicePartitionCount
CLException.InvalidDeviceType
CLException.InvalidEvent
CLException.InvalidEventWaitList
CLException.InvalidGLContextApple
CLException.InvalidGlobalOffset
CLException.InvalidGlobalWorkSize
CLException.InvalidGLObject
CLException.InvalidGLShareGroupReference
CLException.InvalidHostPtr
CLException.InvalidImageDescriptor
CLException.InvalidImageFormatDescriptor
CLException.InvalidImageSize
CLException.InvalidKernel
CLException.InvalidKernelArgs
CLException.InvalidKernelDefinition
CLException.InvalidKernelName
CLException.InvalidLinkerOptions
CLException.InvalidMemObject
CLException.InvalidMipLevel
CLException.InvalidOperation
CLException.InvalidPlatform
CLException.InvalidProgram
CLException.InvalidProgramExecutable
CLException.InvalidProperty
CLException.InvalidQueueProperties
CLException.InvalidSampler
CLException.InvalidValue
CLException.InvalidWorkDimension
CLException.InvalidWorkGroupSize
CLException.InvalidWorkItemSize
CLException.KernelArgInfoNotAvailable
CLException.LinkerNotAvailable
CLException.LinkProgramFailure
CLException.MapFailure
CLException.MemCopyOverlap
CLException.MemObjectAllocationFailure
CLException.MisalignedSubBufferOffset
CLException.OutOfHostMemory
CLException.OutOfResources
CLException.ProfilingInfoNotAvailable

Annotation Types Summary

Annotation Type	Description
CLException.ErrorCode
InfoName	Tagging annotation to indicate the name of an OpenCL information in the OpenCL specifications.

Package com.nativelibs4java.opencl Description

Object-oriented wrappers around the OpenCL API (JavaCL, CLPlatform, CLContext, CLProgram, CLKernel, CLBuffer...)
Also see the low-level bindings : OpenCLLibrary