Enum physx_sys::PxPvdInstrumentationFlag

#[repr(i32)]
pub enum PxPvdInstrumentationFlag {
    Debug = 1,
    Profile = 2,
    Memory = 4,
    All = 7,
}

types of instrumentation that PVD can do.

Variants

Debug = 1

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.

Profile = 2

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 flag works together with a PxCreatePhysics parameter. Using it allows the SDK to send profile events to PVD.

Memory = 4

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.

All = 7

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.

Trait Implementations

impl Clone for PxPvdInstrumentationFlag

fn clone(&self) -> PxPvdInstrumentationFlag

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PxPvdInstrumentationFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PxPvdInstrumentationFlag

fn eq(&self, other: &PxPvdInstrumentationFlag) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PxPvdInstrumentationFlag

impl Eq for PxPvdInstrumentationFlag

impl StructuralEq for PxPvdInstrumentationFlag

impl StructuralPartialEq for PxPvdInstrumentationFlag