Handle class the effectively represents a smart pointer for OpenCL handles.
More...
#include <handle.hpp>
Public Member Functions |
| | handle () |
| | handle (const OCL_TYPE &something) |
| | handle (const handle &other) |
| | ~handle () |
| handle & | operator= (const handle &other) |
| | Copies the OpenCL handle from the provided handle. Does not take ownership like e.g. std::auto_ptr<>, so both handle objects are valid (more like shared_ptr).
|
| handle & | operator= (const OCL_TYPE &something) |
| | Wraps an OpenCL handle. Decreases the reference count if the handle object is destroyed or another OpenCL handle is assigned.
|
| | operator OCL_TYPE () const |
| | Implicit conversion to the plain OpenCL handle. DEPRECATED and will be removed some time in the future.
|
| const OCL_TYPE & | get () const |
| handle & | swap (handle &other) |
| | Swaps the OpenCL handle of two handle objects.
|
| void | inc () |
| | Manually increment the OpenCL reference count. Typically called automatically, but is necessary if user-supplied memory objects are wrapped.
|
| void | dec () |
| | Manually decrement the OpenCL reference count. Typically called automatically, but might be useful with user-supplied memory objects.
|
Detailed Description
template<class OCL_TYPE>
class viennacl::ocl::handle< OCL_TYPE >
Handle class the effectively represents a smart pointer for OpenCL handles.
Constructor & Destructor Documentation
| handle |
( |
const OCL_TYPE & |
something | ) |
[inline] |
Member Function Documentation
Manually decrement the OpenCL reference count. Typically called automatically, but might be useful with user-supplied memory objects.
| const OCL_TYPE& get |
( |
| ) |
const [inline] |
Manually increment the OpenCL reference count. Typically called automatically, but is necessary if user-supplied memory objects are wrapped.
| operator OCL_TYPE |
( |
| ) |
const [inline] |
Implicit conversion to the plain OpenCL handle. DEPRECATED and will be removed some time in the future.
| handle& operator= |
( |
const handle< OCL_TYPE > & |
other | ) |
[inline] |
Copies the OpenCL handle from the provided handle. Does not take ownership like e.g. std::auto_ptr<>, so both handle objects are valid (more like shared_ptr).
| handle& operator= |
( |
const OCL_TYPE & |
something | ) |
[inline] |
Wraps an OpenCL handle. Decreases the reference count if the handle object is destroyed or another OpenCL handle is assigned.
Swaps the OpenCL handle of two handle objects.
The documentation for this class was generated from the following file:
