|
JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java (public API).
|
Represents a OpenCL program executed on one or more CLDevices.
More...
Classes | |
| interface | CompilerOptions |
| Common compiler options for the OpenCL compiler. More... | |
| enum | Status |
Public Member Functions | |
| CLProgram | build () |
| Builds this program for all devices associated with the context. More... | |
| CLProgram | build (final CLBuildListener listener) |
| Builds this program for all devices associated with the context. More... | |
| CLProgram | build (final CLDevice... devices) |
| Builds this program for the given devices. More... | |
| CLProgram | build (final CLBuildListener listener, final CLDevice... devices) |
| Builds this program for the given devices. More... | |
| CLProgram | build (final String options) |
| Builds this program for all devices associated with the context using the specified build options. More... | |
| CLProgram | build (final CLBuildListener listener, final String options) |
| Builds this program for all devices associated with the context using the specified build options. More... | |
| CLProgram | build (final String... options) |
| Builds this program for all devices associated with the context using the specified build options. More... | |
| CLProgram | build (final CLBuildListener listener, final String... options) |
| Builds this program for all devices associated with the context using the specified build options. More... | |
| CLProgram | build (final String options, final CLDevice... devices) |
| Builds this program for the given devices and with the specified build options. More... | |
| CLProgram | build (final CLBuildListener listener, String options, final CLDevice... devices) |
| Builds this program for the given devices and with the specified build options. More... | |
| CLProgramConfiguration | prepare () |
Prepares the build for this program by returning a new CLProgramConfiguration. More... | |
| CLKernel | createCLKernel (final String kernelName) |
| Creates a kernel with the specified kernel name. More... | |
| Map< String, CLKernel > | createCLKernels () |
| Creates all kernels of this program and stores them a Map with the kernel name as key. More... | |
| void | release () |
| Releases this program with its kernels. More... | |
| CLDevice[] | getCLDevices () |
| Returns all devices associated with this program. More... | |
| String | getBuildLog () |
| Returns the build log of this program on all devices. More... | |
| Map< CLDevice, Status > | getBuildStatus () |
| Returns the build status enum of this program for each device as Map. More... | |
| boolean | isExecutable () |
| Returns true if the build status 'BUILD_SUCCESS' for at least one device of this program exists. More... | |
| String | getBuildLog (final CLDevice device) |
| Returns the build log for this program on the specified device. More... | |
| Status | getBuildStatus (final CLDevice device) |
| Returns the build status enum for this program on the specified device. More... | |
| void | setNoSource () |
| Must set this if the program is created from binary so we know not to call getSource(), which can SIGSEGV on Macs if there is no source. More... | |
| String | getSource () |
| Returns the source code of this program. More... | |
| Map< CLDevice, byte[]> | getBinaries () |
| Returns the binaries for this program in an ordered Map containing the device as key and the program binaries as value. More... | |
| String | toString () |
| boolean | equals (final Object obj) |
| int | hashCode () |
Static Public Member Functions | |
| static String | optionsOf (final String... options) |
| Utility method which builds a properly seperated option string. More... | |
| static String | define (final String name) |
| Utility method for defining macros as build options (Returns "-D name"). More... | |
| static String | define (final String name, final Object value) |
| Utility method for defining macros as build options (Returns "-D name=value"). More... | |
Represents a OpenCL program executed on one or more CLDevices.
A CLProgram must be build using one of the build methods before creating CLKernels.
Definition at line 64 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | ) |
Builds this program for all devices associated with the context.
Definition at line 226 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | final CLBuildListener | listener | ) |
Builds this program for all devices associated with the context.
| listener | A listener who is notified when the program was built. |
Definition at line 237 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | final CLBuildListener | listener, |
| final CLDevice... | devices | ||
| ) |
Builds this program for the given devices.
| listener | A listener who is notified when the program was built. |
| devices | A list of devices this program should be build on or null for all devices of its context. |
Definition at line 259 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | final CLBuildListener | listener, |
| final String | options | ||
| ) |
Builds this program for all devices associated with the context using the specified build options.
| listener | A listener who is notified when the program was built. |
Definition at line 281 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | final CLBuildListener | listener, |
| final String... | options | ||
| ) |
Builds this program for all devices associated with the context using the specified build options.
| listener | A listener who is notified when the program was built. |
Definition at line 301 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | final CLBuildListener | listener, |
| String | options, | ||
| final CLDevice... | devices | ||
| ) |
Builds this program for the given devices and with the specified build options.
In case this program was already built and there are kernels associated with this program they will be released first before rebuild.
| devices | A list of devices this program should be build on or null for all devices of its context. |
| listener | A listener who is notified when the program was built. |
Definition at line 327 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | final CLDevice... | devices | ) |
Builds this program for the given devices.
| devices | A list of devices this program should be build on or null for all devices of its context. |
Definition at line 247 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | final String | options | ) |
Builds this program for all devices associated with the context using the specified build options.
Definition at line 269 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | final String | options, |
| final CLDevice... | devices | ||
| ) |
Builds this program for the given devices and with the specified build options.
In case this program was already built and there are kernels associated with this program they will be released first before rebuild.
| devices | A list of devices this program should be build on or null for all devices of its context. |
Definition at line 313 of file CLProgram.java.
| CLProgram com.jogamp.opencl.CLProgram.build | ( | final String... | options | ) |
Builds this program for all devices associated with the context using the specified build options.
Definition at line 290 of file CLProgram.java.
| CLKernel com.jogamp.opencl.CLProgram.createCLKernel | ( | final String | kernelName | ) |
Creates a kernel with the specified kernel name.
Definition at line 410 of file CLProgram.java.
Creates all kernels of this program and stores them a Map with the kernel name as key.
Definition at line 430 of file CLProgram.java.
|
static |
Utility method for defining macros as build options (Returns "-D name").
Definition at line 687 of file CLProgram.java.
|
static |
Utility method for defining macros as build options (Returns "-D name=value").
Definition at line 694 of file CLProgram.java.
| boolean com.jogamp.opencl.CLProgram.equals | ( | final Object | obj | ) |
Definition at line 705 of file CLProgram.java.
Returns the binaries for this program in an ordered Map containing the device as key and the program binaries as value.
Definition at line 624 of file CLProgram.java.
| String com.jogamp.opencl.CLProgram.getBuildLog | ( | ) |
Returns the build log of this program on all devices.
The contents of the log are implementation dependent.
Definition at line 538 of file CLProgram.java.
| String com.jogamp.opencl.CLProgram.getBuildLog | ( | final CLDevice | device | ) |
Returns the build log for this program on the specified device.
The contents of the log are implementation dependent log can be an empty String.
Definition at line 582 of file CLProgram.java.
Returns the build status enum of this program for each device as Map.
Definition at line 558 of file CLProgram.java.
Returns the build status enum for this program on the specified device.
Definition at line 589 of file CLProgram.java.
| CLDevice[] com.jogamp.opencl.CLProgram.getCLDevices | ( | ) |
Returns all devices associated with this program.
Definition at line 507 of file CLProgram.java.
| String com.jogamp.opencl.CLProgram.getSource | ( | ) |
Returns the source code of this program.
Note: sources are not cached, each call of this method calls into Open
Definition at line 609 of file CLProgram.java.
| int com.jogamp.opencl.CLProgram.hashCode | ( | ) |
Definition at line 723 of file CLProgram.java.
| boolean com.jogamp.opencl.CLProgram.isExecutable | ( | ) |
Returns true if the build status 'BUILD_SUCCESS' for at least one device of this program exists.
Definition at line 570 of file CLProgram.java.
|
static |
Utility method which builds a properly seperated option string.
Definition at line 674 of file CLProgram.java.
| CLProgramConfiguration com.jogamp.opencl.CLProgram.prepare | ( | ) |
Prepares the build for this program by returning a new CLProgramConfiguration.
Definition at line 403 of file CLProgram.java.
| void com.jogamp.opencl.CLProgram.release | ( | ) |
Releases this program with its kernels.
Implements com.jogamp.opencl.CLResource.
Definition at line 478 of file CLProgram.java.
| void com.jogamp.opencl.CLProgram.setNoSource | ( | ) |
Must set this if the program is created from binary so we know not to call getSource(), which can SIGSEGV on Macs if there is no source.
Definition at line 601 of file CLProgram.java.
| String com.jogamp.opencl.CLProgram.toString | ( | ) |
Reimplemented from com.jogamp.opencl.CLObject.
Definition at line 699 of file CLProgram.java.