ai_stats.h

Go to the documentation of this file.

// Copyright 2025 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
 
#pragma once
#include "ai_api.h"
#include "ai_string.h"
#include "ai_universe.h"
#include "ai_render.h"
 
#include <stddef.h> // NULL
#include <stdint.h>
 
enum AtStatsMode
{
   AI_STATS_MODE_OVERWRITE,  
   AI_STATS_MODE_APPEND      
};
 
AI_API AI_DEPRECATED AtStatsMode AiStatsGetMode();
AI_API AI_DEPRECATED void        AiStatsSetMode(AtStatsMode mode);
AI_API const char* AiStatsGetFileName();
AI_API void        AiStatsSetFileName(const char* filename);
 
#ifdef AI_GPU_COMPILER
// profiling does not work on GPU
#define AiProfileBlock(...)
#else
#define AiProfileBlock(...) AiProfileBlockRAII Ai_profile_block(__VA_ARGS__)
#endif
 
AI_API void AiProfileSetFileName(const char* filename);
 
AI_API AtString AiProfileGetFileName();
 
/*\}*/
 
AI_API void     AiReportSetFileName(const char* filename);
AI_API AtString AiReportGetFileName();
 
struct AtNode;
 
AI_API void AiProfileUpdate(uint64_t start_counter, uint64_t end_counter,
                            const char* name, const AtNode* node);
 
AI_API uint64_t AiProfileCounter();
 
ARNOLD_FORCEINLINE void AiProfileEnd(uint64_t start_counter, const char* name, const AtNode* node=NULL)
{
   const uint64_t end_counter = AiProfileCounter();
   if (Ai_unlikely(start_counter != end_counter))
      AiProfileUpdate(start_counter, end_counter, name, node);
}
 
struct AiProfileBlockRAII
{
   AiProfileBlockRAII(const char* name, const AtNode* node=NULL) :
      start_counter(AiProfileCounter()), name(name), node(node) { }
 
   AiProfileBlockRAII(const AtNode* node) :
      start_counter(AiProfileCounter()), name(NULL), node(node) { }
 
   ~AiProfileBlockRAII()
   {
      AiProfileEnd(start_counter, name, node);
   }
 
private:
   const uint64_t start_counter;
   const char* const name;
   const AtNode* const node;
};