Inventor/caches/SoVBOMgr.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      : R.ALBOU (Dec 2003)
**=======================================================================*/

#ifndef _SO_VBO_MGR_
#define _SO_VBO_MGR_

#include <Inventor/STL/vector>
#include <Inventor/threads/SbThreadLocalStorage.h>
#include <Inventor/sys/SoGLType.h>

#define SO_MAX_VBO_IN_MGR 36

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

class SoVBOContext;

/*----------------------------------------------------------------------------*/

 SoVBOMgr
{
public:
  // Possible buffer type.
  // TEX_COORDS_BUFFER+n 0<n<31 : specifies the buffer for storing 
  // texture coordinate of the nth unit.
  enum BufferType {
    VERTEX_BUFFER,
    NORMAL_BUFFER,
    COLOR_BUFFER,
    INDEX_BUFFER,
    TEX_COORDS_BUFFER
  } ;

  // Returns an instance of SoVBOMgr if the VBO extension is available,
  // NULL otherwise.
  static SoVBOMgr *createInstance() ;

  // Should be called to delete an instance
  void unref(SoState *state=NULL) ;


  // Creates, if not already created by a previous call, and loads, one of the buffer specified 
  // by bufferType, with data.
  // Returns TRUE if the loading is successful, FALSE otherwise.
  // If the buffer is locked, data are not reloaded.
  // After this call, this buffer becomes active whatever the lock status.
  // context is the OpenGL context used by this buffer.
  SbBool loadData(int context, BufferType bufferType, size_t size, void *data) ;

  // Loads sub-data of the buffer specified by bufferType with data.
  // Considers that the buffer is active (bind called).
  // If the buffer is locked nothing is done.
  // context is the OpenGL context used by this buffer.
  SbBool loadSubData(int context, BufferType bufferType, size_t offset, size_t size, void *data) ;

  //**************** Lock/Unlock a buffer ***************
  // context is the OpenGL context used by a buffer.
  // If context=-1, all buffers of bufferType will be unlocked 
  // -1 is ignored by lock().

  void lock(int context, BufferType bufferType) ;

  void unlock(BufferType bufferType, int context=-1) ;

  SbBool isLocked(int context, BufferType bufferType) ;

  // Unlock all texture buffers
  void unlockTextureBuffers(int context=-1) ;
  //*****************************************************

  // Binds one of the buffer specified by bufferType.
  // Returns the OpenGL target which could be GL_ARRAY_BUFFER or GL_ELEMENT_ARRAY_BUFFER.
  GLenum bind(int context, BufferType bufferType) ;

  // Desactivate the VBO usage.
  static void desactivate() ;

  // Indicates if VBO could be used.
  // If state is different from NULL, SoShapeHintsElement is used to
  // check if VBO should be use (cf SoShapeHints::useVBO).
  // If state is NULL, only the graphic board capabilities are checked.
  static SbBool canUseVBO(SoState *state=NULL) ;

  // Delete all vertex buffer objects which have not been deleted
  // when the destructor was called because the context associated
  // was different from the context at destruction time.
  static void deleteWaitingToBeFreed (int context) ;

  // bind and map buffer in Write mode
  void* map(int context, BufferType bufferType);

  // bind and unamp buffer
  void unmap(int context, BufferType bufferType);

private:
  static void initClass();
  static void exitClass();

  void unlockIgnoreContext(BufferType bufferType) ;

  SB_THREAD_TLS_HEADER();

private:
  // Constructor
  SoVBOMgr() ;

  // Destructor
  ~SoVBOMgr() ;

  // List of contexts containing vertex buffer objects
  typedef std::vector<SoVBOContext*> SoVBOContextsList  ;
  SoVBOContextsList m_VBOContextsList ;

  // Retreives a SoVBOContext associates to context.
  // Creates one if not found.
  SoVBOContext* getVBOContext(int context) ;

  // Per thread static storage.
  struct MTstruct
  {
    // List of all vertex buffer objects which have not been deleted
    // when the destructor was called because the context associated
    // was different from the context at destruction time.
    SoVBOContextsList* m_waitingToBeFreed ;
  };
};/*----------------------------------------------------------------------------*/

#ifdef _MSC_VER
#pragma warning( pop )
#endif

#endif // _SO_VBO_MGR_

---

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