SoGLFormat.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-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#if !defined( SO_GLFORMAT_H )
#define SO_GLFORMAT_H
 
 
#include <Inventor/sys/port.h>
#include <Inventor/SbBase.h>
#include <Inventor/helpers/SbGlContextHelper.h>
 
namespace renderengine
{
  namespace utils
  {
    namespace GL
    {
      class Format;
    }
  }
}
class  SoGLFormat
{
public:
 
  SoGLFormat();
 
  SoGLFormat( const SbGlContextHelper::Display& display );
 
  SoGLFormat( const SoGLFormat& refFormat );
 
  virtual ~SoGLFormat();
 
  void setDoubleBuffersEnabled( const bool enabled );
 
  bool hasDoubleBuffers() const;
 
  bool hasDepth() const;
 
  void setDepthEnabled( const bool enable );
 
  void setDepthBits( const int bits );
 
  int getDepthBits() const;
 
  bool hasAlpha() const;
 
  void setAlphaEnabled( const bool enable );
 
  void setSampleBuffersEnabled( const bool enable );
 
  bool hasSampleBuffers() const;
 
  void setSamplesCount( const int countSamples );
 
  int getSamplesCount() const;
 
  void setStereoEnabled( const bool enable );
 
  bool hasStereo() const;
 
  void setRgbEnabled( const bool enabled );
 
  bool hasRgb() const;
 
  void setRedBits(int bits);
 
  int getRedBits() const;
 
  void setGreenBits(int bits);
 
  int getGreenBits() const;
 
  void setBlueBits(int bits);
 
  int getBlueBits() const;
 
  void setAlphaBits(int bits);
 
  int getAlphaBits() const;
 
  void setFloatColorBufferEnabled( const bool enable );
 
  bool hasFloatColorBuffer() const;
 
  void setStencilBufferEnabled( const bool enabled );
 
  bool hasStencilBuffer() const;
 
  void setStencilBufferBits( const int size );
 
  int getStencilBufferBits() const;
 
  void setAccumBufferEnabled( const bool enabled );
 
  bool hasAccumBuffer() const;
 
  void setAccumBufferBits( const int size );
 
  int getAccumBufferBits() const;
 
  bool isAvailable() const;
 
  SoGLFormat getNearest() const;
 
  bool activate();
 
  const SbGlContextHelper::Display& getDisplay() const;
 
  const SbGlContextHelper::VisualInfo& getVisualInfo() const;
 
  void setCompositionRequired( const bool required );
 
  bool isCompositionRequired() const;
 
  void setGDISupportRequired( const bool required );
 
  bool isGDISupportRequired() const;
 
  void setAccelerationRequired(const bool enable);
 
  bool isAccelerationRequired() const;
 
  static SoGLFormat getDefaultFormat();
 
  void setDisplay( const SbGlContextHelper::Display& display );
 
  void setVisualInfo( const SbGlContextHelper::VisualInfo& visualInfo );
 
  void setVisualInfoId( const int viId );
 
  int getVisualInfoId() const;
 
  void setOpenglAttributes( const SbGlContextHelper::Display& display, int pfd, int* attributes, 
                           int* results );
 
  SoGLFormat& operator=( const SoGLFormat& ref );
 
  void setSoftwareRendererRequired(const bool enable);
 
  bool isSoftwareRendererRequired() const;
 
private:
 
  bool isGDIAvailable() const;
 
  bool isRDPMode() const;
 
#if defined(_WIN32)
  SoGLFormat( const SbGlContextHelper::Display& display, bool copyDC);
 
  void setDisplay( const SbGlContextHelper::Display& display, bool copyDC);
#endif //_WIN32
 
private:
 
  void init();
 
  void resetDetectedData();
 
private:
  renderengine::utils::GL::Format* m_format;
};
 
#endif // SO_GLFORMAT_H