com.nativelibs4java.opencl

Class JavaCL

java.lang.Object

com.nativelibs4java.opencl.JavaCL

public class JavaCL
extends Object

Entry point class for the OpenCL4Java Object-oriented wrappers around the OpenCL API.

Author:

Olivier Chafik

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaCL.OpenCLProbeLibrary

Constructor Summary

Constructors

Constructor and Description
JavaCL()

Method Summary

Modifier and Type	Method and Description
static CLContext	createBestContext() Creates an OpenCL context with the "best" device (see getBestDevice())
static CLContext	createBestContext(CLPlatform.DeviceFeature... preferredFeatures) Creates an OpenCL context with the "best" device based on the comparison of the provided prioritized device feature (see getBestDevice(CLPlatform.DeviceFeature...))
static CLContext	createContext(Map<CLPlatform.ContextProperties,Object> contextProperties, CLDevice... devices) Creates an OpenCL context formed of the provided devices.
static CLContext	createContextFromCurrentGL() Creates an OpenCL context able to share entities with the current OpenGL context.
static CLDevice	getBestDevice() Returns the "best" OpenCL device (currently, the one that has the largest amount of compute units).
static CLDevice	getBestDevice(CLPlatform.DeviceFeature... preferredFeatures) Returns the "best" OpenCL device based on the comparison of the provided prioritized device feature.
static CLPlatform[]	listGPUPoweredPlatforms() List the OpenCL implementations that contain at least one GPU device.
static CLPlatform[]	listPlatforms() Lists all available OpenCL implementations.
static void	unloadCompiler() Allows the implementation to release the resources allocated by the OpenCL compiler.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaCL

public JavaCL()

Method Detail

listGPUPoweredPlatforms

public static CLPlatform[] listGPUPoweredPlatforms()

List the OpenCL implementations that contain at least one GPU device.

listPlatforms

public static CLPlatform[] listPlatforms()

Lists all available OpenCL implementations.

createContext

public static CLContext createContext(Map<CLPlatform.ContextProperties,Object> contextProperties,
                                      CLDevice... devices)

Creates an OpenCL context formed of the provided devices.
It is generally not a good idea to create a context with more than one device, because much data is shared between all the devices in the same context.

Parameters:

devices - devices that are to form the new context

Returns:

new OpenCL context

unloadCompiler

public static void unloadCompiler()

Allows the implementation to release the resources allocated by the OpenCL compiler.
This is a hint from the application and does not guarantee that the compiler will not be used in the future or that the compiler will actually be unloaded by the implementation.
Calls to Program.build() after unloadCompiler() will reload the compiler, if necessary, to build the appropriate program executable.

getBestDevice

public static CLDevice getBestDevice()

Returns the "best" OpenCL device (currently, the one that has the largest amount of compute units).
For more control on what is to be considered a better device, please use the getBestDevice(CLPlatform.DeviceFeature[]) variant.
This is currently equivalent to getBestDevice(MaxComputeUnits)

getBestDevice

public static CLDevice getBestDevice(CLPlatform.DeviceFeature... preferredFeatures)

Returns the "best" OpenCL device based on the comparison of the provided prioritized device feature.
The returned device does not necessarily exhibit the features listed in preferredFeatures, but it has the best ordered composition of them.
For instance on a system with a GPU and a CPU device, JavaCL.getBestDevice(CPU, MaxComputeUnits) will return the CPU device, but on another system with two GPUs and no CPU device it will return the GPU that has the most compute units.

createBestContext

public static CLContext createBestContext()

Creates an OpenCL context with the "best" device (see getBestDevice())

createBestContext

public static CLContext createBestContext(CLPlatform.DeviceFeature... preferredFeatures)

Creates an OpenCL context with the "best" device based on the comparison of the provided prioritized device feature (see getBestDevice(CLPlatform.DeviceFeature...))

createContextFromCurrentGL

public static CLContext createContextFromCurrentGL()

Creates an OpenCL context able to share entities with the current OpenGL context.

Throws:

RuntimeException - if JavaCL is unable to create an OpenGL-shared OpenCL context.