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.
	Image2D ()
	Default constructor - initializes to NULL.
	Image2D (const Image2D &image2D)
	Copy constructor - performs shallow copy.
__CL_EXPLICIT_CONSTRUCTORS	Image2D (const cl_mem &image2D)
	Constructor from cl_mem - takes ownership.
Image2D &	operator= (const Image2D &rhs)
	Assignment from Image2D - performs shallow copy.
Image2D &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy.
Public Member Functions inherited from cl::Image
template<typename T >
cl_int	getImageInfo (cl_image_info name, T *param) const
	Wrapper for clGetImageInfo().
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.
Public Member Functions inherited from cl::Memory
	~Memory ()
	Destructor.
	Memory ()
	Default constructor - initializes to NULL.
	Memory (const Memory &memory)
	Copy constructor - performs shallow copy.
__CL_EXPLICIT_CONSTRUCTORS	Memory (const cl_mem &memory)
	Constructor from cl_mem - takes ownership.
Memory &	operator= (const Memory &rhs)
	Assignment operator from Memory.
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_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.
Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
	Wrapper (const cl_type &obj)
	Wrapper (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const cl_type &rhs)
cl_type	operator() () const
cl_type &	operator() ()

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.
	Image (const Image &image)
	Copy constructor - performs shallow copy.
__CL_EXPLICIT_CONSTRUCTORS	Image (const cl_mem &image)
	Constructor from cl_mem - takes ownership.
Image &	operator= (const Image &rhs)
	Assignment from Image - performs shallow copy.
Image &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy.
Protected Member Functions inherited from cl::detail::Wrapper< cl_mem >
cl_int	retain () const
cl_int	release () 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

Constructor & Destructor Documentation

Image2D() [1/3]

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().

Image2D() [2/3]

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

inline

Copy constructor - performs shallow copy.

See Memory for further details.

Image2D() [3/3]

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

inline

Constructor from cl_mem - takes ownership.

See Memory for further details.

Member Function Documentation

operator=() [1/2]

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

inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

References cl::Image::operator=().

operator=() [2/2]

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

inline

Assignment from Image2D - performs shallow copy.

See Memory for further details.

References cl::Image::operator=().