Inventor/devices/SoBufferObject.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                                       ***
**=======================================================================*/

#pragma once

#include <Inventor/SbBase.h>
#include <Inventor/SbPImpl.h>
#include <Inventor/misc/SoRefCounter.h>
#include <Inventor/SoTypedObject.h>
#include <Inventor/SoSubTypedClass.h>
#include <Inventor/devices/SoDeviceContext.h>
#include <Inventor/threads/SbThreadSpinlock.h>
#include <Inventor/STL/limits>
#include <Inventor/renderer/RendererResourceMacro.h>

#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable:4251)
#endif

class SoDeviceContext;
class SoCpuBufferObject;
class SoCpuBufferObjectCache;

SO_PIMPL_BASE_PUBLIC_DECLARATION(SoBufferObject)


#define SO_BUFFER_SIZE_ALL  ((std::numeric_limits<size_t>::max)())

class  SoBufferObject: public SoRefCounter, public SoTypedObject
{
  SO_TYPED_CLASS_ABSTRACT_HEADER()
  SO_PIMPL_BASE_PUBLIC_HEADER(SoBufferObject)
  RENDERER_RESOURCE(SoBufferObject);

public:

  enum AccessMode
  {
    READ_ONLY,

    SET,

    READ_WRITE
  };

  void lockBuffer();

  void unlockBuffer();

  virtual bool setSize( size_t size );

  virtual size_t getSize() const;

  virtual void* map(AccessMode accessMode, size_t offset = 0, size_t count = SO_BUFFER_SIZE_ALL);

  virtual void unmap();

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

  virtual void unmap( SoBufferObject* bufferObject );

  virtual void memcpy( SoBufferObject* 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 SoBufferObject* createInstance() const = 0;

  virtual void clearInstance() = 0;

  SoDeviceContext* getContext() const;

  SoBufferObject* getMappedBufferObject();

  AccessMode getMappedBufferObjectAccessMode();

  size_t getMappedBufferObjectPosition() const;

  size_t getMappedBufferObjectSize() const;

  static SoCpuBufferObjectCache* getBufferObjectCache();

private:

  // should not be used elsewhere than in SoMemoryObject for compatibility purpose
  void forceSize(size_t size);

  // This function does a copy of the buffer to a CPU buffer object
  virtual void copyToCpuBuffer( SoCpuBufferObject* targetBufferObject, size_t destOffset = 0, size_t sourceOffset = 0, size_t copySize = SO_BUFFER_SIZE_ALL );

  virtual SoBufferObject* clone() const;

  // Set mapped buffer object info
  void setMappedBufferObject(SoBufferObject* bufferObject, SoBufferObject::AccessMode accessMode,
                             size_t startPosition, size_t size);

  // Clear mapped buffer object info
  void clearMappedBufferObject();

  uint64_t getModificationsCounter() const;

  void incrementModificationsCounter() const;

private:

  SoBufferObject();

  virtual ~SoBufferObject();

  void setDeviceContext(SoDeviceContext* context);

  bool checkCopyConditions(size_t sourceSize, size_t sourceOffset,
                           size_t targetSize, size_t targetOffset, size_t copySize);

  void touch();

private:

  SoBufferObject(const SoBufferObject&)
  : SoRefCounter(), SoTypedObject() {}

  // Instance of the class responsible for the cache of BufferObject.
  static SoCpuBufferObjectCache* s_bufferObjectCache;

  friend class SoCpuBufferObject;
};


#ifdef _WIN32
#pragma warning(pop)
#endif

---

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/