SoGLBufferObject.h

/*=======================================================================
 *** 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 SOGLBUFFEROBJECT_H
#define SOGLBUFFEROBJECT_H
 
#include <Inventor/devices/SoInteropBufferObject.h>
#include <Inventor/sys/SoGLType.h>
 
SO_PIMPL_PUBLIC_DECLARATION(SoGLBufferObject)
class SbVec2i32;
 
class  SoGLBufferObject : public SoInteropBufferObject
{
  SO_TYPED_CLASS_HEADER();
  SO_PIMPL_PUBLIC_HEADER(SoGLBufferObject)
 
public:
 
  enum BufferObjectTarget
  {
    PIXEL_PACK_BUFFER,
 
    PIXEL_UNPACK_BUFFER,
 
    ARRAY_BUFFER,
 
    ELEMENT_ARRAY_BUFFER,
 
    SHADER_STORAGE_BUFFER
  };
 
  enum Usage
  {
    STREAM_DRAW,
 
    STREAM_READ,
 
    STREAM_COPY,
 
    STATIC_DRAW,
 
    STATIC_READ,
 
    STATIC_COPY,
 
    DYNAMIC_DRAW,
 
    DYNAMIC_READ,
 
    DYNAMIC_COPY
  };
 
  SoGLBufferObject( Usage usage );
 
  static bool isAvailable();
 
  void setTarget( BufferObjectTarget target );
 
  BufferObjectTarget getTarget() const;
 
  virtual bool setSize( size_t size );
 
  virtual void map( SoBufferObject* targetBufferObject, AccessMode accessMode, size_t startPosition = 0, size_t mappingSize = SO_BUFFER_SIZE_ALL );
 
  virtual void unmap( SoBufferObject* bufferObject );
 
  void bind();
 
  void unbind();
 
  virtual void* map( AccessMode accessMode, size_t offset = 0, size_t count = SO_BUFFER_SIZE_ALL );
 
  virtual void unmap();
 
  bool isValid();
 
  GLuint getId() const;
 
  virtual SoBufferObject* createInstance() const;
 
  virtual void clearInstance();
 
  void memcpy(SoBufferObject* source, size_t destOffset = 0, size_t sourceOffset = 0, size_t copySize = SO_BUFFER_SIZE_ALL);
 
private:
 
  void copyToCpuBuffer( SoCpuBufferObject* targetBufferObject, size_t destOffset = 0, size_t sourceOffset = 0, size_t copySize = SO_BUFFER_SIZE_ALL );
 
  bool isBindable();
 
  void copyFromGLTexture(GLuint tex, const SbVec2i32& size, bool alpha);
 
  struct Configuration
  {
    size_t size;
    BufferObjectTarget target;
    Usage usage;
  };
  
private:
  virtual ~SoGLBufferObject();
 
  SoGLBufferObject();
 
  bool checkContext();
 
};
 
#endif // SOGLBUFFEROBJECT_H