OpenCL C++ Bindings
Loading...
Searching...
No Matches
cl::Program Class Reference

Program interface that implements cl_program. More...

#include <opencl.hpp>

Inheritance diagram for cl::Program:
cl::detail::Wrapper< cl_program >

Public Types

typedef vector< vector< unsigned char > > Binaries
 
typedef vector< string > Sources
 
- Public Types inherited from cl::detail::Wrapper< cl_program >
typedef cl_program cl_type
 

Public Member Functions

 Program (const string &source, bool build=false, cl_int *err=nullptr)
 
 Program (const Context &context, const string &source, bool build=false, cl_int *err=nullptr)
 
 Program (const Sources &sources, cl_int *err=nullptr)
 
 Program (const Context &context, const Sources &sources, cl_int *err=nullptr)
 
 Program (const vector< char > &IL, bool build=false, cl_int *err=nullptr)
 
 Program (const Context &context, const vector< char > &IL, bool build=false, cl_int *err=nullptr)
 
 Program (const Context &context, const vector< Device > &devices, const Binaries &binaries, vector< cl_int > *binaryStatus=nullptr, cl_int *err=nullptr)
 
 Program (const Context &context, const vector< Device > &devices, const string &kernelNames, cl_int *err=nullptr)
 
 Program (const cl_program &program, bool retainObject=false)
 Constructor from cl_program - takes ownership.
 
Programoperator= (const cl_program &rhs)
 
