Struct screen_13::prelude::FrameContext

pub struct FrameContext<'a> {
    pub device: &'a Arc<Device>,
    pub dt: f32,
    pub events: &'a [Event<()>],
    pub height: u32,
    pub render_graph: &'a mut RenderGraph,
    pub swapchain_image: SwapchainImageNode,
    pub will_exit: &'a mut bool,
    pub width: u32,
    pub window: &'a Window,
}

A request to render a single frame to the provided render graph.

Fields

device: &'a Arc<Device>

The device this frame belongs to.

dt: f32

The elapsed seconds since the previous frame.

events: &'a [Event<()>]

A slice of events that have occurred since the previous frame.

height: u32

The height, in pixels, of the current frame.

render_graph: &'a mut RenderGraph

A render graph which rendering commands should be recorded into.

Make sure to write to swapchain_image as part of this graph.

swapchain_image: SwapchainImageNode

A pre-bound image node for the swapchain image to be drawn.

will_exit: &'a mut bool

A mutable bool which indicates if this frame should cause the program to exit.

width: u32

The width, in pixels, of the current frame.

window: &'a Window

A borrow of the operating system window relating to this frame.

Implementations

impl FrameContext<'_>

pub fn exit(&mut self)

Causes the program to exit after rendering this frame.

pub fn render_aspect_ratio(&self) -> f32

Returns the frame width divided by the frame height.

pub fn center_cursor(&self)

Centers the mouse cursor within the window.

pub fn set_cursor_position(&self, x: u32, y: u32)

Sets the mouse cursor at the specified position within the window.