carb/profiler/IProfiler.h

↰ Parent directory: carb/profiler/

carb::profiler interface definition file.

Source: carb/profiler/IProfiler.h

Included By

• carb/thread/Util.h: Carbonite thread utilities.

• carb/profiler/Profile.h: carb::profiler macros and helpers

• carb/profiler/ProfilerUtils.h: carb::profiler helper utilities.

Namespaces

• carb: The main Carbonite namespace.

• carb::profiler: Namespace for carb.profiler and related utilities.

Classes

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

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.

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::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.

• g_carbProfiler: Global pointer used to store the carb::profiler::IProfiler interface.

• g_carbProfilerMask: A global variable used as a cache for the result of carb::profiler::IProfiler::getCaptureMask().