CLBuffer.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/CLBuffer.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 <string>

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

    class ICLUtils_API CLBuffer{
      struct Impl; 
      Impl *impl;  
      
      CLBuffer(cl::Context& context, cl::CommandQueue &cmdQueue, 
               const string &accessMode, size_t size, const void *src=NULL) throw (CLBufferException);
      
      cl::Buffer &getBuffer();
      const cl::Buffer &getBuffer() const;

    public:
      friend class CLProgram; 
      friend class CLKernel;  

      CLBuffer();
      
      CLBuffer(const CLBuffer& other);

      CLBuffer& operator=(const CLBuffer& other);

      ~CLBuffer();
      
      void copy(CLBuffer &dst, int len, int src_offset = 0, int dst_offset = 0) throw (CLBufferException);
      
      void read(void *dst, int len, int offset = 0, bool block = true) throw (CLBufferException);
      
      void write(const void *src, int len, int offset = 0, bool block = true) throw (CLBufferException);
      
      bool isNull() const {
        return !impl;
      }
      
      operator bool() const {
        return impl;
      }
      
    };
  }
}
#endif