mesa  18.2.8
About: Mesa is an open-source implementation of the OpenGL specification - a system for rendering interactive 3D graphics (main library code).
  Fossies Dox: mesa-18.2.8.tar.xz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

cl::Program Class Reference

Program interface that implements cl_program. More...

#include <cl.hpp>

Inheritance diagram for cl::Program:
Collaboration diagram for cl::Program:

Public Types

typedef VECTOR_CLASS< std::pair< const void *, ::size_t > > Binaries
 
typedef VECTOR_CLASS< std::pair< const char *, ::size_t > > Sources
 
- Public Types inherited from cl::detail::Wrapper< cl_program >
typedef cl_program cl_type
 

Public Member Functions

 Program (const Context &context, const Sources &sources, cl_int *err=NULL)
 
 Program (const Context &context, const VECTOR_CLASS< Device > &devices, const Binaries &binaries, VECTOR_CLASS< cl_int > *binaryStatus=NULL, cl_int *err=NULL)
 
 Program ()
 
 Program (const Program &program)
 
Programoperator= (const Program &rhs)
 
cl_int build (const VECTOR_CLASS< Device > &devices, const char *options=NULL, void(CL_CALLBACK *notifyFptr)(cl_program, void *)=NULL, void *data=NULL) const
 
template<typename T >
cl_int getInfo (cl_program_info name, T *param) const
 
template<cl_int name>
detail::param_traits< detail::cl_program_info, name >::param_type getInfo (cl_int *err=NULL) const
 
template<typename T >
cl_int getBuildInfo (const Device &device, cl_program_build_info name, T *param) const
 
template<cl_int name>
detail::param_traits< detail::cl_program_build_info, name >::param_type getBuildInfo (const Device &device, cl_int *err=NULL) const
 
cl_int createKernels (VECTOR_CLASS< Kernel > *kernels)
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_program >
 Wrapper ()
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 ~Wrapper ()
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
cl_type operator() () const
 
cl_typeoperator() ()
 

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 2386 of file cl.hpp.

Member Typedef Documentation

◆ Binaries

typedef VECTOR_CLASS<std::pair<const void*, ::size_t> > cl::Program::Binaries

Definition at line 2389 of file cl.hpp.

◆ Sources

typedef VECTOR_CLASS<std::pair<const char*, ::size_t> > cl::Program::Sources

Definition at line 2390 of file cl.hpp.

Constructor & Destructor Documentation

◆ Program() [1/4]

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

◆ Program() [2/4]

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

◆ Program() [3/4]

cl::Program::Program ( )
inline

Definition at line 2447 of file cl.hpp.

◆ Program() [4/4]

cl::Program::Program ( const Program program)
inline

Definition at line 2449 of file cl.hpp.

Member Function Documentation

◆ build()

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

Definition at line 2459 of file cl.hpp.

References clBuildProgram(), cl::detail::errHandler(), and options.

◆ createKernels()

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

Definition at line 2521 of file cl.hpp.

References CL_SUCCESS, clCreateKernelsInProgram(), cl::detail::errHandler(), and NULL.

◆ getBuildInfo() [1/2]

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

◆ getBuildInfo() [2/2]

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

Definition at line 2510 of file cl.hpp.

References device, and NULL.

◆ getInfo() [1/2]

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

Definition at line 2478 of file cl.hpp.

References clGetProgramInfo(), cl::detail::errHandler(), and cl::detail::getInfo().

◆ getInfo() [2/2]

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

Definition at line 2487 of file cl.hpp.

References cl::detail::getInfo(), and NULL.

◆ operator=()

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

Definition at line 2451 of file cl.hpp.

References cl::detail::Wrapper< T >::operator=().


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