mirror of
https://github.com/wolfpld/tracy.git
synced 2026-10-23 01:00:54 +00:00
Polish the achievement texts.
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# First profiling session
|
||||
|
||||
Let's start our adventure by instrumenting your application and connecting it to the profiler. Here's a quick refresher:
|
||||
Let's start our adventure by instrumenting your application and connecting it to the profiler. Here's what you need to do:
|
||||
|
||||
1. Integrate Tracy Profiler into your application. This can be done using CMake, Meson, or simply by adding the source files to your project.
|
||||
2. Make sure that `TracyClient.cpp` is added to your build, or that the Tracy library is linked.
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# Find some zones
|
||||
|
||||
To find a zone, open the search window with the * Find zone* button on the top bar and type in the zone name — in most cases the function name in the code.
|
||||
To find a zone, open the Find zone window with the * Find* button on the top bar and type in the zone name — in most cases the function name in the code.
|
||||
|
||||
1. If several zones share the name, a list of matches is shown. Select the one you're looking for.
|
||||
2. Selecting a zone shows its statistics (call count, total time, and more) and a histogram of execution times.
|
||||
2. The window shows a histogram of execution times, along with statistics such as total time, mean, and median.
|
||||
3. Drag a range on the histogram to filter the zone list below to just the entries within that range.
|
||||
4. Pick one of the zone groupings to highlight that group's time on the histogram.
|
||||
|
||||
|
||||
@@ -19,4 +19,4 @@ When you profile your application, you will see a new frame appear on the timeli
|
||||
|
||||
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.
|
||||
|
||||
Note that some applications do not have a frame-based structure, and in such cases, frame instrumentation may not be useful. That's ok.
|
||||
Note that some applications do not have a frame-based structure, and in such cases, frame instrumentation may not be useful. That's OK.
|
||||
|
||||
@@ -19,6 +19,6 @@ Now, when you profile your application, you will see a new zone appear on the ti
|
||||
> [!NOTE]
|
||||
> **Note**
|
||||
>
|
||||
> The `ZoneScoped` macro is just one of the many macros provided by Tracy. See the documentation for more information.
|
||||
> The `ZoneScoped` macro is just one of the many macros provided by Tracy. See the manual for more information.
|
||||
|
||||
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.
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
Once you have instrumented your application, you can view the statistics for each zone in the timeline. This allows you to see how much time is spent in each zone and how many times it is called.
|
||||
|
||||
To view the statistics, click on the * Statistics* button on the top bar. This will open a new window with a list of all zones in the trace.
|
||||
To view the statistics, click on the * Statistics* button on the top bar. This opens the Statistics window, which lists every zone name in the trace.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Read the manual
|
||||
|
||||
Tracy ships with a built-in user manual that describes all of its features. You can open it by clicking the * Manual* icon in the top toolbar of the profiler window.
|
||||
Tracy ships with a built-in user manual that describes all of its features. You can open it by clicking the * Manual* button in the top toolbar of the profiler window or on the welcome screen.
|
||||
|
||||
It's an alternative to external documentation — always available offline, and it covers everything from basic instrumentation to advanced sampling and memory profiling.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user