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
impl CompositionEffectFactory
Sourcepub fn compositor(&self) -> &Rc<Compositor>
pub fn compositor(&self) -> &Rc<Compositor>
The compositor of the factory.
Sourcepub fn create_brush(&self) -> CompositionEffectBrush
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.
Sourcepub fn load_status(&self) -> CompositionEffectFactoryLoadStatus
pub fn load_status(&self) -> CompositionEffectFactoryLoadStatus
LoadStatus: whether the effect was loaded.
Sourcepub fn extended_error(&self) -> Option<&CompositionEffectFactoryError>
pub fn extended_error(&self) -> Option<&CompositionEffectFactoryError>
ExtendedError: why the effect was not loaded; None when it was.
Auto Trait Implementations§
impl !RefUnwindSafe for CompositionEffectFactory
impl !Send for CompositionEffectFactory
impl !Sync for CompositionEffectFactory
impl !UnwindSafe for CompositionEffectFactory
impl Freeze for CompositionEffectFactory
impl Unpin for CompositionEffectFactory
impl UnsafeUnpin for CompositionEffectFactory
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> ClassDefaults for Twhere
T: ?Sized,
impl<T> ClassDefaults for Twhere
T: ?Sized,
Source§fn static_constructor()
fn static_constructor()
affects_render, metadata
overrides). Read more