src/OpenGl/OpenGl_Caps.hxx

   1 // Created on: 2013-08-25
   2 // Created by: Kirill GAVRILOV
   3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _OpenGl_Caps_H__
  17 #define _OpenGl_Caps_H__
  18
  19 #include <Standard_Type.hxx>
  20 #include <Standard_Transient.hxx>
  21 #include <OpenGl_ShaderProgramDumpLevel.hxx>
  22
  23 //! Class to define graphic driver capabilities.
  24 //! Notice that these options will be ignored if particular functionality does not provided by GL driver
  25 class OpenGl_Caps : public Standard_Transient
  26 {
  27
  28 public: //! @name flags to disable particular functionality, should be used only for testing purposes!
  29
  30   Standard_Boolean vboDisable;        //!< flag permits VBO usage, will significantly affect performance (OFF by default)
  31   Standard_Boolean pntSpritesDisable; //!< flag permits Point Sprites usage, will significantly affect performance (OFF by default)
  32   Standard_Boolean keepArrayData;     //!< Disables freeing CPU memory after building VBOs (OFF by default)
  33   Standard_Boolean ffpEnable;         //!< Enables FFP (fixed-function pipeline), do not use built-in GLSL programs (ON by default on desktop OpenGL and OFF on OpenGL ES)
  34   Standard_Boolean useSystemBuffer;   //!< Enables usage of system backbuffer for blitting (OFF by default on desktop OpenGL and ON on OpenGL ES for testing)
  35   Standard_Integer swapInterval;      //!< controls swap interval - 0 for VSync off and 1 for VSync on, 1 by default
  36
  37 public: //! @name context creation parameters
  38
  39   /**
  40    * Specify that driver should not swap back/front buffers at the end of frame.
  41    * Useful when OCCT Viewer is integrated into existing OpenGL rendering pipeline as part,
  42    * thus swapping part is performed outside.
  43    *
  44    * OFF by default.
  45    */
  46   Standard_Boolean buffersNoSwap;
  47
  48   /**
  49    * Request stereoscopic context (with Quad Buffer). This flag requires support in OpenGL driver.
  50    *
  51    * OFF by default.
  52    */
  53   Standard_Boolean contextStereo;
  54
  55   /**
  56    * Request debug GL context. This flag requires support in OpenGL driver.
  57    *
  58    * When turned on OpenGL driver emits error and warning messages to provided callback
  59    * (see OpenGl_Context - messages will be printed to standard output).
  60    * Affects performance - thus should not be turned on by products in released state.
  61    *
  62    * OFF by default. Currently implemented only for Windows (WGL).
  63    */
  64   Standard_Boolean contextDebug;
  65
  66   /**
  67    * Request debug GL context to emit messages within main thread (when contextDebug is specified!).
  68    *
  69    * Some implementations performs GL rendering within dedicated thread(s),
  70    * in this case debug messages will be pushed from unknown thread making call stack useless,
  71    * since it does not interconnected to application calls.
  72    * This option asks GL driver to switch into synchronized implementation.
  73    * Affects performance - thus should not be turned on by products in released state.
  74    *
  75    * OFF by default.
  76    */
  77   Standard_Boolean contextSyncDebug;
  78
  79   /**
  80    * Disable hardware acceleration.
  81    *
  82    * This flag overrides default behavior, when accelerated context always preferred over software ones:
  83    * - on Windows will force Microsoft software implementation;
  84    * - on Mac OS X, forces Apple software implementation.
  85    *
  86    * Software implementations are dramatically slower - should never be used.
  87    *
  88    * OFF by default. Currently implemented only for Windows (WGL) and Mac OS X (Cocoa).
  89    */
  90   Standard_Boolean contextNoAccel;
  91
  92   /**
  93    * Request backward-compatible GL context. This flag requires support in OpenGL driver.
  94    *
  95    * Backward-compatible profile includes deprecated functionality like FFP (fixed-function pipeline),
  96    * and might be useful for compatibility with application OpenGL code.
  97    *
  98    * Most drivers support all features within backward-compatibility profile,
  99    * but some limit functionality to OpenGL 2.1 (e.g. OS X) when core profile is not explicitly requested.
 100    *
 101    * Requires OpenGL 3.2+ drivers.
 102    * Has no effect on OpenGL ES 2.0+ drivers (which do not provie FFP compatibility).
 103    * Interacts with ffpEnable option, which should be disabled within core profile.
 104    *
 105    * ON by default.
 106    */
 107   Standard_Boolean contextCompatible;
 108
 109 public: //! @name flags to activate verbose output
 110
 111   //! Print GLSL program compilation/linkage warnings, if any. OFF by default.
 112   Standard_Boolean glslWarnings;
 113
 114   //! Suppress redundant messages from debug GL context. ON by default.
 115   Standard_Boolean suppressExtraMsg;
 116
 117   //! Print GLSL program source code. OFF by default.
 118   OpenGl_ShaderProgramDumpLevel glslDumpLevel;
 119
 120 public: //! @name class methods
 121
 122   //! Default constructor - initialize with most optimal values.
 123   Standard_EXPORT OpenGl_Caps();
 124
 125   //! Destructor.
 126   Standard_EXPORT virtual ~OpenGl_Caps();
 127
 128   //! Copy maker.
 129   Standard_EXPORT OpenGl_Caps& operator= (const OpenGl_Caps& theCopy);
 130
 131 private:
 132
 133   //! Not implemented
 134   OpenGl_Caps (const OpenGl_Caps& );
 135
 136 public:
 137
 138   DEFINE_STANDARD_RTTIEXT(OpenGl_Caps,Standard_Transient) // Type definition
 139
 140 };
 141
 142 DEFINE_STANDARD_HANDLE(OpenGl_Caps, Standard_Transient)
 143
 144 #endif // _OpenGl_Caps_H__