0029528: Visualization, TKOpenGl - allow defining sRGB textures
[occt.git] / 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 sRGBDisable;       //!< Disables sRGB rendering (OFF by default)
31   Standard_Boolean vboDisable;        //!< disallow VBO usage for debugging purposes (OFF by default)
32   Standard_Boolean pntSpritesDisable; //!< flag permits Point Sprites usage, will significantly affect performance (OFF by default)
33   Standard_Boolean keepArrayData;     //!< Disables freeing CPU memory after building VBOs (OFF by default)
34   Standard_Boolean ffpEnable;         //!< Enables FFP (fixed-function pipeline), do not use built-in GLSL programs (OFF by default)
35   Standard_Boolean usePolygonMode;    //!< Enables Polygon Mode instead of built-in GLSL programs (OFF by default; unsupported on OpenGL ES)
36   Standard_Boolean useSystemBuffer;   //!< Enables usage of system backbuffer for blitting (OFF by default on desktop OpenGL and ON on OpenGL ES for testing)
37   Standard_Integer swapInterval;      //!< controls swap interval - 0 for VSync off and 1 for VSync on, 1 by default
38
39 public: //! @name context creation parameters
40
41   /**
42    * Specify that driver should not swap back/front buffers at the end of frame.
43    * Useful when OCCT Viewer is integrated into existing OpenGL rendering pipeline as part,
44    * thus swapping part is performed outside.
45    *
46    * OFF by default.
47    */
48   Standard_Boolean buffersNoSwap;
49
50   /**
51    * Request stereoscopic context (with Quad Buffer). This flag requires support in OpenGL driver.
52    *
53    * OFF by default.
54    */
55   Standard_Boolean contextStereo;
56
57   /**
58    * Request debug GL context. This flag requires support in OpenGL driver.
59    *
60    * When turned on OpenGL driver emits error and warning messages to provided callback
61    * (see OpenGl_Context - messages will be printed to standard output).
62    * Affects performance - thus should not be turned on by products in released state.
63    *
64    * OFF by default.
65    */
66   Standard_Boolean contextDebug;
67
68   /**
69    * Request debug GL context to emit messages within main thread (when contextDebug is specified!).
70    *
71    * Some implementations performs GL rendering within dedicated thread(s),
72    * in this case debug messages will be pushed from unknown thread making call stack useless,
73    * since it does not interconnected to application calls.
74    * This option asks GL driver to switch into synchronized implementation.
75    * Affects performance - thus should not be turned on by products in released state.
76    *
77    * OFF by default.
78    */
79   Standard_Boolean contextSyncDebug;
80
81   /**
82    * Disable hardware acceleration.
83    *
84    * This flag overrides default behavior, when accelerated context always preferred over software ones:
85    * - on Windows will force Microsoft software implementation;
86    * - on Mac OS X, forces Apple software implementation.
87    *
88    * Software implementations are dramatically slower - should never be used.
89    *
90    * OFF by default. Currently implemented only for Windows (WGL) and Mac OS X (Cocoa).
91    */
92   Standard_Boolean contextNoAccel;
93
94   /**
95    * Request backward-compatible GL context. This flag requires support in OpenGL driver.
96    *
97    * Backward-compatible profile includes deprecated functionality like FFP (fixed-function pipeline),
98    * and might be useful for compatibility with application OpenGL code.
99    *
100    * Most drivers support all features within backward-compatibility profile,
101    * but some limit functionality to OpenGL 2.1 (e.g. OS X) when core profile is not explicitly requested.
102    *
103    * Requires OpenGL 3.2+ drivers.
104    * Has no effect on OpenGL ES 2.0+ drivers (which do not provie FFP compatibility).
105    * Interacts with ffpEnable option, which should be disabled within core profile.
106    *
107    * ON by default.
108    */
109   Standard_Boolean contextCompatible;
110
111   /**
112    * Disallow using OpenGL extensions.
113    * Should be used for debugging purposes only!
114    *
115    * OFF by default.
116    */
117   Standard_Boolean contextNoExtensions;
118
119   /**
120    * Synthetically restrict upper version of OpenGL functionality to be used.
121    * Should be used for debugging purposes only!
122    *
123    * (-1, -1) by default, which means no restriction.
124    */
125   Standard_Integer contextMajorVersionUpper;
126   Standard_Integer contextMinorVersionUpper;
127
128 public: //! @name flags to activate verbose output
129
130   //! Print GLSL program compilation/linkage warnings, if any. OFF by default.
131   Standard_Boolean glslWarnings;
132
133   //! Suppress redundant messages from debug GL context. ON by default.
134   Standard_Boolean suppressExtraMsg;
135
136   //! Print GLSL program source code. OFF by default.
137   OpenGl_ShaderProgramDumpLevel glslDumpLevel;
138
139 public: //! @name class methods
140
141   //! Default constructor - initialize with most optimal values.
142   Standard_EXPORT OpenGl_Caps();
143
144   //! Destructor.
145   Standard_EXPORT virtual ~OpenGl_Caps();
146
147   //! Copy maker.
148   Standard_EXPORT OpenGl_Caps& operator= (const OpenGl_Caps& theCopy);
149
150 private:
151
152   //! Not implemented
153   OpenGl_Caps (const OpenGl_Caps& );
154
155 public:
156
157   DEFINE_STANDARD_RTTIEXT(OpenGl_Caps,Standard_Transient) // Type definition
158
159 };
160
161 DEFINE_STANDARD_HANDLE(OpenGl_Caps, Standard_Transient)
162
163 #endif // _OpenGl_Caps_H__