itkOpenCLVectorBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkOpenCLVectorBase_h
#define itkOpenCLVectorBase_h
 
#include "itkOpenCLMemoryObject.h"
 
namespace itk
{
// Forward declaration
class OpenCLContext;
class OpenCLKernel;
class OpenCLVectorBasePimpl;
 
class ITKOpenCL_EXPORT OpenCLVectorBase
{
protected:
  OpenCLVectorBase(const std::size_t elemSize);
 
  OpenCLVectorBase(const std::size_t elemSize, const OpenCLVectorBase & other);
 
  ~OpenCLVectorBase();
 
  void
  Assign(const OpenCLVectorBase & other);
 
  void
  Create(OpenCLContext * context, const OpenCLMemoryObject::Access access, const std::size_t size);
 
  void
  Release();
 
  void
  Map();
 
  void
  Unmap() const;
 
  void
  Read(void * data, const std::size_t size, const std::size_t offset = 0);
 
  void
  Write(const void * data, const std::size_t size, const std::size_t offset = 0);
 
  cl_mem
  GetMemoryId() const;
 
  OpenCLContext *
  GetContext() const;
 
  cl_mem
  GetKernelArgument() const;
 
protected:
  OpenCLVectorBasePimpl * d_ptr;
  std::size_t             m_ElementSize;
  std::size_t             m_Size;
  mutable void *          m_Mapped;
 
  friend class OpenCLKernel;
};
 
} // end namespace itk
 
#endif /* itkOpenCLVectorBase_h */