Struct three_d::window::FrameInput

pub struct FrameInput {
    pub events: Vec<Event>,
    pub elapsed_time: f64,
    pub accumulated_time: f64,
    pub viewport: Viewport,
    pub window_width: u32,
    pub window_height: u32,
    pub device_pixel_ratio: f32,
    pub first_frame: bool,
    pub context: Context,
}

Input for rendering (and whatever else needs it) each frame. It includes events that can be used as input to controls. The data should only be used for one frame.

Note: FrameInput is automatically generated if using the default Window. Use FrameInputGenerator to generate it with a custom winit window.

Fields

events: Vec<Event>

A list of events which has occurred since last frame.

elapsed_time: f64

Milliseconds since last frame.

accumulated_time: f64

Milliseconds accumulated time since start.

viewport: Viewport

Viewport of the window in physical pixels (the size of the screen RenderTarget which is returned from FrameInput::screen).

window_width: u32

Width of the window in logical pixels.

window_height: u32

Height of the window in logical pixels.

device_pixel_ratio: f32

Number of physical pixels for each logical pixel.

first_frame: bool

Whether or not this is the first frame.

context: Context

The graphics context for the window.

Implementations

impl FrameInput

pub fn screen(&self) -> RenderTarget<'_>

Returns the screen render target, which is used for drawing to the screen, for this window. Same as

RenderTarget::screen(&frame_input.context, frame_input.viewport.width, frame_input.viewport.height)

Trait Implementations

impl Clone for FrameInput

fn clone(&self) -> FrameInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameInput

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

Formats the value using the given formatter.