Struct three_d::window::FrameOutput

pub struct FrameOutput {
    pub exit: bool,
    pub swap_buffers: bool,
    pub screenshot: Option<PathBuf>,
    pub wait_next_event: bool,
}

Output from the rendering to the window each frame.

Fields

exit: bool

If this is true:

• On desktop, the window is closed and the renderloop is stopped.
• On web, the render loop is stopped, the event handlers are removed and the Window dropped. Note that the canvas is not removed.

swap_buffers: bool

Swaps the back and front buffer if this is true. Set this to true if something have been rendered this frame and you want to display it. Set it to false if nothing have been rendered this frame, for example if nothing has changed, and you want to reuse the image from an old frame. Currently ignored on web, since it does not use double buffering.

screenshot: Option<PathBuf>

Available on crate feature image-io only.

Takes a screenshot if this is set to some path and saves it at the given location. Only works on desktop and if the image-io feature is enabled.

wait_next_event: bool

Whether to stop the render loop until next event.

Trait Implementations

impl Clone for FrameOutput

fn clone(&self) -> FrameOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FrameOutput

fn default() -> Self

Returns the “default value” for a type.