Open 3D Engine Profiler Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Attributes | Friends | List of all members
Profiler::TreemapNode Struct Reference

#include <ImGuiTreemap.h>

Public Attributes

AZ::Name m_name
 The name of the treemap node.
 
AZ::Name m_group
 
AZStd::string m_tooltip
 If left empty, a tooltip will be automatically generated containing the name and weight (with associated unit label)
 
float m_weight = 0.f
 
uint32_t m_tag = 0
 
AZStd::vector< TreemapNode > m_children
 Count and pointer to an array of m_childCount children. May be left default-initialized for leaf nodes.
 

Friends

class ImGuiTreemapImpl
 

Detailed Description

TreemapNodes support arbitrary child counts and nesting levels. Each node will show up in the final visualization with an area proportional to the node's weight.

Member Data Documentation

◆ m_group

AZ::Name Profiler::TreemapNode::m_group

Nodes may be classified by an additional group label, which may be used to color the node in the final visualization. For example, you might want to highlight all blocks in a treemap that are a particular filetype, or show "Texture2D" allocations as the same color.

◆ m_tag

uint32_t Profiler::TreemapNode::m_tag = 0

ADVANCED The tag can be used to filter this node from displaying or not in the visualization. For example, we may tag all unused memory regions as 0x1, and later use a mask of 0x0 to omit unused memory from the display. By default, all nodes are shown (0xffffffff mask). To show select nodes, use the ImGuiTreemap::AddMask method to set a mask to a particular label. The expression to determine if a node should be included or not is (mask & m_tag > 0). That is, this node will be shown if any of the mask bits coincide with any of the tag bits.

◆ m_weight

float Profiler::TreemapNode::m_weight = 0.f

The weight must be positive definite and should only be specified on the leaves (e.g. m_children is nullptr) The weight may be specified on parent nodes (e.g. to assist in weight normalization of the leaves) but note that this value will be overwritten

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