Struct FpsOverlay 

pub struct FpsOverlay { /* private fields */ }

Pins an FpsMonitor to an edge or corner of its parent, the way a game overlays its frame counter.

Most applications want fps_monitor instead, which creates and reuses the monitor for you. Reach for this when you already hold a configured FpsMonitor.

The overlay positions itself absolutely, so the parent must be relative():

div()
    .relative()
    .size_full()
    .child(content)
    .child(FpsOverlay::new(monitor).anchor(Anchor::BottomLeft))

Implementations

impl FpsOverlay

pub fn new(monitor: &Entity<FpsMonitor>) -> Self

pub fn anchor(self, anchor: Anchor) -> Self

Where in the parent the HUD sits. Defaults to Anchor::TopRight.

pub fn frame_budget(self, budget: Duration) -> Self

The per-frame budget used for chart grading and its vertical scale.

pub fn continuous(self, continuous: bool) -> Self

Whether the HUD requests another animation frame after every render. Defaults to the monitor’s current setting (true on first use).

Trait Implementations

impl IntoElement for FpsOverlay

type Element = ViewElement<FpsOverlay>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for FpsOverlay

fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.