SoGLContext.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-2025 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#if !defined SOGLCONTEXT_H
#define SOGLCONTEXT_H
 
#include <Inventor/devices/SoDeviceContext.h>
#include <Inventor/devices/SoGLFormat.h>
#include <Inventor/devices/SoGLGlew.h>
#include <Inventor/STL/vector>
#include <Inventor/STL/list>
#include <Inventor/STL/map>
#include <Inventor/helpers/SbGlContextHelper.h>
#include <Inventor/threads/SbThreadLocalStorage.h>
#include <Inventor/threads/SbThreadSpinlock.h>
#include <Inventor/errors/SoError.h>
#include <Inventor/image/SbRasterImage.h>
#include <Inventor/threads/SbThreadLocalStorage.h>
 
 
#include <Inventor/SbPList.h> // For SbStringList
#include <Inventor/STL/stack>
 
#include <Inventor/helpers/SbGPUCapabilities.h>
 
#if defined(_WIN32)
#include <windows.h>
#endif
 
 
#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)
#endif
 
class SbThreadMutex;
struct GLEWContextStruct;

class FunctionRedirector;

class  SoGLContext : public SoDeviceContext
{
public:

  enum SharedGroupPolicy
  {
    DISABLED,
    
    CONSERVATIVE,
    
   AGGRESSIVE
  };

  SoGLContext( bool shared );

  SoGLContext( SbGlContextHelper::Display dpy,
               SbGlContextHelper::VisualInfo vis,
               SbGlContextHelper::Drawable drawable,
               SbGlContextHelper::GLContext ctx );

  SoGLContext( const SoGLFormat& format, SbGlContextHelper::GLContext ctx, SbGlContextHelper::Drawable drawable = 0 );

  SoGLContext( const SoGLFormat& format, SbGlContextHelper::Drawable drawable = 0 );

  SoGLContext( SbGlContextHelper::Display dpy,
               SbGlContextHelper::VisualInfo vis,
               SbGlContextHelper::Drawable drawable,
               bool shared = true );

  SoGLContext( SoGLContext* context, bool shared );

  SoGLContext( SoGLContext* context, const SoGLFormat& format, SbGlContextHelper::Drawable drawable = 0 );
  
  virtual void bind();
 

  virtual bool tryBind();

  virtual void unbind();

  bool isSharedWith( const SoDeviceContext* context ) const;

  virtual bool isValid() const;

  void invalidate();

  int getId() const;

  virtual bool isCompatible( SoDeviceContext* context ) const;

  virtual bool isCurrent() const;

  static SoGLContext* getCurrent( bool checkGLState = false );

  const SbGlContextHelper::GLContext& getGLContext() const;

  static SoGLContext* findGLContext( SbGlContextHelper::GLContext );

#if defined(_WIN32)
  typedef int SharedGroupDescription;
#else
  typedef SbGlContextHelper::Display SharedGroupDescription;
#endif
  static SoGLContext* findSharedContext( SharedGroupDescription );

  const SbGlContextHelper::Display& getDisplay() const;

  const SbGlContextHelper::VisualInfo& getVisualInfo() const;

 
  const SoGLFormat& getFormat() const;

  static SoGLContext* getContextFromId( int id );

  static SoGLContext* getContextFromSharedId( int sharedIdGroup );

  bool isValidForCurrent() const;

  void assertContext() const;

  bool swapBuffers();

  SbStringList getSupportedExtensions();

  static SharedGroupPolicy getSharedGroupPolicy();

  void setNoGLContextDelete() { m_noOGLContextDelete = true; }

  const SbGPUCapabilities& getContextGraphicsCapabilities();

  static const SbGPUCapabilities& getGraphicsCapabilities();
 
private:
 
  SB_THREAD_TLS_HEADER();
 
  static void initClass();
  static void exitClass();

  enum GPUVendorType
  {
    GPU_TYPE_NOT_INITIALIZED = -1,
    GPU_NVIDIA = 0,
    GPU_ATI = 1,
    GPU_INTEL = 2,
    GPU_FIREPRO_MAC = 3
  };
 
  /* Returns the GPU vendor type */
  static GPUVendorType getGPUVendorType();

  static SoGLContext* getActualCurrentContext( SoGLContext* supposedContext );

  void setUserData( void* data )
  { m_userData = data; }

  void* getUserData() const
  { return m_userData; }

