Skip to main content

CompositionEffectFactory

Struct CompositionEffectFactory 

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

Creates the brushes of one effect graph (WinUI Microsoft.UI.Composition.CompositionEffectFactory), made by Compositor::create_effect_factory.

The graph is checked when the factory is made: load_status is Success when the brushes can draw it. A factory whose effect cannot be loaded still makes brushes, which draw nothing.

Deviation (winui-composition.md): WinUI throws from CreateEffectFactory for an effect it cannot load; here the factory is made and reports the failure through its load status and extended error. The factory is not a composition object (no Properties, no animations).

Implementations§

Source§

impl CompositionEffectFactory

Source

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

The compositor of the factory.

Source

pub fn create_brush(&self) -> CompositionEffectBrush

CreateBrush: a brush that draws the effect. Its source parameters are bound with set_source_parameter; its animatable properties are entries of its Properties, set to the values of the description.

Source

pub fn load_status(&self) -> CompositionEffectFactoryLoadStatus

LoadStatus: whether the effect was loaded.

Source

pub fn extended_error(&self) -> Option<&CompositionEffectFactoryError>

ExtendedError: why the effect was not loaded; None when it was.

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<T> ClassDefaults for T
where T: ?Sized,

Source§

fn static_constructor()

The static constructor of a type: work done once per thread, after the properties of the type are registered and before its first instance exists (class handlers, affects_render, metadata overrides). Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.