6657515cf9037e73be1657c2c6b36197ec38a069
[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 compressedTexturesDisable; //!< Disables uploading of compressed texture formats native to GPU (OFF by default)
32   Standard_Boolean vboDisable;        //!< disallow VBO usage for debugging purposes (OFF by default)
33   Standard_Boolean pntSpritesDisable; //!< flag permits Point Sprites usage, will significantly affect performance (OFF by default)
34   Standard_Boolean keepArrayData;     //!< Disables freeing CPU memory after building VBOs (OFF by default)
35   Standard_Boolean ffpEnable;         //!< Enables FFP (fixed-function pipeline), do not use built-in GLSL programs (OFF by default)
36   Standard_Boolean usePolygonMode;    //!< Enables Polygon Mode instead of built-in GLSL programs (OFF by default; unsupported on OpenGL ES)
37   Standard_Boolean useSystemBuffer;   //!< Enables usage of system backbuffer for blitting (OFF by default on desktop OpenGL and ON on OpenGL ES for testing)
38   Standard_Integer swapInterval;      //!< controls swap interval - 0 for VSync off and 1 for VSync on, 1 by default
39
40 public: //! @name context creation parameters
41
42   /**
43    * Specify that driver should not swap back/front buffers at the end of frame.
44    * Useful when OCCT Viewer is integrated into existing OpenGL rendering pipeline as part,
45    * thus swapping part is performed outside.
46    *
47    * OFF by default.
48    */
49   Standard_Boolean buffersNoSwap;
50
51   /**
52    * Specify whether alpha component within color buffer should be written or not.
53    * With alpha write enabled, background is considered transparent by default
54    * and overridden by alpha value of last drawn object
55    * (e.g. it could be opaque or not in case of transparent material).
56    * With alpha writes disabled, color buffer will be kept opaque.
57    *
58    * OFF by default.
59    */
60   Standard_Boolean buffersOpaqueAlpha;
61
62   /**
63    * Request stereoscopic context (with Quad Buffer). This flag requires support in OpenGL driver.
64    *
65    * OFF by default.
66    */
67   Standard_Boolean contextStereo;
68
69   /**
70    * Request debug GL context. This flag requires support in OpenGL driver.
71    *
72    * When turned on OpenGL driver emits error and warning messages to provided callback
73    * (see OpenGl_Context - messages will be printed to standard output).
74    * Affects performance - thus should not be turned on by products in released state.
75    *
76    * OFF by default.
77    */
78   Standard_Boolean contextDebug;
79
80   /**
81    * Request debug GL context to emit messages within main thread (when contextDebug is specified!).
82    *
83    * Some implementations performs GL rendering within dedicated thread(s),
84    * in this case debug messages will be pushed from unknown thread making call stack useless,
85    * since it does not interconnected to application calls.
86    * This option asks GL driver to switch into synchronized implementation.
87    * Affects performance - thus should not be turned on by products in released state.
88    *
89    * OFF by default.
90    */
91   Standard_Boolean contextSyncDebug;
92
93   /**
94    * Disable hardware acceleration.
95    *
96    * This flag overrides default behavior, when accelerated context always preferred over software ones:
97    * - on Windows will force Microsoft software implementation;
98    * - on Mac OS X, forces Apple software implementation.
99    *
100    * Software implementations are dramatically slower - should never be used.
101    *
102    * OFF by default. Currently implemented only for Windows (WGL) and Mac OS X (Cocoa).
103    */
104   Standard_Boolean contextNoAccel;
105
106   /**
107    * Request backward-compatible GL context. This flag requires support in OpenGL driver.
108    *
109    * Backward-compatible profile includes deprecated functionality like FFP (fixed-function pipeline),
110    * and might be useful for compatibility with application OpenGL code.
111    *
112    * Most drivers support all features within backward-compatibility profile,
113    * but some limit functionality to OpenGL 2.1 (e.g. OS X) when core profile is not explicitly requested.
114    *
115    * Requires OpenGL 3.2+ drivers.
116    * Has no effect on OpenGL ES 2.0+ drivers (which do not provie FFP compatibility).
117    * Interacts with ffpEnable option, which should be disabled within core profile.
118    *
119    * ON by default.
120    */
121   Standard_Boolean contextCompatible;
122
123   /**
124    * Disallow using OpenGL extensions.
125    * Should be used for debugging purposes only!
126    *
127    * OFF by default.
128    */
129   Standard_Boolean contextNoExtensions;
130
131   /**
132    * Synthetically restrict upper version of OpenGL functionality to be used.
133    * Should be used for debugging purposes only!
134    *
135    * (-1, -1) by default, which means no restriction.
136    */
137   Standard_Integer contextMajorVersionUpper;
138   Standard_Integer contextMinorVersionUpper;
139
140   /**
141    * Define if 2D texture UV coordinates are defined top-down or bottom-up. FALSE by default.
142    *
143    * Proper rendering requires image texture uploading and UV texture coordinates being consistent,
144    * otherwise texture mapping might appear vertically flipped.
145    * Historically, OCCT used image library loading images bottom-up,
146    * so that applications have to generate UV accordingly (flip V when necessary, V' = 1.0 - V).
147    *
148    * Graphic driver now compares this flag with image layout reported by Image_PixMap::IsTopDown(),
149    * and in case of mismatch applies implicit texture coordinates conversion in GLSL program.
150    */
151   Standard_Boolean isTopDownTextureUV;
152
153 public: //! @name flags to activate verbose output
154
155   //! Print GLSL program compilation/linkage warnings, if any. OFF by default.
156   Standard_Boolean glslWarnings;
157
158   //! Suppress redundant messages from debug GL context. ON by default.
159   Standard_Boolean suppressExtraMsg;
160
161   //! Print GLSL program source code. OFF by default.
162   OpenGl_ShaderProgramDumpLevel glslDumpLevel;
163
164 public: //! @name class methods
165
166   //! Default constructor - initialize with most optimal values.
167   Standard_EXPORT OpenGl_Caps();
168
169   //! Destructor.
170   Standard_EXPORT virtual ~OpenGl_Caps();
171
172   //! Copy maker.
173   Standard_EXPORT OpenGl_Caps& operator= (const OpenGl_Caps& theCopy);
174
175 private:
176
177   //! Not implemented
178   OpenGl_Caps (const OpenGl_Caps& );
179
180 public:
181
182   DEFINE_STANDARD_RTTIEXT(OpenGl_Caps,Standard_Transient) // Type definition
183
184 };
185
186 DEFINE_STANDARD_HANDLE(OpenGl_Caps, Standard_Transient)
187
188 #endif // _OpenGl_Caps_H__