From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../files/classphysx_1_1PxProfilerCallback.html | 181 +++++++++++++++++++++ 1 file changed, 181 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxProfilerCallback.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxProfilerCallback.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxProfilerCallback.html b/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxProfilerCallback.html new file mode 100644 index 00000000..0750a06a --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxProfilerCallback.html @@ -0,0 +1,181 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: physx::PxProfilerCallback Class Reference + + + + + + + +
physx::PxProfilerCallback +
+
+

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-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3