OpenCL C++ Bindings
|
Class interface for Buffer Memory Objects. More...
Public Member Functions | |
Buffer (const Context &context, cl_mem_flags flags, size_type size, void *host_ptr=NULL, cl_int *err=NULL) | |
Constructs a Buffer in a specified context. More... | |
Buffer (cl_mem_flags flags, size_type size, void *host_ptr=NULL, cl_int *err=NULL) | |
Constructs a Buffer in the default context. More... | |
template<typename IteratorType > | |
Buffer (IteratorType startIterator, IteratorType endIterator, bool readOnly, bool useHostPtr=false, cl_int *err=NULL) | |
Construct a Buffer from a host container via iterators. IteratorType must be random access. If useHostPtr is specified iterators must represent contiguous data. | |
template<typename IteratorType > | |
Buffer (const Context &context, IteratorType startIterator, IteratorType endIterator, bool readOnly, bool useHostPtr=false, cl_int *err=NULL) | |
Construct a Buffer from a host container via iterators using a specified context. IteratorType must be random access. If useHostPtr is specified iterators must represent contiguous data. | |
template<typename IteratorType > | |
Buffer (const CommandQueue &queue, IteratorType startIterator, IteratorType endIterator, bool readOnly, bool useHostPtr=false, cl_int *err=NULL) | |
Construct a Buffer from a host container via iterators using a specified queue. If useHostPtr is specified iterators must be random access. | |
Buffer () | |
Default constructor - initializes to NULL. | |
Buffer (const cl_mem &buffer, bool retainObject=false) | |
Constructor from cl_mem - takes ownership. More... | |
Buffer & | operator= (const cl_mem &rhs) |
Assignment from cl_mem - performs shallow copy. More... | |
Buffer (const Buffer &buf) | |
Copy constructor to forward copy to the superclass correctly. Required for MSVC. | |
Buffer & | operator= (const Buffer &buf) |
Copy assignment to forward copy to the superclass correctly. Required for MSVC. | |
Buffer (Buffer &&buf) CL_HPP_NOEXCEPT_ | |
Move constructor to forward move to the superclass correctly. Required for MSVC. | |
Buffer & | operator= (Buffer &&buf) |
Move assignment to forward move to the superclass correctly. Required for MSVC. | |
Buffer | createSubBuffer (cl_mem_flags flags, cl_buffer_create_type buffer_create_type, const void *buffer_create_info, cl_int *err=NULL) |
Creates a new buffer object from this. 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 |
Additional Inherited Members | |
![]() | |
typedef cl_mem | cl_type |
![]() | |
cl_int | retain () const |
cl_int | release () const |
![]() | |
cl_type | object_ |
Class interface for Buffer Memory Objects.
See Memory for details about copy semantics, etc.
Definition at line 3866 of file opencl.hpp.
|
inline |
Constructs a Buffer in a specified context.
Wraps clCreateBuffer().
host_ptr | Storage to be used if the CL_MEM_USE_HOST_PTR flag was specified. Note alignment & exclusivity requirements. |
Definition at line 3877 of file opencl.hpp.
|
inline |
Constructs a Buffer in the default context.
Wraps clCreateBuffer().
host_ptr | Storage to be used if the CL_MEM_USE_HOST_PTR flag was specified. Note alignment & exclusivity requirements. |
Definition at line 3902 of file opencl.hpp.
|
inlineexplicit |
Constructor from cl_mem - takes ownership.
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 3998 of file opencl.hpp.
|
inline |
Creates a new buffer object from this.
Wraps clCreateSubBuffer().
Definition at line 4044 of file opencl.hpp.
|
inline |
Assignment from cl_mem - performs shallow copy.
See Memory for further details.
Definition at line 4005 of file opencl.hpp.