1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: physx::PxProfilerCallback Class Reference</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
</head>
<body bgcolor="#FFFFFF">
<div id="header">
<hr class="first">
<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
<center>
<a class="qindex" href="main.html">Main Page</a>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navpath"><a class="el" href="namespacephysx.html">physx</a>::<a class="el" href="classphysx_1_1PxProfilerCallback.html">PxProfilerCallback</a>
</div>
<div class="contents">
<h1>physx::PxProfilerCallback Class Reference</h1><!-- doxytag: class="physx::PxProfilerCallback" -->The pure virtual callback interface for general purpose instrumentation and profiling of GameWorks modules as well as applications.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxProfiler_8h-source.html">PxProfiler.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for physx::PxProfilerCallback:</div>
<div class="dynsection">
<p><center><img src="classphysx_1_1PxProfilerCallback__inherit__graph.png" border="0" usemap="#physx_1_1PxProfilerCallback__inherit__map" alt="Inheritance graph"></center>
<map name="physx_1_1PxProfilerCallback__inherit__map">
<area shape="rect" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface..." alt="PxPvd" coords="60,85,108,107"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classphysx_1_1PxProfilerCallback-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxProfilerCallback.html#c56a58ecceddf722cc977b60d2dd04e9">zoneStart</a> (const char *eventName, bool detached, uint64_t contextId)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mark the beginning of a nested profile block. <a href="#c56a58ecceddf722cc977b60d2dd04e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxProfilerCallback.html#44a5930843bb99af0264a6872cc120cb">zoneEnd</a> (void *profilerData, const char *eventName, bool detached, uint64_t contextId)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mark the end of a nested profile block. <a href="#44a5930843bb99af0264a6872cc120cb"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxProfilerCallback.html#1ba891db352394fcb7c3ccfcce066643">~PxProfilerCallback</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The pure virtual callback interface for general purpose instrumentation and profiling of GameWorks modules as well as applications. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1ba891db352394fcb7c3ccfcce066643"></a><!-- doxytag: member="physx::PxProfilerCallback::~PxProfilerCallback" ref="1ba891db352394fcb7c3ccfcce066643" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual physx::PxProfilerCallback::~PxProfilerCallback </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="44a5930843bb99af0264a6872cc120cb"></a><!-- doxytag: member="physx::PxProfilerCallback::zoneEnd" ref="44a5930843bb99af0264a6872cc120cb" args="(void *profilerData, const char *eventName, bool detached, uint64_t contextId)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void physx::PxProfilerCallback::zoneEnd </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>profilerData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>eventName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>detached</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"> <em>contextId</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Mark the end of a nested profile block.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>profilerData</em> </td><td>The data returned by the corresponding zoneStart call (or NULL if not available) </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>eventName</em> </td><td>The name of the zone ending, must match the corresponding name passed with 'zoneStart'. Must be a persistent const char *. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>detached</em> </td><td>True for cross thread events. Should match the value passed to zoneStart. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>contextId</em> </td><td>The context of this zone. Should match the value passed to zoneStart.</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>eventName plus contextId can be used to uniquely match up start and end of a zone. </dd></dl>
<p>Referenced by <a class="el" href="PxProfiler_8h-source.html#l00085">physx::PxProfileScoped::~PxProfileScoped()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c56a58ecceddf722cc977b60d2dd04e9"></a><!-- doxytag: member="physx::PxProfilerCallback::zoneStart" ref="c56a58ecceddf722cc977b60d2dd04e9" args="(const char *eventName, bool detached, uint64_t contextId)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* physx::PxProfilerCallback::zoneStart </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>eventName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>detached</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"> <em>contextId</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Mark the beginning of a nested profile block.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>eventName</em> </td><td>Event name. Must be a persistent const char * </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>detached</em> </td><td>True for cross thread events </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>contextId</em> </td><td>the context id of this zone. Zones with the same id belong to the same group. 0 is used for no specific group. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns implementation-specific profiler data for this event </dd></dl>
<p>Referenced by <a class="el" href="PxProfiler_8h-source.html#l00074">physx::PxProfileScoped::PxProfileScoped()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxProfiler_8h-source.html">PxProfiler.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>
|