Skip to main content

LayerTree

Struct LayerTree 

Source
pub struct LayerTree { /* private fields */ }
Expand description

The retained-mode layer tree. Maintained across frames by the CompositorEngine.

Implementations§

Source§

impl LayerTree

Source

pub fn new() -> Self

Creates a new empty layer tree.

Source

pub fn allocate_id(&mut self) -> LayerId

Allocates and returns a new layer ID.

Source

pub fn insert_layer(&mut self, layer: Layer)

Inserts a new layer into the tree.

Source

pub fn remove_layer(&mut self, id: LayerId) -> Option<Layer>

Removes a layer from the tree.

Source

pub fn get_layer(&self, id: LayerId) -> Option<&Layer>

Returns a reference to a layer by ID.

Source

pub fn get_layer_mut(&mut self, id: LayerId) -> Option<&mut Layer>

Returns a mutable reference to a layer by ID.

Source

pub fn roots(&self) -> &[LayerId]

Returns the root layer IDs in painter’s order.

Source

pub fn set_roots(&mut self, roots: Vec<LayerId>)

Sets the root layer IDs.

Source

pub fn mark_dirty(&mut self, id: LayerId)

Marks a layer as dirty (modified since last frame).

Source

pub fn is_dirty(&self, id: LayerId, since_generation: u64) -> bool

Returns true if the layer has been modified since the given generation.

Source

pub fn advance_generation(&mut self)

Advances the global generation counter. Call once per frame after processing damage.

Source

pub fn generation(&self) -> u64

Returns the current global generation.

Source

pub fn iter_layers(&self) -> impl Iterator<Item = &Layer>

Iterates over all layers in the tree.

Source

pub fn len(&self) -> usize

Returns the number of layers in the tree.

Source

pub fn is_empty(&self) -> bool

Returns true if the tree has no layers.

Source

pub fn clear(&mut self)

Clears all layers from the tree.

Trait Implementations§

Source§

impl Default for LayerTree

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.