C++ guide and API reference#

Include isaacsim/common/profiling/Profiling.hpp and link isaacsim::common-profiling. Use Zone directly or the convenience macros in ProfileMacros.hpp to emit events only while the selected profiling mask is enabled.

API reference#

Fully qualified namespace: isaacsim::common::profiling

namespace profiling#

Classes Summary#

Zone

Movable RAII ownership for one admitted CPU zone.

Enumerations Summary#

InstantType

Timeline occupied by an instant event.

Functions Summary#

void flow(bool begin, std::uint64_t identifier, std::string_view name={}, Mask mask=0, SourceLocation location=makeSourceLocation()) noexcept

Emit one endpoint of a cross-thread flow.

void frame(std::string_view name, Mask mask=0) noexcept

Emit a frame marker for the calling thread.

void instant(std::string_view name, InstantType type=InstantType::eThread, Mask mask=0, SourceLocation location=makeSourceLocation()) noexcept

Emit an instant event.

bool isEnabled(Mask mask=0) noexcept

Return whether the attached Carbonite profiler admits the selected mask.

SourceLocation makeSourceLocation(const char *file=nullptr, const char *function=nullptr, std::uint32_t line=0) noexcept

Create source metadata for one event.

void setThreadName(std::string_view name) noexcept

Assign a profiler-visible name to the calling thread.

void value(std::string_view name, std::int32_t selected, Mask mask=0) noexcept

Emit a signed integer value.

void value(std::string_view name, float selected, Mask mask=0) noexcept

Emit a floating-point value.

Typedefs Summary#