include/opencascade/Graphic3d_FrameStatsCounter.hxx

0001 // Copyright (c) 2018 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _Graphic3d_FrameStatsCounter_HeaderFile
0015 #define _Graphic3d_FrameStatsCounter_HeaderFile
0016
0017 //! Stats counter.
0018 enum Graphic3d_FrameStatsCounter
0019 {
0020   // overall scene counters
0021   Graphic3d_FrameStatsCounter_NbLayers = 0,           //!< number of ZLayers
0022   Graphic3d_FrameStatsCounter_NbStructs,              //!< number of defined OpenGl_Structure
0023   Graphic3d_FrameStatsCounter_EstimatedBytesGeom,     //!< estimated GPU memory used for geometry
0024   Graphic3d_FrameStatsCounter_EstimatedBytesFbos,     //!< estimated GPU memory used for FBOs
0025   Graphic3d_FrameStatsCounter_EstimatedBytesTextures, //!< estimated GPU memory used for textures
0026
0027   // rendered counters
0028   Graphic3d_FrameStatsCounter_NbLayersNotCulled,      //!< number of not culled ZLayers
0029   Graphic3d_FrameStatsCounter_NbStructsNotCulled,     //!< number of not culled OpenGl_Structure
0030   Graphic3d_FrameStatsCounter_NbGroupsNotCulled,      //!< number of not culled OpenGl_Group
0031   Graphic3d_FrameStatsCounter_NbElemsNotCulled,       //!< number of not culled OpenGl_Element
0032   Graphic3d_FrameStatsCounter_NbElemsFillNotCulled,   //!< number of not culled OpenGl_PrimitiveArray drawing triangles
0033   Graphic3d_FrameStatsCounter_NbElemsLineNotCulled,   //!< number of not culled OpenGl_PrimitiveArray drawing lines
0034   Graphic3d_FrameStatsCounter_NbElemsPointNotCulled,  //!< number of not culled OpenGl_PrimitiveArray drawing points
0035   Graphic3d_FrameStatsCounter_NbElemsTextNotCulled,   //!< number of not culled OpenGl_Text
0036   Graphic3d_FrameStatsCounter_NbTrianglesNotCulled,   //!< number of not culled (as structure) triangles
0037   Graphic3d_FrameStatsCounter_NbLinesNotCulled,       //!< number of not culled (as structure) line segments
0038   Graphic3d_FrameStatsCounter_NbPointsNotCulled,      //!< number of not culled (as structure) points
0039   //Graphic3d_FrameStatsCounter_NbGlyphsNotCulled,    //!< number glyphs, to be considered in future
0040
0041   // immediate layer rendered counters
0042   Graphic3d_FrameStatsCounter_NbLayersImmediate,      //!< number of ZLayers in immediate layer
0043   Graphic3d_FrameStatsCounter_NbStructsImmediate,     //!< number of OpenGl_Structure in immediate layer
0044   Graphic3d_FrameStatsCounter_NbGroupsImmediate,      //!< number of OpenGl_Group in immediate layer
0045   Graphic3d_FrameStatsCounter_NbElemsImmediate,       //!< number of OpenGl_Element in immediate layer
0046   Graphic3d_FrameStatsCounter_NbElemsFillImmediate,   //!< number of OpenGl_PrimitiveArray drawing triangles in immediate layer
0047   Graphic3d_FrameStatsCounter_NbElemsLineImmediate,   //!< number of OpenGl_PrimitiveArray drawing lines in immediate layer
0048   Graphic3d_FrameStatsCounter_NbElemsPointImmediate,  //!< number of OpenGl_PrimitiveArray drawing points in immediate layer
0049   Graphic3d_FrameStatsCounter_NbElemsTextImmediate,   //!< number of OpenGl_Text in immediate layer
0050   Graphic3d_FrameStatsCounter_NbTrianglesImmediate,   //!< number of triangles in immediate layer
0051   Graphic3d_FrameStatsCounter_NbLinesImmediate,       //!< number of line segments in immediate layer
0052   Graphic3d_FrameStatsCounter_NbPointsImmediate,      //!< number of points in immediate layer
0053 };
0054 enum
0055 {
0056   Graphic3d_FrameStatsCounter_NB = Graphic3d_FrameStatsCounter_NbPointsImmediate + 1,
0057   Graphic3d_FrameStatsCounter_SCENE_LOWER = Graphic3d_FrameStatsCounter_NbLayers,
0058   Graphic3d_FrameStatsCounter_SCENE_UPPER = Graphic3d_FrameStatsCounter_EstimatedBytesTextures,
0059   Graphic3d_FrameStatsCounter_RENDERED_LOWER = Graphic3d_FrameStatsCounter_NbLayersNotCulled,
0060   Graphic3d_FrameStatsCounter_RENDERED_UPPER = Graphic3d_FrameStatsCounter_NbPointsNotCulled,
0061   Graphic3d_FrameStatsCounter_IMMEDIATE_LOWER = Graphic3d_FrameStatsCounter_NbLayersImmediate,
0062   Graphic3d_FrameStatsCounter_IMMEDIATE_UPPER = Graphic3d_FrameStatsCounter_NbPointsImmediate,
0063 };
0064
0065 #endif // _Graphic3d_FrameStatsCounter_HeaderFile