Inventor/devices/SoOpenCLBufferObject.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#if !defined SoOpenCLBUFFEROBJECT_H
#define SoOpenCLBUFFEROBJECT_H

#include <Inventor/devices/SoBufferObject.h>
#include <Inventor/devices/SoOpenCLContext.h>
#include <Inventor/OpenCL/SoOpenCLDefs.h>

#include <Inventor/sys/SoCL.h>

class SoCpuBufferObject;
class SoGLBufferObject;

class INVENTOROPENCL_API SoOpenCLBufferObject : public SoBufferObject
{
  SO_TYPED_CLASS_HEADER();

public:

  SoOpenCLBufferObject();

  virtual bool setSize( size_t size );

  virtual void memcpy( SoBufferObject* sourceBufferObject, size_t destOffset = 0, size_t sourceOffset = 0, size_t copySize = SO_BUFFER_SIZE_ALL );

  virtual void memcpy( SoCpuBufferObject* sourceBufferObject, size_t destOffset = 0, size_t sourceOffset = 0, size_t copySize = SO_BUFFER_SIZE_ALL );

  virtual void memcpy( SoOpenCLBufferObject* sourceBufferObject, size_t destOffset = 0, size_t sourceOffset = 0, size_t copySize = SO_BUFFER_SIZE_ALL );

  virtual void memcpy( SoGLBufferObject* sourceBufferObject, size_t destOffset = 0, size_t sourceOffset = 0, size_t copySize = SO_BUFFER_SIZE_ALL );

  virtual void memset( void* value, size_t valueSize = 1, size_t offset = 0, size_t count = SO_BUFFER_SIZE_ALL );

  virtual void map( SoBufferObject* targetBufferObject, AccessMode accessMode, size_t startPosition = 0, size_t mappingSize = SO_BUFFER_SIZE_ALL );

  virtual void map( SoOpenCLBufferObject* targetBufferObject, AccessMode accessMode, size_t startPosition = 0, size_t mappingSize = SO_BUFFER_SIZE_ALL );

  virtual void map( SoCpuBufferObject* targetBufferObject, AccessMode accessMode, size_t startPosition = 0, size_t mappingSize = SO_BUFFER_SIZE_ALL );

  virtual void map( SoGLBufferObject* targetBufferObject, AccessMode accessMode, size_t startPosition = 0, size_t mappingSize = SO_BUFFER_SIZE_ALL );

  virtual void unmap( SoBufferObject* bufferObject );

  virtual void unmap( SoOpenCLBufferObject* bufferObject );

  virtual void unmap( SoCpuBufferObject* bufferObject );

  virtual void unmap( SoGLBufferObject* bufferObject );

  virtual cl_mem getLocation();

  virtual SoBufferObject* createInstance() const;

  virtual void clearInstance();

  // ----------------------- Internal usage --------------------------------------

private:

  virtual void copyToCpuBuffer( SoCpuBufferObject* targetBufferObject, size_t destOffset = 0, size_t sourceOffset = 0, size_t copySize = SO_BUFFER_SIZE_ALL );

  void copyToGLBuffer( SoGLBufferObject* targetBufferObject, size_t destOffset = 0, size_t sourceOffset = 0, size_t copySize = SO_BUFFER_SIZE_ALL );

  // ----------------------- Protected usage --------------------------------------
private:
  virtual ~SoOpenCLBufferObject();

  // return the attached context current 
  cl_context getOpenCLContext() const
  {
    SoOpenCLContext* ctx = (SoOpenCLContext *)getContext();
    return ctx->getOpenCLContext();
  }
  // get the attached command queue
  cl_command_queue getDefaultCommandQueue() const
  {
    SoOpenCLContext* ctx = (SoOpenCLContext *)getContext();
    return ctx->getOpenCLCommandQueue();
  }

  virtual void copyHostToDevice( void* sourceBuffer, size_t sourceOffset, size_t destOffset, size_t copySize );

  virtual void copyDeviceToHost( void* targetBuffer, size_t targetOffset, size_t sourceOffset, size_t copySize );

private:

  void setBuffer( cl_mem buffer, size_t size );

  cl_mem m_buffer;

  bool m_isOwner;
};


#endif //SoOpenCLBUFFEROBJECT_H

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/