mirror/tracy
1
0
Fork 0
mirror of https://github.com/wolfpld/tracy.git synced 2024-09-20 05:42:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Finish instrumentation intro achievement description.

Browse Source
This commit is contained in:
Bartosz Taudul 2024-06-08 13:10:04 +02:00
parent e09379bd16
commit 03e9c89dd8
No known key found for this signature in database
GPG Key ID: B7FE2008B7575DF3
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,14 +1,37 @@
#include "IconsFontAwesome6.h" #include "IconsFontAwesome6.h"
#include "TracyAchievements.hpp" #include "TracyAchievements.hpp"
#include "TracyImGui.hpp" #include "TracyImGui.hpp"
#include "TracySourceContents.hpp"
#include "TracyWeb.hpp" #include "TracyWeb.hpp"
namespace tracy::data namespace tracy::data
{ {
AchievementItem ai_instrumentationIntro = { "instrumentationIntro", "Instrumentation", [](const ctx&){ AchievementItem ai_instrumentationIntro = { "instrumentationIntro", "Instrumentation", [](const ctx& c){
constexpr const char* src = R"(#include "Tracy.hpp"
void SomeFunction()
{
ZoneScoped;
// Your code here
}
)";
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( "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::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 );
PrintSource( sc.get() );
ImGui::PopFont();
ImGui::TextWrapped( "Now, when you profile your application, you will see a new zone appear on the timeline for each call to the function. This allows you to see how much time is spent in each call and how many times the function is called." );
ImGui::PushFont( c.small );
ImGui::PushStyleColor( ImGuiCol_Text, 0xFF888888 );
ImGui::TextWrapped( "Note: The ZoneScoped macro is just one of the many macros provided by Tracy. See the documentation for more information." );
ImGui::TextWrapped( "The above description applies to C++ code, but things are done similarly in other programming languages. Refer to the documentation for your language for more information." );
ImGui::PopStyleColor();
ImGui::PopFont();
} }; } };
AchievementItem* ac_instrumentationItems[] = { &ai_instrumentationIntro, nullptr }; AchievementItem* ac_instrumentationItems[] = { &ai_instrumentationIntro, nullptr };