|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.jogamp.opencl.CLProgramBuilder
public final class CLProgramBuilder
CLProgramBuilder is a helper for building programs with more complex configurations or
building multiple programs with similar configurations.
CLProgramBuilder is used to create CLProgramConfigurations and CLBuildConfigurations.
CLProgram.prepare(),
createConfiguration(),
createConfiguration(com.jogamp.opencl.CLProgram),
loadConfiguration(java.io.ObjectInputStream),
loadConfiguration(java.io.ObjectInputStream, com.jogamp.opencl.CLContext),
Serialized Form| Method Summary | |
|---|---|
CLProgramBuilder |
asBuildConfiguration()
Returns a new instance of of this configuration without a CLProgram,
program binaries or sources associated with it. |
CLProgram |
build()
Builds or rebuilds a program. |
CLProgram |
build(CLBuildListener listener)
Builds or rebuilds a program. |
CLProgram |
build(CLProgram program)
Builds or rebuilds the program. |
CLProgram |
build(CLProgram program,
CLBuildListener listener)
Builds or rebuilds the program. |
CLProgramBuilder |
clone()
Clones this configuration. |
static CLBuildConfiguration |
createConfiguration()
Creates a new CLBuildConfiguration. |
static CLProgramConfiguration |
createConfiguration(CLProgram program)
Creates a new CLProgramConfiguration for this program. |
boolean |
equals(Object o)
|
CLProgramBuilder |
forDevice(CLDevice device)
Adds the device as build target. |
CLProgramBuilder |
forDevices(CLDevice... devices)
Adds the devices as build target. |
CLProgram |
getProgram()
Returns the program. |
int |
hashCode()
|
static CLBuildConfiguration |
loadConfiguration(ObjectInputStream ois)
Loads a CLBuildConfiguration. |
static CLProgramConfiguration |
loadConfiguration(ObjectInputStream ois,
CLContext context)
Loads a CLProgramConfiguration containing a CLProgram. |
CLProgramBuilder |
reset()
Resets this builder's configuration like options, devices and definitions. |
CLProgramConfiguration |
resetDefines()
Resets this builder's macro definitions. |
CLProgramConfiguration |
resetDevices()
Resets this builder's device list. |
CLProgramConfiguration |
resetOptions()
Resets this builder's configuration options. |
void |
save(ObjectOutputStream oos)
Saves this configuration to the ObjectOutputStream. |
CLProgramBuilder |
setProgram(CLProgram program)
Sets the program which should be build. |
String |
toString()
|
CLProgramBuilder |
withDefine(String name)
Adds the definition to the build configuration. |
CLProgramBuilder |
withDefine(String name,
Object value)
Adds the definition to the build configuration. |
CLProgramBuilder |
withDefines(Map<String,? extends Object> defines)
Adds the definitions to the build configuration. |
CLProgramBuilder |
withDefines(String... names)
Adds the definitions to the build configuration. |
CLProgramBuilder |
withOption(String option)
Adds the compiler option to the build configuration. |
CLProgramBuilder |
withOptions(String... options)
Adds the compiler options to the build configuration. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Method Detail |
|---|
public static CLBuildConfiguration createConfiguration()
public static CLProgramConfiguration createConfiguration(CLProgram program)
public static CLBuildConfiguration loadConfiguration(ObjectInputStream ois)
throws IOException,
ClassNotFoundException
ois - The ObjectInputStream for reading the object.
IOException
ClassNotFoundException
public static CLProgramConfiguration loadConfiguration(ObjectInputStream ois,
CLContext context)
throws IOException,
ClassNotFoundException
ois - The ObjectInputStream for reading the object.context - The context used for program initialization.
IOException
ClassNotFoundException
public void save(ObjectOutputStream oos)
throws IOException
CLBuildConfiguration
save in interface CLBuildConfigurationIOExceptionpublic CLProgramBuilder withOption(String option)
CLBuildConfiguration
withOption in interface CLBuildConfigurationwithOption in interface CLProgramConfigurationCLProgram.CompilerOptionspublic CLProgramBuilder withOptions(String... options)
CLBuildConfiguration
withOptions in interface CLBuildConfigurationwithOptions in interface CLProgramConfigurationCLProgram.CompilerOptionspublic CLProgramBuilder withDefine(String name)
CLBuildConfiguration
withDefine in interface CLBuildConfigurationwithDefine in interface CLProgramConfigurationCLProgram.define(java.lang.String)public CLProgramBuilder withDefines(String... names)
CLBuildConfiguration
withDefines in interface CLBuildConfigurationwithDefines in interface CLProgramConfigurationCLProgram.define(java.lang.String)
public CLProgramBuilder withDefine(String name,
Object value)
CLBuildConfiguration
withDefine in interface CLBuildConfigurationwithDefine in interface CLProgramConfigurationCLProgram.define(java.lang.String, java.lang.Object)public CLProgramBuilder withDefines(Map<String,? extends Object> defines)
CLBuildConfiguration
withDefines in interface CLBuildConfigurationwithDefines in interface CLProgramConfigurationCLProgram.define(java.lang.String, java.lang.Object)public CLProgramBuilder forDevice(CLDevice device)
CLBuildConfiguration
forDevice in interface CLBuildConfigurationforDevice in interface CLProgramConfigurationpublic CLProgramBuilder forDevices(CLDevice... devices)
CLBuildConfiguration
forDevices in interface CLBuildConfigurationforDevices in interface CLProgramConfigurationpublic CLProgram build()
CLProgramConfiguration
build in interface CLProgramConfigurationpublic CLProgram build(CLBuildListener listener)
CLProgramConfiguration
build in interface CLProgramConfigurationlistener - The callback who will be notified when the program has built.public CLProgram build(CLProgram program)
CLBuildConfiguration
build in interface CLBuildConfigurationprogram - The program which should be build.
public CLProgram build(CLProgram program,
CLBuildListener listener)
CLBuildConfiguration
build in interface CLBuildConfigurationprogram - The program which should be build.listener - The callback who is notified when the program has built.public CLProgramBuilder reset()
CLBuildConfiguration
reset in interface CLBuildConfigurationreset in interface CLProgramConfigurationpublic CLProgramConfiguration resetDefines()
CLBuildConfiguration
resetDefines in interface CLBuildConfigurationresetDefines in interface CLProgramConfigurationpublic CLProgramConfiguration resetDevices()
CLBuildConfiguration
resetDevices in interface CLBuildConfigurationresetDevices in interface CLProgramConfigurationpublic CLProgramConfiguration resetOptions()
CLBuildConfiguration
resetOptions in interface CLBuildConfigurationresetOptions in interface CLProgramConfigurationpublic CLProgramBuilder asBuildConfiguration()
CLProgramConfigurationCLProgram,
program binaries or sources associated with it.
asBuildConfiguration in interface CLProgramConfigurationpublic CLProgramBuilder clone()
CLBuildConfiguration
clone in interface CLBuildConfigurationclone in interface CLProgramConfigurationclone in class Objectpublic CLProgram getProgram()
CLProgramConfiguration
getProgram in interface CLProgramConfigurationpublic CLProgramBuilder setProgram(CLProgram program)
CLBuildConfiguration
setProgram in interface CLBuildConfigurationpublic String toString()
toString in class Objectpublic boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||