0031505: Point Cloud Rendering - fix on-screen statistics about number of visible...
[occt.git] / src / OpenGl / OpenGl_FrameStats.cxx
1 // Copyright (c) 2017 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #include <OpenGl_FrameStats.hxx>
15
16 #include <OpenGl_GlCore20.hxx>
17 #include <OpenGl_View.hxx>
18 #include <OpenGl_Workspace.hxx>
19
20 IMPLEMENT_STANDARD_RTTIEXT(OpenGl_FrameStats, Graphic3d_FrameStats)
21
22 namespace
23 {
24   //! Return estimated data size.
25   static Standard_Size estimatedDataSize (const Handle(OpenGl_Resource)& theRes)
26   {
27     return !theRes.IsNull() ? theRes->EstimatedDataSize() : 0;
28   }
29 }
30
31 // =======================================================================
32 // function : OpenGl_FrameStats
33 // purpose  :
34 // =======================================================================
35 OpenGl_FrameStats::OpenGl_FrameStats()
36 {
37   //
38 }
39
40 // =======================================================================
41 // function : ~OpenGl_FrameStats
42 // purpose  :
43 // =======================================================================
44 OpenGl_FrameStats::~OpenGl_FrameStats()
45 {
46   //
47 }
48
49 // =======================================================================
50 // function : IsFrameUpdated
51 // purpose  :
52 // =======================================================================
53 bool OpenGl_FrameStats::IsFrameUpdated (Handle(OpenGl_FrameStats)& thePrev) const
54 {
55   const Graphic3d_FrameStatsData& aFrame = LastDataFrame();
56   if (thePrev.IsNull())
57   {
58     thePrev = new OpenGl_FrameStats();
59   }
60   // check just a couple of major counters
61   else if (myLastFrameIndex == thePrev->myLastFrameIndex
62         && Abs (aFrame.FrameRate()    - thePrev->myCountersTmp.FrameRate())    <= 0.001
63         && Abs (aFrame.FrameRateCpu() - thePrev->myCountersTmp.FrameRateCpu()) <= 0.001
64         && aFrame[Graphic3d_FrameStatsCounter_NbLayers]           == thePrev->myCountersTmp[Graphic3d_FrameStatsCounter_NbLayers]
65         && aFrame[Graphic3d_FrameStatsCounter_NbLayersNotCulled]  == thePrev->myCountersTmp[Graphic3d_FrameStatsCounter_NbLayersNotCulled]
66         && aFrame[Graphic3d_FrameStatsCounter_NbStructs]          == thePrev->myCountersTmp[Graphic3d_FrameStatsCounter_NbStructs]
67         && aFrame[Graphic3d_FrameStatsCounter_NbStructsNotCulled] == thePrev->myCountersTmp[Graphic3d_FrameStatsCounter_NbStructsNotCulled])
68   {
69     return false;
70   }
71
72   thePrev->myLastFrameIndex = myLastFrameIndex;
73   thePrev->myCountersTmp = aFrame;
74   return true;
75 }
76
77 // =======================================================================
78 // function : updateStatistics
79 // purpose  :
80 // =======================================================================
81 void OpenGl_FrameStats::updateStatistics (const Handle(Graphic3d_CView)& theView,
82                                           bool theIsImmediateOnly)
83 {
84   const OpenGl_View* aView = dynamic_cast<const OpenGl_View*> (theView.get());
85   if (aView == NULL)
86   {
87     myCounters.SetValue (myLastFrameIndex, myCountersTmp);
88     myCountersTmp.Reset();
89     return;
90   }
91
92   const Graphic3d_RenderingParams::PerfCounters aBits = theView->RenderingParams().CollectedStats;
93   const Standard_Boolean toCountMem     = (aBits & Graphic3d_RenderingParams::PerfCounters_EstimMem)  != 0;
94   const Standard_Boolean toCountTris    = (aBits & Graphic3d_RenderingParams::PerfCounters_Triangles) != 0
95                                        || (aBits & Graphic3d_RenderingParams::PerfCounters_Lines)     != 0
96                                        || (aBits & Graphic3d_RenderingParams::PerfCounters_Points)    != 0;
97   const Standard_Boolean toCountElems   = (aBits & Graphic3d_RenderingParams::PerfCounters_GroupArrays) != 0 || toCountTris || toCountMem;
98   const Standard_Boolean toCountGroups  = (aBits & Graphic3d_RenderingParams::PerfCounters_Groups)      != 0 || toCountElems;
99   const Standard_Boolean toCountStructs = (aBits & Graphic3d_RenderingParams::PerfCounters_Structures)  != 0
100                                        || (aBits & Graphic3d_RenderingParams::PerfCounters_Layers)      != 0 || toCountGroups;
101
102   myCountersTmp[Graphic3d_FrameStatsCounter_NbLayers] = aView->LayerList().Layers().Size();
103   if (toCountStructs
104    || (aBits & Graphic3d_RenderingParams::PerfCounters_Layers)    != 0)
105   {
106     const Standard_Integer aViewId = aView->Identification();
107     for (NCollection_List<Handle(Graphic3d_Layer)>::Iterator aLayerIter (aView->LayerList().Layers()); aLayerIter.More(); aLayerIter.Next())
108     {
109       const Handle(OpenGl_Layer)& aLayer = aLayerIter.Value();
110       myCountersTmp[Graphic3d_FrameStatsCounter_NbStructs] += aLayer->NbStructures();
111       if (theIsImmediateOnly && !aLayer->LayerSettings().IsImmediate())
112       {
113         continue;
114       }
115
116       if (!aLayer->IsCulled())
117       {
118         ++myCountersTmp[Graphic3d_FrameStatsCounter_NbLayersNotCulled];
119       }
120       myCountersTmp[Graphic3d_FrameStatsCounter_NbStructsNotCulled] += aLayer->NbStructuresNotCulled();
121       if (toCountGroups)
122       {
123         updateStructures (aViewId, aLayer->CullableStructuresBVH().Structures(), toCountElems, toCountTris, toCountMem);
124         updateStructures (aViewId, aLayer->CullableTrsfPersStructuresBVH().Structures(), toCountElems, toCountTris, toCountMem);
125         updateStructures (aViewId, aLayer->NonCullableStructures(), toCountElems, toCountTris, toCountMem);
126       }
127     }
128   }
129   if (toCountMem)
130   {
131     for (OpenGl_Context::OpenGl_ResourcesMap::Iterator aResIter (aView->GlWindow()->GetGlContext()->SharedResources());
132          aResIter.More(); aResIter.Next())
133     {
134       myCountersTmp[Graphic3d_FrameStatsCounter_EstimatedBytesTextures] += aResIter.Value()->EstimatedDataSize();
135     }
136
137     {
138       Standard_Size& aMemFbos = myCountersTmp[Graphic3d_FrameStatsCounter_EstimatedBytesFbos];
139       // main FBOs
140       aMemFbos += estimatedDataSize (aView->myMainSceneFbos[0]);
141       aMemFbos += estimatedDataSize (aView->myMainSceneFbos[1]);
142       aMemFbos += estimatedDataSize (aView->myImmediateSceneFbos[0]);
143       aMemFbos += estimatedDataSize (aView->myImmediateSceneFbos[1]);
144       // OIT FBOs
145       aMemFbos += estimatedDataSize (aView->myMainSceneFbosOit[0]);
146       aMemFbos += estimatedDataSize (aView->myMainSceneFbosOit[1]);
147       aMemFbos += estimatedDataSize (aView->myImmediateSceneFbosOit[0]);
148       aMemFbos += estimatedDataSize (aView->myImmediateSceneFbosOit[1]);
149       // dump FBO
150       aMemFbos += estimatedDataSize (aView->myFBO);
151       // RayTracing FBO
152       aMemFbos += estimatedDataSize (aView->myOpenGlFBO);
153       aMemFbos += estimatedDataSize (aView->myOpenGlFBO2);
154       aMemFbos += estimatedDataSize (aView->myRaytraceFBO1[0]);
155       aMemFbos += estimatedDataSize (aView->myRaytraceFBO1[1]);
156       aMemFbos += estimatedDataSize (aView->myRaytraceFBO2[0]);
157       aMemFbos += estimatedDataSize (aView->myRaytraceFBO2[1]);
158       // also RayTracing
159       aMemFbos += estimatedDataSize (aView->myRaytraceOutputTexture[0]);
160       aMemFbos += estimatedDataSize (aView->myRaytraceOutputTexture[1]);
161       aMemFbos += estimatedDataSize (aView->myRaytraceVisualErrorTexture[0]);
162       aMemFbos += estimatedDataSize (aView->myRaytraceVisualErrorTexture[1]);
163       aMemFbos += estimatedDataSize (aView->myRaytraceTileOffsetsTexture[0]);
164       aMemFbos += estimatedDataSize (aView->myRaytraceTileOffsetsTexture[1]);
165       aMemFbos += estimatedDataSize (aView->myRaytraceTileSamplesTexture[0]);
166       aMemFbos += estimatedDataSize (aView->myRaytraceTileSamplesTexture[1]);
167     }
168     {
169       // Ray Tracing geometry
170       Standard_Size& aMemGeom = myCountersTmp[Graphic3d_FrameStatsCounter_EstimatedBytesGeom];
171       aMemGeom += estimatedDataSize (aView->mySceneNodeInfoTexture);
172       aMemGeom += estimatedDataSize (aView->mySceneMinPointTexture);
173       aMemGeom += estimatedDataSize (aView->mySceneMaxPointTexture);
174       aMemGeom += estimatedDataSize (aView->mySceneTransformTexture);
175       aMemGeom += estimatedDataSize (aView->myGeometryVertexTexture);
176       aMemGeom += estimatedDataSize (aView->myGeometryNormalTexture);
177       aMemGeom += estimatedDataSize (aView->myGeometryTexCrdTexture);
178       aMemGeom += estimatedDataSize (aView->myGeometryTriangTexture);
179       aMemGeom += estimatedDataSize (aView->myRaytraceMaterialTexture);
180       aMemGeom += estimatedDataSize (aView->myRaytraceLightSrcTexture);
181     }
182   }
183 }
184
185 // =======================================================================
186 // function : updateStructures
187 // purpose  :
188 // =======================================================================
189 void OpenGl_FrameStats::updateStructures (Standard_Integer theViewId,
190                                           const NCollection_IndexedMap<const Graphic3d_CStructure*>& theStructures,
191                                           Standard_Boolean theToCountElems,
192                                           Standard_Boolean theToCountTris,
193                                           Standard_Boolean theToCountMem)
194 {
195   for (OpenGl_Structure::StructIterator aStructIter (theStructures); aStructIter.More(); aStructIter.Next())
196   {
197     const OpenGl_Structure* aStruct = aStructIter.Value();
198     const bool isStructHidden = aStruct->IsCulled()
199                             || !aStruct->IsVisible (theViewId);
200     for (; aStruct != NULL; aStruct = aStruct->InstancedStructure())
201     {
202       if (isStructHidden)
203       {
204         if (theToCountMem)
205         {
206           for (OpenGl_Structure::GroupIterator aGroupIter (aStruct->Groups()); aGroupIter.More(); aGroupIter.Next())
207           {
208             const OpenGl_Group* aGroup = aGroupIter.Value();
209             for (const OpenGl_ElementNode* aNodeIter = aGroup->FirstNode(); aNodeIter != NULL; aNodeIter = aNodeIter->next)
210             {
211               aNodeIter->elem->UpdateMemStats (myCountersTmp);
212             }
213           }
214         }
215         continue;
216       }
217
218       myCountersTmp[Graphic3d_FrameStatsCounter_NbGroupsNotCulled] += aStruct->Groups().Size();
219       if (!theToCountElems)
220       {
221         continue;
222       }
223
224       for (OpenGl_Structure::GroupIterator aGroupIter (aStruct->Groups()); aGroupIter.More(); aGroupIter.Next())
225       {
226         const OpenGl_Group* aGroup = aGroupIter.Value();
227         for (const OpenGl_ElementNode* aNodeIter = aGroup->FirstNode(); aNodeIter != NULL; aNodeIter = aNodeIter->next)
228         {
229           if (theToCountMem)
230           {
231             aNodeIter->elem->UpdateMemStats (myCountersTmp);
232           }
233           aNodeIter->elem->UpdateDrawStats (myCountersTmp, theToCountTris);
234         }
235       }
236     }
237   }
238 }