Top Description Methods
com.jogamp.opencl.util

public Interface CLProgramConfiguration

extends CLBuildConfiguration
Known Direct Implementers
com.jogamp.opencl.CLProgramBuilder
Imports
com.jogamp.opencl.CLDevice, .CLProgram, java.util.Map
Configuration representing everything needed to build an OpenCL program (program included). CLProgramConfiguration is a helper for building programs with more complex configurations or building multiple programs with the similar configuration.
Author
Michael Bien
See Also
CLProgram#prepare(), com.jogamp.opencl.CLProgramBuilder#createConfiguration(com.jogamp.opencl.CLProgram), com.jogamp.opencl.CLProgramBuilder#loadConfiguration(java.io.ObjectInputStream, com.jogamp.opencl.CLContext)

Method Summary

Modifier and TypeMethod and Description
public CLBuildConfiguration
asBuildConfiguration()

Returns a new instance of of this configuration without a CLProgram, program binaries or sources associated with it.

public CLProgram
build()

Builds or rebuilds a program.

public CLProgram
build(CLBuildListener
The callback who will be notified when the program has built.
listener)

Builds or rebuilds a program.

public CLProgramConfiguration
clone()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.clone.

Clones this configuration.
public CLProgramConfiguration
forDevice(CLDevice device)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.forDevice.

Adds the device as build target.
public CLProgramConfiguration
forDevices(CLDevice... devices)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.forDevices.

Adds the devices as build target.
public CLProgram
getProgram()

Returns the program.

public CLProgramConfiguration
reset()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.reset.

Resets this builder's configuration like options, devices and definitions.
public CLProgramConfiguration
resetDefines()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.resetDefines.

Resets this builder's macro definitions.
public CLProgramConfiguration
resetDevices()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.resetDevices.

Resets this builder's device list.
public CLProgramConfiguration
resetOptions()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.resetOptions.

Resets this builder's configuration options.
public CLProgramConfiguration
withDefine(String name)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withDefine.

Adds the definition to the build configuration.
public CLProgramConfiguration
withDefine(String name, Object value)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withDefine.

Adds the definition to the build configuration.
public CLProgramConfiguration
withDefines(String... names)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withDefines.

Adds the definitions to the build configuration.
public CLProgramConfiguration
withDefines(Map<String, ? extends Object> defines)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withDefines.

Adds the definitions to the build configuration.
public CLProgramConfiguration
withOption(String option)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withOption.

Adds the compiler option to the build configuration.
public CLProgramConfiguration
withOptions(String... options)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withOptions.

Adds the compiler options to the build configuration.
Inherited from com.jogamp.opencl.util.CLBuildConfiguration:
buildbuildsavesetProgram

Method Detail

asBuildConfigurationback to summary
public CLBuildConfiguration asBuildConfiguration()

Returns a new instance of of this configuration without a CLProgram, program binaries or sources associated with it.

buildback to summary
public CLProgram build()

Builds or rebuilds a program.

buildback to summary
public CLProgram build(CLBuildListener listener)

Builds or rebuilds a program.

Parameters
listener:CLBuildListener

The callback who will be notified when the program has built.

cloneback to summary
public CLProgramConfiguration clone()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.clone.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.clone.

Clones this configuration.

Annotations
@Override
forDeviceback to summary
public CLProgramConfiguration forDevice(CLDevice device)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.forDevice.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.forDevice.

Adds the device as build target.

Annotations
@Override
forDevicesback to summary
public CLProgramConfiguration forDevices(CLDevice... devices)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.forDevices.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.forDevices.

Adds the devices as build target.

Annotations
@Override
getProgramback to summary
public CLProgram getProgram()

Returns the program.

resetback to summary
public CLProgramConfiguration reset()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.reset.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.reset.

Resets this builder's configuration like options, devices and definitions.

Annotations
@Override
resetDefinesback to summary
public CLProgramConfiguration resetDefines()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.resetDefines.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.resetDefines.

Resets this builder's macro definitions.

Annotations
@Override
resetDevicesback to summary
public CLProgramConfiguration resetDevices()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.resetDevices.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.resetDevices.

Resets this builder's device list.

Annotations
@Override
resetOptionsback to summary
public CLProgramConfiguration resetOptions()

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.resetOptions.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.resetOptions.

Resets this builder's configuration options.

Annotations
@Override
withDefineback to summary
public CLProgramConfiguration withDefine(String name)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withDefine.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.withDefine.

Adds the definition to the build configuration.

Annotations
@Override
withDefineback to summary
public CLProgramConfiguration withDefine(String name, Object value)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withDefine.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.withDefine.

Adds the definition to the build configuration.

Annotations
@Override
withDefinesback to summary
public CLProgramConfiguration withDefines(String... names)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withDefines.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.withDefines.

Adds the definitions to the build configuration.

Annotations
@Override
withDefinesback to summary
public CLProgramConfiguration withDefines(Map<String, ? extends Object> defines)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withDefines.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.withDefines.

Adds the definitions to the build configuration.

Annotations
@Override
withOptionback to summary
public CLProgramConfiguration withOption(String option)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withOption.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.withOption.

Adds the compiler option to the build configuration.

Annotations
@Override
withOptionsback to summary
public CLProgramConfiguration withOptions(String... options)

Redeclares com.jogamp.opencl.util.CLBuildConfiguration.withOptions.

Doc from com.jogamp.opencl.util.CLBuildConfiguration.withOptions.

Adds the compiler options to the build configuration.

Annotations
@Override