Skip to main content

ArithmeticCompositeEffect

Struct ArithmeticCompositeEffect 

Source
pub struct ArithmeticCompositeEffect {
    pub name: String,
    pub multiply_amount: f32,
    pub source1_amount: f32,
    pub source2_amount: f32,
    pub offset: f32,
    pub clamp_output: bool,
    pub source1: Option<GraphicsEffectSource>,
    pub source2: Option<GraphicsEffectSource>,
}
Expand description

Combines two sources channel by channel as MultiplyAmount * s1 * s2 + Source1Amount * s1 + Source2Amount * s2 + Offset on premultiplied colours (Win2D ArithmeticCompositeEffect). Animatable: MultiplyAmount, Source1Amount, Source2Amount, Offset.

Drawn when one of the sources is a colour source: the combination is then a colour matrix of the other source. A factory made from one whose sources are both images reports CompositionEffectFactoryError::EffectTypeNotSupported.

Fields§

§name: String

The name of the effect.

§multiply_amount: f32

The weight of the product of the sources (default 1).

§source1_amount: f32

The weight of the first source (default 0).

§source2_amount: f32

The weight of the second source (default 0).

§offset: f32

The constant added (default 0).

§clamp_output: bool

Whether the output is clamped (stored; the drawing contexts clamp).

§source1: Option<GraphicsEffectSource>

The first input.

§source2: Option<GraphicsEffectSource>

The second input.

Trait Implementations§

Source§

impl Clone for ArithmeticCompositeEffect

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ArithmeticCompositeEffect

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ArithmeticCompositeEffect

Source§

fn default() -> Self

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

impl From<ArithmeticCompositeEffect> for GraphicsEffect

Source§

fn from(effect: ArithmeticCompositeEffect) -> Self

Converts to this type from the input type.
Source§

impl From<ArithmeticCompositeEffect> for GraphicsEffectSource

Source§

fn from(effect: ArithmeticCompositeEffect) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ArithmeticCompositeEffect

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ArithmeticCompositeEffect

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> AnyValue for T
where T: PartialEq + 'static,

Source§

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

Source§

fn any_value_eq(&self, other: &(dyn AnyValue + 'static)) -> bool

Source§

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

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> PropertyValue for T
where T: Clone + PartialEq + 'static,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.