Inventor/SoFrameBufferObject.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)
**=======================================================================*/
#ifndef _SO_FRAME_BUFFER_H_
#define _SO_FRAME_BUFFER_H_

#include <Inventor/SbBasic.h>
#include <Inventor/SbLinear.h>
#include <Inventor/sys/SoGLType.h>

#include <Inventor/SoGLRenderToBuffer.h>

#include <Inventor/STL/vector>

class SoGLRenderBuffer;
class SoState;
class SoGLTexture;
class SoGLObjectCache;

#ifdef _WIN32
#pragma warning( push )
#pragma warning(disable:4251)
#endif
class SoDEPRECATED  SoFrameBufferObject : public SoGLRenderToBuffer {

public:
  enum Attachment
  {
    COLOR_ATTACHMENT0,
    COLOR_ATTACHMENT1,
    COLOR_ATTACHMENT2,
    COLOR_ATTACHMENT3,
    COLOR_ATTACHMENT4,
    COLOR_ATTACHMENT5,
    COLOR_ATTACHMENT6,
    COLOR_ATTACHMENT7,
    COLOR_ATTACHMENT8,
    COLOR_ATTACHMENT9,
    COLOR_ATTACHMENT10,
    COLOR_ATTACHMENT11,
    COLOR_ATTACHMENT12,
    COLOR_ATTACHMENT13,
    COLOR_ATTACHMENT14,
    COLOR_ATTACHMENT15,
    DEPTH_ATTACHMENT,
    STENCIL_ATTACHMENT,
    DEPTH_STENCIL_ATTACHMENT,
    LAST_ATTACHMENT
  };

  SoFrameBufferObject();

  ~SoFrameBufferObject();

  static void initClass();

  static void exitClass();

  static SbBool isAvailable( SoState* state = NULL );

  static SbBool isMultisamplingAvailable( SoState* state = NULL );

  static int getMaxSamples( SoState* state = NULL );

  void setSamplesCount(int samples);

  int getActualSamplesCount() const;

  SbBool resize(const SbVec2s &size);

  SbVec2s getSize() const;

  void setRenderToTexture(SbBool enable, TextureFormat format = TEXTURE_RGB,
                           TextureTarget target = TEXTURE_2D, SbBool autoMipmap = FALSE,
                           SbBool hasDepth = FALSE);

  GLuint getTexture() const;

  GLenum getTextureFormat() const;

  GLenum getTextureTarget() const;

  SbBool bind(SoState* state = NULL, bool bindMultisampleFBO = true);

  void unbind();

  void flush(SoState* state = NULL);

   SbBool bindToTexture(SbBool bindDepth = FALSE, GLuint texObj=-1);

  SbBool create(SbVec2s size);

  SbBool create(SbVec2i32 size);

  SbBool resize(const SbVec2i32 &size);

  const SbVec2i32& getSize_i32() const;

#if 1             SoDEPRECATED
  SbBool makeCurrent();
SoDEPRECATED
  void disable();
SoDEPRECATED
  void setGraphicConfigTemplate(SoGLGraphicConfigTemplate* gTemplate);
SoDEPRECATED
  SoGLGraphicConfigTemplate* getGraphicConfigTemplate();
SoDEPRECATED
  void setPixelFormat(int format);
SoDEPRECATED
  int getPixelFormat();
SoDEPRECATED
  SbBool releaseTexImage(SbBool bindDepth = FALSE );
SoDEPRECATED
  SbBool selectCubeMapFace(CubeMapTextureFace face);
SoDEPRECATED
  void setDisplayConnection(SbGlContextHelper::Display) { };
SoDEPRECATED
  void setContextForSharing(SoGLContext * SO_UNUSED_PARAM(context)) { };

#endif 
private:
  
  GLuint getId(SoState* state = NULL);

  GLenum getStatus() const;

  bool isValid() const;

  SoGLRenderBuffer* getDepthRenderBuffer() const
  { return m_depthRenderBuffer;}

