Inventor/SoPBuffer.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_PBUFFER_H_
#define _SO_PBUFFER_H_

#include <Inventor/SbBasic.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SoGLRenderToBuffer.h>
#include <Inventor/helpers/SbGlContextHelper.h>

// In order to make this interface system-independent we need a
// portable opaque type that can contain any of the system-dependent
// types used internally (eg. XID, GLXContext, HANDLE, HDC, etc).
#ifndef _SBHANDLE_
#define _SBHANDLE_ 1
typedef void *SbHandle;
#endif

class SoGLContext;
class SoGLGraphicDevice; 
class SoGLGraphicConfig;
class SoGLWindow;
class SoDEPRECATED  SoPBuffer : public SoGLRenderToBuffer {
    
 public:
  SoPBuffer();

  ~SoPBuffer();

  static SbBool isAvailable(SbGlContextHelper::Display display = NULL);

  SbBool create(SbVec2s size);

  SbBool create(SbVec2i32 size);
  SbBool makeCurrent();

  void disable();

  void shareCurrentContext();

  SbBool resize(const SbVec2s &size);

  SbBool resize(const SbVec2i32 &size);

  SbVec2s getSize() const;  

  const SbVec2i32& getSize_i32() const;


  void setPixelFormat(int format);

  int getPixelFormat();

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

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


  SbBool selectCubeMapFace(CubeMapTextureFace face);

  SoGLGraphicConfigTemplate* getGraphicConfigTemplate();
    
 
  void setGraphicConfigTemplate(SoGLGraphicConfigTemplate* gTemplate);



  
 private:

  // ----- Methods using system-dependent types -----
  // (only needed for special cases)

  virtual void setDisplayConnection(SbGlContextHelper::Display display);

  virtual void setContextForSharing(SoGLContext *context);

  SbHandle getHandle();

  SbGlContextHelper::Display getDisplay();

  SoGLContext* getContext();

  virtual SbBool isPBuffer()
  { return TRUE; }

 private:

  // register in database
  static void initClass();
  // unregister from database
  static void exitClass();

  void copyToTexture();

  // Gets the current graphic device.
  SoGLGraphicDevice* getGraphicDevice();

  // Gets the current graphic configuration.
  SoGLGraphicConfig* getGraphicConfig();
  
  virtual void setFaceTarget(int faceTarget);

  // Enables alpha channel for pbuffer
  void setAlpha( SbBool enable ) { m_needAlpha = enable; } // Disabled by default
  SbBool hasAlpha() const { return m_needAlpha; }

  virtual SbBool isUsingWglRenderToTex();
  
 private:
  SbHandle m_fbconfig;
  SbHandle m_pbuffer ;

  SbGlContextHelper::Display m_display;
  SbBool   m_displayIsInternal;

  // handles if user request to share the PBuffer with an existing context
  SoGLContext *m_shareContext;
  bool   m_shared;


  SbVec2i32  m_size_i32;
  SbVec2s    m_size;

  SoGLGraphicDevice* m_currentGraphicDevice;
  SbBool m_currentGraphicConfigIsUsed;
  SoGLGraphicConfig* m_currentGraphicConfig;
  SbBool m_currentGraphicDeviceIsUsed;
  SbBool m_renderToTexture;
  TextureFormat m_textureFormat;
  TextureTarget m_textureTarget;
  bool m_autoMipmap;

  int m_cubeMapFaceAttr;
  int m_faceTarget;

private:
  void cleanUpCreate( SoGLWindow* glWindow );

  // this is our openGL context
  SoGLContext* m_glContext;
  // Context here before we bind our context.
  // Used only with OIV_COMPAT_CONTEXT_80 > 0 where we have to manually manage contexts.
  SoGLContext* m_prevContext;

  // Needed for a PFD with alpha channel enabled (Windows only)
  SbBool m_needAlpha;

  bool m_isDisabled;

  // handle OIV_PBUFFER_DEBUG envvar
  static SbBool s_debugFlag;
  static void debugPrint(const char *format, void *p1 = NULL, void *p2 = NULL, void *p3 = NULL);

  // handle OIV_PBUFFER_ENABLE envvar
  static SbBool s_isForcedDisabled;

  // handle OIV_COMPAT_CONTEXT_80 envar
  static int s_oivCompatibilityMode;

  // handle WGL_NV_render_depth_texture extension
  bool m_WGL_NV_render_depth_texture_available;
};

#endif //_SO_PBUFFER_H_

---

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