Struct ViewportOutput

pub struct ViewportOutput {
    pub parent: ViewportId,
    pub class: ViewportClass,
    pub builder: ViewportBuilder,
    pub viewport_ui_cb: Option<Arc<dyn Fn(&Context) + Sync + Send>>,
    pub commands: Vec<ViewportCommand>,
    pub repaint_delay: Duration,
}

Describes a viewport, i.e. a native window.

This is returned by crate::Context::run on each frame, and should be applied by the integration.

Fields

parent: ViewportId

Id of our parent viewport.

class: ViewportClass

What type of viewport are we?

This will never be ViewportClass::Embedded, since those don’t result in real viewports.

builder: ViewportBuilder

The window attrbiutes such as title, position, size, etc.

Use this when first constructing the native window. Also check for changes in it using ViewportBuilder::patch, and apply them as needed.

viewport_ui_cb: Option<Arc<dyn Fn(&Context) + Sync + Send>>

The user-code that shows the GUI, used for deferred viewports.

None for immediate viewports and the ROOT viewport.

commands: Vec<ViewportCommand>

Commands to change the viewport, e.g. window title and size.

repaint_delay: Duration

Schedule a repaint of this viewport after this delay.

It is preferable to instead install a Context::set_request_repaint_callback, but if you haven’t, you can use this instead.

If the duration is zero, schedule a repaint immediately.

Implementations

impl ViewportOutput

pub fn append(&mut self, newer: ViewportOutput)

Add on new output.

Trait Implementations

impl Clone for ViewportOutput

fn clone(&self) -> ViewportOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.