0026823: Configuration - use EGL on another platform without GLX
[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_GradientFillMethod.hxx>
24 #include <Aspect_FillMethod.hxx>
25 #include <Aspect_TypeOfTriedronPosition.hxx>
26 #include <Aspect_TypeOfTriedronEcho.hxx>
27 #include <Aspect_Handle.hxx>
28 #include <Aspect_PrintAlgo.hxx>
29 #include <Aspect_RenderingContext.hxx>
30 #include <gp_Ax2.hxx>
31 #include <Graphic3d_CView.hxx>
32 #include <Graphic3d_CStructure.hxx>
33 #include <Graphic3d_TextPath.hxx>
34 #include <Graphic3d_HorizontalTextAlignment.hxx>
35 #include <Graphic3d_VerticalTextAlignment.hxx>
36 #include <Graphic3d_GraduatedTrihedron.hxx>
37 #include <Graphic3d_TypeOfComposition.hxx>
38 #include <Graphic3d_ExportFormat.hxx>
39 #include <Graphic3d_SortType.hxx>
40 #include <Graphic3d_PtrFrameBuffer.hxx>
41 #include <Graphic3d_Array1OfVertex.hxx>
42 #include <Graphic3d_Array2OfVertex.hxx>
43 #include <Graphic3d_BufferType.hxx>
44 #include <NCollection_DataMap.hxx>
45 #include <OpenGl_Context.hxx>
46 #include <OpenGl_MapOfZLayerSettings.hxx>
47 #include <Quantity_PlaneAngle.hxx>
48 #include <Quantity_NameOfColor.hxx>
49 #include <Standard_CString.hxx>
50 #include <TColStd_Array1OfInteger.hxx>
51 #include <TColStd_Array2OfReal.hxx>
52 #include <TColStd_HArray1OfByte.hxx>
53 #include <TColStd_HArray1OfReal.hxx>
54 #include <TColStd_MapOfInteger.hxx>
55
56 class Aspect_Window;
57 class Graphic3d_Vector;
58 class Quantity_Color;
59 class Graphic3d_Vertex;
60 class TCollection_ExtendedString;
61 class Image_PixMap;
62 class OpenGl_Element;
63 class OpenGl_Structure;
64 class OpenGl_Text;
65 class OpenGl_View;
66 class OpenGl_Window;
67
68 //! Tool class to implement consistent state counter
69 //! for objects inside the same driver instance.
70 class OpenGl_StateCounter
71 {
72 public:
73
74   OpenGl_StateCounter() : myCounter (0) { }
75
76   Standard_Size Increment() { return ++myCounter; }
77
78 private:
79
80   Standard_Size myCounter;
81 };
82
83 class OpenGl_GraphicDriver;
84
85 DEFINE_STANDARD_HANDLE(OpenGl_GraphicDriver,Graphic3d_GraphicDriver)
86
87 //! This class defines an OpenGl graphic driver
88 class OpenGl_GraphicDriver : public Graphic3d_GraphicDriver
89 {
90 public:
91
92   //! Constructor.
93   //! @param theDisp connection to display, required on Linux but optional on other systems
94   //! @param theToInitialize perform initialization of default OpenGL context on construction
95   Standard_EXPORT OpenGl_GraphicDriver (const Handle(Aspect_DisplayConnection)& theDisp,
96                                         const Standard_Boolean                  theToInitialize = Standard_True);
97
98   //! Destructor.
99   Standard_EXPORT virtual ~OpenGl_GraphicDriver();
100
101   //! Release default context.
102   Standard_EXPORT void ReleaseContext();
103
104   //! Perform initialization of default OpenGL context.
105   Standard_EXPORT Standard_Boolean InitContext();
106
107 #if defined(HAVE_EGL) || defined(__ANDROID__) || defined(__QNX__)
108   //! Initialize default OpenGL context using existing one.
109   //! @param theEglDisplay EGL connection to the Display
110   //! @param theEglContext EGL rendering context
111   //! @param theEglConfig  EGL configuration
112   Standard_EXPORT Standard_Boolean InitEglContext (Aspect_Display          theEglDisplay,
113                                                    Aspect_RenderingContext theEglContext,
114                                                    void*                   theEglConfig);
115 #endif
116
117   Standard_EXPORT Standard_Integer InquireLightLimit ();
118   Standard_EXPORT Standard_Integer InquireViewLimit ();
119
120 public:
121
122   Standard_EXPORT virtual Handle(Graphic3d_CStructure) CreateStructure (const Handle(Graphic3d_StructureManager)& theManager) Standard_OVERRIDE;
123
124   Standard_EXPORT virtual void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure) Standard_OVERRIDE;
125
126   Standard_EXPORT virtual Handle(Graphic3d_CView) CreateView (const Handle(Graphic3d_StructureManager)& theMgr) Standard_OVERRIDE;
127
128   Standard_EXPORT virtual void RemoveView (const Handle(Graphic3d_CView)& theView) Standard_OVERRIDE;
129
130   Standard_EXPORT virtual Handle(OpenGl_Window) CreateRenderWindow (const Handle(Aspect_Window)& theWindow, const Aspect_RenderingContext theContext);
131
132 public:
133
134   Standard_EXPORT void TextSize (const Handle(Graphic3d_CView)& theView,
135                                  const Standard_CString         theText,
136                                  const Standard_ShortReal       theHeight,
137                                  Standard_ShortReal&            theWidth,
138                                  Standard_ShortReal&            theAscent,
139                                  Standard_ShortReal&            theDescent) const;
140
141   Standard_EXPORT Standard_Integer InquirePlaneLimit();
142
143   Standard_EXPORT Standard_ShortReal DefaultTextHeight() const;
144
145   Standard_EXPORT Standard_Boolean ViewExists (const Handle(Aspect_Window)& theWindow, Handle(Graphic3d_CView)& theView) Standard_OVERRIDE;
146
147 public:
148
149   //! Adds a new top-level z layer with ID theLayerId for all views. Z layers allow drawing structures in higher layers
150   //! in foreground of structures in lower layers. To add a structure to desired layer on display it is necessary to
151   //! set the layer index for the structure. The passed theLayerId should be not less than 0 (reserved for default layers).
152   Standard_EXPORT void AddZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
153
154   //! Removes Z layer. All structures displayed at the moment in layer will be displayed in
155   //! default layer (the bottom-level z layer). By default, there are always default
156   //! bottom-level layer that can't be removed.  The passed theLayerId should be not less than 0
157   //! (reserved for default layers that can not be removed).
158   Standard_EXPORT void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
159
160   //! Returns list of Z layers defined for the graphical driver.
161   Standard_EXPORT void ZLayers (TColStd_SequenceOfInteger& theLayerSeq) const Standard_OVERRIDE;
162
163   //! Sets the settings for a single Z layer.
164   Standard_EXPORT void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE;
165
166   //! Returns the settings of a single Z layer.
167   Standard_EXPORT virtual Graphic3d_ZLayerSettings ZLayerSettings (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
168
169 public:
170
171   //! @return the visualization options
172   inline const OpenGl_Caps& Options() const
173   {
174     return *myCaps.operator->();
175   }
176
177   //! @return the visualization options
178   inline OpenGl_Caps& ChangeOptions()
179   {
180     return *myCaps.operator->();
181   }
182
183   //! Specify swap buffer behavior.
184   Standard_EXPORT void SetBuffersNoSwap (const Standard_Boolean theIsNoSwap);
185
186   //! VBO usage can be forbidden by this method even if it is supported by GL driver.
187   //! Notice that disabling of VBO will cause rendering performance degradation.
188   //! Warning! This method should be called only before any primitives are displayed in GL scene!
189   Standard_EXPORT void EnableVBO (const Standard_Boolean theToTurnOn);
190
191   //! Returns information about GPU memory usage.
192   //! Please read OpenGl_Context::MemoryInfo() for more description.
193   Standard_EXPORT Standard_Boolean MemoryInfo (Standard_Size&           theFreeBytes,
194                                                TCollection_AsciiString& theInfo) const;
195
196 public:
197
198   //! Method to retrieve valid GL context.
199   //! Could return NULL-handle if no window created by this driver.
200   Standard_EXPORT const Handle(OpenGl_Context)& GetSharedContext() const;
201
202 #if defined(HAVE_EGL) || defined(__ANDROID__) || defined(__QNX__)
203   Aspect_Display          getRawGlDisplay() const { return myEglDisplay; }
204   Aspect_RenderingContext getRawGlContext() const { return myEglContext;  }
205   void*                   getRawGlConfig()  const { return myEglConfig; }
206 #endif
207
208 public:
209
210   DEFINE_STANDARD_RTTI(OpenGl_GraphicDriver, Graphic3d_GraphicDriver)
211
212 protected:
213
214   Standard_Boolean        myIsOwnContext; //!< indicates that shared context has been created within OpenGl_GraphicDriver
215 #if defined(HAVE_EGL) || defined(__ANDROID__) || defined(__QNX__)
216   Aspect_Display          myEglDisplay;   //!< EGL connection to the Display : EGLDisplay
217   Aspect_RenderingContext myEglContext;   //!< EGL rendering context         : EGLContext
218   void*                   myEglConfig;    //!< EGL configuration             : EGLConfig
219 #endif
220
221   Handle(OpenGl_Caps)                                             myCaps;
222   NCollection_Map<Handle(OpenGl_View)>                            myMapOfView;
223   NCollection_DataMap<Standard_Integer, OpenGl_Structure*>        myMapOfStructure;
224
225 public:
226
227   TColStd_MapOfInteger       myLayerIds;
228   TColStd_SequenceOfInteger  myLayerSeq;
229   OpenGl_MapOfZLayerSettings myMapOfZLayerSettings;
230
231 public:
232
233   //! State counter for OpenGl structures.
234   OpenGl_StateCounter* GetStateCounter() const { return &myStateCounter; }
235
236   //! Returns unique ID for primitive arrays.
237   const Standard_Size GetNextPrimitiveArrayUID() const { return myUIDGenerator.Increment(); }
238
239 protected:
240
241   mutable OpenGl_StateCounter myStateCounter; //!< State counter for OpenGl structures.
242   mutable OpenGl_StateCounter myUIDGenerator; //!< Unique ID counter for primitive arrays.
243
244 };
245
246 #endif //_OpenGl_GraphicDriver_HeaderFile