OpenCL C++ Bindings
|
Class interface for Pipe Memory Objects. More...
Public Member Functions | |
Pipe (const Context &context, cl_uint packet_size, cl_uint max_packets, cl_int *err=NULL) | |
Constructs a Pipe in a specified context. More... | |
Pipe (cl_uint packet_size, cl_uint max_packets, cl_int *err=NULL) | |
Constructs a Pipe in a the default context. More... | |
Pipe () | |
Default constructor - initializes to NULL. | |
Pipe (const cl_mem &pipe, bool retainObject=false) | |
Constructor from cl_mem - takes ownership. More... | |
Pipe & | operator= (const cl_mem &rhs) |
Assignment from cl_mem - performs shallow copy. More... | |
Pipe (const Pipe &pipe) | |
Copy constructor to forward copy to the superclass correctly. Required for MSVC. | |
Pipe & | operator= (const Pipe &pipe) |
Copy assignment to forward copy to the superclass correctly. Required for MSVC. | |
Pipe (Pipe &&pipe) CL_HPP_NOEXCEPT_ | |
Move constructor to forward move to the superclass correctly. Required for MSVC. | |
Pipe & | operator= (Pipe &&pipe) |
Move assignment to forward move to the superclass correctly. Required for MSVC. | |
template<typename T > | |
cl_int | getInfo (cl_pipe_info name, T *param) const |
Wrapper for clGetMemObjectInfo(). | |
template<cl_pipe_info name> | |
detail::param_traits< detail::cl_pipe_info, name >::param_type | getInfo (cl_int *err=NULL) const |
Wrapper for clGetMemObjectInfo() that returns by value. | |
![]() | |
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 Pipe Memory Objects.
See Memory for details about copy semantics, etc.
Definition at line 5476 of file opencl.hpp.
|
inline |
Constructs a Pipe in a specified context.
Wraps clCreatePipe().
context | Context in which to create the pipe. |
flags | Bitfield. Only CL_MEM_READ_WRITE and CL_MEM_HOST_NO_ACCESS are valid. |
packet_size | Size in bytes of a single packet of the pipe. |
max_packets | Number of packets that may be stored in the pipe. |
Definition at line 5489 of file opencl.hpp.
|
inline |
Constructs a Pipe in a the default context.
Wraps clCreatePipe().
flags | Bitfield. Only CL_MEM_READ_WRITE and CL_MEM_HOST_NO_ACCESS are valid. |
packet_size | Size in bytes of a single packet of the pipe. |
max_packets | Number of packets that may be stored in the pipe. |
Definition at line 5514 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 5542 of file opencl.hpp.
|
inline |
Assignment from cl_mem - performs shallow copy.
See Memory for further details.
Definition at line 5549 of file opencl.hpp.