|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jogamp.opencl.CLPlatform
public final class CLPlatform
CLPlatfrorm representing a OpenCL implementation (e.g. graphics driver). optional eager initialization:
try{ CLPlatform.initialize(); }catch(JogampRuntimeException ex) { throw new RuntimeException("could not load Java OpenCL Binding"); }Example initialization:
CLPlatform platform = CLPlatform.getDefault(type(GPU)); if(platform == null) { throw new RuntimeException("please update your graphics drivers"); } CLContext context = CLContext.create(platform.getMaxFlopsDevice()); try { // use it }finally{ context.release(); }concurrency:
initialize()
,
getDefault()
,
listCLPlatforms()
Field Summary | |
---|---|
long |
ID
OpenCL platform id for this platform. |
CLVersion |
version
Version of this OpenCL platform. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
static CLPlatform |
getDefault()
Returns the default OpenCL platform or null when no platform found. |
static CLPlatform |
getDefault(Filter<CLPlatform>... filter)
Returns the default OpenCL platform or null when no platform found. |
Set<String> |
getExtensions()
Returns all platform extension names as unmodifiable Set. |
String |
getICDSuffix()
Returns the ICD suffix. |
String |
getInfoString(int key)
Returns a info string in exchange for a key (CL_PLATFORM_*). |
static CL |
getLowLevelCLInterface()
Returns the low level binding interface to the OpenCL APIs. |
CLDevice |
getMaxFlopsDevice()
Returns the device with maximal FLOPS from this platform. |
CLDevice |
getMaxFlopsDevice(CLDevice.Type... types)
Returns the device with maximal FLOPS and the specified type from this platform. |
String |
getName()
Returns the platform name. |
String |
getProfile()
Returns the platform profile. |
Map<String,String> |
getProperties()
Returns a Map of platform properties with the enum names as keys. |
String |
getSpecVersion()
Returns the OpenCL Specification version supported by this platform. |
String |
getVendor()
Returns the platform vendor. |
CLVersion |
getVersion()
Returns the OpenCL version supported by this platform. |
int |
hashCode()
|
static void |
initialize()
Eagerly initializes JOCL. |
boolean |
isAtLeast(CLVersion other)
|
boolean |
isAtLeast(int major,
int minor)
|
boolean |
isExtensionAvailable(String extension)
Returns true if the extension is supported on this platform. |
CLDevice[] |
listCLDevices()
Lists all physical devices available on this platform. |
CLDevice[] |
listCLDevices(CLDevice.Type... types)
Lists all physical devices available on this platform matching the given CLDevice.Type . |
static CLPlatform[] |
listCLPlatforms()
Lists all available OpenCL implementations. |
static CLPlatform[] |
listCLPlatforms(Filter<CLPlatform>... filter)
Lists all available OpenCL implementations. |
String |
toString()
|
static void |
unloadCompiler()
Hint to allow the implementation to release the resources allocated by the OpenCL compiler. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public final long ID
public final CLVersion version
Method Detail |
---|
public static void initialize() throws JogampRuntimeException
JogampRuntimeException
- if something went wrong in the initialization (e.g. OpenCL lib not found).public static CLPlatform getDefault()
public static CLPlatform getDefault(Filter<CLPlatform>... filter)
public static CLPlatform[] listCLPlatforms()
CLException
- if something went wrong initializing OpenCLpublic static CLPlatform[] listCLPlatforms(Filter<CLPlatform>... filter)
filter
- Acceptance filter for the returned platforms.
CLException
- if something went wrong initializing OpenCLpublic static CL getLowLevelCLInterface()
public static void unloadCompiler()
CLProgram.build()
after unloadCompiler will reload the compiler if necessary.
public CLDevice[] listCLDevices()
listCLDevices(com.jogamp.opencl.CLDevice.Type...)
public CLDevice[] listCLDevices(CLDevice.Type... types)
CLDevice.Type
.
public CLDevice getMaxFlopsDevice()
getMaxFlopsDevice(com.jogamp.opencl.CLDevice.Type...)
public CLDevice getMaxFlopsDevice(CLDevice.Type... types)
public String getName()
public CLVersion getVersion()
public String getSpecVersion()
public boolean isAtLeast(CLVersion other)
CLVersion.isAtLeast(com.jogamp.opencl.CLVersion)
public boolean isAtLeast(int major, int minor)
CLVersion.isAtLeast(int, int)
public String getProfile()
public String getVendor()
public String getICDSuffix()
public boolean isExtensionAvailable(String extension)
public Set<String> getExtensions()
public Map<String,String> getProperties()
CLUtil.obtainPlatformProperties(com.jogamp.opencl.CLPlatform)
public String getInfoString(int key)
public String toString()
toString
in class Object
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |