Struct physx::visual_debugger::VisualDebugger

pub struct VisualDebugger { /* private fields */ }

Combines the Pvd and it’s current PvdTransport, if there is one.

Implementations

impl VisualDebugger

pub fn new(foundation: &mut impl Foundation, port: i32) -> Option<Self>

Create a new VisualDebugger instance, a utility class that combines the TCP setup and the Pvd into one object. The port default for the PVD program is port 5425, so it is suggested to use this unless you’re explicitly changing the other one as well.

This function internally calls new_with_timeout with a default timeout of 10 ms.

pub fn new_with_timeout(
    foundation: &mut impl Foundation,
    port: i32,
    timeout: u32
) -> Option<Self>

See description of new

pub fn connect(&mut self, flags: PxPvdInstrumentationFlags) -> bool

Connect the Pvd to the PvdTransport.

pub fn disconnect(&mut self)

Disconnect the Pvd it’s transport.

pub fn is_connected(&mut self, use_cached_status: bool) -> bool

Check if the Pvd is connected. The cached status may be up to one frame out of date. When use_cached_status is false, the low-level status is checked which requires locking the network stream.

pub fn get_transport(&mut self) -> Option<&mut PvdTransport>

Get the transport connected to the Pvd, if there is one.

pub fn set_transport(
    &mut self,
    transport: Owner<PvdTransport>,
    flags: PxPvdInstrumentationFlags
) -> bool

Connect to a new transport, disconnecting from and dropping the old one. Returns true if the connection succeeded.

Trait Implementations

impl Class<PxPvd> for VisualDebugger

fn as_ptr(&self) -> *const PxPvd

Returns a raw const pointer to the wrapped type. Retrieving a raw pointer is safe. However, pretty much any use of a raw pointer is unsafe. In particular: this pointer should not be used to construct a second owning wrapper around the pointer.

fn as_mut_ptr(&mut self) -> *mut PxPvd

Returns a raw mut pointer to the wrapped type. Retrieving a raw pointer is safe. However, pretty much any use of a raw pointer is unsafe. In particular: this pointer should not be used to construct a second owning wrapper around the pointer.

impl Drop for VisualDebugger

fn drop(&mut self)

Executes the destructor for this type.