Open 3D Engine Profiler Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | List of all members
Profiler::ImGuiTreemapFactory Class Referenceabstract

#include <ImGuiTreemap.h>

Inherited by Profiler::ImGuiTreemapFactoryImpl.

Public Types

using Interface = AZ::Interface< ImGuiTreemapFactory >
 

Public Member Functions

 AZ_RTTI (ImGuiTreemapFactory, "{90BCA753-6152-4942-8A81-DD14196A6811}")
 
virtual ImGuiTreemap & Create (AZ::Name name, const char *unitLabel)=0
 
virtual void Destroy (ImGuiTreemap *treemap)=0
 

Detailed Description

Usage: Create a treemap using the factory interface like so: Profiler::ImGuiTreemapFactory::Interface::Get()->Create(AZ::Name{ "My Treemap" }, "MiB"); When you no longer need the treemap, pass the created treemap to the Destroy method.

Member Function Documentation

◆ Create()

virtual ImGuiTreemap& Profiler::ImGuiTreemapFactory::Create ( AZ::Name  name,
const char *  unitLabel 
)
pure virtual

Create an ImGuiTreemap with managed lifetime given the specified name and unit label (threadsafe)

Parameters
nameTreemap name (shows up in the UI titlebar)
unitLabelUnit label This shows up after node weights are displayed, e.g. "382 degrees centigrade" if unitLabel == "degrees centigrade" and the node weight is 382)

Implemented in Profiler::ImGuiTreemapFactoryImpl.

◆ Destroy()

virtual void Profiler::ImGuiTreemapFactory::Destroy ( ImGuiTreemap *  treemap)
pure virtual

Destroys a previously created treemap (threadsafe)

Parameters
treemapPointer to the treemap created previously

Implemented in Profiler::ImGuiTreemapFactoryImpl.

The documentation for this class was generated from the following file: