Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bombomby/optick
C++ Profiler For Games
https://github.com/bombomby/optick
c-plus-plus games performance profiler
Last synced: 2 days ago
JSON representation
C++ Profiler For Games
- Host: GitHub
- URL: https://github.com/bombomby/optick
- Owner: bombomby
- License: mit
- Created: 2015-01-17T13:37:17.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-25T15:51:48.000Z (8 months ago)
- Last Synced: 2024-10-29T15:09:16.197Z (2 months ago)
- Topics: c-plus-plus, games, performance, profiler
- Language: C#
- Homepage: https://optick.dev
- Size: 78 MB
- Stars: 2,933
- Watchers: 66
- Forks: 294
- Open Issues: 84
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-unreal - optick - C++ Profiler For Games (Tools)
- programming-awesome-list - optick
- AwesomeCppGameDev - optick
README
# [Optick: C++ Profiler For Games](https://optick.dev)
 
Optick is a super-lightweight C++ profiler for Games.
It provides access for all the necessary tools required for efficient performance analysis and optimization:
instrumentation, switch-contexts, sampling, GPU counters.
> Looking for 'Brofiler'? It has been renamed to 'Optick', so you are in the right place.
## Build Status
| Windows (x64: msvc) | Linux (x64: clang, gcc) | MacOS (x64: clang, gcc) | Static Code Analysis |
| ------- | ----- | ----- | --------------------- |
| [](https://ci.appveyor.com/project/bombomby/optick) | [](https://travis-ci.org/bombomby/optick) | [](https://travis-ci.org/bombomby/optick) | [](https://lgtm.com/projects/g/bombomby/optick/alerts/) [](https://www.codacy.com/app/bombomby/optick?utm_source=github.com&utm_medium=referral&utm_content=bombomby/optick&utm_campaign=Badge_Grade) |
| Features | Windows | Linux | MacOS | XBox | PS4 | UE4 |
| -------- | ------- | ----- | ----- | ---- | --- | --- |
| Instrumentation | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :grey_question: | :heavy_check_mark: |
| Switch Contexts | :heavy_check_mark: ETW | :heavy_check_mark: FTrace | :heavy_check_mark: DTrace | :heavy_check_mark: | :grey_question: | :heavy_check_mark: Win |
| Sampling | :heavy_check_mark: ETW | | | :grey_question: | :grey_question: | :heavy_check_mark: Win |
| GPU | :heavy_check_mark: D3D12, Vulkan | :heavy_check_mark: Vulkan | :heavy_check_mark: Vulkan | | | :hourglass_flowing_sand: |
:heavy_check_mark: - works out of the box, :hourglass_flowing_sand: - in progress, :grey_question: - coming soon for the certified developers
## List of Games and Studios using Optick(Brofiler)
   
   
## Video Tutorial
[](https://www.youtube.com/watch?v=p57TV5342fo)
## Basic Integration (one line of code)
1) Copy 'src' folder from the repository or latest release to your game project
2) Add `OPTICK_FRAME("MainThread");` macro to the main loop of your game and `#include "optick.h"` header
```c++
#include "optick.h"
...
while( true )
{
OPTICK_FRAME("MainThread");
engine.Update();
}
```
3) Use `OPTICK_EVENT();` macro to instrument a function
```c++
void SlowFunction()
{
OPTICK_EVENT();
...
}
```
4) Add `OPTICK_THREAD("Name");` macro to declare a new thread with Optick
```c++
void WorkerThread(...)
{
OPTICK_THREAD("Worker");
while (isRunning)
{
...
}
}
```
5) Edit `optick.config.h` to enable/disable some of the features in specific configs or platforms.
(e.g. disabling Optick in final builds)
> :warning: If your Game uses **dynamic linking** and you are planning to **use Optick from multiple dlls** within the same executable - please make sure that Optick's code is added to the common **Dynamic Library** and this library is compiled with **OPTICK_EXPORT** define (Static Library won't work).
> You could also use precompiled **OptickCore.dll** which is packaged with every release:
> - Add `include` folder to the extra include dirs of your project
> - Add `lib/x64/debug` and `lib/x64/release` to the extra library dirs of your project
> - Copy `lib/x64/debug/OptickCore.dll` and `lib/x64/release/OptickCore.dll` to the debug and release output folders of your project respectively
## API
All the available API calls are documented here:
https://github.com/bombomby/optick/wiki/Optick-API
## Unreal Engine
Optick provides a special plugin for UE4. Check more detailed documentation here:
https://github.com/bombomby/optick/wiki/UE4-Optick-Plugin
https://github.com/bombomby/optick/wiki/UE5-Optick-Plugin
## Samples
Run [GenerateProjects_gpu.bat](https://github.com/bombomby/optick/blob/master/tools/GenerateProjects_gpu.bat) to generate project files. To compile the samples you'll need to install VulkanSDK. Alternatively you could use [GenerateProjects.bat](https://github.com/bombomby/optick/blob/master/tools/GenerateProjects.bat) to generate only minimal solution with ConsoleApp sample.
Open solution `build\vs2017\Optick.sln` with generated samples.
| [WindowsD3D12](https://github.com/bombomby/optick/tree/master/samples/WindowsD3D12) | [WindowsVulkan](https://github.com/bombomby/optick/tree/master/samples/WindowsVulkan) | [ConsoleApp](https://github.com/bombomby/optick/tree/master/samples/ConsoleApp) |
| ---------- | ------------ | ------------- |
|  |  |  |
| DirectX12 multithreading sample with Optick integration | SaschaWillems's vulkan multithreading sample with Optick integration | Basic ConsoleApp with Optick integration (Windows, Linux, MacOS) |
## Brofiler
Brofiler has been renamed into Optick starting from v1.2.0.
All the future development is going under the new name.
Cheatsheet for upgrading to the new version:
* `BROFILER_FRAME("MainThread");` => `OPTICK_FRAME("MainThread");`
* `BROFILER_THREAD("WorkerThread");` => `OPTICK_THREAD("WorkerThread");`
* `BROFILER_CATEGORY("Physics", Brofiler::Color::Green);` => `OPTICK_CATEGORY("Physics", Optick::Category::Physics);`
* `BROFILER_EVENT(NAME);` => `OPTICK_EVENT(NAME);`
* `PROFILE;` => `OPTICK_EVENT();`
## How To Start?
You can find a short instruction here:
https://github.com/bombomby/optick/wiki/How-to-start%3F-(Programmers-Setup)