com.jogamp.opencl
Class CLUserEvent

java.lang.Object
  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
protected  CL cl
           
protected  CLContext context
           
 long ID
          The OpenCL object handle.
 
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.
 CLContext getContext()
          Returns the context for this OpenCL object.
 long getID()
          Returns the OpenCL object handle
 CLPlatform getPlatform()
          Returns the platform for this OpenCL object.
 CLEvent.CommandType getType()
          Returns CLEvent.CommandType.USER.
 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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public final long ID
The OpenCL object handle.


context

protected CLContext context

cl

protected final CL cl
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. TODO remove as soon we have extension methods.

Specified by:
close in interface AutoCloseable
See Also:
AutoCloseable

getContext

public CLContext getContext()
Returns the context for this OpenCL object.


getPlatform

public CLPlatform getPlatform()
Returns the platform for this OpenCL object.


getID

public long getID()
Returns the OpenCL object handle