cl::Memory Class Reference

Class interface for cl_mem. More...

#include <cl.hpp>

Inheritance diagram for cl::Memory:

Public Member Functions
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 ()

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	release () const
cl_int	retain () 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

Definition at line 3016 of file cl.hpp.

Constructor & Destructor Documentation

cl::Memory::Memory ( )

inline

Default constructor - initializes to NULL.

Definition at line 3020 of file cl.hpp.

__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.

Definition at line 3027 of file cl.hpp.

cl::Memory::Memory ( const Memory &  mem )

inline

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

Definition at line 3043 of file cl.hpp.

Member Function Documentation

template<typename T >

cl_int cl::Memory::getInfo ( cl_mem_info  name, T *  param  ) const

inline

Wrapper for clGetMemObjectInfo().

Definition at line 3072 of file cl.hpp.

template<cl_int name>

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

inline

Wrapper for clGetMemObjectInfo() that returns by value.

Definition at line 3082 of file cl.hpp.

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.

Definition at line 3034 of file cl.hpp.

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

inline

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

Definition at line 3048 of file cl.hpp.

---

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

• cl.hpp