diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/structPxPvdInstrumentationFlag.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/structPxPvdInstrumentationFlag.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxPvdInstrumentationFlag.html | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxPvdInstrumentationFlag.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxPvdInstrumentationFlag.html new file mode 100644 index 00000000..1ab08c7a --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxPvdInstrumentationFlag.html @@ -0,0 +1,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> + <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="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 <<a class="el" href="PxPvd_8h-source.html">PxPvd.h</a>></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeede">Enum</a> { <br> + <a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeededaffb4216dd0bc2a5683245ea725afdf">eDEBUG</a> = 1 << 0, +<br> + <a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeedead2e5f3100343f6f8b7bfe7b5b8e1978">ePROFILE</a> = 1 << 1, +<br> + <a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeede1e1edeea03427ccaef15df3fb6c37eea">eMEMORY</a> = 1 << 2, +<br> + <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> </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> </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> </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> </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 © 2008-2016 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> |