PxProfilerCallback

Defined in include/foundation/PxProfiler.h

class PxProfilerCallback

The pure virtual callback interface for general purpose instrumentation and profiling of GameWorks modules as well as applications.

Public Functions

virtual void *zoneStart(const char *eventName, bool detached, uint64_t contextId) = 0

Mark the beginning of a nested profile block.

Parameters

  • eventName – [in] Event name. Must be a persistent const char *

  • detached – [in] True for cross thread events

  • contextId – [in] the context id of this zone. Zones with the same id belong to the same group. 0 is used for no specific group.

Returns

Returns implementation-specific profiler data for this event

virtual void zoneEnd(void *profilerData, const char *eventName, bool detached, uint64_t contextId) = 0

Mark the end of a nested profile block.

Note

eventName plus contextId can be used to uniquely match up start and end of a zone.

Parameters

  • profilerData – [in] The data returned by the corresponding zoneStart call (or NULL if not available)

  • eventName – [in] The name of the zone ending, must match the corresponding name passed with ‘zoneStart’. Must be a persistent const char *.

  • detached – [in] True for cross thread events. Should match the value passed to zoneStart.

  • contextId – [in] The context of this zone. Should match the value passed to zoneStart.

Protected Functions

inline virtual ~PxProfilerCallback()