aboutsummaryrefslogtreecommitdiff
path: root/PxShared/include/pvd
diff options
context:
space:
mode:
authorsschirm <[email protected]>2016-12-23 14:20:36 +0100
committersschirm <[email protected]>2016-12-23 14:56:17 +0100
commitef6937e69e8ee3f409cf9d460d5ad300a65d5924 (patch)
tree710426e8daa605551ce3f34b581897011101c30f /PxShared/include/pvd
parentInitial commit: (diff)
downloadphysx-3.4-ef6937e69e8ee3f409cf9d460d5ad300a65d5924.tar.xz
physx-3.4-ef6937e69e8ee3f409cf9d460d5ad300a65d5924.zip
PhysX 3.4 / APEX 1.4 release candidate @21506124
Diffstat (limited to 'PxShared/include/pvd')
-rw-r--r--PxShared/include/pvd/PxPvd.h62
1 files changed, 32 insertions, 30 deletions
diff --git a/PxShared/include/pvd/PxPvd.h b/PxShared/include/pvd/PxPvd.h
index 0ed17fde..ecacf5a6 100644
--- a/PxShared/include/pvd/PxPvd.h
+++ b/PxShared/include/pvd/PxPvd.h
@@ -67,47 +67,49 @@ struct PxPvdInstrumentationFlag
enum Enum
{
/**
- \brief Send debugging information to PVD.
+ \brief Send debugging information to PVD.
- 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.
+ 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.
*/
eDEBUG = 1 << 0,
+
/**
- \brief Send profile information to PVD.
+ \brief Send profile information to PVD.
- 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.
+ 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.
- This flag works together with a PxCreatePhysics parameter.
- Using it allows the SDK to send profile
- events to PVD.
+ This flag works together with a PxCreatePhysics parameter.
+ Using it allows the SDK to send profile events to PVD.
*/
ePROFILE = 1 << 1,
+
/**
- \brief Send memory information to PVD.
-
- 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.
-
- 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.
-
- 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.
+ \brief Send memory information to PVD.
+
+ 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.
+
+ 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.
+
+ 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.
*/
eMEMORY = 1 << 2,
+
eALL = (eDEBUG | ePROFILE | eMEMORY)
};
};