JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
com.jogamp.opencl.CLUserEvent Class Reference

Custom, user controlled event. More...

Inheritance diagram for com.jogamp.opencl.CLUserEvent:
Collaboration diagram for com.jogamp.opencl.CLUserEvent:

Public Member Functions

CLUserEvent setStatus (final CLEvent.ExecutionStatus status)
 Sets the event execution status. More...
 
CLUserEvent setComplete ()
 Sets this event's status to CLEvent.ExecutionStatus#COMPLETE. More...
 
CommandType getType ()
 Returns CLEvent.CommandType#USER. More...
 
- Public Member Functions inherited from com.jogamp.opencl.CLEvent
void registerCallback (final CLEventListener callback)
 Registers a callback which will be called when the event terminates (COMPLETE or ERROR). More...
 
void release ()
 Releases the OpenCL resource. More...
 
ExecutionStatus getStatus ()
 Returns the execution status of the command which triggers this event. More...
 
boolean isComplete ()
 Returns true only if getStatus returns ExecutionStatus#COMPLETE. More...
 
int getStatusCode ()
 
CommandType getType ()
 
long getProfilingInfo (final ProfilingCommand command)
 
String toString ()
 
boolean equals (final Object obj)
 
int hashCode ()
 

Static Public Member Functions

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

Detailed Description

Custom, user controlled event.

See also
CLEvent
Author
Michael Bien

Definition at line 44 of file CLUserEvent.java.

Member Function Documentation

◆ create()

static CLUserEvent com.jogamp.opencl.CLUserEvent.create ( final CLContext  context)
static

Creates a new user event.

Definition at line 53 of file CLUserEvent.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getType()

CommandType com.jogamp.opencl.CLUserEvent.getType ( )

Returns CLEvent.CommandType#USER.

Reimplemented from com.jogamp.opencl.CLEvent.

Definition at line 86 of file CLUserEvent.java.

Here is the caller graph for this function:

◆ setComplete()

CLUserEvent com.jogamp.opencl.CLUserEvent.setComplete ( )

Sets this event's status to CLEvent.ExecutionStatus#COMPLETE.

See also
setStatus(com.jogamp.opencl.CLEvent.ExecutionStatus)

Definition at line 78 of file CLUserEvent.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setStatus()

CLUserEvent com.jogamp.opencl.CLUserEvent.setStatus ( final CLEvent.ExecutionStatus  status)

Sets the event execution status.

Calls {@native clSetUserEventStatus}.

Definition at line 65 of file CLUserEvent.java.

Here is the call graph for this function:
Here is the caller graph for this function:

The documentation for this class was generated from the following file: