com.jme3.opencl

Class CommandQueue

java.lang.Object

com.jme3.opencl.AbstractOpenCLObject

com.jme3.opencl.CommandQueue

All Implemented Interfaces:

OpenCLObject

Direct Known Subclasses:

JoclCommandQueue, LwjglCommandQueue

public abstract class CommandQueue
extends AbstractOpenCLObject

Wrapper for an OpenCL command queue. The command queue serializes every GPU function call: By passing the same queue to OpenCL function (buffer, image operations, kernel calls), it is ensured that they are executed in the order in which they are passed.
Each command queue is associtated with exactly one device: that device is specified on creation (Context.createQueue(com.jme3.opencl.Device)) and all commands are sent to this device.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jme3.opencl.OpenCLObject

OpenCLObject.ObjectReleaser

Field Summary

Fields

Modifier and Type	Field and Description
protected Device	device

Fields inherited from class com.jme3.opencl.AbstractOpenCLObject

releaser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandQueue(OpenCLObject.ObjectReleaser releaser, Device device)

Method Summary

Modifier and Type	Method and Description
abstract void	finish() Blocks until all previously queued OpenCL commands in command queue are issued to the associated device and have completed.
abstract void	flush() Issues all previously queued OpenCL commands in command_queue to the device associated with command queue.
Device	getDevice() Returns the device associated with this command queue.
CommandQueue	register() Registers this object for automatic releasing on garbage collection.

Methods inherited from class com.jme3.opencl.AbstractOpenCLObject

finalize, getReleaser, release

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

device

protected Device device

Constructor Detail

CommandQueue

protected CommandQueue(OpenCLObject.ObjectReleaser releaser,
                       Device device)

Method Detail

register

public CommandQueue register()

Description copied from interface: OpenCLObject

Registers this object for automatic releasing on garbage collection. By default, OpenCLObjects are not registered in the OpenCLObjectManager, you have to release it manually by calling OpenCLObject.release(). Without registering or releasing, a memory leak might occur.
Returns this to allow calls like Buffer buffer = clContext.createBuffer(1024).register();.

Specified by:

register in interface OpenCLObject

Overrides:

register in class AbstractOpenCLObject

Returns:

this

getDevice

public Device getDevice()

Returns the device associated with this command queue. It can be used to query properties of the device that is used to execute the commands issued to this command queue.

Returns:

the associated device

flush

public abstract void flush()

Issues all previously queued OpenCL commands in command_queue to the device associated with command queue. Flush only guarantees that all queued commands to command_queue will eventually be submitted to the appropriate device. There is no guarantee that they will be complete after flush returns.

finish

public abstract void finish()

Blocks until all previously queued OpenCL commands in command queue are issued to the associated device and have completed. Finish does not return until all previously queued commands in command queue have been processed and completed. Finish is also a synchronization point.