com.jme3.opencl.jocl

Class JoclKernel

java.lang.Object

com.jme3.opencl.AbstractOpenCLObject

com.jme3.opencl.Kernel

com.jme3.opencl.jocl.JoclKernel

All Implemented Interfaces:

OpenCLObject

public class JoclKernel
extends Kernel

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.opencl.Kernel

Kernel.LocalMem, Kernel.LocalMemPerElement, Kernel.WorkSize

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

OpenCLObject.ObjectReleaser

Field Summary

Fields inherited from class com.jme3.opencl.Kernel

globalWorkSize, workGroupSize

Fields inherited from class com.jme3.opencl.AbstractOpenCLObject

releaser

Constructor Summary

Constructors

Constructor and Description
JoclKernel(long kernel)

Method Summary

Modifier and Type	Method and Description
int	getArgCount()
long	getMaxWorkGroupSize(Device device) Returns the maximal work group size when this kernel is executed on the specified device
java.lang.String	getName()
Event	Run(CommandQueue queue) Launches the kernel with the current global work size, work group size and arguments.
void	RunNoEvent(CommandQueue queue) Launches the kernel with the current global work size, work group size and arguments without returning an event object.
void	setArg(int index, Buffer t)
void	setArg(int index, byte b)
void	setArg(int index, java.nio.ByteBuffer buffer, long size) Raw version to set an argument.
void	setArg(int index, double d)
void	setArg(int index, float f)
void	setArg(int index, Image i)
void	setArg(int index, int i)
void	setArg(int index, Kernel.LocalMem t)
void	setArg(int index, Kernel.LocalMemPerElement t)
void	setArg(int index, long l)
void	setArg(int index, Matrix4f m)
void	setArg(int index, Quaternion q)
void	setArg(int index, short s)
void	setArg(int index, Vector2f v)
void	setArg(int index, Vector4f v)

Methods inherited from class com.jme3.opencl.Kernel

getGlobalWorkSize, getWorkGroupSize, register, Run1, Run1NoEvent, Run2, Run2NoEvent, setArg, setArg, setGlobalWorkSize, setGlobalWorkSize, setGlobalWorkSize, setGlobalWorkSize, setWorkGroupSdize, setWorkGroupSize, setWorkGroupSize, setWorkGroupSize, setWorkGroupSizeToNull, toString

Methods inherited from class com.jme3.opencl.AbstractOpenCLObject

finalize, getReleaser, release

Methods inherited from class java.lang.Object

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

Constructor Detail

JoclKernel

public JoclKernel(long kernel)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class Kernel

Returns:

the name of the kernel as defined in the program source code

getArgCount

public int getArgCount()

Specified by:

getArgCount in class Kernel

Returns:

the number of arguments

getMaxWorkGroupSize

public long getMaxWorkGroupSize(Device device)

Description copied from class: Kernel

Returns the maximal work group size when this kernel is executed on the specified device

Specified by:

getMaxWorkGroupSize in class Kernel

Parameters:

device - the device

Returns:

the maximal work group size

setArg

public void setArg(int index,
                   Kernel.LocalMemPerElement t)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   Kernel.LocalMem t)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   Buffer t)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   Image i)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   byte b)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   short s)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   int i)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   long l)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   float f)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   double d)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   Vector2f v)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   Vector4f v)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   Quaternion q)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   Matrix4f m)

Specified by:

setArg in class Kernel

setArg

public void setArg(int index,
                   java.nio.ByteBuffer buffer,
                   long size)

Description copied from class: Kernel

Raw version to set an argument. size bytes of the provided byte buffer are copied to the kernel argument. The size in bytes must match exactly the argument size as defined in the kernel code. Use this method to send custom structures to the kernel

Specified by:

setArg in class Kernel

Parameters:

index - the index of the argument

buffer - the raw buffer

size - the size in bytes

Run

public Event Run(CommandQueue queue)

Description copied from class: Kernel

Launches the kernel with the current global work size, work group size and arguments. If the returned event object is not needed and would otherwise be released immediately, Kernel.RunNoEvent(com.jme3.opencl.CommandQueue) might bring a better performance.

Specified by:

Run in class Kernel

Parameters:

queue - the command queue

Returns:

an event object indicating when the kernel is finished

See Also:

Kernel.setGlobalWorkSize(com.jme3.opencl.Kernel.WorkSize), Kernel.setWorkGroupSize(com.jme3.opencl.Kernel.WorkSize), Kernel.setArg(int, java.lang.Object)

RunNoEvent

public void RunNoEvent(CommandQueue queue)

Description copied from class: Kernel

Launches the kernel with the current global work size, work group size and arguments without returning an event object. The generated event is directly released. Therefore, the performance is better, but there is no way to detect when the kernel execution has finished. For this purpose, use Kernel.Run(com.jme3.opencl.CommandQueue).

Overrides:

RunNoEvent in class Kernel

Parameters:

queue - the command queue

See Also:

Kernel.setGlobalWorkSize(com.jme3.opencl.Kernel.WorkSize), Kernel.setWorkGroupSize(com.jme3.opencl.Kernel.WorkSize), Kernel.setArg(int, java.lang.Object)