cl::Memory Class Reference

Class interface for cl_mem. More...

#include <cl.hpp>

Inheritance diagram for cl::Memory:

Public Member Functions
	~Memory ()
	Destructor.
	Memory ()
	Default constructor - initializes to NULL.
	Memory (const Memory &memory)
	Copy constructor - performs shallow copy.
__CL_EXPLICIT_CONSTRUCTORS	Memory (const cl_mem &memory)
	Constructor from cl_mem - takes ownership.
Memory &	operator= (const Memory &rhs)
	Assignment operator from Memory.
Memory &	operator= (const cl_mem &rhs)
	Assignment operator from cl_mem - takes ownership.
template<typename T >
cl_int	getInfo (cl_mem_info name, T *param) const
	Wrapper for clGetMemObjectInfo().
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.
Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
	Wrapper (const cl_type &obj)
	Wrapper (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const cl_type &rhs)
cl_type	operator() () const
cl_type &	operator() ()

Additional Inherited Members
Public Types inherited from cl::detail::Wrapper< cl_mem >
typedef cl_mem	cl_type
Protected Member Functions inherited from cl::detail::Wrapper< cl_mem >
cl_int	retain () const
cl_int	release () const
Protected Attributes inherited from cl::detail::Wrapper< cl_mem >
cl_type	object_

Detailed Description

Class interface for cl_mem.

Note

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

See also

cl_mem

Constructor & Destructor Documentation

~Memory()

cl::Memory::~Memory ( )

inline

Destructor.

This calls clReleaseMemObject() on the value held by this instance.

Memory() [1/2]

cl::Memory::Memory ( const Memory &  memory )

inline

Copy constructor - performs shallow copy.

This calls clRetainMemObject() on the parameter's cl_mem.

Memory() [2/2]

__CL_EXPLICIT_CONSTRUCTORS cl::Memory::Memory ( const cl_mem &  memory )

inline

Constructor from cl_mem - takes ownership.

This effectively transfers ownership of a refcount on the cl_mem into the new Memory object.

Member Function Documentation

operator=() [1/2]

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

inline

Assignment operator from cl_mem - takes ownership.

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

operator=() [2/2]

Memory & cl::Memory::operator= ( const Memory &  rhs )

inline

Assignment operator from Memory.

This calls clRetainMemObject() on the parameter and clReleaseMemObject() on the previous value held by this instance.

Referenced by cl::Buffer::operator=(), cl::Buffer::operator=(), cl::Image::operator=(), and cl::Image::operator=().