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                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#if !defined SOBUFFEROBJECT_H
#define SOBUFFEROBJECT_H

#include <Inventor/SbBase.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>

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

class SoCpuBufferObject;
class SoDeviceContext;
class SoCpuBufferObjectCache;

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

class  SoBufferObject: public SoRefCounter, public SoTypedObject
{
  SO_TYPED_CLASS_ABSTRACT_HEADER()
  // ----------------------- Public usage --------------------------------------

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( SoBufferObject* targetBufferObject, AccessMode accessMode, size_t startPosition = 0, size_t mappingSize = SO_BUFFER_SIZE_ALL ) = 0;

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

  virtual void unmap( SoBufferObject* bufferObject ) = 0;

  virtual void unmap( SoCpuBufferObject* bufferObject ) = 0;

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


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

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

  virtual SoBufferObject* createInstance() const = 0;

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

  virtual void clearInstance() = 0;

  SoDeviceContext* getContext() const;

  SoBufferObject* getMappedBufferObject();


  void setMappedBufferObject( SoBufferObject* bufferObject );

  void setMappingAccessMode( AccessMode accessMode );


  AccessMode getMappingAccessMode();

  void setMappingZoneInformation( size_t startPosition, size_t size );

  size_t getMappingStartPosition() const;

  size_t getMappingSize() 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;

  uint64_t getModificationsCounter() const;

  void incrementModificationsCounter() const;

  // ----------------------- Protected usage --------------------------------------
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();

  uint64_t getNextModificationId() const;

  // ----------------------- Protected data usage --------------------------------------

private:

  // ----------------------- Private usage --------------------------------------

private:
  size_t m_size;

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

  SoRef<SoDeviceContext> m_deviceContext;

  SbThreadSpinlock m_bufferMutex;

  SoBufferObject* m_mappedBufferObject;

  AccessMode m_mappingAccessMode;

  size_t m_mappingStartPosition;

  size_t m_mappingSize;

  mutable uint64_t m_modificationsCounter;

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

};

// ----------------------- Inline functions --------------------------------------



//------------------------------------------------------------------------------
inline SoBufferObject*
SoBufferObject::getMappedBufferObject()
{
  return m_mappedBufferObject;
}


//------------------------------------------------------------------------------
inline void
SoBufferObject::setMappingAccessMode( SoBufferObject::AccessMode accessMode )
{
  m_mappingAccessMode = accessMode;
}


//------------------------------------------------------------------------------
inline SoBufferObject::AccessMode
SoBufferObject::getMappingAccessMode()
{
  return m_mappingAccessMode;
}


//------------------------------------------------------------------------------
inline void
SoBufferObject::setMappingZoneInformation( size_t startPosition, size_t size )
{
  m_mappingStartPosition = startPosition;
  m_mappingSize = size;
}


//------------------------------------------------------------------------------
inline size_t
SoBufferObject::getMappingStartPosition() const
{
  return m_mappingStartPosition;
}


//------------------------------------------------------------------------------
inline size_t
SoBufferObject::getMappingSize() const
{
  return m_mappingSize;
}


//------------------------------------------------------------------------------
inline bool
SoBufferObject::setSize( size_t size )
{
  m_size = size;
  incrementModificationsCounter();
  return true;
}

//------------------------------------------------------------------------------
inline size_t
SoBufferObject::getSize() const
{
  return m_size;
}

//------------------------------------------------------------------------------
inline bool
SoBufferObject::checkCopyConditions( size_t sourceSize, size_t sourceOffset,
                                     size_t targetSize, size_t targetOffset, size_t copySize )
{
  if ( copySize == SO_BUFFER_SIZE_ALL )
  {
    if ( targetOffset >= getSize() )
      return false;
    else
      copySize = sourceSize - sourceOffset;
  }

  if ( sourceOffset + copySize > sourceSize )
    return false;

  if ( targetOffset + copySize > targetSize )
    return false;

  return true;
}


//------------------------------------------------------------------------------
inline SoDeviceContext*
SoBufferObject::getContext() const
{
  return m_deviceContext.ptr();
}



//------------------------------------------------------------------------------
inline void
SoBufferObject::setDeviceContext( SoDeviceContext* context )
{
  m_deviceContext = context;
}

//------------------------------------------------------------------------------
inline uint64_t
SoBufferObject::getModificationsCounter() const
{
  return m_modificationsCounter;
}

//------------------------------------------------------------------------------
inline void
SoBufferObject::incrementModificationsCounter() const
{
  m_modificationsCounter = getNextModificationId();
}

#ifdef _WIN32
#pragma warning(pop)
#endif

#endif //SOBUFFEROBJECT_H

---

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