Struct webrender::clip::ClipTree

pub struct ClipTree {
    nodes: Vec<ClipTreeNode>,
    leaves: Vec<ClipTreeLeaf>,
    clip_root_stack: Vec<ClipNodeId>,
}

A clip-tree built during scene building and used during frame-building to apply clips to primitives.

Fields

nodes: Vec<ClipTreeNode>

leaves: Vec<ClipTreeLeaf>

clip_root_stack: Vec<ClipNodeId>

Implementations

impl ClipTree

pub fn new() -> Self

pub fn reset(&mut self)

fn add_impl( id: ClipNodeId, clips: &[Handle<ClipIntern>], nodes: &mut Vec<ClipTreeNode>, ) -> ClipNodeId

Add a set of clips to the provided tree node id, reusing existing nodes in the tree where possible

pub fn add( &mut self, root: ClipNodeId, clips: &[Handle<ClipIntern>], ) -> ClipNodeId

Add a set of clips to the provided tree node id, reusing existing nodes in the tree where possible

pub fn current_clip_root(&self) -> ClipNodeId

Get the current clip root (the node in the clip-tree where clips can be ignored when building the clip-chain instance for a primitive)

pub fn push_clip_root_leaf(&mut self, clip_leaf_id: ClipLeafId)

Push a clip root (e.g. when a surface is encountered) that prevents clips from this node and above being applied to primitives within the root.

pub fn push_clip_root_node(&mut self, clip_node_id: ClipNodeId)

Push a clip root (e.g. when a surface is encountered) that prevents clips from this node and above being applied to primitives within the root.

pub fn pop_clip_root(&mut self)

Pop a clip root, when exiting a surface.

pub fn get_node(&self, id: ClipNodeId) -> &ClipTreeNode

Retrieve a clip tree node by id

pub fn get_leaf(&self, id: ClipLeafId) -> &ClipTreeLeaf

Retrieve a clip tree leaf by id

pub fn print(&self)

Debug print the clip-tree

pub fn find_lowest_common_ancestor( &self, node1: ClipNodeId, node2: ClipNodeId, ) -> ClipNodeId

Find the lowest common ancestor of two clip tree nodes. This is useful to identify shared clips between primitives attached to different clip-leaves.

Trait Implementations

impl Serialize for ClipTree

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

where __S: Serializer,

Serialize this value into the given Serde serializer.