com.jogamp.opencl
Class CLUserEvent

java.lang.Object
  extended by com.jogamp.opencl.CLObject
      extended by com.jogamp.opencl.CLEvent
          extended by com.jogamp.opencl.CLUserEvent
All Implemented Interfaces:
AutoCloseable, CLResource

public class CLUserEvent
extends CLEvent

Custom, user controlled event.

Author:
Michael Bien
See Also:
CLEvent

Nested Class Summary
 
Nested classes/interfaces inherited from class com.jogamp.opencl.CLEvent
CLEvent.CommandType, CLEvent.ExecutionStatus, CLEvent.ProfilingCommand
 
Field Summary
 
Fields inherited from class com.jogamp.opencl.CLObject
context, ID
 
Method Summary
 void close()
          Deprecated. This method is not intended to be called from client code.
static CLUserEvent create(CLContext context)
          Creates a new user event.
 CLEvent.CommandType getType()
          Returns CLEvent.CommandType.USER.
 boolean isReleased()
          Returns true if CLResource.release() has been called.
 CLUserEvent setComplete()
          Sets this event's status to CLEvent.ExecutionStatus.COMPLETE.
 CLUserEvent setStatus(CLEvent.ExecutionStatus status)
          Sets the event execution status.
 
Methods inherited from class com.jogamp.opencl.CLEvent
equals, getProfilingInfo, getStatus, getStatusCode, hashCode, isComplete, registerCallback, release, toString
 
Methods inherited from class com.jogamp.opencl.CLObject
getContext, getID, getPlatform
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

create

public static CLUserEvent create(CLContext context)
Creates a new user event.


setStatus

public CLUserEvent setStatus(CLEvent.ExecutionStatus status)
Sets the event execution status. Calls clSetUserEventStatus.


setComplete

public CLUserEvent setComplete()
Sets this event's status to CLEvent.ExecutionStatus.COMPLETE.

See Also:
setStatus(com.jogamp.opencl.CLEvent.ExecutionStatus)

getType

public CLEvent.CommandType getType()
Returns CLEvent.CommandType.USER.

Overrides:
getType in class CLEvent

close

@Deprecated
public final void close()
Deprecated. This method is not intended to be called from client code.

Implementation detail, satisfying AutoCloseable. Might be remove as soon we have extension methods, but shall validate with Java 1.5 specs.

Specified by:
close in interface AutoCloseable
See Also:
AutoCloseable

isReleased

public boolean isReleased()
Description copied from interface: CLResource
Returns true if CLResource.release() has been called.

Specified by:
isReleased in interface CLResource