cl::Image3D Class Reference

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

#include <cl.hpp>

Inheritance diagram for cl::Image3D:

Public Member Functions
	Image3D (const Context &context, cl_mem_flags flags, ImageFormat format, ::size_t width, ::size_t height, ::size_t depth, ::size_t row_pitch=0, ::size_t slice_pitch=0, void *host_ptr=NULL, cl_int *err=NULL)
	Constructs a 3D Image in a specified context.
	Image3D ()
	Default constructor - initializes to NULL.
	Image3D (const Image3D &image3D)
	Copy constructor - performs shallow copy.
__CL_EXPLICIT_CONSTRUCTORS	Image3D (const cl_mem &image3D)
	Constructor from cl_mem - takes ownership.
Image3D &	operator= (const Image3D &rhs)
	Assignment from Image3D - performs shallow copy.
Image3D &	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 3D Image Memory objects.

See Memory for details about copy semantics, etc.

See also

Memory

Constructor & Destructor Documentation

Image3D() [1/3]

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

inline

Constructs a 3D Image in a specified context.

Wraps clCreateImage().

Image3D() [2/3]

cl::Image3D::Image3D ( const Image3D &  image3D )

inline

Copy constructor - performs shallow copy.

See Memory for further details.

Image3D() [3/3]

__CL_EXPLICIT_CONSTRUCTORS cl::Image3D::Image3D ( const cl_mem &  image3D )

inline

Constructor from cl_mem - takes ownership.

See Memory for further details.

Member Function Documentation

operator=() [1/2]

Image3D & cl::Image3D::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]

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

inline

Assignment from Image3D - performs shallow copy.

See Memory for further details.

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

Referenced by cl::Image3DGL::operator=(), and cl::Image3DGL::operator=().