aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxProfiler_8h-source.html
blob: a678b080542d778010c1a703cd539667ed399d57 (plain) (blame)
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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxProfiler.h Source File</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> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<h1>PxProfiler.h</h1><a href="PxProfiler_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// Redistribution and use in source and binary forms, with or without</span>
<a name="l00003"></a>00003 <span class="comment">// modification, are permitted provided that the following conditions</span>
<a name="l00004"></a>00004 <span class="comment">// are met:</span>
<a name="l00005"></a>00005 <span class="comment">//  * Redistributions of source code must retain the above copyright</span>
<a name="l00006"></a>00006 <span class="comment">//    notice, this list of conditions and the following disclaimer.</span>
<a name="l00007"></a>00007 <span class="comment">//  * Redistributions in binary form must reproduce the above copyright</span>
<a name="l00008"></a>00008 <span class="comment">//    notice, this list of conditions and the following disclaimer in the</span>
<a name="l00009"></a>00009 <span class="comment">//    documentation and/or other materials provided with the distribution.</span>
<a name="l00010"></a>00010 <span class="comment">//  * Neither the name of NVIDIA CORPORATION nor the names of its</span>
<a name="l00011"></a>00011 <span class="comment">//    contributors may be used to endorse or promote products derived</span>
<a name="l00012"></a>00012 <span class="comment">//    from this software without specific prior written permission.</span>
<a name="l00013"></a>00013 <span class="comment">//</span>
<a name="l00014"></a>00014 <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY</span>
<a name="l00015"></a>00015 <span class="comment">// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00016"></a>00016 <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span>
<a name="l00017"></a>00017 <span class="comment">// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR</span>
<a name="l00018"></a>00018 <span class="comment">// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span>
<a name="l00019"></a>00019 <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span>
<a name="l00020"></a>00020 <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<a name="l00021"></a>00021 <span class="comment">// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY</span>
<a name="l00022"></a>00022 <span class="comment">// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<a name="l00023"></a>00023 <span class="comment">// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
<a name="l00024"></a>00024 <span class="comment">// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00025"></a>00025 <span class="comment">//</span>
<a name="l00026"></a>00026 <span class="comment">// Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef PXFOUNDATION_PXPROFILER_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define PXFOUNDATION_PXPROFILER_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="PxFoundation_8h.html">foundation/PxFoundation.h</a>"</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">namespace </span>physx
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 
<a name="l00040"></a><a class="code" href="classphysx_1_1PxProfilerCallback.html">00040</a> <span class="keyword">class </span><a class="code" href="classphysx_1_1PxProfilerCallback.html" title="The pure virtual callback interface for general purpose instrumentation and profiling...">PxProfilerCallback</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">protected</span>:
<a name="l00043"></a><a class="code" href="classphysx_1_1PxProfilerCallback.html#1ba891db352394fcb7c3ccfcce066643">00043</a>     <span class="keyword">virtual</span> <a class="code" href="classphysx_1_1PxProfilerCallback.html#1ba891db352394fcb7c3ccfcce066643">~PxProfilerCallback</a>()   {}
<a name="l00044"></a>00044 
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00046"></a>00046     <span class="comment">/**************************************************************************************************************************</span>
<a name="l00047"></a>00047 <span class="comment">    Instrumented profiling events</span>
<a name="l00048"></a>00048 <span class="comment">    ***************************************************************************************************************************/</span>
<a name="l00049"></a>00049 
<a name="l00057"></a>00057     <span class="keyword">virtual</span> <span class="keywordtype">void</span>* <a class="code" href="classphysx_1_1PxProfilerCallback.html#c56a58ecceddf722cc977b60d2dd04e9" title="Mark the beginning of a nested profile block.">zoneStart</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* eventName, <span class="keywordtype">bool</span> detached, uint64_t contextId) = 0;
<a name="l00058"></a>00058 
<a name="l00068"></a>00068     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classphysx_1_1PxProfilerCallback.html#44a5930843bb99af0264a6872cc120cb" title="Mark the end of a nested profile block.">zoneEnd</a>(<span class="keywordtype">void</span>* profilerData, <span class="keyword">const</span> <span class="keywordtype">char</span>* eventName, <span class="keywordtype">bool</span> detached, uint64_t contextId) = 0;
<a name="l00069"></a>00069 };
<a name="l00070"></a>00070 
<a name="l00071"></a><a class="code" href="classphysx_1_1PxProfileScoped.html">00071</a> <span class="keyword">class </span><a class="code" href="classphysx_1_1PxProfileScoped.html">PxProfileScoped</a>
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073   <span class="keyword">public</span>:
<a name="l00074"></a><a class="code" href="classphysx_1_1PxProfileScoped.html#7aa2be3e529c68553421da54ef8ecb2c">00074</a>     <a class="code" href="group__foundation.html#g6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="code" href="classphysx_1_1PxProfileScoped.html#7aa2be3e529c68553421da54ef8ecb2c">PxProfileScoped</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* eventName, <span class="keywordtype">bool</span> detached, uint64_t contextId) : <a class="code" href="classphysx_1_1PxProfileScoped.html#42e4610fe823cf0f96f71338859bd1ea">mCallback</a>(<a class="code" href="group__foundation.html#g0fb72a858fd527761dbe042cb4adbbe6" title="Get the callback that will be used for all profiling.">PxGetProfilerCallback</a>()), <a class="code" href="classphysx_1_1PxProfileScoped.html#ce0e4bb97a41a567d2221e2381273131">mProfilerData</a>(NULL)
<a name="l00075"></a>00075     {
<a name="l00076"></a>00076         <span class="keywordflow">if</span>(<a class="code" href="classphysx_1_1PxProfileScoped.html#42e4610fe823cf0f96f71338859bd1ea">mCallback</a>)
<a name="l00077"></a>00077         {
<a name="l00078"></a>00078             <a class="code" href="classphysx_1_1PxProfileScoped.html#12ddb6b683d02a2b43a688c355fd9b08">mEventName</a>      = eventName;
<a name="l00079"></a>00079             <a class="code" href="classphysx_1_1PxProfileScoped.html#567ba4c44f861d0d1fe3bd5c60b48f25">mContextId</a>      = contextId;
<a name="l00080"></a>00080             <a class="code" href="classphysx_1_1PxProfileScoped.html#04efa3a9cbbdb80a3db35a5d2a1dfba6">mDetached</a>       = detached;
<a name="l00081"></a>00081             <a class="code" href="classphysx_1_1PxProfileScoped.html#ce0e4bb97a41a567d2221e2381273131">mProfilerData</a>   = <a class="code" href="classphysx_1_1PxProfileScoped.html#42e4610fe823cf0f96f71338859bd1ea">mCallback</a>-&gt;<a class="code" href="classphysx_1_1PxProfilerCallback.html#c56a58ecceddf722cc977b60d2dd04e9" title="Mark the beginning of a nested profile block.">zoneStart</a>(eventName, detached, contextId);
<a name="l00082"></a>00082         }
<a name="l00083"></a>00083     }
<a name="l00084"></a>00084 
<a name="l00085"></a><a class="code" href="classphysx_1_1PxProfileScoped.html#9ac116464c96060c48afe899f125f367">00085</a>     <a class="code" href="group__foundation.html#g6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="code" href="classphysx_1_1PxProfileScoped.html#9ac116464c96060c48afe899f125f367">~PxProfileScoped</a>()
<a name="l00086"></a>00086     {
<a name="l00087"></a>00087         <span class="keywordflow">if</span>(<a class="code" href="classphysx_1_1PxProfileScoped.html#42e4610fe823cf0f96f71338859bd1ea">mCallback</a>)
<a name="l00088"></a>00088             <a class="code" href="classphysx_1_1PxProfileScoped.html#42e4610fe823cf0f96f71338859bd1ea">mCallback</a>-&gt;<a class="code" href="classphysx_1_1PxProfilerCallback.html#44a5930843bb99af0264a6872cc120cb" title="Mark the end of a nested profile block.">zoneEnd</a>(<a class="code" href="classphysx_1_1PxProfileScoped.html#ce0e4bb97a41a567d2221e2381273131">mProfilerData</a>, <a class="code" href="classphysx_1_1PxProfileScoped.html#12ddb6b683d02a2b43a688c355fd9b08">mEventName</a>, <a class="code" href="classphysx_1_1PxProfileScoped.html#04efa3a9cbbdb80a3db35a5d2a1dfba6">mDetached</a>, <a class="code" href="classphysx_1_1PxProfileScoped.html#567ba4c44f861d0d1fe3bd5c60b48f25">mContextId</a>);
<a name="l00089"></a>00089     }
<a name="l00090"></a><a class="code" href="classphysx_1_1PxProfileScoped.html#42e4610fe823cf0f96f71338859bd1ea">00090</a>     <a class="code" href="classphysx_1_1PxProfilerCallback.html" title="The pure virtual callback interface for general purpose instrumentation and profiling...">physx::PxProfilerCallback</a>*  <a class="code" href="classphysx_1_1PxProfileScoped.html#42e4610fe823cf0f96f71338859bd1ea">mCallback</a>;
<a name="l00091"></a><a class="code" href="classphysx_1_1PxProfileScoped.html#12ddb6b683d02a2b43a688c355fd9b08">00091</a>     <span class="keyword">const</span> <span class="keywordtype">char</span>*                 <a class="code" href="classphysx_1_1PxProfileScoped.html#12ddb6b683d02a2b43a688c355fd9b08">mEventName</a>;
<a name="l00092"></a><a class="code" href="classphysx_1_1PxProfileScoped.html#ce0e4bb97a41a567d2221e2381273131">00092</a>     <span class="keywordtype">void</span>*                       <a class="code" href="classphysx_1_1PxProfileScoped.html#ce0e4bb97a41a567d2221e2381273131">mProfilerData</a>;
<a name="l00093"></a><a class="code" href="classphysx_1_1PxProfileScoped.html#567ba4c44f861d0d1fe3bd5c60b48f25">00093</a>     uint64_t                    <a class="code" href="classphysx_1_1PxProfileScoped.html#567ba4c44f861d0d1fe3bd5c60b48f25">mContextId</a>;
<a name="l00094"></a><a class="code" href="classphysx_1_1PxProfileScoped.html#04efa3a9cbbdb80a3db35a5d2a1dfba6">00094</a>     <span class="keywordtype">bool</span>                        <a class="code" href="classphysx_1_1PxProfileScoped.html#04efa3a9cbbdb80a3db35a5d2a1dfba6">mDetached</a>;
<a name="l00095"></a>00095 };
<a name="l00096"></a>00096 
<a name="l00097"></a>00097 } <span class="comment">// end of physx namespace</span>
<a name="l00098"></a>00098 
<a name="l00099"></a>00099 <span class="preprocessor">#if PX_DEBUG || PX_CHECKED || PX_PROFILE</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor">    #define PX_PROFILE_ZONE(x, y)                                       \</span>
<a name="l00101"></a>00101 <span class="preprocessor">        physx::PxProfileScoped PX_CONCAT(_scoped, __LINE__)(x, false, y)</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span><span class="preprocessor">    #define PX_PROFILE_START_CROSSTHREAD(x, y)                          \</span>
<a name="l00103"></a>00103 <span class="preprocessor">        if(PxGetProfilerCallback())                                     \</span>
<a name="l00104"></a>00104 <span class="preprocessor">            PxGetProfilerCallback()-&gt;zoneStart(x, true, y)</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span><span class="preprocessor">    #define PX_PROFILE_STOP_CROSSTHREAD(x, y)                           \</span>
<a name="l00106"></a>00106 <span class="preprocessor">        if(PxGetProfilerCallback())                                     \</span>
<a name="l00107"></a>00107 <span class="preprocessor">            PxGetProfilerCallback()-&gt;zoneEnd(NULL, x, true, y)</span>
<a name="l00108"></a>00108 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00109"></a><a class="code" href="PxProfiler_8h.html#5cac644a3ff98a88f49dc2257c5ed36a">00109</a> <span class="preprocessor"></span><span class="preprocessor">    #define PX_PROFILE_ZONE(x, y)</span>
<a name="l00110"></a><a class="code" href="PxProfiler_8h.html#1dfc16e2fb70dbf1c861593b494bf678">00110</a> <span class="preprocessor"></span><span class="preprocessor">    #define PX_PROFILE_START_CROSSTHREAD(x, y)</span>
<a name="l00111"></a><a class="code" href="PxProfiler_8h.html#4d0aaafdc752f6111c8259ecf0afb27e">00111</a> <span class="preprocessor"></span><span class="preprocessor">    #define PX_PROFILE_STOP_CROSSTHREAD(x, y)</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00113"></a>00113 <span class="preprocessor"></span>
<a name="l00114"></a><a class="code" href="PxProfiler_8h.html#8dc063f399d7b06f612494e98d14a746">00114</a> <span class="preprocessor">#define PX_PROFILE_POINTER_TO_U64(pointer) static_cast&lt;uint64_t&gt;(reinterpret_cast&lt;size_t&gt;(pointer))</span>
<a name="l00115"></a>00115 <span class="preprocessor"></span>
<a name="l00116"></a>00116 <span class="preprocessor">#endif // PXFOUNDATION_PXPROFILER_H</span>
</pre></div></div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 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>