physx::PxProfilerCallback Class Reference

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

#include <PxProfiler.h>

Inheritance diagram for physx::PxProfilerCallback:

Inheritance graph
PxPvd
[legend]

List of all members.

Public Member Functions

virtual void * zoneStart (const char *eventName, bool detached, uint64_t contextId)=0
 Mark the beginning of a nested profile block.
virtual void zoneEnd (void *profilerData, const char *eventName, bool detached, uint64_t contextId)=0
 Mark the end of a nested profile block.

Protected Member Functions

virtual ~PxProfilerCallback ()


Detailed Description

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

Constructor & Destructor Documentation

virtual physx::PxProfilerCallback::~PxProfilerCallback (  )  [inline, protected, virtual]


Member Function Documentation

virtual void physx::PxProfilerCallback::zoneEnd ( void *  profilerData,
const char *  eventName,
bool  detached,
uint64_t  contextId 
) [pure virtual]

Mark the end of a nested profile block.

Parameters:
[in] profilerData The data returned by the corresponding zoneStart call (or NULL if not available)
[in] eventName The name of the zone ending, must match the corresponding name passed with 'zoneStart'. Must be a persistent const char *.
[in] detached True for cross thread events. Should match the value passed to zoneStart.
[in] contextId The context of this zone. Should match the value passed to zoneStart.
Note:
eventName plus contextId can be used to uniquely match up start and end of a zone.

Referenced by physx::PxProfileScoped::~PxProfileScoped().

virtual void* physx::PxProfilerCallback::zoneStart ( const char *  eventName,
bool  detached,
uint64_t  contextId 
) [pure virtual]

Mark the beginning of a nested profile block.

Parameters:
[in] eventName Event name. Must be a persistent const char *
[in] detached True for cross thread events
[in] contextId 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

Referenced by physx::PxProfileScoped::PxProfileScoped().


The documentation for this class was generated from the following file:


Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com