CLPlatform (JavaCL Core / BridJ 1.0.0-RC4 API)

java.lang.Object
- com.nativelibs4java.opencl.CLPlatform

```
public class CLPlatform
extends Object
```
OpenCL implementation entry point. see JavaCL.listPlatforms()

Author:

Olivier Chafik

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CLPlatform.ContextProperties` Bit values for CL_CONTEXT_PROPERTIES
`static class`	`CLPlatform.DeviceComparator`
`static class`	`CLPlatform.DeviceFeature` Enums used to indicate how to choose the best CLDevice.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CLContext`	`createContext(Map<CLPlatform.ContextProperties,Object> contextProperties, CLDevice... devices)` Calls clCreateContext.
`CLContext`	`createContextFromCurrentGL()`
`CLContext`	`createGLCompatibleContext(CLDevice... devices)` Deprecated.
`boolean`	`equals(Object obj)` Underyling implementation pointer-based equality test
`CLDevice`	`getBestDevice()`
`static CLDevice`	`getBestDevice(List<CLPlatform.DeviceFeature> evals, Collection<CLDevice> devices)`
`static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E>`	`getEntities(A[] objects, Pointer<E> out)`
`String[]`	`getExtensions()` Returns a list of extension names Extensions defined here must be supported by all devices associated with this platform.
`String`	`getName()` Platform name string.
`String`	`getProfile()` OpenCL profile string.
`String`	`getVendor()` Platform vendor string.
`String`	`getVersion()` OpenCL version string.
`boolean`	`hasExtension(String name)`
`int`	`hashCode()` Underyling implementation pointer-based hashCode computation
`boolean`	`isByteAddressableStoreSupported()`
`boolean`	`isGLSharingSupported()`
`boolean`	`isNVCompilerOptionsSupported()`
`boolean`	`isNVDeviceAttributeQuerySupported()`
`CLDevice[]`	`listAllDevices(boolean onlyAvailable)` Lists all the devices of the platform
`CLDevice[]`	`listCPUDevices(boolean onlyAvailable)` Lists all the CPU devices of the platform
`CLDevice[]`	`listDevices(CLDevice.Type type, boolean onlyAvailable)` Calls clGetDeviceIDs.
`CLDevice[]`	`listGPUDevices(boolean onlyAvailable)` Lists all the GPU devices of the platform
`void`	`release()` Manual release of the OpenCL resources represented by this object.
`String`	`toString()`
`void`	`unloadPlatformCompiler()` Allows the implementation to release the resources allocated by the OpenCL compiler for this platform.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - listAllDevices
```
public CLDevice[] listAllDevices(boolean onlyAvailable)
```
    Lists all the devices of the platform
    
    Parameters:
    
    onlyAvailable - if true, only returns devices that are available see listDevices(CLDevice.Type, boolean)
  - listGPUDevices
```
public CLDevice[] listGPUDevices(boolean onlyAvailable)
```
    Lists all the GPU devices of the platform
    
    Parameters:
    
    onlyAvailable - if true, only returns GPU devices that are available see listDevices(CLDevice.Type, boolean)
  - listCPUDevices
```
public CLDevice[] listCPUDevices(boolean onlyAvailable)
```
    Lists all the CPU devices of the platform
    
    Parameters:
    
    onlyAvailable - if true, only returns CPU devices that are available see listDevices(CLDevice.Type, boolean)
  - getBestDevice
```
public static CLDevice getBestDevice(List<CLPlatform.DeviceFeature> evals,
                                     Collection<CLDevice> devices)
```
  - getBestDevice
```
public CLDevice getBestDevice()
```
  - createContextFromCurrentGL
```
public CLContext createContextFromCurrentGL()
```
  - createGLCompatibleContext
```
@Deprecated
public CLContext createGLCompatibleContext(CLDevice... devices)
```
    Deprecated.
    
    Calls clCreateContext.
  - createContext
```
public CLContext createContext(Map<CLPlatform.ContextProperties,Object> contextProperties,
                               CLDevice... devices)
```
    Calls clCreateContext.
    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
  - listDevices
```
public CLDevice[] listDevices(CLDevice.Type type,
                              boolean onlyAvailable)
```
    Calls clGetDeviceIDs.
    List all the devices of the specified types, with only the ones declared as available if onlyAvailable is true.
  - getProfile
```
public String getProfile()
```
    OpenCL profile string. Returns the profile name supported by the implementation. The profile name returned can be one of the following strings:
    - FULL_PROFILE if the implementation supports the OpenCL specification (functionality defined as part of the core specification and does not require any extensions to be supported).
    - EMBEDDED_PROFILE if the implementation supports the OpenCL embedded profile. The embedded profile is defined to be a subset for each version of OpenCL. The embedded profile for OpenCL 1.0 is described in section 10.
  - getVersion
```
public String getVersion()
```
    OpenCL version string. Returns the OpenCL version supported by the implementation. This version string has the following format: OpenCL<space><major_version.min or_version><space><platform- specific information> Last Revision Date: 5/16/09 Page 30 The major_version.minor_version value returned will be 1.0.
  - getName
```
public String getName()
```
    Platform name string.
  - getVendor
```
public String getVendor()
```
    Platform vendor string.
  - getExtensions
```
public String[] getExtensions()
```
    Returns a list of extension names
    Extensions defined here must be supported by all devices associated with this platform.
  - hasExtension
```
public boolean hasExtension(String name)
```
  - isNVDeviceAttributeQuerySupported
```
public boolean isNVDeviceAttributeQuerySupported()
```
  - isNVCompilerOptionsSupported
```
public boolean isNVCompilerOptionsSupported()
```
  - isByteAddressableStoreSupported
```
public boolean isByteAddressableStoreSupported()
```
  - isGLSharingSupported
```
public boolean isGLSharingSupported()
```
  - unloadPlatformCompiler
```
public void unloadPlatformCompiler()
```
    Allows the implementation to release the resources allocated by the OpenCL compiler for this platform.
  - release
```
public void release()
```
    Manual release of the OpenCL resources represented by this object.
    Note that resources are automatically released by the garbage collector, so in general there's no need to call this method.
    In an environment with fast allocation/deallocation of large objects, it might be safer to call release() manually, though.
    Note that release() does not necessarily free the object immediately : OpenCL maintains a reference count for all its objects, and an object released on the Java side might still be pointed to by running kernels or queued operations.
  - getEntities
```
public static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E> getEntities(A[] objects,
                                                                                                                    Pointer<E> out)
```
  - hashCode
```
public int hashCode()
```
    Underyling implementation pointer-based hashCode computation
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Underyling implementation pointer-based equality test
    
    Overrides:
    
    equals in class Object

Class CLPlatform

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toString

listAllDevices

listGPUDevices

listCPUDevices

getBestDevice

getBestDevice

createContextFromCurrentGL

createGLCompatibleContext

createContext

listDevices

getProfile

getVersion

getName

getVendor

getExtensions

hasExtension

isNVDeviceAttributeQuerySupported

isNVCompilerOptionsSupported

isByteAddressableStoreSupported

isGLSharingSupported

unloadPlatformCompiler

release

getEntities

hashCode

equals