0030748: Visualization - Marker displayed in immediate layer ruins QT Quick view...
[occt.git] / src / OpenGl / OpenGl_GraphicDriver.hxx
1 // Created on: 2011-10-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-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_GraphicDriver_HeaderFile
17 #define _OpenGl_GraphicDriver_HeaderFile
18
19 #include <Graphic3d_GraphicDriver.hxx>
20
21 #include <Aspect_Display.hxx>
22 #include <Aspect_DisplayConnection.hxx>
23 #include <Aspect_RenderingContext.hxx>
24 #include <Graphic3d_CView.hxx>
25 #include <Graphic3d_CStructure.hxx>
26 #include <NCollection_DataMap.hxx>
27 #include <OpenGl_Context.hxx>
28
29 class Aspect_Window;
30 class Quantity_Color;
31 class OpenGl_Structure;
32 class OpenGl_View;
33 class OpenGl_Window;
34
35 //! Tool class to implement consistent state counter
36 //! for objects inside the same driver instance.
37 class OpenGl_StateCounter
38 {
39 public:
40
41   OpenGl_StateCounter() : myCounter (0) { }
42
43   Standard_Size Increment() { return ++myCounter; }
44
45 private:
46
47   Standard_Size myCounter;
48 };
49
50 //! This class defines an OpenGl graphic driver
51 class OpenGl_GraphicDriver : public Graphic3d_GraphicDriver
52 {
53   DEFINE_STANDARD_RTTIEXT(OpenGl_GraphicDriver, Graphic3d_GraphicDriver)
54 public:
55
56   //! Constructor.
57   //! @param theDisp connection to display, required on Linux but optional on other systems
58   //! @param theToInitialize perform initialization of default OpenGL context on construction
59   Standard_EXPORT OpenGl_GraphicDriver (const Handle(Aspect_DisplayConnection)& theDisp,
60                                         const Standard_Boolean                  theToInitialize = Standard_True);
61
62   //! Destructor.
63   Standard_EXPORT virtual ~OpenGl_GraphicDriver();
64
65   //! Release default context.
66   Standard_EXPORT void ReleaseContext();
67
68   //! Perform initialization of default OpenGL context.
69   Standard_EXPORT Standard_Boolean InitContext();
70
71 #if defined(HAVE_EGL) || defined(HAVE_GLES2) || defined(OCCT_UWP) || defined(__ANDROID__) || defined(__QNX__)
72   //! Initialize default OpenGL context using existing one.
73   //! @param theEglDisplay EGL connection to the Display
74   //! @param theEglContext EGL rendering context
75   //! @param theEglConfig  EGL configuration
76   Standard_EXPORT Standard_Boolean InitEglContext (Aspect_Display          theEglDisplay,
77                                                    Aspect_RenderingContext theEglContext,
78                                                    void*                   theEglConfig);
79 #endif
80
81   //! Request limit of graphic resource of specific type.
82   Standard_EXPORT virtual Standard_Integer InquireLimit (const Graphic3d_TypeOfLimit theType) const Standard_OVERRIDE;
83
84 public:
85
86   Standard_EXPORT virtual Handle(Graphic3d_CStructure) CreateStructure (const Handle(Graphic3d_StructureManager)& theManager) Standard_OVERRIDE;
87
88   Standard_EXPORT virtual void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure) Standard_OVERRIDE;
89
90   Standard_EXPORT virtual Handle(Graphic3d_CView) CreateView (const Handle(Graphic3d_StructureManager)& theMgr) Standard_OVERRIDE;
91
92   Standard_EXPORT virtual void RemoveView (const Handle(Graphic3d_CView)& theView) Standard_OVERRIDE;
93
94   Standard_EXPORT virtual Handle(OpenGl_Window) CreateRenderWindow (const Handle(Aspect_Window)& theWindow, const Aspect_RenderingContext theContext);
95
96 public:
97
98   Standard_EXPORT void TextSize (const Handle(Graphic3d_CView)& theView,
99                                  const Standard_CString         theText,
100                                  const Standard_ShortReal       theHeight,
101                                  Standard_ShortReal&            theWidth,
102                                  Standard_ShortReal&            theAscent,
103                                  Standard_ShortReal&            theDescent) const Standard_OVERRIDE;
104
105   Standard_EXPORT Standard_ShortReal DefaultTextHeight() const Standard_OVERRIDE;
106
107   Standard_EXPORT Standard_Boolean ViewExists (const Handle(Aspect_Window)& theWindow, Handle(Graphic3d_CView)& theView) Standard_OVERRIDE;
108
109 public:
110
111   //! Adds a new top-level z layer with ID theLayerId for all views. Z layers allow drawing structures in higher layers
112   //! in foreground of structures in lower layers. To add a structure to desired layer on display it is necessary to
113   //! set the layer index for the structure. The passed theLayerId should be not less than 0 (reserved for default layers).
114   Standard_EXPORT void AddZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
115
116   //! Removes Z layer. All structures displayed at the moment in layer will be displayed in
117   //! default layer (the bottom-level z layer). By default, there are always default
118   //! bottom-level layer that can't be removed.  The passed theLayerId should be not less than 0
119   //! (reserved for default layers that can not be removed).
120   Standard_EXPORT void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
121
122   //! Sets the settings for a single Z layer.
123   Standard_EXPORT void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE;
124
125 public:
126
127   //! @return the visualization options
128   inline const OpenGl_Caps& Options() const
129   {
130     return *myCaps.operator->();
131   }
132
133   //! @return the visualization options
134   inline OpenGl_Caps& ChangeOptions()
135   {
136     return *myCaps.operator->();
137   }
138
139   //! Specify swap buffer behavior.
140   Standard_EXPORT void SetBuffersNoSwap (const Standard_Boolean theIsNoSwap);
141
142   //! VBO usage can be forbidden by this method even if it is supported by GL driver.
143   //! Notice that disabling of VBO will cause rendering performance degradation.
144   //! Warning! This method should be called only before any primitives are displayed in GL scene!
145   Standard_EXPORT void EnableVBO (const Standard_Boolean theToTurnOn) Standard_OVERRIDE;
146
147   //! Returns information about GPU memory usage.
148   //! Please read OpenGl_Context::MemoryInfo() for more description.
149   Standard_EXPORT Standard_Boolean MemoryInfo (Standard_Size&           theFreeBytes,
150                                                TCollection_AsciiString& theInfo) const Standard_OVERRIDE;
151
152 public:
153
154   //! Method to retrieve valid GL context.
155   //! Could return NULL-handle if no window created by this driver.
156   //! @param theBound if TRUE then currently bound context will be returned,
157   //!                 any context will be returned otherwise
158   Standard_EXPORT const Handle(OpenGl_Context)& GetSharedContext (bool theBound = false) const;
159
160 #if defined(HAVE_EGL) || defined(HAVE_GLES2) || defined(OCCT_UWP) || defined(__ANDROID__) || defined(__QNX__)
161   Aspect_Display          getRawGlDisplay() const { return myEglDisplay; }
162   Aspect_RenderingContext getRawGlContext() const { return myEglContext;  }
163   void*                   getRawGlConfig()  const { return myEglConfig; }
164 #endif
165
166   //! Set device lost flag for redrawn views.
167   Standard_EXPORT void setDeviceLost();
168
169 public:
170
171   //! State counter for OpenGl structures.
172   OpenGl_StateCounter* GetStateCounter() const { return &myStateCounter; }
173
174   //! Returns unique ID for primitive arrays.
175   Standard_Size GetNextPrimitiveArrayUID() const { return myUIDGenerator.Increment(); }
176
177 protected:
178
179   Standard_Boolean        myIsOwnContext; //!< indicates that shared context has been created within OpenGl_GraphicDriver
180 #if defined(HAVE_EGL) || defined(HAVE_GLES2) || defined(OCCT_UWP) || defined(__ANDROID__) || defined(__QNX__)
181   Aspect_Display          myEglDisplay;   //!< EGL connection to the Display : EGLDisplay
182   Aspect_RenderingContext myEglContext;   //!< EGL rendering context         : EGLContext
183   void*                   myEglConfig;    //!< EGL configuration             : EGLConfig
184 #endif
185
186   Handle(OpenGl_Caps)                                      myCaps;
187   NCollection_Map<Handle(OpenGl_View)>                     myMapOfView;
188   NCollection_DataMap<Standard_Integer, OpenGl_Structure*> myMapOfStructure;
189
190   mutable OpenGl_StateCounter myStateCounter; //!< State counter for OpenGl structures.
191   mutable OpenGl_StateCounter myUIDGenerator; //!< Unique ID counter for primitive arrays.
192
193 };
194
195 DEFINE_STANDARD_HANDLE(OpenGl_GraphicDriver, Graphic3d_GraphicDriver)
196
197 #endif //_OpenGl_GraphicDriver_HeaderFile