cl::Kernel Class Reference

Class interface for cl_kernel. More...

#include <cl.hpp>

Inheritance diagram for cl::Kernel:

Public Member Functions
template<typename T >
cl_int	getInfo (cl_kernel_info name, T *param) const
template<cl_int name>
detail::param_traits< detail::cl_kernel_info, name >::param_type	getInfo (cl_int *err=NULL) const
template<typename T >
cl_int	getWorkGroupInfo (const Device &device, cl_kernel_work_group_info name, T *param) const
template<cl_int name>
detail::param_traits< detail::cl_kernel_work_group_info, name >::param_type	getWorkGroupInfo (const Device &device, cl_int *err=NULL) const
	Kernel (const Program &program, const char *name, cl_int *err=NULL)
	Kernel ()
	Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS	Kernel (const cl_kernel &kernel)
	Constructor from cl_kernel - takes ownership. More...
	Kernel (const Kernel &kernel)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Kernel &	operator= (const cl_kernel &rhs)
	Assignment operator from cl_kernel - takes ownership. More...
Kernel &	operator= (const Kernel &kernel)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
template<typename T >
cl_int	setArg (cl_uint index, const T &value)
cl_int	setArg (cl_uint index,::size_t size, const void *argPtr)
Public Member Functions inherited from cl::detail::Wrapper< cl_kernel >
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
Public Types inherited from cl::detail::Wrapper< cl_kernel >
typedef cl_kernel	cl_type
Protected Member Functions inherited from cl::detail::Wrapper< cl_kernel >
cl_int	release () const
cl_int	retain () const
Protected Attributes inherited from cl::detail::Wrapper< cl_kernel >
cl_type	object_

Detailed Description

Class interface for cl_kernel.

Note

Copies of these objects are shallow, meaning that the copy will refer to the same underlying cl_kernel as the original. For details, see clRetainKernel() and clReleaseKernel().

See also

cl_kernel

Definition at line 4844 of file cl.hpp.

Constructor & Destructor Documentation

cl::Kernel::Kernel ( const Program &  program, const char *  name, cl_int *  err = NULL  )

inline

Definition at line 5461 of file cl.hpp.

cl::Kernel::Kernel ( )

inline

Default constructor - initializes to NULL.

Definition at line 4850 of file cl.hpp.

__CL_EXPLICIT_CONSTRUCTORS cl::Kernel::Kernel ( const cl_kernel &  kernel )

inline

Constructor from cl_kernel - takes ownership.

This effectively transfers ownership of a refcount on the cl_kernel into the new Kernel object.

Definition at line 4857 of file cl.hpp.

cl::Kernel::Kernel ( const Kernel &  kernel )

inline

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

Definition at line 4873 of file cl.hpp.

Member Function Documentation

template<typename T >

cl_int cl::Kernel::getInfo ( cl_kernel_info  name, T *  param  ) const

inline

Definition at line 4901 of file cl.hpp.

template<cl_int name>

detail::param_traits<detail::cl_kernel_info, name>::param_type cl::Kernel::getInfo ( cl_int *  err = NULL ) const

inline

Definition at line 4910 of file cl.hpp.

template<typename T >

cl_int cl::Kernel::getWorkGroupInfo ( const Device &  device, cl_kernel_work_group_info  name, T *  param  ) const

inline

Definition at line 4945 of file cl.hpp.

template<cl_int name>

detail::param_traits<detail::cl_kernel_work_group_info, name>::param_type cl::Kernel::getWorkGroupInfo ( const Device &  device, cl_int *  err = NULL  ) const

inline

Definition at line 4956 of file cl.hpp.

Kernel& cl::Kernel::operator= ( const cl_kernel &  rhs )

inline

Assignment operator from cl_kernel - takes ownership.

This effectively transfers ownership of a refcount on the rhs and calls clReleaseKernel() on the value previously held by this instance.

Definition at line 4864 of file cl.hpp.

Kernel& cl::Kernel::operator= ( const Kernel &  kernel )

inline

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

Definition at line 4878 of file cl.hpp.

template<typename T >

cl_int cl::Kernel::setArg ( cl_uint  index, const T &  value  )

inline

Definition at line 4968 of file cl.hpp.

cl_int cl::Kernel::setArg ( cl_uint  index, ::size_t  size, const void *  argPtr  )

inline

Definition at line 4979 of file cl.hpp.

---

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

• cl.hpp