Skip to content

APerformanceSection#

Defines performance profiling named (and colored) span within RAII range.

Header:#include <AUI/Performance/APerformanceSection.h>
CMake:aui_link(my_target PUBLIC aui::core)

Public Types#

Data#

struct APerformanceSection::Data

Empty structure.

Public Methods#

constructor#

APerformanceSection::APerformanceSection(const char* name, AOptional<AColor> color = std::nullopt, std::string verboseInfo = { })

Defines performance profiling named (and colored) span within RAII range.

Arguments
name
name of the section. Since it is a C-style string, it must be alive during the whole lifetime of the program. Typically, you would want to use string literals. C-style string is used to avoid performance overhead.
color
color of the section. If nullopt, it would be generated from name.
verboseInfo
extra usefull information that displayed in tree view in paused mode.
APerformanceSection::APerformanceSection(const char* name, AOptional<AColor> color = std::nullopt, std::string verboseInfo = { })

Defines performance profiling named (and colored) span within RAII range.

Arguments
name
name of the section. Since it is a C-style string, it must be alive during the whole lifetime of the program. Typically, you would want to use string literals. C-style string is used to avoid performance overhead.
color
color of the section. If nullopt, it would be generated from name.
verboseInfo
extra usefull information that displayed in tree view in paused mode.