Awesome

Optick: C++ Profiler For Games

<br/> Optick is a super-lightweight C++ profiler for Games.<br/> It provides access for all the necessary tools required for efficient performance analysis and optimization:<br/> instrumentation, switch-contexts, sampling, GPU counters.<br/>

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

: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

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

#include "optick.h"
...
while( true ) 
{
	OPTICK_FRAME("MainThread");
	engine.Update();
}

3. Use OPTICK_EVENT(); macro to instrument a function

void SlowFunction()
{ 
	OPTICK_EVENT();
	...
}

4. Add OPTICK_THREAD("Name"); macro to declare a new thread with Optick

void WorkerThread(...)
{
	OPTICK_THREAD("Worker");
	while (isRunning)
	{
		...
	}
}

5. Edit optick.config.h to enable/disable some of the features in specific configs or platforms.<br/>(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).<br/> 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:<br/> https://github.com/bombomby/optick/wiki/Optick-API

Unreal Engine

Optick provides a special plugin for UE4. Check more detailed documentation here: <br/> https://github.com/bombomby/optick/wiki/UE4-Optick-Plugin <br/> https://github.com/bombomby/optick/wiki/UE5-Optick-Plugin <br/>

Samples

Run GenerateProjects_gpu.bat to generate project files. To compile the samples you'll need to install VulkanSDK. Alternatively you could use GenerateProjects.bat to generate only minimal solution with ConsoleApp sample.<br/> Open solution build\vs2017\Optick.sln with generated samples.

WindowsD3D12	WindowsVulkan	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.<br/> All the future development is going under the new name.<br/> 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:<br/> https://github.com/bombomby/optick/wiki/How-to-start%3F-(Programmers-Setup)