0031478: Visualization, TKOpenGl - allow uploading Cubemap in compressed DDS format...
[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    * Request stereoscopic context (with Quad Buffer). This flag requires support in OpenGL driver.
53    *
54    * OFF by default.
55    */
56   Standard_Boolean contextStereo;
57
58   /**
59    * Request debug GL context. This flag requires support in OpenGL driver.
60    *
61    * When turned on OpenGL driver emits error and warning messages to provided callback
62    * (see OpenGl_Context - messages will be printed to standard output).
63    * Affects performance - thus should not be turned on by products in released state.
64    *
65    * OFF by default.
66    */
67   Standard_Boolean contextDebug;
68
69   /**
70    * Request debug GL context to emit messages within main thread (when contextDebug is specified!).
71    *
72    * Some implementations performs GL rendering within dedicated thread(s),
73    * in this case debug messages will be pushed from unknown thread making call stack useless,
74    * since it does not interconnected to application calls.
75    * This option asks GL driver to switch into synchronized implementation.
76    * Affects performance - thus should not be turned on by products in released state.
77    *
78    * OFF by default.
79    */
80   Standard_Boolean contextSyncDebug;
81
82   /**
83    * Disable hardware acceleration.
84    *
85    * This flag overrides default behavior, when accelerated context always preferred over software ones:
86    * - on Windows will force Microsoft software implementation;
87    * - on Mac OS X, forces Apple software implementation.
88    *
89    * Software implementations are dramatically slower - should never be used.
90    *
91    * OFF by default. Currently implemented only for Windows (WGL) and Mac OS X (Cocoa).
92    */
93   Standard_Boolean contextNoAccel;
94
95   /**
96    * Request backward-compatible GL context. This flag requires support in OpenGL driver.
97    *
98    * Backward-compatible profile includes deprecated functionality like FFP (fixed-function pipeline),
99    * and might be useful for compatibility with application OpenGL code.
100    *
101    * Most drivers support all features within backward-compatibility profile,
102    * but some limit functionality to OpenGL 2.1 (e.g. OS X) when core profile is not explicitly requested.
103    *
104    * Requires OpenGL 3.2+ drivers.
105    * Has no effect on OpenGL ES 2.0+ drivers (which do not provie FFP compatibility).
106    * Interacts with ffpEnable option, which should be disabled within core profile.
107    *
108    * ON by default.
109    */
110   Standard_Boolean contextCompatible;
111
112   /**
113    * Disallow using OpenGL extensions.
114    * Should be used for debugging purposes only!
115    *
116    * OFF by default.
117    */
118   Standard_Boolean contextNoExtensions;
119
120   /**
121    * Synthetically restrict upper version of OpenGL functionality to be used.
122    * Should be used for debugging purposes only!
123    *
124    * (-1, -1) by default, which means no restriction.
125    */
126   Standard_Integer contextMajorVersionUpper;
127   Standard_Integer contextMinorVersionUpper;
128
129   /**
130    * Define if 2D texture UV coordinates are defined top-down or bottom-up. FALSE by default.
131    *
132    * Proper rendering requires image texture uploading and UV texture coordinates being consistent,
133    * otherwise texture mapping might appear vertically flipped.
134    * Historically, OCCT used image library loading images bottom-up,
135    * so that applications have to generate UV accordingly (flip V when necessary, V' = 1.0 - V).
136    *
137    * Graphic driver now compares this flag with image layout reported by Image_PixMap::IsTopDown(),
138    * and in case of mismatch applies implicit texture coordinates conversion in GLSL program.
139    */
140   Standard_Boolean isTopDownTextureUV;
141
142 public: //! @name flags to activate verbose output
143
144   //! Print GLSL program compilation/linkage warnings, if any. OFF by default.
145   Standard_Boolean glslWarnings;
146
147   //! Suppress redundant messages from debug GL context. ON by default.
148   Standard_Boolean suppressExtraMsg;
149
150   //! Print GLSL program source code. OFF by default.
151   OpenGl_ShaderProgramDumpLevel glslDumpLevel;
152
153 public: //! @name class methods
154
155   //! Default constructor - initialize with most optimal values.
156   Standard_EXPORT OpenGl_Caps();
157
158   //! Destructor.
159   Standard_EXPORT virtual ~OpenGl_Caps();
160
161   //! Copy maker.
162   Standard_EXPORT OpenGl_Caps& operator= (const OpenGl_Caps& theCopy);
163
164 private:
165
166   //! Not implemented
167   OpenGl_Caps (const OpenGl_Caps& );
168
169 public:
170
171   DEFINE_STANDARD_RTTIEXT(OpenGl_Caps,Standard_Transient) // Type definition
172
173 };
174
175 DEFINE_STANDARD_HANDLE(OpenGl_Caps, Standard_Transient)
176
177 #endif // _OpenGl_Caps_H__