Struct Frame 

pub struct Frame {
    pub seq: u64,
    pub viewport: Point,
    pub background: Color,
    pub layers: BTreeMap<u64, Layer>,
}

A whole page at one moment.

Fields

seq: u64

Monotonic per tab; a patch names the frame it applies to.

viewport: Point

background: Color

Canvas colour behind everything (the root background propagates to it).

layers: BTreeMap<u64, Layer>

Implementations

impl Frame

pub fn root(&self) -> Option<&Layer>

pub fn blobs(&self) -> impl Iterator<Item = &BlobRef>

pub fn layer_to_viewport(&self, layer: u64) -> Option<(Point, Option<Rect>)>

Absolute offset that maps layer’s content coordinates to the viewport, and the layer’s clip in viewport coordinates when it (or an ancestor) clips. None for an unknown layer or a parent cycle.

pub fn hit_test(&self, p: Point) -> Option<ItemKey>

The topmost item under a viewport point: what a pointer or an agent would hit. Layers paint in item order, so the last hit wins.

impl Frame

pub fn diff(&self, next: &Frame) -> Patch

pub fn apply(&mut self, patch: &Patch) -> Result<(), PatchError>

Apply patch. On error the frame is unchanged.

Errors

PatchError::WrongBase when the patch was made against another frame; the other variants for a malformed patch.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Frame

fn deserialize<__D>( __deserializer: __D, ) -> Result<Frame, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Frame

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Frame