  bool attachTexture2D(Attachment attachment, GLenum target,
                       GLuint texId, int level);
  bool attachTexture1D(Attachment attachement, GLuint texId, int level);

  bool attachTexture2D(Attachment attachement, GLuint texId, int level);

  bool attachTexture2DArray(Attachment attachement, GLuint texId, int level, int layer);

  bool attachTexture3D(Attachment attachement, GLuint texId, int level, int zoffset);

  bool attachTextureCubeMap(Attachment attachment, GLuint texId, int level,
                            CubeMapTextureFace face);

  bool attachTexture1D(SoState* state, Attachment attachement,
                       SoGLTexture* tex, int level);

  bool attachTexture2D(SoState* state, Attachment attachement, SoGLTexture* tex, int level);

  bool attachTexture2DArray(SoState* state, Attachment attachement, SoGLTexture* tex,
                       int level, int layer);

  bool attachTexture3D(SoState* state, Attachment attachement, SoGLTexture* tex,
                       int level, int zoffset);

  bool attachTexture(SoState* state, Attachment att, SoGLTexture* tex, int level = 0, int layer = 0);

  bool attachTextureCubeMap(SoState* state, Attachment attachment, SoGLTexture* tex,
                            int level, CubeMapTextureFace face);

  bool attachRenderBuffer(SoState* state, Attachment attachement, SoGLRenderBuffer* renderBuffer);

  bool attachRenderBuffer(Attachment attachement, GLuint renderBufferId);

  SoGLTexture* getTextureAttachment(Attachment attachment);

  SoGLRenderBuffer* getRenderBufferAttachment(Attachment attachment);

  SbBool checkStatus() const;

  bool isValid(SoState* state);

  static GLenum getGLAttachment(Attachment attachment);


  private:

    SbBool bindInternal(SoState* state = NULL, bool bindMultisampleFBO = true);

    bool attachRenderBuffer(Attachment attachment, GLuint renderBufferId, bool createMultisampled);

    TextureFormat graphicConfigTemplateToTextureFormat(SoGLGraphicConfigTemplate *gct);

    TextureFormat getDepth(SoGLGraphicConfigTemplate *gct);

    int getMaxPow2Bits(SbVec4i32 bits);

    bool update(SoState* state = NULL);

    void setupMSAA(SoState* state);

    void blitMSAA(SoState* state);

    void clearMSAA(SoState* state);

    // current size of the FrameBuffer
    SbVec2i32 m_size;
    bool m_needResize;

    SbBool m_renderToTexture;
    SbBool m_autoMipmap;
    SbBool m_hasDepth;
    GLenum m_textureFormat;
    TextureFormat m_textureFormatIV;
    GLenum m_textureTarget;

    // OpenGL related variables
    GLuint m_internalTexID;
    SoGLRenderBuffer* m_depthRenderBuffer;

    SoGLObjectCache* m_fboCache;

    //New FBO
    bool m_needUpdate;

    //Id of previously binded fbos
    std::vector<GLint> m_previousFboIds;

    //Textures and rb currently attached to the fbo. m_attachedTextures[attachment] is texture currently 
    // attached to attachment.
    std::vector<SoGLTexture*> m_attachedTextures;
    std::vector<SoGLRenderBuffer*> m_attachedRenderBuffers;

    // Multisample FBO
    int m_numSamples;
    SoGLObjectCache* m_fboMSAACache;
    std::vector<SoGLRenderBuffer*> m_attachedMSAARenderBuffers;

    SoGLRenderBuffer* m_depthRenderBufferMSAA;
    SoGLRenderBuffer* m_internalTexMSAA;

    // - Indicates if the FBO need to be blited.
    bool m_fboBlited;

    static int s_framebuffer_extensionID;
    static int s_framebuffer_blit_extensionID;
    static int s_framebuffer_multisample_extensionID;
    static int s_ogl12_extensionID;
};
/*****************************************************************************/


#ifdef _WIN32
#pragma warning( pop )
#endif

#endif // _SO_FRAME_BUFFER_H_

---

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