CLImage2D.h

Go to the documentation of this file.

/********************************************************************
 **                Image Component Library (ICL)                    **
 **                                                                 **
 ** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
 **                         Neuroinformatics Group                  **
 ** Website: www.iclcv.org and                                      **
 **          http://opensource.cit-ec.de/projects/icl               **
 **                                                                 **
 ** File   : ICLUtils/src/ICLUtils/CLImage2D.h                      **
 ** Module : ICLUtils                                               **
 ** Authors: Viktor Losing                                          **
 **                                                                 **
 **                                                                 **
 ** GNU LESSER GENERAL PUBLIC LICENSE                               **
 ** This file may be used under the terms of the GNU Lesser General **
 ** Public License version 3.0 as published by the                  **
 **                                                                 **
 ** Free Software Foundation and appearing in the file LICENSE.GPL  **
 ** included in the packaging of this file.  Please review the      **
 ** following information to ensure the license requirements will   **
 ** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
 **                                                                 **
 ** The development of this software was supported by the           **
 ** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
 ** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
 ** Forschungsgemeinschaft (DFG) in the context of the German       **
 ** Excellence Initiative.                                          **
 **                                                                 **
 ********************************************************************/
#ifdef ICL_HAVE_OPENCL
#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/CLException.h>
#include <ICLUtils/Rect.h>
#include <ICLUtils/CLMemory.h>
#include <string>

#include <set>
#include <map>
#include <stdint.h>

namespace cl {
    class Image2D;
    class Context;
    class CommandQueue;
}
namespace icl {
    namespace utils {


          class ICLUtils_API CLImage2D : public CLMemory {
            struct Impl; 
            Impl *impl;

                        CLImage2D(cl::Context& context, cl::CommandQueue &cmdQueue,
                                        const string &accessMode, const size_t width, const size_t height,
                                        int depth, int num_channel, const void *src=NULL, std::map< uint32_t, std::set<uint32_t> > const
                                          &supported_formats = std::map< uint32_t, std::set<uint32_t> >()) ;

            cl::Image2D getImage2D();
                        const cl::Image2D getImage2D() const;

                public:

            friend class CLProgram;
            friend class CLKernel;
                        friend class CLDeviceContext;

                        CLImage2D();

            CLImage2D(const CLImage2D& other);

            CLImage2D& operator=(const CLImage2D& other);

            ~CLImage2D();


            void read(void *dst, const utils::Rect &region=utils::Rect::null,  bool block = true) ;


            void write(const void *src,const utils::Rect &region=utils::Rect::null,
                    bool block = true) ;

            bool isNull() const {
                return !impl;
            }

            operator bool() const {
                return impl;
            }

                        icl32s getWidth() const { return m_dimensions[0]; }
                        icl32s getHeight() const { return m_dimensions[1]; }
                        icl32s getChannelSize() const { return m_dimensions[0]*m_dimensions[1]; }
                        icl32s getNumChannels() const { return m_dimensions[2]; }

        };
    }
}
#endif