com.jme3.opencl.jocl

Class JoclProgram

java.lang.Object

com.jme3.opencl.AbstractOpenCLObject

com.jme3.opencl.Program

com.jme3.opencl.jocl.JoclProgram

All Implemented Interfaces:

OpenCLObject

public class JoclProgram
extends Program

Nested Class Summary

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

OpenCLObject.ObjectReleaser

Field Summary

Fields inherited from class com.jme3.opencl.AbstractOpenCLObject

releaser

Constructor Summary

Constructors

Constructor and Description
JoclProgram(long program, JoclContext context)

Method Summary

Modifier and Type	Method and Description
void	build(java.lang.String args, Device... devices) Builds this program with the specified argument string on the specified devices.
Kernel[]	createAllKernels() Creates all available kernels in this program.
Kernel	createKernel(java.lang.String name) Creates the kernel with the specified name.
java.nio.ByteBuffer	getBinary(Device d) Queries a compiled binary representation of this program for a particular device.

Methods inherited from class com.jme3.opencl.Program

build, register

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

Constructor Detail

JoclProgram

public JoclProgram(long program,
                   JoclContext context)

Method Detail

build

public void build(java.lang.String args,
                  Device... devices)
           throws KernelCompilationException

Description copied from class: Program

Builds this program with the specified argument string on the specified devices. Please see the official OpenCL specification for a definition of all supported arguments. The list of devices specify on which device the compiled program can then be executed. It must be a subset of Context.getDevices(). If null is passed, the program is built on all available devices.

Specified by:

build in class Program

Parameters:

args - the compilation arguments

devices - a list of devices on which the program is build.

Throws:

KernelCompilationException - if the compilation fails

See Also:

Program.build()

createKernel

public Kernel createKernel(java.lang.String name)

Description copied from class: Program

Creates the kernel with the specified name.

Specified by:

createKernel in class Program

Parameters:

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

Returns:

the kernel object

createAllKernels

public Kernel[] createAllKernels()

Description copied from class: Program

Creates all available kernels in this program. The names of the kernels can then by queried by Kernel.getName().

Specified by:

createAllKernels in class Program

Returns:

an array of all kernels

getBinary

public java.nio.ByteBuffer getBinary(Device d)

Description copied from class: Program

Queries a compiled binary representation of this program for a particular device. This binary can then be used e.g. in the next application launch to create the program from the binaries and not from the sources. This saves time.

Specified by:

getBinary in class Program

Parameters:

d - the device from which the binaries are taken

Returns:

the binaries

See Also:

Context.createProgramFromBinary(java.nio.ByteBuffer, com.jme3.opencl.Device)