aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/structPxPvdInstrumentationFlag.html
blob: e7093e944190403c237d35d016cb6938fccfdd81 (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPvdInstrumentationFlag Struct 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> &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 -->
<div class="contents">
<h1>PxPvdInstrumentationFlag Struct Reference<br>
<small>
[<a class="el" href="group__pvd.html">Pvd</a>]</small>
</h1><!-- doxytag: class="PxPvdInstrumentationFlag" -->types of instrumentation that PVD can do.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxPvd_8h-source.html">PxPvd.h</a>&gt;</code>
<p>

<p>
<a href="structPxPvdInstrumentationFlag-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeede">Enum</a> { <br>
&nbsp;&nbsp;<a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeededaffb4216dd0bc2a5683245ea725afdf">eDEBUG</a> =  1 &lt;&lt; 0, 
<br>
&nbsp;&nbsp;<a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeedead2e5f3100343f6f8b7bfe7b5b8e1978">ePROFILE</a> =  1 &lt;&lt; 1, 
<br>
&nbsp;&nbsp;<a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeede1e1edeea03427ccaef15df3fb6c37eea">eMEMORY</a> =  1 &lt;&lt; 2, 
<br>
&nbsp;&nbsp;<a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeede105907e11b7280f3bf29a2187688fa54">eALL</a> =  (eDEBUG | ePROFILE | eMEMORY)
<br>
 }</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
types of instrumentation that PVD can do. <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="e5be1bcb179a96c601194126230aeede"></a><!-- doxytag: member="PxPvdInstrumentationFlag::Enum" ref="e5be1bcb179a96c601194126230aeede" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeede">PxPvdInstrumentationFlag::Enum</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="e5be1bcb179a96c601194126230aeededaffb4216dd0bc2a5683245ea725afdf"></a><!-- doxytag: member="eDEBUG" ref="e5be1bcb179a96c601194126230aeededaffb4216dd0bc2a5683245ea725afdf" args="" -->eDEBUG</em>&nbsp;</td><td>
Send debugging information to PVD. 
<p>
This information is the actual object data of the rigid statics, shapes, articulations, etc. Sending this information has a noticeable impact on performance and thus this flag should not be set if you want an accurate performance profile. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e5be1bcb179a96c601194126230aeedead2e5f3100343f6f8b7bfe7b5b8e1978"></a><!-- doxytag: member="ePROFILE" ref="e5be1bcb179a96c601194126230aeedead2e5f3100343f6f8b7bfe7b5b8e1978" args="" -->ePROFILE</em>&nbsp;</td><td>
Send profile information to PVD. 
<p>
This information populates PVD's profile view. It has (at this time) negligible cost compared to Debug information and makes PVD *much* more useful so it is quite highly recommended.<p>
This flag works together with a PxCreatePhysics parameter. Using it allows the SDK to send profile events to PVD. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e5be1bcb179a96c601194126230aeede1e1edeea03427ccaef15df3fb6c37eea"></a><!-- doxytag: member="eMEMORY" ref="e5be1bcb179a96c601194126230aeede1e1edeea03427ccaef15df3fb6c37eea" args="" -->eMEMORY</em>&nbsp;</td><td>
Send memory information to PVD. 
<p>
The PVD sdk side hooks into the Foundation memory controller and listens to allocation/deallocation events. This has a noticable hit on the first frame, however, this data is somewhat compressed and the PhysX SDK doesn't allocate much once it hits a steady state. This information also has a fairly negligible impact and thus is also highly recommended.<p>
This flag works together with a PxCreatePhysics parameter, trackOutstandingAllocations. Using both of them together allows users to have an accurate view of the overall memory usage of the simulation at the cost of a hashtable lookup per allocation/deallocation. Again, PhysX makes a best effort attempt not to allocate or deallocate during simulation so this hashtable lookup tends to have no effect past the first frame.<p>
Sending memory information without tracking outstanding allocations means that PVD will accurate information about the state of the memory system before the actual connection happened. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e5be1bcb179a96c601194126230aeede105907e11b7280f3bf29a2187688fa54"></a><!-- doxytag: member="eALL" ref="e5be1bcb179a96c601194126230aeede105907e11b7280f3bf29a2187688fa54" args="" -->eALL</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="PxPvd_8h-source.html">PxPvd.h</a></ul>
</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>