JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
com.jogamp.opencl.util.CLProgramConfiguration Interface Reference

Configuration representing everything needed to build an OpenCL program (program included). More...

Inheritance diagram for com.jogamp.opencl.util.CLProgramConfiguration:
Collaboration diagram for com.jogamp.opencl.util.CLProgramConfiguration:

Public Member Functions

CLProgram build ()
 Builds or rebuilds a program. More...
 
CLProgram build (CLBuildListener listener)
 Builds or rebuilds a program. More...
 
CLProgram getProgram ()
 Returns the program. More...
 
CLBuildConfiguration asBuildConfiguration ()
 Returns a new instance of of this configuration without a CLProgram, program binaries or sources associated with it. More...
 
CLProgramConfiguration forDevice (CLDevice device)
 Adds the device as build target. More...
 
CLProgramConfiguration forDevices (CLDevice... devices)
 Adds the devices as build target. More...
 
CLProgramConfiguration withDefine (String name)
 Adds the definition to the build configuration. More...
 
CLProgramConfiguration withDefine (String name, Object value)
 Adds the definition to the build configuration. More...
 
CLProgramConfiguration withDefines (String... names)
 Adds the definitions to the build configuration. More...
 
CLProgramConfiguration withDefines (Map< String, ? extends Object > defines)
 Adds the definitions to the build configuration. More...
 
CLProgramConfiguration withOption (String option)
 Adds the compiler option to the build configuration. More...
 
CLProgramConfiguration withOptions (String... options)
 Adds the compiler options to the build configuration. More...
 
CLProgramConfiguration reset ()
 Resets this builder's configuration like options, devices and definitions. More...
 
CLProgramConfiguration resetOptions ()
 Resets this builder's configuration options. More...
 
CLProgramConfiguration resetDefines ()
 Resets this builder's macro definitions. More...
 
CLProgramConfiguration resetDevices ()
 Resets this builder's device list. More...
 
CLProgramConfiguration clone ()
 Clones this configuration. More...
 
- Public Member Functions inherited from com.jogamp.opencl.util.CLBuildConfiguration
CLProgram build (CLProgram program)
 Builds or rebuilds the program. More...
 
CLProgram build (CLProgram program, CLBuildListener listener)
 Builds or rebuilds the program. More...
 
CLProgramConfiguration setProgram (CLProgram program)
 Sets the program which should be build. More...
 
CLBuildConfiguration forDevice (CLDevice device)
 Adds the device as build target. More...
 
CLBuildConfiguration forDevices (CLDevice... devices)
 Adds the devices as build target. More...
 
CLBuildConfiguration reset ()
 Resets this builder's configuration like options, devices and definitions. More...
 
CLBuildConfiguration resetOptions ()
 Resets this builder's configuration options. More...
 
CLBuildConfiguration resetDefines ()
 Resets this builder's macro definitions. More...
 
CLBuildConfiguration resetDevices ()
 Resets this builder's device list. More...
 
CLBuildConfiguration withDefine (String name)
 Adds the definition to the build configuration. More...
 
CLBuildConfiguration withDefine (String name, Object value)
 Adds the definition to the build configuration. More...
 
CLBuildConfiguration withDefines (String... names)
 Adds the definitions to the build configuration. More...
 
CLBuildConfiguration withDefines (Map< String, ? extends Object > defines)
 Adds the definitions to the build configuration. More...
 
CLBuildConfiguration withOption (String option)
 Adds the compiler option to the build configuration. More...
 
CLBuildConfiguration withOptions (String... options)
 Adds the compiler options to the build configuration. More...
 
CLBuildConfiguration clone ()
 Clones this configuration. More...
 
void save (ObjectOutputStream oos) throws IOException
 Saves this configuration to the ObjectOutputStream. More...
 

Detailed Description

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.

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)
Author
Michael Bien

Definition at line 44 of file CLProgramConfiguration.java.

Member Function Documentation

◆ asBuildConfiguration()

CLBuildConfiguration com.jogamp.opencl.util.CLProgramConfiguration.asBuildConfiguration ( )

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

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ build() [1/2]

CLProgram com.jogamp.opencl.util.CLProgramConfiguration.build ( )

Builds or rebuilds a program.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ build() [2/2]

CLProgram com.jogamp.opencl.util.CLProgramConfiguration.build ( CLBuildListener  listener)

Builds or rebuilds a program.

Parameters
listenerThe callback who will be notified when the program has built.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ clone()

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.clone ( )

Clones this configuration.

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ forDevice()

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.forDevice ( CLDevice  device)

Adds the device as build target.

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ forDevices()

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.forDevices ( CLDevice...  devices)

Adds the devices as build target.

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ getProgram()

CLProgram com.jogamp.opencl.util.CLProgramConfiguration.getProgram ( )

Returns the program.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ reset()

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.reset ( )

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

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ resetDefines()

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.resetDefines ( )

Resets this builder's macro definitions.

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ resetDevices()

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.resetDevices ( )

Resets this builder's device list.

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ resetOptions()

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.resetOptions ( )

Resets this builder's configuration options.

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ withDefine() [1/2]

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.withDefine ( String  name)

Adds the definition to the build configuration.

See also
CLProgram::define(java.lang.String)

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ withDefine() [2/2]

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.withDefine ( String  name,
Object  value 
)

Adds the definition to the build configuration.

See also
CLProgram::define(java.lang.String, java.lang.Object)

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ withDefines() [1/2]

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.withDefines ( Map< String, ? extends Object >  defines)

Adds the definitions to the build configuration.

See also
com.jogamp.opencl.CLProgram::define(java.lang.String, java.lang.Object)

Implements com.jogamp.opencl.util.CLBuildConfiguration.

◆ withDefines() [2/2]

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.withDefines ( String...  names)

Adds the definitions to the build configuration.

See also
com.jogamp.opencl.CLProgram::define(java.lang.String)

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ withOption()

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.withOption ( String  option)

Adds the compiler option to the build configuration.

See also
com.jogamp.opencl.CLProgram.CompilerOptions

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.

◆ withOptions()

CLProgramConfiguration com.jogamp.opencl.util.CLProgramConfiguration.withOptions ( String...  options)

Adds the compiler options to the build configuration.

See also
com.jogamp.opencl.CLProgram.CompilerOptions

Implements com.jogamp.opencl.util.CLBuildConfiguration.

Implemented in com.jogamp.opencl.CLProgramBuilder.


The documentation for this interface was generated from the following file: