OpenCL C++ Bindings
|
Class interface for 2D Image Memory objects. More...
#include <opencl.hpp>
Public Member Functions | |
Image2D (const Context &context, cl_mem_flags flags, ImageFormat format, size_type width, size_type height, size_type row_pitch=0, void *host_ptr=nullptr, cl_int *err=nullptr) | |
Constructs a 2D Image in a specified context. | |
Image2D (const Context &context, ImageFormat format, const Buffer &sourceBuffer, size_type width, size_type height, size_type row_pitch=0, cl_int *err=nullptr) | |
Constructs a 2D Image from a buffer. | |
Image2D (const Context &context, cl_channel_order order, const Image &sourceImage, cl_int *err=nullptr) | |
Constructs a 2D Image from an image. | |
Image2D () | |
Default constructor - initializes to nullptr. | |
Image2D (const cl_mem &image2D, bool retainObject=false) | |
Constructor from cl_mem - takes ownership. | |
Image2D & | operator= (const cl_mem &rhs) |
Assignment from cl_mem - performs shallow copy. | |
![]() | |
template<typename T > | |
cl_int | getImageInfo (cl_image_info name, T *param) const |
Wrapper for clGetImageInfo(). | |
template<cl_image_info name> | |
detail::param_traits< detail::cl_image_info, name >::param_type | getImageInfo (cl_int *err=nullptr) const |
Wrapper for clGetImageInfo() that returns by value. | |
![]() | |
Memory () | |
Default constructor - initializes to nullptr. | |
Memory (const cl_mem &memory, bool retainObject) | |
Constructor from cl_mem - takes ownership. | |
Memory & | operator= (const cl_mem &rhs) |
Assignment operator from cl_mem - takes ownership. | |
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=nullptr) const |
Wrapper for clGetMemObjectInfo() that returns by value. | |
cl_int | setDestructorCallback (void(CL_CALLBACK *pfn_notify)(cl_mem, void *), void *user_data=nullptr) |
Registers a callback function to be called when the memory object is no longer needed. | |
![]() | |
Wrapper (const cl_type &obj, bool retainObject) | |
Wrapper (const Wrapper< cl_type > &rhs) | |
Wrapper (Wrapper< cl_type > &&rhs) 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 |
![]() | |
Image () | |
Default constructor - initializes to nullptr. | |
Image (const cl_mem &image, bool retainObject=false) | |
Constructor from cl_mem - takes ownership. | |
Image & | operator= (const cl_mem &rhs) |
Assignment from cl_mem - performs shallow copy. | |
![]() | |
cl_int | retain () const |
cl_int | release () const |
![]() | |
cl_type | object_ |
Class interface for 2D Image Memory objects.
See Memory for details about copy semantics, etc.
Definition at line 4983 of file opencl.hpp.
|
inline |
Constructs a 2D Image in a specified context.
Wraps clCreateImage().
Definition at line 4990 of file opencl.hpp.
|
inline |
Constructs a 2D Image from a buffer.
Requires OpenCL 2.0 or newer or OpenCL 1.2 and the cl_khr_image2d_from_buffer extension.
Wraps clCreateImage().
Definition at line 5061 of file opencl.hpp.
|
inline |
Constructs a 2D Image from an image.
The image will be created matching with a descriptor matching the source.
order | is the channel order to reinterpret the image data as. The channel order may differ as described in the OpenCL 2.0 API specification. |
Wraps clCreateImage().
Definition at line 5107 of file opencl.hpp.
|
inline |
Default constructor - initializes to nullptr.
Definition at line 5158 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 5167 of file opencl.hpp.
|
inline |
Assignment from cl_mem - performs shallow copy.
See Memory for further details.
Definition at line 5174 of file opencl.hpp.