ASL  0.1.6
Advanced Simulation Library
Public Member Functions | Protected Member Functions | List of all members
cl::Image Class Reference

C++ base class for Image Memory objects. More...

#include <cl.hpp>

Inheritance diagram for cl::Image:
cl::Memory cl::Memory cl::detail::Wrapper< cl_mem > cl::detail::Wrapper< cl_mem > cl::detail::Wrapper< cl_mem > cl::detail::Wrapper< cl_mem > cl::Image2D cl::Image2D cl::Image3D cl::Image3D cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED cl::CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED cl::Image3DGL cl::Image3DGL cl::Image3DGL cl::Image3DGL

Public Member Functions

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...
 
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
 Memory ()
 Default constructor - initializes to NULL. More...
 
__CL_EXPLICIT_CONSTRUCTORS Memory (const cl_mem &memory)
 Constructor from cl_mem - takes ownership. More...
 
Memoryoperator= (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. More...
 
Memoryoperator= (const Memory &mem)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
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...
 
Memoryoperator= (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. More...
 
Memoryoperator= (const Memory &mem)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
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...
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
 Wrapper ()
 
 Wrapper (const cl_type &obj)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 Wrapper ()
 
 Wrapper (const cl_type &obj)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 ~Wrapper ()
 
 ~Wrapper ()
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (const 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_typeoperator() ()
 
cl_type operator() () const
 
cl_typeoperator() ()
 

Protected Member Functions

 Image ()
 Default constructor - initializes to NULL. More...
 
__CL_EXPLICIT_CONSTRUCTORS Image (const cl_mem &image)
 Constructor from cl_mem - takes ownership. More...
 
Imageoperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy. More...
 
 Image (const Image &img)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
 
Imageoperator= (const Image &img)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
 Image ()
 Default constructor - initializes to NULL. More...
 
__CL_EXPLICIT_CONSTRUCTORS Image (const cl_mem &image)
 Constructor from cl_mem - takes ownership. More...
 
Imageoperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy. More...
 
 Image (const Image &img)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
 
Imageoperator= (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 retain () const
 
cl_int retain () const
 
cl_int release () const
 
cl_int release () const
 

Additional Inherited Members

- Public Types inherited from cl::detail::Wrapper< cl_mem >
typedef cl_mem cl_type
 
typedef cl_mem cl_type
 
- Protected Attributes inherited from cl::detail::Wrapper< cl_mem >
cl_type object_
 

Detailed Description

C++ base class for Image Memory objects.

See Memory for details about copy semantics, etc.

See also
Memory

Definition at line 3426 of file cl.hpp.

Constructor & Destructor Documentation

cl::Image::Image ( )
inlineprotected

Default constructor - initializes to NULL.

Definition at line 3430 of file cl.hpp.

__CL_EXPLICIT_CONSTRUCTORS cl::Image::Image ( const cl_mem &  image)
inlineprotected

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 3436 of file cl.hpp.

cl::Image::Image ( const Image img)
inlineprotected

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

Definition at line 3451 of file cl.hpp.

cl::Image::Image ( )
inlineprotected

Default constructor - initializes to NULL.

Definition at line 3430 of file cl.hpp.

__CL_EXPLICIT_CONSTRUCTORS cl::Image::Image ( const cl_mem &  image)
inlineprotected

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 3436 of file cl.hpp.

cl::Image::Image ( const Image img)
inlineprotected

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

Definition at line 3451 of file cl.hpp.

Member Function Documentation

template<typename T >
cl_int cl::Image::getImageInfo ( cl_image_info  name,
T *  param 
) const
inline

Wrapper for clGetImageInfo().

Definition at line 3481 of file cl.hpp.

template<typename T >
cl_int cl::Image::getImageInfo ( cl_image_info  name,
T *  param 
) const
inline

Wrapper for clGetImageInfo().

Definition at line 3481 of file cl.hpp.

template<cl_int name>
detail::param_traits<detail::cl_image_info, name>::param_type cl::Image::getImageInfo ( cl_int *  err = NULL) const
inline

Wrapper for clGetImageInfo() that returns by value.

Definition at line 3491 of file cl.hpp.

template<cl_int name>
detail::param_traits<detail::cl_image_info, name>::param_type cl::Image::getImageInfo ( cl_int *  err = NULL) const
inline

Wrapper for clGetImageInfo() that returns by value.

Definition at line 3491 of file cl.hpp.

Image& cl::Image::operator= ( const cl_mem &  rhs)
inlineprotected

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 3442 of file cl.hpp.

Image& cl::Image::operator= ( const cl_mem &  rhs)
inlineprotected

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 3442 of file cl.hpp.

Image& cl::Image::operator= ( const Image img)
inlineprotected

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

Definition at line 3456 of file cl.hpp.

Image& cl::Image::operator= ( const Image img)
inlineprotected

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

Definition at line 3456 of file cl.hpp.


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