Struct ShotFrame 

pub struct ShotFrame {
    pub state: State,
    pub theme: Theme,
    pub text: TextRenderer,
    pub presence: PresenceCtx,
    pub permission: PermissionContext,
    /* private fields */
}

The document, theme, text renderer and layout tree of one offscreen frame.

Fields

state: State

Document the widget syncs from. Seed it before ShotFrame::sync.

theme: Theme

Theme passed to layout and every draw pass.

text: TextRenderer

Text renderer shared by measurement and drawing.

presence: PresenceCtx

Presence passed to the draw passes; empty unless a shot stages peers.

permission: PermissionContext

Permission context scoped around the root draw.

Implementations

impl ShotFrame

pub fn new(viewport: (u32, u32), theme: Theme) -> ShotFrame

A frame at viewport with a fresh document, the theme’s text scale applied to the text renderer, and settled layout. Its PNG lands on the window ground (surfaces.content), as a live window clears.

pub fn with_state(self, state: State) -> ShotFrame

Replace the document the widget syncs from.

pub fn viewport(&self) -> (u32, u32)

The viewport this frame lays out and renders at.

pub fn sync(&mut self, widget: &mut dyn Widget)

Pull the widget’s visual state from ShotFrame::state.

pub fn layout( &mut self, widget: &mut dyn Widget, ) -> Result<(), WidgetLayoutError>

Build a fresh layout tree for the widget inside a viewport-sized root, resolve it, and apply the result.

Errors

Returns the solver’s error when Taffy rejects the tree or allocation dependent styles do not settle.

pub fn layout_at( &mut self, widget: &mut dyn Widget, _: (u32, u32), ) -> Result<(), WidgetLayoutError>

ShotFrame::layout at a viewport other than the frame’s own, to simulate the window size a widget saw before a resize.

Errors

As ShotFrame::layout.

pub fn layout_parts(&mut self) -> Option<(&mut State, &TaffyTree, NodeId)>

The document, the layout tree of the last ShotFrame::layout and the widget’s node in it, for scenarios that stage input against laid-out geometry.

pub fn draw(&mut self, widget: &mut dyn Widget) -> Scene

Paint the widget’s main pass into a new scene, culled against the frame’s window as a live host culls.

pub fn draw_overlay(&mut self, widget: &mut dyn Widget, scene: &mut Scene)

Composite the widget’s top layer (open menus, popovers, modals) onto scene over the frame’s window, as the live host does after the main pass and the window chrome.

pub fn draw_floating_surfaces( &mut self, widget: &mut dyn Widget, scene: &mut Scene, )

Paint app-owned floating surfaces onto scene, in the order the live compositor stacks them above the window.

impl ShotFrame

pub fn write_png(&self, scene: &Scene, out: &Path)

Rasterise scene over the window ground at the frame’s viewport and publish it to out as a PNG, creating the parent directory.

Panics

Panics when the offscreen renderer cannot publish the file, as OffscreenRenderer::render_png does.