DtProfiler.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2019 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/


#pragma once

#include <vrvUtil/vrvUtil.h>
#include <vrvUtil/DtProfileManager.h>

#include <boost/type_traits/integral_constant.hpp>

//easy to use macro to profile a section
// should pass a "const char*" as name because the pointer is getting
// used to do the string compare (to be fast)
// if a std::string is passed instead it will cause a crashed when 
// loading/unloading terrain with the performance/stats displayed 
#define DtPROFILE_RESTRICTED(name, target) makVrv::DtProfileTarget<target> _profileTarget##line(name);
#define DtPROFILE(name) DtPROFILE_X(name, __LINE__)
#define DtPROFILE_X(name, line) DtPROFILE_ACTUAL(name, line)
#define DtPROFILE_ACTUAL(name, line) makVrv::DtProfileSample _profileSample##line(name);
#define DtPROFILE_FUNCTION(name, func) {makVrv::DtProfileSample _profileSample(name); (func);}
#define DtPROFILE_SECTION(name) { makVrv::DtProfileSample _profileSample(name); 
#define DtPROFILE_SECTION_END }

#define DtPERFORMANCE_STAT(name) DtPERFORMANCE_STAT_X(name, __LINE__)
#define DtPERFORMANCE_STAT_X(name, line) DtPERFORMANCE_STAT_ACTUAL(name, line)
#define DtPERFORMANCE_STAT_ACTUAL(name, line) makVrv::DtPerfomanceStatSample _performanceStatSample##line(name);


// These constants configure  DtPROFILE_RESTRICTED
// 
// Define them to boost::true_type to enable profiling of those sections
const bool Profile_DtSceneObjectUpdater = false;
const bool Profile_DtSurfaceClampingUpdater = false;
const bool Profile_DtOsgCullVisitor = false;

namespace makVrv
{
   class DT_DLL_VRVUTIL DtProfileSample 
   {
   public:
      DtProfileSample(const char* name )
      { 
         DtProfileManager::startProfile( name ); 
      }

      ~DtProfileSample( )              
      { 
         DtProfileManager::stopProfile(); 
      }
   };

   template <bool Enabled>
   struct DtProfileTarget
   {
      DtProfileTarget(const char* name) {}
   };

   template <>
   struct DtProfileTarget<true>
   {
      DtProfileTarget(const char* name )
      { 
         DtProfileManager::startProfile( name ); 
      }

      ~DtProfileTarget( )              
      { 
         DtProfileManager::stopProfile(); 
      }
   };
   
   class DT_DLL_VRVUTIL DtPerfomanceStatSample 
   {
   public:
      DtPerfomanceStatSample(const char* name )
      { 
         DtProfileManager::startPerformanceStat( name ); 
      }

      ~DtPerfomanceStatSample( )             
      { 
         DtProfileManager::stopPerformanceStat(); 
      }
   };
}