Package com.jme3.opencl

Class Event

java.lang.Object

com.jme3.opencl.AbstractOpenCLObject

com.jme3.opencl.Event

All Implemented Interfaces:

OpenCLObject

Direct Known Subclasses:

LwjglEvent

public abstract class Event
extends AbstractOpenCLObject

Wrapper for an OpenCL Event object. Events are returned from kernel launches and all asynchronous operations. They allow us to test whether an action has completed and block until the operation is done.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jme3.opencl.OpenCLObject

OpenCLObject.ObjectReleaser

Field Summary

Fields inherited from class com.jme3.opencl.AbstractOpenCLObject

releaser

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Event(OpenCLObject.ObjectReleaser releaser)

Method Summary

Modifier and Type	Method	Description
abstract boolean	isCompleted()	Tests if the action is completed.
Event	register()	Registers this object for automatic releasing on garbage collection.
abstract void	waitForFinished()	Waits until the action has finished (blocking).

Methods inherited from class com.jme3.opencl.AbstractOpenCLObject

finalize, getReleaser, release

Methods inherited from class java.lang.Object

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

Constructor Details

Event

protected Event(OpenCLObject.ObjectReleaser releaser)

Method Details

register

public Event register()

Description copied from interface: OpenCLObject

Registers this object for automatic releasing on garbage collection. By default, OpenCLObjects are not registered in the OpenCLObjectManager, you have to release it manually by calling OpenCLObject.release(). Without registering or releasing, a memory leak might occur.
Returns this to allow calls like Buffer buffer = clContext.createBuffer(1024).register();.

Specified by:

register in interface OpenCLObject

Overrides:

register in class AbstractOpenCLObject

Returns:

this

waitForFinished

public abstract void waitForFinished()

Waits until the action has finished (blocking). This automatically releases the event.

isCompleted

public abstract boolean isCompleted()

Tests if the action is completed. If the action is completed, the event is released.

Returns:

true if the action is completed