Class interface for cl_mem.
More...
|
| Memory () |
| Default constructor - initializes to NULL.
|
|
| Memory (const cl_mem &memory, bool retainObject) |
| Constructor from cl_mem - takes ownership. More...
|
|
Memory & | operator= (const cl_mem &rhs) |
| Assignment operator from cl_mem - takes ownership. More...
|
|
| Memory (const Memory &mem) |
| Copy constructor to forward copy to the superclass correctly. Required for MSVC.
|
|
Memory & | operator= (const Memory &mem) |
| Copy assignment to forward copy to the superclass correctly. Required for MSVC.
|
|
| Memory (Memory &&mem) CL_HPP_NOEXCEPT_ |
| Move constructor to forward move to the superclass correctly. Required for MSVC.
|
|
Memory & | operator= (Memory &&mem) |
| Move assignment to forward move to the superclass correctly. Required for MSVC.
|
|
template<typename T > |
cl_int | getInfo (cl_mem_info name, T *param) const |
| Wrapper for clGetMemObjectInfo().
|
|
template<cl_mem_info name> |
detail::param_traits< detail::cl_mem_info, name >::param_type | getInfo (cl_int *err=NULL) const |
| Wrapper for clGetMemObjectInfo() that returns by value.
|
|
cl_int | setDestructorCallback (void(CL_CALLBACK *pfn_notify)(cl_mem, void *), void *user_data=NULL) |
| Registers a callback function to be called when the memory object is no longer needed. More...
|
|
| Wrapper (const cl_type &obj, bool retainObject) |
|
| Wrapper (const Wrapper< cl_type > &rhs) |
|
| Wrapper (Wrapper< cl_type > &&rhs) CL_HPP_NOEXCEPT_ |
|
Wrapper< cl_type > & | operator= (const Wrapper< cl_type > &rhs) |
|
Wrapper< cl_type > & | operator= (Wrapper< cl_type > &&rhs) |
|
Wrapper< cl_type > & | operator= (const cl_type &rhs) |
|
const cl_type & | operator() () const |
|
cl_type & | operator() () |
|
cl_type | get () const |
|
|
typedef cl_mem | cl_type |
|
cl_int | retain () const |
|
cl_int | release () const |
|
cl_type | object_ |
|
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 3325 of file cl2.hpp.
◆ Memory()
cl::Memory::Memory |
( |
const cl_mem & |
memory, |
|
|
bool |
retainObject |
|
) |
| |
|
inlineexplicit |
Constructor from cl_mem - takes ownership.
Optionally transfer ownership of a refcount on the cl_mem into the new Memory object.
- Parameters
-
retainObject | will cause the constructor to retain its cl object. Defaults to false to maintain compatibility with earlier versions. |
See Memory for further details.
Definition at line 3342 of file cl2.hpp.
◆ operator=()
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 3350 of file cl2.hpp.
◆ setDestructorCallback()
cl_int cl::Memory::setDestructorCallback |
( |
void(CL_CALLBACK *pfn_notify)(cl_mem, void *) |
, |
|
|
void * |
user_data = NULL |
|
) |
| |
|
inline |
Registers a callback function to be called when the memory object is no longer needed.
Wraps clSetMemObjectDestructorCallback().
Repeated calls to this function, for a given cl_mem value, will append to the list of functions called (in reverse order) when memory object's resources are freed and the memory object is deleted.
- Note
- The registered callbacks are associated with the underlying cl_mem value - not the Memory class instance.
Definition at line 3422 of file cl2.hpp.
The documentation for this class was generated from the following file: