# GodotTracy

**Repository Path**: DannyJones/GodotTracy

## Basic Information

- **Project Name**: GodotTracy
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: 3.5.x
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-07
- **Last Updated**: 2024-11-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GodotTracy
[Tracy Profiler](https://github.com/wolfpld/tracy) module for the [Godot Engine](https://github.com/godotengine/godot)

![](godot_tracy_screenshot.png)

`git clone --recurse-submodules https://github.com/Pineapple/GodotTracy.git`

Copy `godot_tracy` folder to modules folder in Godot sources.

Add `module_godot_tracy_enabled=true` to your SCons command to build with Tracy enabled.

Get Tracy documentation and profiler binary from [releases page](https://github.com/wolfpld/tracy/releases/).

## Example how to add Tracy instrumentation in Godot

In every file where you call Tracy functions add `#include "modules/godot_tracy/profiler.h"`

Add `FrameMark;` in platform specific loop to mark the boundaries of the frames. On Windows it's inside `OS_Windows::run()` in `platform/windows/os_windows.cpp`

![](godot_os_windows.png)

Add `ZoneScopedN("Text visible in Tracy");` inside the functions you want to profile in Tracy.

![](godot_main.png)