  bool setSharedWith( SoGLContext* sharedContext );
 
  // internally used by PBuffer to change the display.
  void forceDisplay( const SbGlContextHelper::Display& display );
 
  // Used internally in remote to update the drawable (Linux only)
  void forceDrawable( const SbGlContextHelper::Drawable& drawable );
 
  // Used internally to avoid the destruction of the context
  // in some cases, like Qt because Qt destroy the context.
  void forceContext( const SbGlContextHelper::GLContext& context )
  { m_context = context; }
 
  //Allow to change the no delete flag since the public method is one way only
  inline void forceNoGLContextDelete(bool flag) { m_noOGLContextDelete = flag; }
 
  // Used internally to get the drawable of this context
  const SbGlContextHelper::Drawable& getDrawable() const
  { return m_drawable;}
 
  virtual SbString getInfos();
 
  //Provides the name of the graphic card used by the context.
  SbString getDeviceName() const;

  void printInformation();

  static void printCurrentContextInformation();

  static void printContextsInformation();

  static void invalidateDrawable(SbGlContextHelper::Drawable drawable);

  static void invalidateDisplay(SbGlContextHelper::Display display);

  bool setVSyncEnabled(bool SO_UNUSED_PARAM(on));

  bool isVSyncEnabled();

  bool isBinded();
 
  static GLEWContextStruct* glewGetCurrentContext();
  static SoGLGlew::GlewContextNative* glewGetCurrentContextNative();
 
private:
  virtual ~SoGLContext();

  void removeSharedObjects();
 
private:

  void checkRefCount() const;
  
  virtual bool setSharedWith( SoDeviceContext* sourceCtx );

  void setSwapInterval(int interval);
 
  // Class static thread local storage
  struct MTstruct
  {
    typedef std::vector<SoGLContext*> ContextVec;
    ContextVec* m_bindedContexts;
  };
 
  bool initContext( SoGLContext* sourceContext, bool shared );
  void preInitContext();
  bool postInitContext();
 
  void checkContextParameters( const char* function );
 
  SoGLContext* findSharedContext() const;
 
  typedef std::list< SoGLContext* > SoGLContextList;

  static SoGLContextList s_contexts;

  static int s_firstAvailableId;

  static SbThreadSpinlock s_contextsMutex;

  int m_id;
 
  SbGlContextHelper::GLContext m_context;
  SbGlContextHelper::Drawable m_drawable;

  SbGlContextHelper::GLContext m_savedContextForDelete;
 
  SoGLFormat m_format;
 
  void* m_userData;
 
  static GPUVendorType m_GpuVendorType;
 
  bool m_noOGLContextDelete;
 
  bool m_drawableIsValid;
  bool m_displayIsValid;
 
  static int s_checkContext;
 
  static int s_oivCompatibilityMode;

  static SharedGroupPolicy s_sharedGroupPolicy;
 
  // True if all content of shared group is removed.
  bool m_sharedObjectsRemoved;

  bool m_displayWarning;
 
  static SoGLContext* findSoGLContext(SbGlContextHelper::GLContext ctx);
  void pushInBindedList();
  static void updateBindedList();
  static void updateBindedList(SbGlContextHelper::Display display, SbGlContextHelper::Drawable drawable, SbGlContextHelper::GLContext context);
  static SoGLContext* popBindedList();
 
  bool m_thirdPartyContext;
  bool m_isBeingDestroyed;
  SbGPUCapabilities* m_graphicCapabilities;
  static FunctionRedirector s_deleteContextRedirector;
  
  static bool callOriginalDeleteContext(SbGlContextHelper::Display display, SbGlContextHelper::GLContext context, int& returnValue);
  static int commonDeleteContextHook(SbGlContextHelper::Display dpy, SbGlContextHelper::GLContext ctx);
 
#if defined(WIN32)
  static int _stdcall deleteContextHook(SbGlContextHelper::GLContext context);
#elif defined(__APPLE__)
  static int deleteContextHook(SbGlContextHelper::GLContext context);
#else
  static int deleteContextHook(SbGlContextHelper::Display dpy, SbGlContextHelper::GLContext ctx);
#endif
    
  static MTstruct::ContextVec& getBindedContextsList();
};
 
#ifdef _MSC_VER
#pragma warning( pop )
#endif
 
 
#endif //SOGLCONTEXT_H