Enum BlendMode 

pub enum BlendMode {
    Clear,
    Src,
    Dst,
    SrcOver,
    DstOver,
    SrcIn,
    DstIn,
    SrcOut,
    DstOut,
    SrcAtop,
    DstAtop,
    Xor,
    Plus,
    Modulate,
    Screen,
    Overlay,
    Darken,
    Lighten,
    ColorDodge,
    ColorBurn,
    HardLight,
    SoftLight,
    Difference,
    Exclusion,
    Multiply,
    Hue,
    Saturation,
    Color,
    Luminosity,
    PlusDarker,
}

BlendMode controls how source pixels combine with destination pixels.

BlendMode::SrcOver is the default. Advanced modes that read destination pixels may require an additional render-pass break and snapshot.

Variants

Clear

Src

Dst

SrcOver

DstOver

SrcIn

DstIn

SrcOut

DstOut

SrcAtop

DstAtop

Xor

Plus

Plus adds source and destination, clamped at one: Core Graphics’ kCGBlendModePlusLighter and Core Animation’s plusL filter.

Over premultiplied colour it is R = min(1, S + D), alpha included (CGContext.h); Core Image’s _plusLighter kernel is src + dst, so the clamp is the target’s own and a float target keeps the sum, as the blend unit does here.

Modulate

Screen

Overlay

Darken

Lighten

ColorDodge

ColorBurn

HardLight

SoftLight

Difference

Exclusion

Multiply

Hue

Saturation

Color

Luminosity

PlusDarker

PlusDarker adds source and destination toward black: Core Graphics’ kCGBlendModePlusDarker, Core Animation’s plusD filter and Core Image’s CIPlusDarkerCompositing. It is not one of Flutter’s modes.

Over premultiplied colour it is Core Image’s _plusDarker kernel, as CoreImage ships it in macOS 27: Ra = min(1, Sa + Da) and Rc = Ra − min(1, (Sa − Sc) + (Da − Dc)), which for opaque colours is R = max(0, 1 − ((1 − D) + (1 − S))) (the comment in CGContext.h drops the outer 1 −; Core Graphics draws the kernel’s values). A transparent source leaves the destination as it is, and over a transparent destination the source shows unchanged. It reads the destination, so like Overlay it breaks the render pass.

Implementations

impl BlendMode

pub fn is_destructive(self) -> bool

is_destructive reports whether transparent source pixels can change destination pixels outside the source ink.

Trait Implementations

impl Clone for BlendMode

fn clone(&self) -> BlendMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlendMode

impl Debug for BlendMode

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

Formats the value using the given formatter.

impl Default for BlendMode

fn default() -> BlendMode

Returns the “default value” for a type.

impl Eq for BlendMode

impl Hash for BlendMode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BlendMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BlendMode