Document plotting

master
Marc Gilleron 2021-05-29 19:06:02 +01:00
parent d2d07904b8
commit c657eefca1
1 changed files with 10 additions and 0 deletions

View File

@ -252,6 +252,16 @@ void some_function() {
By default scopes take the name of the function, or file and a line number, but you can give a name explicitely using `VOXEL_PROFILE_SCOPE_NAMED("Hello")`. Only compile-time strings are supported, don't use `String` or `std::string`.
It is also possible to plot numeric values so they are displayed in the timeline too:
```cpp
void process_every_frame() {
// Some code...
VOXEL_PROFILE_PLOT("Bunnies", bunnies.size());
}
```
### Adding Tracy to Godot
To add Tracy support, clone it under `thirdparty/tracy` (Godot's `thirdparty` folder, not the voxel module), and add the following lines in `core/SCsub`: