cl::Image Class Reference

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

`#include <cl.hpp>`

Inheritance diagram for cl::Image:
[legend]
Collaboration diagram for cl::Image:
[legend]

## 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...
Memory & | operator= (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...
Memory & | operator= (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...
Memory & | operator= (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...
Memory & | operator= (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_type & | operator() ()
cl_type | operator() () const
cl_type & | operator() ()

## 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...
Image & | operator= (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...
Image & | operator= (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...
Image & | operator= (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...
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 | 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

## Image() [1/6]

cl::Image::Image | ( |  | ) |

inline protected

Default constructor - initializes to NULL.

Definition at line 3430 of file cl.hpp.

## Image() [2/6]

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

inline protected

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 3436 of file cl.hpp.

## Image() [3/6]

cl::Image::Image | ( | const Image & | img | ) |

inline protected

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

Definition at line 3451 of file cl.hpp.

## Image() [4/6]

cl::Image::Image | ( |  | ) |

inline protected

Default constructor - initializes to NULL.

Definition at line 3430 of file cl.hpp.

## Image() [5/6]

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

inline protected

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 3436 of file cl.hpp.

## Image() [6/6]

cl::Image::Image | ( | const Image & | img | ) |

inline protected

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

Definition at line 3451 of file cl.hpp.

## Member Function Documentation

## getImageInfo() [1/4]

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.

## getImageInfo() [2/4]

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.

## getImageInfo() [3/4]

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.

## getImageInfo() [4/4]

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.

## operator=() [1/4]

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

inline protected

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 3442 of file cl.hpp.

## operator=() [2/4]

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

inline protected

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 3442 of file cl.hpp.

## operator=() [3/4]

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

inline protected

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

Definition at line 3456 of file cl.hpp.

## operator=() [4/4]

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

inline protected

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:

- /build/asl-1Fw6fH/asl-0.1.7/debian/tmp/usr/include/ASL/acl/cl.hpp