cl_int build (const vector< Device > &devices, const string &options, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int build (const vector< Device > &devices, const char *options=nullptr, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int build (const Device &device, const string &options, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int build (const Device &device, const char *options=nullptr, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int build (const string &options, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int build (const char *options=nullptr, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int compile (const string &options, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int compile (const char *options=nullptr, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int compile (const string &options, const vector< Program > &inputHeaders, const vector< string > &headerIncludeNames, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int compile (const char *options, const vector< Program > &inputHeaders, const vector< string > &headerIncludeNames, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int compile (const string &options, const vector< Device > &deviceList, const vector< Program > &inputHeaders=vector< Program >(), const vector< string > &headerIncludeNames=vector< string >(), void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
cl_int compile (const char *options, const vector< Device > &deviceList, const vector< Program > &inputHeaders=vector< Program >(), const vector< string > &headerIncludeNames=vector< string >(), void(CL_CALLBACK *notifyFptr)(cl_program, void *)=nullptr, void *data=nullptr) const
 
template<typename T >
cl_int getInfo (cl_program_info name, T *param) const
 
template<cl_program_info name>
detail::param_traits< detail::cl_program_info, name >::param_type getInfo (cl_int *err=nullptr) const
 
template<typename T >
cl_int getBuildInfo (const Device &device, cl_program_build_info name, T *param) const
 
template<cl_program_build_info name>
detail::param_traits< detail::cl_program_build_info, name >::param_type getBuildInfo (const Device &device, cl_int *err=nullptr) const
 
template<cl_program_build_info name>
vector< std::pair< cl::Device, typename detail::param_traits< detail::cl_program_build_info, name >::param_type > > getBuildInfo (cl_int *err=nullptr) const
 
cl_int createKernels (vector< Kernel > *kernels)
 
CL_API_PREFIX__VERSION_2_2_DEPRECATED cl_int setReleaseCallback (void(CL_CALLBACK *pfn_notify)(cl_program program, void *user_data), void *user_data=nullptr) CL_API_SUFFIX__VERSION_2_2_DEPRECATED
 Registers a callback function to be called when destructors for program scope global variables are complete and before the program is released.
 
template<typename T >
std::enable_if<!std::is_pointer< T >::value, cl_int >::type setSpecializationConstant (cl_uint index, const T &value)
 Sets a SPIR-V specialization constant.
 
cl_int setSpecializationConstant (cl_uint index, size_type size, const void *value)
 Sets a SPIR-V specialization constant.
 
template<>
cl_int getInfo (cl_program_info name, vector< vector< unsigned char > > *param) const
 
template<>
vector< vector< unsigned char > > getInfo (cl_int *err) const
 
template<>
cl_int setSpecializationConstant (cl_uint index, const bool &value)
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_program >
 Wrapper (const cl_type &obj, bool retainObject)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 Wrapper (Wrapper< cl_type > &&rhs) noexcept
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (Wrapper< cl_type > &&rhs)
 
Wrapper< cl_type > & operator= (const cl_type &rhs)
 
const cl_type & operator() () const
 
cl_type & operator() ()
 
cl_type get () const
 

Additional Inherited Members

- Protected Member Functions inherited from cl::detail::Wrapper< cl_program >
cl_int retain () const
 
cl_int release () const
 
- Protected Attributes inherited from cl::detail::Wrapper< cl_program >
cl_type object_
 

Detailed Description

Program interface that implements cl_program.

Definition at line 6246 of file opencl.hpp.

Member Typedef Documentation

◆ Binaries

typedef vector<vector<unsigned char> > cl::Program::Binaries

Definition at line 6250 of file opencl.hpp.

◆ Sources

typedef vector<string> cl::Program::Sources

Definition at line 6251 of file opencl.hpp.

Constructor & Destructor Documentation

◆ Program() [1/10]

cl::Program::Program ( const string &  source,
bool  build = false,
cl_int *  err = nullptr 
)
inline

Definition at line 6257 of file opencl.hpp.

◆ Program() [2/10]

cl::Program::Program ( const Context context,
const string &  source,
bool  build = false,
cl_int *  err = nullptr 
)
inline

Definition at line 6296 of file opencl.hpp.

◆ Program() [3/10]

cl::Program::Program ( const Sources &  sources,
cl_int *  err = nullptr 
)
inline

Create a program from a vector of source strings and the default context. Does not compile or link the program.

Definition at line 6337 of file opencl.hpp.

◆ Program() [4/10]

cl::Program::Program ( const Context context,
const Sources &  sources,
cl_int *  err = nullptr 
)
inline

Create a program from a vector of source strings and a provided context. Does not compile or link the program.

Definition at line 6372 of file opencl.hpp.

◆ Program() [5/10]

cl::Program::Program ( const vector< char > &  IL,
bool  build = false,
cl_int *  err = nullptr 
)
inline

Program constructor to allow construction of program from SPIR-V or another IL.

Requires OpenCL 2.1 or newer or the cl_khr_il_program extension.

Definition at line 6409 of file opencl.hpp.

◆ Program() [6/10]

cl::Program::Program ( const Context context,
const vector< char > &  IL,
bool  build = false,
cl_int *  err = nullptr 
)
inline

Program constructor to allow construction of program from SPIR-V or another IL for a specific context.

Requires OpenCL 2.1 or newer or the cl_khr_il_program extension.

Definition at line 6464 of file opencl.hpp.

◆ Program() [7/10]

cl::Program::Program ( const Context context,
const vector< Device > &  devices,
const Binaries &  binaries,
vector< cl_int > *  binaryStatus = nullptr,
cl_int *  err = nullptr 
)
inline

Construct a program object from a list of devices and a per-device list of binaries.

Parameters
contextA valid OpenCL context in which to construct the program.
devicesA vector of OpenCL device objects for which the program will be created.
binariesA vector of pairs of a pointer to a binary object and its length.
binaryStatusAn optional vector that on completion will be resized to match the size of binaries and filled with values to specify if each binary was successfully loaded. Set to CL_SUCCESS if the binary was successfully loaded. Set to CL_INVALID_VALUE if the length is 0 or the binary pointer is nullptr. Set to CL_INVALID_BINARY if the binary provided is not valid for the matching device.
errif non-nullptr will be set to CL_SUCCESS on successful operation or one of the following errors: CL_INVALID_CONTEXT if context is not a valid context. CL_INVALID_VALUE if the length of devices is zero; or if the length of binaries does not match the length of devices; or if any entry in binaries is nullptr or has length 0. CL_INVALID_DEVICE if OpenCL devices listed in devices are not in the list of devices associated with context. CL_INVALID_BINARY if an invalid program binary was encountered for any device. binaryStatus will return specific status for each device. CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

Definition at line 6531 of file opencl.hpp.

◆ Program() [8/10]

cl::Program::Program ( const Context context,
const vector< Device > &  devices,
const string &  kernelNames,
cl_int *  err = nullptr 
)
inline

Create program using builtin kernels.

Parameters
kernelNamesSemi-colon separated list of builtin kernel names

Definition at line 6594 of file opencl.hpp.

◆ Program() [9/10]

cl::Program::Program ( )
inline

Definition at line 6623 of file opencl.hpp.

◆ Program() [10/10]

cl::Program::Program ( const cl_program &  program,
bool  retainObject = false 
)
inlineexplicit

Constructor from cl_program - takes ownership.

Parameters
retainObjectwill cause the constructor to retain its cl object. Defaults to false to maintain compatibility with earlier versions.

Definition at line 6632 of file opencl.hpp.

Member Function Documentation

◆ build() [1/6]

cl_int cl::Program::build ( const char *  options = nullptr,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6713 of file opencl.hpp.

◆ build() [2/6]

cl_int cl::Program::build ( const Device device,
const char *  options = nullptr,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6684 of file opencl.hpp.

◆ build() [3/6]

cl_int cl::Program::build ( const Device device,
const string &  options,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6675 of file opencl.hpp.

◆ build() [4/6]

cl_int cl::Program::build ( const string &  options,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6705 of file opencl.hpp.

◆ build() [5/6]

cl_int cl::Program::build ( const vector< Device > &  devices,
const char *  options = nullptr,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6650 of file opencl.hpp.

◆ build() [6/6]

cl_int cl::Program::build ( const vector< Device > &  devices,
const string &  options,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6641 of file opencl.hpp.

◆ compile() [1/6]

cl_int cl::Program::compile ( const char *  options,
const vector< Device > &  deviceList,
const vector< Program > &  inputHeaders = vector<Program>(),
const vector< string > &  headerIncludeNames = vector<string>(),
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6803 of file opencl.hpp.

◆ compile() [2/6]

cl_int cl::Program::compile ( const char *  options,
const vector< Program > &  inputHeaders,
const vector< string > &  headerIncludeNames,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6766 of file opencl.hpp.

◆ compile() [3/6]

cl_int cl::Program::compile ( const char *  options = nullptr,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6738 of file opencl.hpp.

◆ compile() [4/6]

cl_int cl::Program::compile ( const string &  options,
const vector< Device > &  deviceList,
const vector< Program > &  inputHeaders = vector<Program>(),
const vector< string > &  headerIncludeNames = vector<string>(),
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6792 of file opencl.hpp.

◆ compile() [5/6]

cl_int cl::Program::compile ( const string &  options,
const vector< Program > &  inputHeaders,
const vector< string > &  headerIncludeNames,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6756 of file opencl.hpp.

◆ compile() [6/6]

cl_int cl::Program::compile ( const string &  options,
void(CL_CALLBACK *notifyFptr)(cl_program, void *)  = nullptr,
void *  data = nullptr 
) const
inline

Definition at line 6730 of file opencl.hpp.

◆ createKernels()

cl_int cl::Program::createKernels ( vector< Kernel > *  kernels)
inline

Definition at line 6923 of file opencl.hpp.

◆ getBuildInfo() [1/3]

template<cl_program_build_info name>
vector< std::pair< cl::Device, typename detail::param_traits< detail::cl_program_build_info, name >::param_type > > cl::Program::getBuildInfo ( cl_int *  err = nullptr) const
inline

Build info function that returns a vector of device/info pairs for the specified info type and for all devices in the program. On an error reading the info for any device, an empty vector of info will be returned.

Definition at line 6886 of file opencl.hpp.

◆ getBuildInfo() [2/3]

template<cl_program_build_info name>
detail::param_traits< detail::cl_program_build_info, name >::param_type cl::Program::getBuildInfo ( const Device device,
cl_int *  err = nullptr 
) const
inline

Definition at line 6868 of file opencl.hpp.

◆ getBuildInfo() [3/3]

template<typename T >
cl_int cl::Program::getBuildInfo ( const Device device,
cl_program_build_info  name,
T *  param 
) const
inline

Definition at line 6857 of file opencl.hpp.

◆ getInfo() [1/4]

template<>
vector< vector< unsigned char > > cl::Program::getInfo ( cl_int *  err) const
inline

Definition at line 7111 of file opencl.hpp.

◆ getInfo() [2/4]

template<cl_program_info name>
detail::param_traits< detail::cl_program_info, name >::param_type cl::Program::getInfo ( cl_int *  err = nullptr) const
inline

Definition at line 6845 of file opencl.hpp.

◆ getInfo() [3/4]

template<typename T >
cl_int cl::Program::getInfo ( cl_program_info  name,
T *  param 
) const
inline

Definition at line 6836 of file opencl.hpp.

◆ getInfo() [4/4]

template<>
cl_int cl::Program::getInfo ( cl_program_info  name,
vector< vector< unsigned char > > *  param 
) const
inline

Definition at line 7111 of file opencl.hpp.

◆ operator=()

Program & cl::Program::operator= ( const cl_program &  rhs)
inline

Definition at line 6635 of file opencl.hpp.

◆ setReleaseCallback()

CL_API_PREFIX__VERSION_2_2_DEPRECATED cl_int cl::Program::setReleaseCallback ( void(CL_CALLBACK *pfn_notify)(cl_program program, void *user_data)  ,
void *  user_data = nullptr 
)
inline

Registers a callback function to be called when destructors for program scope global variables are complete and before the program is released.

Wraps clSetProgramReleaseCallback().

Each call to this function registers the specified user callback function on a callback stack associated with program. The registered user callback functions are called in the reverse order in which they were registered.

Definition at line 6965 of file opencl.hpp.

◆ setSpecializationConstant() [1/3]

template<>
cl_int cl::Program::setSpecializationConstant ( cl_uint  index,
const bool &  value 
)
inline

Definition at line 7152 of file opencl.hpp.

◆ setSpecializationConstant() [2/3]

template<typename T >
std::enable_if<!std::is_pointer< T >::value, cl_int >::type cl::Program::setSpecializationConstant ( cl_uint  index,
const T &  value 
)
inline

Sets a SPIR-V specialization constant.

Wraps clSetProgramSpecializationConstant().

Definition at line 6984 of file opencl.hpp.

◆ setSpecializationConstant() [3/3]

cl_int cl::Program::setSpecializationConstant ( cl_uint  index,
size_type  size,
const void *  value 
)
inline

Sets a SPIR-V specialization constant.

Wraps clSetProgramSpecializationConstant().

Definition at line 6999 of file opencl.hpp.


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