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

Fixed size list for storing CLEvents. More...

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

Public Member Functions

 CLEventList (final int capacity)
 
 CLEventList (final CLEvent... events)
 
 CLEventList (final CachedBufferFactory factory, final int capacity)
 
 CLEventList (final CachedBufferFactory factory, final CLEvent... events)
 
void waitForEvents ()
 Waits for all events in this list to occur. More...
 
void waitForEvents (final int start, final int range)
 Waits for all events of the specified region in this list to occur. More...
 
void waitForEvent (final int index)
 Waits for the event with the given index in this list to occur. More...
 
void release ()
 Releases all CLEvents in this list. More...
 
final void close ()
 
CLEvent getEvent (final int index)
 
int size ()
 Returns the current size of this list. More...
 
int capacity ()
 Returns the maximum size of this list. More...
 
boolean isReleased ()
 Returns true if release() has been called. More...
 
Iterator< CLEventiterator ()
 
String toString ()
 
void release ()
 Releases the OpenCL resource. More...
 
boolean isReleased ()
 Returns true if release() has been called. More...
 
void close ()
 

Detailed Description

Fixed size list for storing CLEvents.

Author
Michael Bien, et al.

Definition at line 40 of file CLEventList.java.

Constructor & Destructor Documentation

◆ CLEventList() [1/4]

com.jogamp.opencl.CLEventList.CLEventList ( final int  capacity)

Definition at line 56 of file CLEventList.java.

Here is the call graph for this function:

◆ CLEventList() [2/4]

com.jogamp.opencl.CLEventList.CLEventList ( final CLEvent...  events)

Definition at line 60 of file CLEventList.java.

◆ CLEventList() [3/4]

com.jogamp.opencl.CLEventList.CLEventList ( final CachedBufferFactory  factory,
final int  capacity 
)

Definition at line 64 of file CLEventList.java.

Here is the call graph for this function:

◆ CLEventList() [4/4]

com.jogamp.opencl.CLEventList.CLEventList ( final CachedBufferFactory  factory,
final CLEvent...  events 
)

Definition at line 70 of file CLEventList.java.

Member Function Documentation

◆ capacity()

int com.jogamp.opencl.CLEventList.capacity ( )

Returns the maximum size of this list.

Definition at line 175 of file CLEventList.java.

Here is the caller graph for this function:

◆ close()

final void com.jogamp.opencl.CLEventList.close ( )
Deprecated:
use release() instead.

Implements com.jogamp.opencl.AutoCloseable.

Definition at line 155 of file CLEventList.java.

Here is the call graph for this function:

◆ getEvent()

CLEvent com.jogamp.opencl.CLEventList.getEvent ( final int  index)

Definition at line 159 of file CLEventList.java.

Here is the caller graph for this function:

◆ isReleased()

boolean com.jogamp.opencl.CLEventList.isReleased ( )

Returns true if release() has been called.

Implements com.jogamp.opencl.CLResource.

Definition at line 180 of file CLEventList.java.

◆ iterator()

Iterator< CLEvent > com.jogamp.opencl.CLEventList.iterator ( )

Definition at line 185 of file CLEventList.java.

◆ release()

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

Releases all CLEvents in this list.

Implements com.jogamp.opencl.CLResource.

Definition at line 141 of file CLEventList.java.

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

◆ size()

int com.jogamp.opencl.CLEventList.size ( )

Returns the current size of this list.

Definition at line 168 of file CLEventList.java.

◆ toString()

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

Definition at line 190 of file CLEventList.java.

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

◆ waitForEvent()

void com.jogamp.opencl.CLEventList.waitForEvent ( final int  index)

Waits for the event with the given index in this list to occur.

Definition at line 132 of file CLEventList.java.

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

◆ waitForEvents() [1/2]

void com.jogamp.opencl.CLEventList.waitForEvents ( )

Waits for all events in this list to occur.

If this list is empty this method won't do anything.

Definition at line 110 of file CLEventList.java.

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

◆ waitForEvents() [2/2]

void com.jogamp.opencl.CLEventList.waitForEvents ( final int  start,
final int  range 
)

Waits for all events of the specified region in this list to occur.

Will throw IndexOutOfBoundsException if indices are out of bounds.

Definition at line 120 of file CLEventList.java.

Here is the call graph for this function:

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