1 // Created on: 2011-10-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _OpenGl_GraphicDriver_HeaderFile
17 #define _OpenGl_GraphicDriver_HeaderFile
19 #include <Graphic3d_GraphicDriver.hxx>
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_RenderingContext.hxx>
30 #include <Graphic3d_CView.hxx>
31 #include <Graphic3d_CStructure.hxx>
32 #include <Graphic3d_TextPath.hxx>
33 #include <Graphic3d_HorizontalTextAlignment.hxx>
34 #include <Graphic3d_VerticalTextAlignment.hxx>
35 #include <Graphic3d_GraduatedTrihedron.hxx>
36 #include <Graphic3d_TypeOfComposition.hxx>
37 #include <Graphic3d_ExportFormat.hxx>
38 #include <Graphic3d_SortType.hxx>
39 #include <Graphic3d_BufferType.hxx>
40 #include <NCollection_DataMap.hxx>
41 #include <OpenGl_Context.hxx>
42 #include <OpenGl_MapOfZLayerSettings.hxx>
43 #include <Quantity_PlaneAngle.hxx>
44 #include <Quantity_NameOfColor.hxx>
45 #include <Standard_CString.hxx>
46 #include <TColStd_Array1OfInteger.hxx>
47 #include <TColStd_Array2OfReal.hxx>
48 #include <TColStd_HArray1OfByte.hxx>
49 #include <TColStd_HArray1OfReal.hxx>
50 #include <TColStd_MapOfInteger.hxx>
53 class Graphic3d_Vector;
55 class Graphic3d_Vertex;
56 class TCollection_ExtendedString;
59 class OpenGl_Structure;
64 //! Tool class to implement consistent state counter
65 //! for objects inside the same driver instance.
66 class OpenGl_StateCounter
70 OpenGl_StateCounter() : myCounter (0) { }
72 Standard_Size Increment() { return ++myCounter; }
76 Standard_Size myCounter;
79 class OpenGl_GraphicDriver;
81 DEFINE_STANDARD_HANDLE(OpenGl_GraphicDriver,Graphic3d_GraphicDriver)
83 //! This class defines an OpenGl graphic driver
84 class OpenGl_GraphicDriver : public Graphic3d_GraphicDriver
89 //! @param theDisp connection to display, required on Linux but optional on other systems
90 //! @param theToInitialize perform initialization of default OpenGL context on construction
91 Standard_EXPORT OpenGl_GraphicDriver (const Handle(Aspect_DisplayConnection)& theDisp,
92 const Standard_Boolean theToInitialize = Standard_True);
95 Standard_EXPORT virtual ~OpenGl_GraphicDriver();
97 //! Release default context.
98 Standard_EXPORT void ReleaseContext();
100 //! Perform initialization of default OpenGL context.
101 Standard_EXPORT Standard_Boolean InitContext();
103 #if defined(HAVE_EGL) || defined(HAVE_GLES2) || defined(OCCT_UWP) || defined(__ANDROID__) || defined(__QNX__)
104 //! Initialize default OpenGL context using existing one.
105 //! @param theEglDisplay EGL connection to the Display
106 //! @param theEglContext EGL rendering context
107 //! @param theEglConfig EGL configuration
108 Standard_EXPORT Standard_Boolean InitEglContext (Aspect_Display theEglDisplay,
109 Aspect_RenderingContext theEglContext,
113 //! Request limit of graphic resource of specific type.
114 Standard_EXPORT virtual Standard_Integer InquireLimit (const Graphic3d_TypeOfLimit theType) const Standard_OVERRIDE;
118 Standard_EXPORT virtual Handle(Graphic3d_CStructure) CreateStructure (const Handle(Graphic3d_StructureManager)& theManager) Standard_OVERRIDE;
120 Standard_EXPORT virtual void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure) Standard_OVERRIDE;
122 Standard_EXPORT virtual Handle(Graphic3d_CView) CreateView (const Handle(Graphic3d_StructureManager)& theMgr) Standard_OVERRIDE;
124 Standard_EXPORT virtual void RemoveView (const Handle(Graphic3d_CView)& theView) Standard_OVERRIDE;
126 Standard_EXPORT virtual Handle(OpenGl_Window) CreateRenderWindow (const Handle(Aspect_Window)& theWindow, const Aspect_RenderingContext theContext);
130 Standard_EXPORT void TextSize (const Handle(Graphic3d_CView)& theView,
131 const Standard_CString theText,
132 const Standard_ShortReal theHeight,
133 Standard_ShortReal& theWidth,
134 Standard_ShortReal& theAscent,
135 Standard_ShortReal& theDescent) const Standard_OVERRIDE;
137 Standard_EXPORT Standard_ShortReal DefaultTextHeight() const Standard_OVERRIDE;
139 Standard_EXPORT Standard_Boolean ViewExists (const Handle(Aspect_Window)& theWindow, Handle(Graphic3d_CView)& theView) Standard_OVERRIDE;
143 //! Adds a new top-level z layer with ID theLayerId for all views. Z layers allow drawing structures in higher layers
144 //! in foreground of structures in lower layers. To add a structure to desired layer on display it is necessary to
145 //! set the layer index for the structure. The passed theLayerId should be not less than 0 (reserved for default layers).
146 Standard_EXPORT void AddZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
148 //! Removes Z layer. All structures displayed at the moment in layer will be displayed in
149 //! default layer (the bottom-level z layer). By default, there are always default
150 //! bottom-level layer that can't be removed. The passed theLayerId should be not less than 0
151 //! (reserved for default layers that can not be removed).
152 Standard_EXPORT void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
154 //! Returns list of Z layers defined for the graphical driver.
155 Standard_EXPORT void ZLayers (TColStd_SequenceOfInteger& theLayerSeq) const Standard_OVERRIDE;
157 //! Sets the settings for a single Z layer.
158 Standard_EXPORT void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE;
160 //! Returns the settings of a single Z layer.
161 Standard_EXPORT virtual Graphic3d_ZLayerSettings ZLayerSettings (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
165 //! @return the visualization options
166 inline const OpenGl_Caps& Options() const
168 return *myCaps.operator->();
171 //! @return the visualization options
172 inline OpenGl_Caps& ChangeOptions()
174 return *myCaps.operator->();
177 //! Specify swap buffer behavior.
178 Standard_EXPORT void SetBuffersNoSwap (const Standard_Boolean theIsNoSwap);
180 //! VBO usage can be forbidden by this method even if it is supported by GL driver.
181 //! Notice that disabling of VBO will cause rendering performance degradation.
182 //! Warning! This method should be called only before any primitives are displayed in GL scene!
183 Standard_EXPORT void EnableVBO (const Standard_Boolean theToTurnOn) Standard_OVERRIDE;
185 //! Returns information about GPU memory usage.
186 //! Please read OpenGl_Context::MemoryInfo() for more description.
187 Standard_EXPORT Standard_Boolean MemoryInfo (Standard_Size& theFreeBytes,
188 TCollection_AsciiString& theInfo) const Standard_OVERRIDE;
192 //! Method to retrieve valid GL context.
193 //! Could return NULL-handle if no window created by this driver.
194 Standard_EXPORT const Handle(OpenGl_Context)& GetSharedContext() const;
196 #if defined(HAVE_EGL) || defined(HAVE_GLES2) || defined(OCCT_UWP) || defined(__ANDROID__) || defined(__QNX__)
197 Aspect_Display getRawGlDisplay() const { return myEglDisplay; }
198 Aspect_RenderingContext getRawGlContext() const { return myEglContext; }
199 void* getRawGlConfig() const { return myEglConfig; }
202 //! Insert index layer at proper position.
203 Standard_EXPORT void addZLayerIndex (const Graphic3d_ZLayerId theLayerId);
207 DEFINE_STANDARD_RTTIEXT(OpenGl_GraphicDriver,Graphic3d_GraphicDriver)
211 Standard_Boolean myIsOwnContext; //!< indicates that shared context has been created within OpenGl_GraphicDriver
212 #if defined(HAVE_EGL) || defined(HAVE_GLES2) || defined(OCCT_UWP) || defined(__ANDROID__) || defined(__QNX__)
213 Aspect_Display myEglDisplay; //!< EGL connection to the Display : EGLDisplay
214 Aspect_RenderingContext myEglContext; //!< EGL rendering context : EGLContext
215 void* myEglConfig; //!< EGL configuration : EGLConfig
218 Handle(OpenGl_Caps) myCaps;
219 NCollection_Map<Handle(OpenGl_View)> myMapOfView;
220 NCollection_DataMap<Standard_Integer, OpenGl_Structure*> myMapOfStructure;
224 TColStd_MapOfInteger myLayerIds;
225 TColStd_SequenceOfInteger myLayerSeq;
226 OpenGl_MapOfZLayerSettings myMapOfZLayerSettings;
230 //! State counter for OpenGl structures.
231 OpenGl_StateCounter* GetStateCounter() const { return &myStateCounter; }
233 //! Returns unique ID for primitive arrays.
234 Standard_Size GetNextPrimitiveArrayUID() const { return myUIDGenerator.Increment(); }
238 mutable OpenGl_StateCounter myStateCounter; //!< State counter for OpenGl structures.
239 mutable OpenGl_StateCounter myUIDGenerator; //!< Unique ID counter for primitive arrays.
243 #endif //_OpenGl_GraphicDriver_HeaderFile