itkOpenCLBuffer.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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  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 __itkOpenCLBuffer_h
#define __itkOpenCLBuffer_h
 
#include "itkOpenCLMemoryObject.h"
#include "itkOpenCLEvent.h"
 
namespace itk
{
// Forward declaration
class OpenCLImage;
 
class ITKOpenCL_EXPORT OpenCLBuffer : public OpenCLMemoryObject
{
public:
 
  typedef OpenCLBuffer Self;
 
  OpenCLBuffer() {}
 
  OpenCLBuffer( OpenCLContext * context, const cl_mem id );
 
  OpenCLBuffer( const OpenCLBuffer & other );
 
  OpenCLBuffer & operator=( const OpenCLBuffer & other );
 
  bool Read( void * data, const std::size_t size, const std::size_t offset = 0 );
 
  OpenCLEvent ReadAsync( void * data, const std::size_t size,
    const OpenCLEventList & event_list = OpenCLEventList(),
    const std::size_t offset = 0 );
 
  bool Write( const void * data, const std::size_t size, const std::size_t offset = 0 );
 
  OpenCLEvent WriteAsync( const void * data, const std::size_t size,
    const OpenCLEventList & event_list = OpenCLEventList(),
    const std::size_t offset = 0 );
 
  bool ReadRect( void * data, const RectangleType & rect,
    const std::size_t bufferBytesPerLine, const std::size_t hostBytesPerLine );
 
  OpenCLEvent ReadRectAsync( void * data, const RectangleType & rect,
    const std::size_t bufferBytesPerLine, const std::size_t hostBytesPerLine,
    const OpenCLEventList & event_list = OpenCLEventList() );
 
  bool ReadRect( void * data,
    const std::size_t origin[ 3 ], const std::size_t size[ 3 ],
    const std::size_t bufferBytesPerLine, const std::size_t bufferBytesPerSlice,
    const std::size_t hostBytesPerLine, const std::size_t hostBytesPerSlice );
 
  OpenCLEvent ReadRectAsync( void * data,
    const std::size_t origin[ 3 ],  const std::size_t size[ 3 ],
    const std::size_t bufferBytesPerLine, const std::size_t bufferBytesPerSlice,
    const std::size_t hostBytesPerLine, const std::size_t hostBytesPerSlice,
    const OpenCLEventList & event_list = OpenCLEventList() );
 
  bool WriteRect( const void * data, const RectangleType & rect,
    const std::size_t bufferBytesPerLine, const std::size_t hostBytesPerLine );
 
  OpenCLEvent WriteRectAsync( const void * data, const RectangleType & rect,
    const std::size_t bufferBytesPerLine, const std::size_t hostBytesPerLine,
    const OpenCLEventList & event_list = OpenCLEventList() );
 
  bool WriteRect( const void * data,
    const std::size_t origin[ 3 ], const std::size_t size[ 3 ],
    const std::size_t bufferBytesPerLine, const std::size_t bufferBytesPerSlice,
    const std::size_t hostBytesPerLine,  const std::size_t hostBytesPerSlice );
 
  OpenCLEvent WriteRectAsync( const void * data,
    const std::size_t origin[ 3 ], const std::size_t size[ 3 ],
    const std::size_t bufferBytesPerLine, const std::size_t bufferBytesPerSlice,
    const std::size_t hostBytesPerLine, const std::size_t hostBytesPerSlice,
    const OpenCLEventList & event_list = OpenCLEventList() );
 
  bool CopyToBuffer( const OpenCLBuffer & dest, const std::size_t size,
    const std::size_t dst_offset = 0, const std::size_t offset = 0 );
 
  OpenCLEvent CopyToBufferAsync( const OpenCLBuffer & dest,
    const std::size_t size,
    const OpenCLEventList & event_list = OpenCLEventList(),
    const std::size_t dst_offset = 0,
    const std::size_t offset = 0 );
 
  bool CopyToImage( const OpenCLImage & dest,
    const OpenCLSize & origin, const OpenCLSize & region,
    const std::size_t src_offset = 0 );
 
  OpenCLEvent CopyToImageAsync( const OpenCLImage & dest,
    const OpenCLSize & origin, const OpenCLSize & region,
    const OpenCLEventList & event_list = OpenCLEventList(),
    const std::size_t src_offset = 0 );
 
  bool CopyToRect( const OpenCLBuffer & dest,
    const RectangleType & rect, const PointType & destPoint,
    const std::size_t bufferBytesPerLine, std::size_t destBytesPerLine );
 
  OpenCLEvent CopyToRectAsync( const OpenCLBuffer & dest,
    const RectangleType & rect, const PointType & destPoint,
    const std::size_t bufferBytesPerLine, const std::size_t destBytesPerLine,
    const OpenCLEventList & event_list = OpenCLEventList() );
 
  bool CopyToRect( const OpenCLBuffer & dest,
    const std::size_t origin[ 3 ], const std::size_t size[ 3 ],
    const std::size_t destOrigin[ 3 ],
    const std::size_t bufferBytesPerLine, const std::size_t bufferBytesPerSlice,
    const std::size_t destBytesPerLine, const std::size_t destBytesPerSlice );
 
  OpenCLEvent CopyToRectAsync( const OpenCLBuffer & dest,
    const std::size_t origin[ 3 ], const std::size_t size[ 3 ],
    const std::size_t destOrigin[ 3 ],
    const std::size_t bufferBytesPerLine, const std::size_t bufferBytesPerSlice,
    const std::size_t destBytesPerLine, const std::size_t destBytesPerSlice,
    const OpenCLEventList & event_list = OpenCLEventList() );
 
  void * Map( const OpenCLMemoryObject::Access access,
    const std::size_t size, const std::size_t offset = 0 );
 
  OpenCLEvent MapAsync( void ** ptr, const OpenCLMemoryObject::Access access,
    const std::size_t size, const OpenCLEventList & event_list = OpenCLEventList(),
    const std::size_t offset = 0 );
 
  void * Map( const OpenCLMemoryObject::Access access );
 
  OpenCLBuffer CreateSubBuffer
    ( const OpenCLMemoryObject::Access access,
    const std::size_t size, const std::size_t offset = 0 );
 
  OpenCLBuffer GetParentBuffer() const;
 
  std::size_t GetOffset() const;
 
};
 
} // end namespace itk
 
#endif /* __itkOpenCLBuffer_h */