carb::profiler

Namespace for carb.profiler and related utilities.

Classes

• carb::profiler::IProfileMonitor: Defines an interface to monitor profiling events.

• carb::profiler::IProfiler: Defines the profiler system that is associated with the carb::Framework.

• carb::profiler::ProfileEvent: A struct describing a specific profiling event.

• carb::profiler::Channel: Profiler channel which can be configured via ISettings.

• carb::profiler::ProfiledMutex: Wrapper to add automatic profiling to a mutex.

• carb::profiler::ProfiledSharedMutex: Wrapper to add automatic profiling to a shared mutex.

• carb::profiler::ProfileZoneDynamic: Helper class that allows to automatically stop profiling upon leaving block.

• carb::profiler::ProfileZoneStatic: Helper class that allows to automatically stop profiling upon leaving block.

Enums

• carb::profiler::FlowType: The type of flow event passed to IProfiler::emitFlowStatic() / IProfiler::emitFlowDynamic(). Typically used only by profiler macros.

• carb::profiler::InstantType: The type of instant event passed to IProfiler::emitInstantStatic() / IProfiler::emitInstantDynamic().

• carb::profiler::LockableOperationType: The type of lockable operation event.

Functions

• carb::profiler::deregisterProfilerForClient: Clears the g_carbProfiler global variable and unregisters load and release hooks with the carb::Framework.

• carb::profiler::getProfiler: Allows access to the g_carbProfiler global variable previously registered with carb::profiler::registerProfilerForClient.

• carb::profiler::registerProfilerForClient: Acquires the default carb::profiler::IProfiler interface and assigns it to the g_carbProfiler global variable.

Typedefs

• carb::profiler::GpuContextId: ID for a GPU context created with IProfiler::createGpuContext.

• carb::profiler::LockableId: ID for a Lockable context created with IProfiler::createLockable.

• carb::profiler::MaskCallbackFn: A callback used for IProfiler::setMaskCallback(). Typically handled automatically by carb::profiler::registerProfilerForClient.

• carb::profiler::ProfileEvents: An opaque pointer used by carb::profiler::IProfileMonitor.

• carb::profiler::StaticStringType: A type representing a static string returned by IProfiler::registerStaticString().

• carb::profiler::ZoneId: An opaque ID returned by IProfiler::beginStatic() / IProfiler::beginDynamic() that should be returned in IProfiler::endEx() to validate that the zone was closed properly.

Variables

• carb::profiler::kCaptureMaskAll: Captures all events.

• carb::profiler::kCaptureMaskDefault: If zero is provided to an event function, it becomes this.

• carb::profiler::kCaptureMaskNone: Captures no events, effectively disabling the profiler.

• carb::profiler::kCaptureMaskProfiler: The mask used by the profiler for profiling itself.

• carb::profiler::kInvalidGpuContextId: Special value to indicate that a GPU context ID is invalid.

• carb::profiler::kInvalidLockableId: Special value to indicate that a LockableId is invalid.

• carb::profiler::kInvalidStaticString: Returned as an error by IProfiler::registerStaticString() if the string could not be registered.

• carb::profiler::kNoZoneId: A marker returned by IProfiler::beginStatic() / IProfiler::beginDynamic() to indicate that the zone should be discarded, typically because it doesn’t match the current capture mask.

• carb::profiler::kUnknownZoneId: A marker that is returned IProfiler::beginStatic() / IProfiler::beginDynamic() on error and can be passed to IProfiler::endEx() to prevent zone validation checking.