Program interface that implements cl_program. More...

#include <cl.hpp>

Inheritance 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
cl_int	build (const VECTOR_CLASS< Device > &devices, const char options=NULL, void(CL_CALLBACK notifyFptr)(cl_program, void )=NULL, void data=NULL) const

cl_int	build (const char options=NULL, void(CL_CALLBACK notifyFptr)(cl_program, void )=NULL, void data=NULL) const

cl_int	createKernels (VECTOR_CLASS< Kernel > *kernels)

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

template<>
VECTOR_CLASS< char * >	getInfo (cl_int *err) 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

Program &	operator= (const cl_program &rhs)

Program &	operator= (const Program &program)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...

	Program (const STRING_CLASS &source, bool build=false, cl_int *err=NULL)

	Program (const Context &context, const STRING_CLASS &source, bool build=false, cl_int *err=NULL)

	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 ()

__CL_EXPLICIT_CONSTRUCTORS	Program (const cl_program &program)

	Program (const Program &program)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...

Public Member Functions inherited from cl::detail::Wrapper< cl_program >
cl_type	operator() () const

cl_type &	operator() ()

Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)

Wrapper< cl_type > &	operator= (const cl_type &rhs)

	Wrapper ()

	Wrapper (const cl_type &obj)

	Wrapper (const Wrapper< cl_type > &rhs)

	~Wrapper ()

Additional Inherited Members
Protected Member Functions inherited from cl::detail::Wrapper< cl_program >
cl_int	release () const

cl_int	retain () const

Protected Attributes inherited from cl::detail::Wrapper< cl_program >
cl_type	object_

Detailed Description

Program interface that implements cl_program.

Definition at line 4990 of file cl.hpp.

Member Typedef Documentation

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

Definition at line 4993 of file cl.hpp.

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

Definition at line 4994 of file cl.hpp.

Constructor & Destructor Documentation

cl::Program::Program	(	const STRING_CLASS &	source,
		bool	build = `false`,
		cl_int *	err = `NULL`
	)

inline

Definition at line 4996 of file cl.hpp.

cl::Program::Program	(	const Context &	context,
		const STRING_CLASS &	source,
		bool	build = `false`,
		cl_int *	err = `NULL`
	)

inline

Definition at line 5031 of file cl.hpp.

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

inline

Definition at line 5065 of file cl.hpp.

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

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

Parameters

context	A valid OpenCL context in which to construct the program.
devices	A vector of OpenCL device objects for which the program will be created.
binaries	A vector of pairs of a pointer to a binary object and its length.
binaryStatus	An 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 NULL. Set to CL_INVALID_BINARY if the binary provided is not valid for the matching device.
err	if non-NULL 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 NULL 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 5109 of file cl.hpp.

cl::Program::Program ( )

inline

Definition at line 5195 of file cl.hpp.

__CL_EXPLICIT_CONSTRUCTORS cl::Program::Program ( const cl_program & program )

inline

Definition at line 5197 of file cl.hpp.

cl::Program::Program ( const Program & program )

inline

Copy constructor to forward copy to the superclass correctly. Required for MSVC.

Definition at line 5208 of file cl.hpp.

Member Function Documentation

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

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

inline

Definition at line 5259 of file cl.hpp.

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

inline

Definition at line 5340 of file cl.hpp.

template<typename T >

cl_int cl::Program::getBuildInfo	(	const Device &	device,
		cl_program_build_info	name,
		T *	param
	)		const

inline

Definition at line 5318 of file cl.hpp.

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

template<>

VECTOR_CLASS<char *> cl::Program::getInfo ( cl_int * err ) const

inline

Definition at line 5442 of file cl.hpp.

template<typename T >

cl_int cl::Program::getInfo	(	cl_program_info	name,
		T *	param
	)		const

inline

Definition at line 5297 of file cl.hpp.

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

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

inline

Definition at line 5199 of file cl.hpp.

Program& cl::Program::operator= ( const Program & program )

inline

Copy assignment to forward copy to the superclass correctly. Required for MSVC.

Definition at line 5213 of file cl.hpp.

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

cl.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation