Struct CompositionScopedBatch 

pub struct CompositionScopedBatch { /* private fields */ }

An explicitly created group of active animations or effects (WinUI CompositionScopedBatch).

Every key frame animation started while the batch is active (created and neither suspended nor ended) belongs to it, also the animations of a group and implicit animations. Once end has been called and all its animations are over, the batch raises completed on the thread of its compositor.

Several batches may be active at once; an animation belongs to each of them.

Implementations

impl CompositionScopedBatch

pub fn compositor(&self) -> &Rc<Compositor>

The associated compositor.

pub fn is_active(&self) -> bool

Whether the batch is open for animations to be aggregated: false once it is suspended or ended.

pub fn is_ended(&self) -> bool

Whether the batch has been closed and can no longer accept changes.

pub fn end(&self)

Closes the batch. Once closed it cannot be suspended or resumed again. Completed is raised once all the animations of the batch are over, right away (asynchronously) when there are none. Ending a batch again does nothing.

pub fn suspend(&self)

Suspends aggregating animations in the batch until resume. Panics when the batch is ended (WinUI throws).

pub fn resume(&self)

Resumes aggregating animations in the batch. Panics when the batch is ended (WinUI throws).

pub fn completed( &self, handler: impl Fn(&CompositionBatchCompletedEventArgs) + 'static, ) -> Rc<dyn IDisposable>

Raised once all animations of the ended batch have completed. Disposing the returned handle unsubscribes.

Trait Implementations

impl AsCompositionObject for CompositionScopedBatch

fn as_composition_object(&self) -> &CompositionObject

The embedded CompositionObject.

fn composition_type_name(&self) -> &'static str

The name of the class of the object, for messages.

fn as_property_set(self: Rc<Self>) -> Option<Rc<CompositionPropertySet>>

The object as a property set, if it is one (the is CompositionPropertySet test of upstream).