cl::Image2D Class Reference

Class interface for 2D Image Memory objects. More...

#include <cl.hpp>

Inheritance diagram for cl::Image2D:

Public Member Functions
	Image2D (const Context &context, cl_mem_flags flags, ImageFormat format,::size_t width,::size_t height,::size_t row_pitch=0, void *host_ptr=NULL, cl_int *err=NULL)
	Constructs a 1D Image in a specified context. More...
	Image2D ()
	Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS	Image2D (const cl_mem &image2D)
	Constructor from cl_mem - takes ownership. More...
	Image2D (const Image2D &img)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Image2D &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy. More...
Image2D &	operator= (const Image2D &img)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
Public Member Functions inherited from cl::Image
template<typename T >
cl_int	getImageInfo (cl_image_info name, T *param) const
	Wrapper for clGetImageInfo(). More...
template<cl_int name>
detail::param_traits< detail::cl_image_info, name >::param_type	getImageInfo (cl_int *err=NULL) const
	Wrapper for clGetImageInfo() that returns by value. More...
Public Member Functions inherited from cl::Memory
template<typename T >
cl_int	getInfo (cl_mem_info name, T *param) const
	Wrapper for clGetMemObjectInfo(). More...
template<cl_int name>
detail::param_traits< detail::cl_mem_info, name >::param_type	getInfo (cl_int *err=NULL) const
	Wrapper for clGetMemObjectInfo() that returns by value. More...
	Memory ()
	Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS	Memory (const cl_mem &memory)
	Constructor from cl_mem - takes ownership. More...
	Memory (const Memory &mem)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Memory &	operator= (const cl_mem &rhs)
	Assignment operator from cl_mem - takes ownership. More...
Memory &	operator= (const Memory &mem)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
cl_type	operator() () const
cl_type &	operator() ()
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const cl_type &rhs)
	Wrapper ()
	Wrapper (const cl_type &obj)
	Wrapper (const Wrapper< cl_type > &rhs)
	~Wrapper ()

Additional Inherited Members
Public Types inherited from cl::detail::Wrapper< cl_mem >
typedef cl_mem	cl_type
Protected Member Functions inherited from cl::Image
	Image ()
	Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS	Image (const cl_mem &image)
	Constructor from cl_mem - takes ownership. More...
	Image (const Image &img)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Image &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy. More...
Image &	operator= (const Image &img)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
Protected Member Functions inherited from cl::detail::Wrapper< cl_mem >
cl_int	release () const
cl_int	retain () const
Protected Attributes inherited from cl::detail::Wrapper< cl_mem >
cl_type	object_

Detailed Description

Class interface for 2D Image Memory objects.

See Memory for details about copy semantics, etc.

See also

Memory

Definition at line 3885 of file cl.hpp.

Constructor & Destructor Documentation

cl::Image2D::Image2D ( const Context &  context, cl_mem_flags  flags, ImageFormat  format, ::size_t  width, ::size_t  height, ::size_t  row_pitch = 0, void *  host_ptr = NULL, cl_int *  err = NULL  )

inline

Constructs a 1D Image in a specified context.

Wraps clCreateImage().

Definition at line 3892 of file cl.hpp.

cl::Image2D::Image2D ( )

inline

Default constructor - initializes to NULL.

Definition at line 3958 of file cl.hpp.

__CL_EXPLICIT_CONSTRUCTORS cl::Image2D::Image2D ( const cl_mem &  image2D )

inline

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 3964 of file cl.hpp.

cl::Image2D::Image2D ( const Image2D &  img )

inline

Copy constructor to forward copy to the superclass correctly. Required for MSVC.

Definition at line 3979 of file cl.hpp.

Member Function Documentation

Image2D& cl::Image2D::operator= ( const cl_mem &  rhs )

inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 3970 of file cl.hpp.

Image2D& cl::Image2D::operator= ( const Image2D &  img )

inline

Copy assignment to forward copy to the superclass correctly. Required for MSVC.

Definition at line 3984 of file cl.hpp.

---

The documentation for this class was generated from the following file:

• cl.hpp