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

Event objects can be used for synchronizing command queues, e.g you can wait until a event occurs or they can also be used to capture profiling information that measure execution time of a command. More...

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

Classes

enum  CommandType
 
enum  ExecutionStatus
 
enum  ProfilingCommand
 

Public Member Functions

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 ()
 

Detailed Description

Event objects can be used for synchronizing command queues, e.g you can wait until a event occurs or they can also be used to capture profiling information that measure execution time of a command.

Profiling of OpenCL commands can be enabled by using a com.jogamp.opencl.CLCommandQueue created with com.jogamp.opencl.CLCommandQueue.Mode#PROFILING_MODE.

Author
Michael Bien, et al.

Definition at line 48 of file CLEvent.java.

Member Function Documentation

◆ equals()

boolean com.jogamp.opencl.CLEvent.equals ( final Object  obj)

Definition at line 120 of file CLEvent.java.

◆ getProfilingInfo()

long com.jogamp.opencl.CLEvent.getProfilingInfo ( final ProfilingCommand  command)

Definition at line 107 of file CLEvent.java.

Here is the caller graph for this function:

◆ getStatus()

ExecutionStatus com.jogamp.opencl.CLEvent.getStatus ( )

Returns the execution status of the command which triggers this event.

Definition at line 87 of file CLEvent.java.

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

◆ getStatusCode()

int com.jogamp.opencl.CLEvent.getStatusCode ( )

Definition at line 98 of file CLEvent.java.

Here is the caller graph for this function:

◆ getType()

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

Reimplemented in com.jogamp.opencl.CLUserEvent.

Definition at line 102 of file CLEvent.java.

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

◆ hashCode()

int com.jogamp.opencl.CLEvent.hashCode ( )

Definition at line 138 of file CLEvent.java.

Here is the call graph for this function:

◆ isComplete()

boolean com.jogamp.opencl.CLEvent.isComplete ( )

Returns true only if getStatus returns ExecutionStatus#COMPLETE.

Definition at line 94 of file CLEvent.java.

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

◆ registerCallback()

void com.jogamp.opencl.CLEvent.registerCallback ( final CLEventListener  callback)

Registers a callback which will be called when the event terminates (COMPLETE or ERROR).

Definition at line 64 of file CLEvent.java.

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

◆ release()

void com.jogamp.opencl.CLEvent.release ( )

Releases the OpenCL resource.

Implements com.jogamp.opencl.CLResource.

Definition at line 78 of file CLEvent.java.

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

◆ toString()

String com.jogamp.opencl.CLEvent.toString ( )

Reimplemented from com.jogamp.opencl.CLObject.

Definition at line 113 of file CLEvent.java.

Here is the call graph for this function:

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