com.nativelibs4java.opencl

Class CLUserEvent

java.lang.Object

com.nativelibs4java.opencl.CLEvent

com.nativelibs4java.opencl.CLUserEvent

public class CLUserEvent
extends CLEvent

Nested Class Summary

Nested classes/interfaces inherited from class com.nativelibs4java.opencl.CLEvent

CLEvent.CommandExecutionStatus, CLEvent.CommandType, CLEvent.EventCallback

Field Summary

Fields inherited from class com.nativelibs4java.opencl.CLEvent

FIRE_AND_FORGET

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Underyling implementation pointer-based equality test
static <E extends TypedPointer,A extends com.nativelibs4java.opencl.CLAbstractEntity> Pointer<E>	getEntities(A[] objects, Pointer<E> out)
int	hashCode() Underyling implementation pointer-based hashCode computation
void	release() Manual release of the OpenCL resources represented by this object.
void	setComplete() Calls setStatus(CL_COMPLETE)
void	setStatus(int executionStatus) Calls clSetUserEventStatus.

Methods inherited from class com.nativelibs4java.opencl.CLEvent

getCommandExecutionStatus, getCommandExecutionStatusValue, getCommandType, getProfilingCommandEnd, getProfilingCommandQueued, getProfilingCommandStart, getProfilingCommandSubmit, getQueue, invokeUponCompletion, invokeUponCompletion, setCallback, setCompletionCallback, toString, waitFor, waitFor

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

setStatus

public void setStatus(int executionStatus)

Calls clSetUserEventStatus.
Sets the execution status of a this event object. NOTE: Enqueued commands that specify user events in the event_wait_list argument of clEnqueue*** commands must ensure that the status of these user events being waited on are set using clSetUserEventStatus before any OpenCL APIs that release OpenCL objects except for event objects are called; otherwise the behavior is undefined. More details in the OpenCL specifications at section 5.9.

Parameters:

executionStatus - specifies the new execution status to be set and can be CL_COMPLETE or a negative integer value to indicate an error. A negative integer value causes all enqueued commands that wait on this user event to be terminated. setStatus can only be called once to change the execution status of event.

setComplete

public void setComplete()

Calls setStatus(CL_COMPLETE)

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