DtProfiler.h

Go to the documentation of this file.

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


#pragma once

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

// Single location to define profiling colors
#define DTPROFILE_TRACYCOLOR_SILVERLINING 0x0b8bf8
#define DTPROFILE_TRACYCOLOR_TRITON 0x123f7b
#define DTPROFILE_TRACYCOLOR_SPEEDTREE 0x0f502d
#define DTPROFILE_TRACYCOLOR_INDIRECT 0x3333cc
#define DTPROFILE_TRACYCOLOR_LIGHTING 0xffaa00
#define DTPROFILE_TRACYCOLOR_POSTEFFECT 0xffb31a
#define DTPROFILE_TRACYCOLOR_VIRTUALREALITY 0xa3297a
#define DTPROFILE_TRACYCOLOR_GLCONTEXT 0xe68a00
#define DTPROFILE_TRACYCOLOR_RENDERER 0xb990000




//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 TRACY_ENABLE
//#define OPTICK_ENABLE
//#define NO_PROFILER
 
#ifndef TRACY_ENABLE 
#ifndef OPTICK_ENABLE
#define NO_PROFILER
#endif
#endif
//optick
#ifdef OPTICK_ENABLE
#include <optick/optick.h>
//#pragma comment(lib, "OptickCore.lib") 

// win32 creates macros that work with our stats and tracy
#define DtPROFILE(name) OPTICK_EVENT(name); DtPROFILE_X(name, __LINE__);
#define DtPROFILEC(name, color) OPTICK_EVENT(name); DtPROFILE_X(name, __LINE__);
#define DtPROFILE_SECTION(name) {OPTICK_EVENT(name); makVrv::DtProfileSample _profileSample(name); 

#define DtProfilerFrameMark OPTICK_FRAME("MainThread")
#define DtProfilerThreadName(name) OPTICK_THREAD(name);
#define DtProfilerMessage(str, stringLen)

#define DtProfilerPlot(x,y)
#define DtProfilerText(text) 

#endif

//tracy
#ifdef TRACY_ENABLE
#define TRACY_ON_DEMAND
#define TRACY_DELAYED_INIT 
#define TRACY_MANUAL_LIFETIME
//#define TRACY_NO_BROADCAST
// TO DO include tracy on linux just to get it's macros for throwing things out
#include <TracyClient/Tracy.hpp>
#include <TracyClient/client/TracyProfiler.hpp>
//#pragma comment(lib, "TracyClient.lib") 

#define ZoneScopedNA( name, active ) ZoneNamedN( ___tracy_scoped_zone, name, active )
#define ZoneScopedNCA( name, color, active ) ZoneNamedNC( ___tracy_scoped_zone, name, color, active )

// win32 creates macros that work with our stats and tracy
#define DtPROFILEzone ZoneNamed(___tracy_scoped_zone, makVrv::DtProfileManager::collectTracyStats());
#define DtPROFILEzoneN(name) ZoneNamedN(___tracy_scoped_zone, name, makVrv::DtProfileManager::collectTracyStats());
#define DtPROFILE(name) ZoneScopedNA(name, makVrv::DtProfileManager::collectTracyStats()); DtPROFILE_X(name, __LINE__);
#define DtPROFILEC(name, color) ZoneScopedNCA(name, color, makVrv::DtProfileManager::collectTracyStats()); DtPROFILE_X(name, __LINE__);
#define DtPROFILE_SECTION(name) {ZoneScopedNA(name, makVrv::DtProfileManager::collectTracyStats()); makVrv::DtProfileSample _profileSample(name); 
// call stack version doesn't work RtlWalkFrameChain unresolved.
//#define DtPROFILE(name) ZoneScopedNS(name, 4); DtPROFILE_X(name, __LINE__);
#define DtProfilerFrameMark if(makVrv::DtProfileManager::tracyProfilerInitialized()) { FrameMark; }
#define DtProfilerPlot(x,y) TracyPlot(x,y)
#define DtProfilerThreadName(name) tracy::SetThreadName(name );
#define DtProfilerMessage(str, stringLen) TracyMessage(str, stringLen)
#define DtProfilerText(text) _zoneSetText(___tracy_scoped_zone, text)

inline void _zoneSetText(tracy::ScopedZone& zone, const char* text) {
   zone.Text(text, strlen(text));
}
inline void _zoneSetText(tracy::ScopedZone& zone, const std::string& text) {
   zone.Text(text.c_str(), text.size());
}

#define DtProfilerName(text) _zoneSetName(___tracy_scoped_zone, text)

inline void _zoneSetName( tracy::ScopedZone& zone, const char* text )
{
   zone.Name( text, strlen( text ) );
}
inline void _zoneSetName( tracy::ScopedZone& zone, const std::string& text )
{
   zone.Name( text.c_str(), text.size() );
}
#endif


#ifdef NO_PROFILER
#define DtPROFILEzone
#define DtPROFILE(name) DtPROFILE_X(name, __LINE__);
#define DtPROFILEC(name, color) DtPROFILE_X(name, __LINE__);
#define DtPROFILE_SECTION(name) {makVrv::DtProfileSample _profileSample(name); 
#define DtPROFILEzone DtPROFILE_X(__func__, __LINE__);

#define DtProfilerPlot(x,y) 

#define DtProfilerFrameMark 
#define DtProfilerThreadName(name)
#define DtProfilerPlot(x,y)
#define DtProfilerMessage(str, stringLen)
#define DtProfilerText(text)
#endif

#define DtPROFILE_RESTRICTED(name, target) makVrv::DtProfileTarget<target> _profileTarget##line(name);

#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_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
{
   void DT_DLL_VRVUTIL SetThreadName(const char* name);

   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(); 
      }
   };
}