Package com.jogamp.opencl.util
Interface CLProgramConfiguration
-
- All Superinterfaces:
CLBuildConfiguration,Cloneable
- All Known Implementing Classes:
CLProgramBuilder
public interface CLProgramConfiguration extends CLBuildConfiguration
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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CLBuildConfigurationasBuildConfiguration()Returns a new instance of of this configuration without aCLProgram, program binaries or sources associated with it.CLProgrambuild()Builds or rebuilds a program.CLProgrambuild(CLBuildListener listener)Builds or rebuilds a program.CLProgramConfigurationclone()Clones this configuration.CLProgramConfigurationforDevice(CLDevice device)Adds the device as build target.CLProgramConfigurationforDevices(CLDevice... devices)Adds the devices as build target.CLProgramgetProgram()Returns the program.CLProgramConfigurationreset()Resets this builder's configuration like options, devices and definitions.CLProgramConfigurationresetDefines()Resets this builder's macro definitions.CLProgramConfigurationresetDevices()Resets this builder's device list.CLProgramConfigurationresetOptions()Resets this builder's configuration options.CLProgramConfigurationwithDefine(String name)Adds the definition to the build configuration.CLProgramConfigurationwithDefine(String name, Object value)Adds the definition to the build configuration.CLProgramConfigurationwithDefines(String... names)Adds the definitions to the build configuration.CLProgramConfigurationwithDefines(Map<String,? extends Object> defines)Adds the definitions to the build configuration.CLProgramConfigurationwithOption(String option)Adds the compiler option to the build configuration.CLProgramConfigurationwithOptions(String... options)Adds the compiler options to the build configuration.-
Methods inherited from interface com.jogamp.opencl.util.CLBuildConfiguration
build, build, save, setProgram
-
-
-
-
Method Detail
-
build
CLProgram build()
Builds or rebuilds a program.
-
build
CLProgram build(CLBuildListener listener)
Builds or rebuilds a program.- Parameters:
listener- The callback who will be notified when the program has built.
-
getProgram
CLProgram getProgram()
Returns the program.
-
asBuildConfiguration
CLBuildConfiguration asBuildConfiguration()
Returns a new instance of of this configuration without aCLProgram, program binaries or sources associated with it.
-
forDevice
CLProgramConfiguration forDevice(CLDevice device)
Description copied from interface:CLBuildConfigurationAdds the device as build target.- Specified by:
forDevicein interfaceCLBuildConfiguration
-
forDevices
CLProgramConfiguration forDevices(CLDevice... devices)
Description copied from interface:CLBuildConfigurationAdds the devices as build target.- Specified by:
forDevicesin interfaceCLBuildConfiguration
-
withDefine
CLProgramConfiguration withDefine(String name)
Description copied from interface:CLBuildConfigurationAdds the definition to the build configuration.- Specified by:
withDefinein interfaceCLBuildConfiguration- See Also:
CLProgram.define(java.lang.String)
-
withDefine
CLProgramConfiguration withDefine(String name, Object value)
Description copied from interface:CLBuildConfigurationAdds the definition to the build configuration.- Specified by:
withDefinein interfaceCLBuildConfiguration- See Also:
CLProgram.define(java.lang.String, java.lang.Object)
-
withDefines
CLProgramConfiguration withDefines(String... names)
Description copied from interface:CLBuildConfigurationAdds the definitions to the build configuration.- Specified by:
withDefinesin interfaceCLBuildConfiguration- See Also:
CLProgram.define(java.lang.String)
-
withDefines
CLProgramConfiguration withDefines(Map<String,? extends Object> defines)
Description copied from interface:CLBuildConfigurationAdds the definitions to the build configuration.- Specified by:
withDefinesin interfaceCLBuildConfiguration- See Also:
CLProgram.define(java.lang.String, java.lang.Object)
-
withOption
CLProgramConfiguration withOption(String option)
Description copied from interface:CLBuildConfigurationAdds the compiler option to the build configuration.- Specified by:
withOptionin interfaceCLBuildConfiguration- See Also:
CLProgram.CompilerOptions
-
withOptions
CLProgramConfiguration withOptions(String... options)
Description copied from interface:CLBuildConfigurationAdds the compiler options to the build configuration.- Specified by:
withOptionsin interfaceCLBuildConfiguration- See Also:
CLProgram.CompilerOptions
-
reset
CLProgramConfiguration reset()
Description copied from interface:CLBuildConfigurationResets this builder's configuration like options, devices and definitions.- Specified by:
resetin interfaceCLBuildConfiguration
-
resetOptions
CLProgramConfiguration resetOptions()
Description copied from interface:CLBuildConfigurationResets this builder's configuration options.- Specified by:
resetOptionsin interfaceCLBuildConfiguration
-
resetDefines
CLProgramConfiguration resetDefines()
Description copied from interface:CLBuildConfigurationResets this builder's macro definitions.- Specified by:
resetDefinesin interfaceCLBuildConfiguration
-
resetDevices
CLProgramConfiguration resetDevices()
Description copied from interface:CLBuildConfigurationResets this builder's device list.- Specified by:
resetDevicesin interfaceCLBuildConfiguration
-
clone
CLProgramConfiguration clone()
Description copied from interface:CLBuildConfigurationClones this configuration.- Specified by:
clonein interfaceCLBuildConfiguration
-
-