Package physx.support

Enum Class PxPvdInstrumentationFlagEnum

java.lang.Object
java.lang.Enum<PxPvdInstrumentationFlagEnum>
physx.support.PxPvdInstrumentationFlagEnum
All Implemented Interfaces:
Serializable, Comparable<PxPvdInstrumentationFlagEnum>, Constable

public enum PxPvdInstrumentationFlagEnum extends Enum<PxPvdInstrumentationFlagEnum>
types of instrumentation that PVD can do.
  • Enum Constant Details

    • eDEBUG

      public static final PxPvdInstrumentationFlagEnum eDEBUG
      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.

    • ePROFILE

      public static final PxPvdInstrumentationFlagEnum ePROFILE
      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.

    • eMEMORY

      public static final PxPvdInstrumentationFlagEnum eMEMORY
      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.

    • eALL

      public static final PxPvdInstrumentationFlagEnum eALL
  • Field Details

    • value

      public final int value
  • Method Details

    • values

      public static PxPvdInstrumentationFlagEnum[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PxPvdInstrumentationFlagEnum valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • forValue

      public static PxPvdInstrumentationFlagEnum forValue(int value)