RenetClientVisualizer

Struct RenetClientVisualizer 

Source
pub struct RenetClientVisualizer<const N: usize> { /* private fields */ }
Expand description

Egui visualizer for the renet client. Draws graphs with metrics: RTT, Packet Loss, Kbitps Sent/Received.

N: determines how many values are shown in the graph. 200 is a good value, if updated at 60 fps the graphs would hold 3 seconds of data.

Implementations§

Source§

impl<const N: usize> RenetClientVisualizer<N>

Source

pub fn new(style: RenetVisualizerStyle) -> Self

Source

pub fn add_network_info(&mut self, network_info: NetworkInfo)

Add the network information from the client. Should be called every time the client updates.

§Usage
client.update(delta);
visualizer.add_network_info(client.network_info());
Source

pub fn show_window(&self, ctx: &Context)

Renders a new window with all the graphs metrics drawn.

Source

pub fn draw_received_kbps(&self, ui: &mut Ui)

Draws only the Received Kilobits Per Second metric.

Source

pub fn draw_sent_kbps(&self, ui: &mut Ui)

Draws only the Sent Kilobits Per Second metric.

Source

pub fn draw_packet_loss(&self, ui: &mut Ui)

Draws only the Packet Loss metric.

Source

pub fn draw_rtt(&self, ui: &mut Ui)

Draws only the Round Trip Time metric.

Source

pub fn draw_all(&self, ui: &mut Ui)

Draw all metrics without a window or layout.

Trait Implementations§

Source§

impl<const N: usize> Default for RenetClientVisualizer<N>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<const N: usize> Resource for RenetClientVisualizer<N>
where Self: Send + Sync + 'static,

Auto Trait Implementations§

§

impl<const N: usize> Freeze for RenetClientVisualizer<N>

§

impl<const N: usize> RefUnwindSafe for RenetClientVisualizer<N>

§

impl<const N: usize> Send for RenetClientVisualizer<N>

§

impl<const N: usize> Sync for RenetClientVisualizer<N>

§

impl<const N: usize> Unpin for RenetClientVisualizer<N>

§

impl<const N: usize> UnwindSafe for RenetClientVisualizer<N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ConditionalSend for T
where T: Send,