mirrors/tracy
1
0
Fork 0
mirror of https://github.com/wolfpld/tracy synced 2025-04-29 04:23:51 +00:00
Code Issues Releases Wiki Activity

Add frame instrumentation achievement.

Browse Source
This commit is contained in:
Bartosz Taudul 2024-07-08 19:30:27 +02:00
parent e4cda51bf6
commit 69c50cb6cb
No known key found for this signature in database
GPG Key ID: B7FE2008B7575DF3
2 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
profiler/src/profiler/TracyAchievementData.cpp
View File

@ -66,7 +66,7 @@ void SomeFunction()
static SourceContents sc;
sc.Parse( src );
ImGui::TextWrapped( "Instrumentation is a powerful feature that allows you to see the exact runtime of each call to the selected set of functions. The downside is that it takes a bit of manual work to get it set up." );
ImGui::TextWrapped( "To get started, open a source file and include the Tracy.hpp header. This will give you access to a variety of macros provided by Tracy. Next, add the ZoneScoped macro to the beginning of one of your functions, like this:" );
ImGui::PushFont( c.fixed );
@ -81,7 +81,31 @@ void SomeFunction()
ImGui::PopFont();
}, ac_instrumentationIntroItems };
AchievementItem* ac_instrumentationItems[] = { &ai_instrumentationIntro, nullptr };
AchievementItem ai_instrumentFrames = { "instrumentFrames", "Instrumenting frames", [](const ctx& c){
constexpr const char* src = R"(#include "Tracy.hpp"
void Render()
{
// Render the frame
SwapBuffers();
FrameMark;
}
)";
static SourceContents sc;
sc.Parse( src );
ImGui::TextWrapped( "In addition to instrumenting functions, you can also instrument frames. This allows you to see how much time is spent in each frame of your application." );
ImGui::TextWrapped( "To instrument frames, you need to add the FrameMark macro at the beginning of each frame. This can be done in the main loop of your application, or in a separate function that is called at the beginning of each frame." );
ImGui::PushFont( c.fixed );
PrintSource( sc.get() );
ImGui::PopFont();
ImGui::TextWrapped( "When you profile your application, you will see a new frame appear on the timeline each time the FrameMark macro is called. This allows you to see how much time is spent in each frame and how many frames are rendered per second." );
ImGui::TextWrapped( "The FrameMark macro is a great way to see at a glance how your application is performing over time. Maybe there are some performance problems that only appear after a few minutes of running the application? A frame graph is drawn at the top of the profiler window where you can see the timing of all frames." );
ImGui::TextWrapped( "Note that some applications do not have a frame-based structure, and in such cases, frame instrumentation may not be useful. That's ok." );
} };
AchievementItem* ac_instrumentationItems[] = { &ai_instrumentationIntro, &ai_instrumentFrames, nullptr };
AchievementCategory ac_instrumentation = { "instrumentation", "Instrumentation", ac_instrumentationItems };

1
profiler/src/profiler/TracyView.cpp
View File

@ -685,6 +685,7 @@ bool View::DrawImpl()
if( m_worker.GetZoneCount() > 0 ) Achieve( "instrumentationIntro" );
if( m_worker.GetZoneCount() > 100 * 1000 * 1000 ) Achieve( "100million" );
if( m_worker.GetCallstackSampleCount() > 0 ) Achieve( "samplingIntro" );
if( m_worker.AreFramesUsed() ) Achieve( "instrumentFrames" );
}
Attention( m_attnWorking );