cl::Image Class Reference

C++ base class for Image Memory objects. More...

#include <cl.hpp>

Inheritance diagram for cl::Image:

Public Member Functions
template<typename T >
cl_int	getImageInfo (cl_image_info name, T *param) const
	Wrapper for clGetImageInfo(). More...
template<cl_int name>
detail::param_traits< detail::cl_image_info, name >::param_type	getImageInfo (cl_int *err=NULL) const
	Wrapper for clGetImageInfo() that returns by value. More...
Public Member Functions inherited from cl::Memory
template<typename T >
cl_int	getInfo (cl_mem_info name, T *param) const
	Wrapper for clGetMemObjectInfo(). More...
template<cl_int name>
detail::param_traits< detail::cl_mem_info, name >::param_type	getInfo (cl_int *err=NULL) const
	Wrapper for clGetMemObjectInfo() that returns by value. More...
	Memory ()
	Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS	Memory (const cl_mem &memory)
	Constructor from cl_mem - takes ownership. More...
	Memory (const Memory &mem)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Memory &	operator= (const cl_mem &rhs)
	Assignment operator from cl_mem - takes ownership. More...
Memory &	operator= (const Memory &mem)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
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 ()

Protected Member Functions
	Image ()
	Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS	Image (const cl_mem &image)
	Constructor from cl_mem - takes ownership. More...
	Image (const Image &img)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Image &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy. More...
Image &	operator= (const Image &img)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
Protected Member Functions inherited from cl::detail::Wrapper< cl_mem >
cl_int	release () const
cl_int	retain () const

Additional Inherited Members
Public Types inherited from cl::detail::Wrapper< cl_mem >
typedef cl_mem	cl_type
Protected Attributes inherited from cl::detail::Wrapper< cl_mem >
cl_type	object_

Detailed Description

C++ base class for Image Memory objects.

See Memory for details about copy semantics, etc.

See also

Memory

Definition at line 3549 of file cl.hpp.

Constructor & Destructor Documentation

cl::Image::Image ( )

inlineprotected

Default constructor - initializes to NULL.

Definition at line 3553 of file cl.hpp.

__CL_EXPLICIT_CONSTRUCTORS cl::Image::Image ( const cl_mem &  image )

inlineprotected

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 3559 of file cl.hpp.

cl::Image::Image ( const Image &  img )

inlineprotected

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

Definition at line 3574 of file cl.hpp.

Member Function Documentation

template<typename T >

cl_int cl::Image::getImageInfo ( cl_image_info  name, T *  param  ) const

inline

Wrapper for clGetImageInfo().

Definition at line 3604 of file cl.hpp.

template<cl_int name>

detail::param_traits<detail::cl_image_info, name>::param_type cl::Image::getImageInfo ( cl_int *  err = NULL ) const

inline

Wrapper for clGetImageInfo() that returns by value.

Definition at line 3614 of file cl.hpp.

Image& cl::Image::operator= ( const cl_mem &  rhs )

inlineprotected

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 3565 of file cl.hpp.

Image& cl::Image::operator= ( const Image &  img )

inlineprotected

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

Definition at line 3579 of file cl.hpp.

---

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

• cl.hpp