Modifier and Type	Class and Description
private static class	CLEventList.EventIterator

Access	Constructor and Description
public	CLEventList(final int capacity)
public	CLEventList(final CLEvent... events)
public	CLEventList(final CachedBufferFactory factory, final int capacity)
public	CLEventList(final CachedBufferFactory factory, final CLEvent... events)

Method Summary

Modifier and Type	Method and Description
public int	capacity() Returns the maximum size of this list.
public final void	close() Implements com.jogamp.opencl.AutoCloseable.close. Deprecated use `release()` instead.
pack-priv void	createEvent(final CLContext context)
public CLEvent	getEvent(final int index)
pack-priv PointerBuffer	getEventBuffer(final int index)
private PointerBuffer	initIDBuffer(final CachedBufferFactory factory, final int size)
public boolean	isReleased() Implements com.jogamp.opencl.CLResource.isReleased. Returns true if `release()` has been called.
public Iterator<CLEvent>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public void	release() Implements com.jogamp.opencl.CLResource.release. Releases all CLEvents in this list.
public int	size() Returns the current size of this list.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	waitForEvent(final int index) Waits for the event with the given index in this list to occur.
public void	waitForEvents() Waits for all events in this list to occur.
public void	waitForEvents(final int start, final int range) Waits for all events of the specified region in this list to occur.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

events	back to summary
private final CLEvent[] events

IDs	back to summary
pack-priv final PointerBuffer IDs stores event ids for fast access.

IDsView	back to summary
pack-priv final PointerBuffer IDsView Points always to the first element of the id buffer.

size	back to summary
pack-priv int size

CLEventList	back to summary
public CLEventList(final int capacity)

CLEventList	back to summary
public CLEventList(final CLEvent... events)

CLEventList	back to summary
public CLEventList(final CachedBufferFactory factory, final int capacity)

CLEventList	back to summary
public CLEventList(final CachedBufferFactory factory, final CLEvent... events)

Method Detail

capacity	back to summary
public int capacity() Returns the maximum size of this list.

close back to summary

close	back to summary
public final void close() Implements com.jogamp.opencl.AutoCloseable.close. Deprecated use `release()` instead. Annotations @Deprecated @Override

public final void close()

Implements com.jogamp.opencl.AutoCloseable.close.

Deprecated

use release() instead.

Annotations

@Deprecated
@Override

createEvent	back to summary
pack-priv void createEvent(final CLContext context)

getEvent	back to summary
public CLEvent getEvent(final int index)

getEventBuffer	back to summary
pack-priv PointerBuffer getEventBuffer(final int index)

initIDBuffer	back to summary
private PointerBuffer initIDBuffer(final CachedBufferFactory factory, final int size)

isReleased back to summary

isReleased	back to summary
public boolean isReleased() Implements com.jogamp.opencl.CLResource.isReleased. Doc from com.jogamp.opencl.CLResource.isReleased. Returns true if `release()` has been called.

public boolean isReleased()

Implements com.jogamp.opencl.CLResource.isReleased.

Doc from com.jogamp.opencl.CLResource.isReleased.

Returns true if release() has been called.

iterator back to summary

iterator	back to summary
public Iterator<CLEvent> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<CLEvent> an Iterator. Annotations @Override

public Iterator<CLEvent> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<CLEvent>

an Iterator.

Annotations

@Override

release	back to summary
public void release() Implements com.jogamp.opencl.CLResource.release. Releases all CLEvents in this list. Annotations @Override

release

back to summary

public void release()

Implements com.jogamp.opencl.CLResource.release.

Releases all CLEvents in this list.

Annotations

@Override

size	back to summary
public int size() Returns the current size of this list.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

waitForEvent	back to summary
public void waitForEvent(final int index) Waits for the event with the given index in this list to occur.

waitForEvents	back to summary
public void waitForEvents() Waits for all events in this list to occur. If this list is empty this method won't do anything.

waitForEvents	back to summary
public void 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.

com.jogamp.opencl back to summary

private Class CLEventList.EventIterator

Class Inheritance

extends Object
implements Iterator<CLEvent>

java.lang.Object
com.jogamp.opencl.CLEventList.EventIterator

All Implemented Interfaces

java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private final CLEvent[]	events
private int	index
private final int	size

Constructor Summary

Access	Constructor and Description
private	EventIterator(final CLEvent[] events, final int size)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public CLEvent	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

events	back to summary
private final CLEvent[] events

index	back to summary
private int index

size	back to summary
private final int size

Constructor Detail

EventIterator	back to summary
private EventIterator(final CLEvent[] events, final int size)

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public CLEvent next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:CLEvent the next element in the iteration Annotations @Override

back to summary

public CLEvent next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:CLEvent

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public final Class CLEventList

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CLEventList.EventIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final CLEvent[]	events
pack-priv final PointerBuffer	IDs stores event ids for fast access.
pack-priv final PointerBuffer	IDsView Points always to the first element of the id buffer.
pack-priv int	size