OpenCL C++ Wrapper API 1.1
 All Classes Namespaces Files Functions Variables Typedefs Defines
Public Member Functions | Protected Member Functions
cl::Image Class Reference

Base class interface for all images. More...

#include <cl.hpp>

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

List of all members.

Public Member Functions

template<typename T >
cl_int getImageInfo (cl_image_info name, T *param) const
template<cl_int name>
detail::param_traits
< detail::cl_image_info, name >
::param_type 
getImageInfo (cl_int *err=NULL) const

Protected Member Functions

 Image ()
 Image (const Image &image)
 Image (const cl_mem &image)
Imageoperator= (const Image &rhs)
Imageoperator= (const cl_mem &rhs)

Detailed Description

Base class interface for all images.

Definition at line 2302 of file cl.hpp.


Constructor & Destructor Documentation

cl::Image::Image ( ) [inline, protected]

Definition at line 2305 of file cl.hpp.

: Memory() { }
cl::Image::Image ( const Image image) [inline, protected]

Definition at line 2307 of file cl.hpp.

: Memory(image) { }
cl::Image::Image ( const cl_mem &  image) [inline, protected]

Definition at line 2309 of file cl.hpp.

: Memory(image) { }

Member Function Documentation

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

Definition at line 2327 of file cl.hpp.

    {
        return detail::errHandler(
            detail::getInfo(&::clGetImageInfo, object_, name, param),
            __GET_IMAGE_INFO_ERR);
    }
template<cl_int name>
detail::param_traits<detail::cl_image_info, name>::param_type cl::Image::getImageInfo ( cl_int *  err = NULL) const [inline]

Definition at line 2336 of file cl.hpp.

    {
        typename detail::param_traits<
            detail::cl_image_info, name>::param_type param;
        cl_int result = getImageInfo(name, &param);
        if (err != NULL) {
            *err = result;
        }
        return param;
    }
Image& cl::Image::operator= ( const Image rhs) [inline, protected]

Definition at line 2311 of file cl.hpp.

    {
        if (this != &rhs) {
            Memory::operator=(rhs);
        }
        return *this;
    }
Image& cl::Image::operator= ( const cl_mem &  rhs) [inline, protected]

Reimplemented from cl::Memory.

Reimplemented in cl::Image3DGL, cl::Image3D, cl::Image2DGL, and cl::Image2D.

Definition at line 2319 of file cl.hpp.

    {
        Memory::operator=(rhs);
        return *this;
    }

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Defines