Struct Frame 

pub struct Frame {
    pub clear_color: [f32; 4],
    /* private fields */
}

Fields

clear_color: [f32; 4]

Implementations

impl Frame

pub fn painter<'a>(&'a mut self, gfx: &'a mut Graphics) -> Painter<'a>

Begin a 2D rendering pass. Returns a Painter that flushes on drop.

pub fn encoder_mut(&mut self) -> Option<&mut CommandEncoder>

pub fn view(&self) -> &TextureView

The window’s (surface’s) view. With a virtual resolution the painter draws into the canvas instead (Self::target_view), which is scaled onto this view by Graphics::flush_pending or at the end of the frame.

pub fn target_view(&self) -> &TextureView

The view the painter draws into: the virtual-resolution canvas when one is set, else the window’s view.

With indexed colour on (Self::target_is_indexed) this is the index canvas: it holds palette indices, not colours. Write them with index_out from INDEX_WGSL (feature indexed); an RGBA pass would write meaningless indices. Colour effects belong in a PostEffect, which sees the resolved colours.

pub fn target_is_indexed(&self) -> bool

Whether Self::target_view holds palette indices (indexed colour was on when the frame began) rather than colours. Always false without the indexed feature.

pub fn view_and_encoder(&mut self) -> (&TextureView, &mut CommandEncoder)

Split borrow of the view and encoder so overlays (egui, custom passes) can record into the same frame without fighting the borrow checker.