0025147: Visualization, TKOpenGl - support EGL as alternative to GLX
[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_DefineHandle.hxx>
20 #include <Standard_Transient.hxx>
21 #include <Handle_Standard_Transient.hxx>
22
23 //! Class to define graphich 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
34 public: //! @name context creation parameters
35
36   /**
37    * Specify that driver should not swap back/front buffers at the end of frame.
38    * Useful when OCCT Viewer is integrated into existing OpenGL rendering pipeline as part,
39    * thus swapping part is performed outside.
40    *
41    * OFF by default.
42    */
43   Standard_Boolean buffersNoSwap;
44
45   /**
46    * Request stereoscopic context (with Quad Buffer). This flag requires support in OpenGL driver.
47    *
48    * OFF by default.
49    */
50   Standard_Boolean contextStereo;
51
52   /**
53    * Request debug GL context. This flag requires support in OpenGL driver.
54    *
55    * When turned on OpenGL driver emits error and warning messages to provided callback
56    * (see OpenGl_Context - messages will be printed to standard output).
57    * Affects performance - thus should not be turned on by products in released state.
58    *
59    * OFF by default. Currently implemented only for Windows (WGL).
60    */
61   Standard_Boolean contextDebug;
62
63   /**
64    * Disable hardware acceleration.
65    *
66    * This flag overrides default behavior, when accelerated context always preferred over software ones:
67    * - on Windows will force Microsoft software implementation;
68    * - on Mac OS X, forces Apple software implementation.
69    *
70    * Software implementations are dramatically slower - should never be used.
71    *
72    * OFF by default. Currently implemented only for Windows (WGL) and Mac OS X (Cocoa).
73    */
74   Standard_Boolean contextNoAccel;
75
76 public: //! @name flags to activate verbose output
77
78   //! Print GLSL program compilation/linkage warnings, if any. OFF by default.
79   Standard_Boolean glslWarnings;
80
81 public: //! @name class methods
82
83   //! Default constructor - initialize with most optimal values.
84   Standard_EXPORT OpenGl_Caps();
85
86   //! Destructor.
87   Standard_EXPORT virtual ~OpenGl_Caps();
88
89   //! Copy maker.
90   Standard_EXPORT OpenGl_Caps& operator= (const OpenGl_Caps& theCopy);
91
92 private:
93
94   //! Not implemented
95   OpenGl_Caps (const OpenGl_Caps& );
96
97 public:
98
99   DEFINE_STANDARD_RTTI(OpenGl_Caps) // Type definition
100
101 };
102
103 DEFINE_STANDARD_HANDLE(OpenGl_Caps, Standard_Transient)
104
105 #endif // _OpenGl_Caps_H__