Struct ggez::graphics::BlendMode

pub struct BlendMode {
    pub color: BlendComponent,
    pub alpha: BlendComponent,
}

Describes the blend mode used when drawing images.

Fields

color: BlendComponent

The blend mode for the color channels.

alpha: BlendComponent

The blend mode for the alpha channel.

Implementations

impl BlendMode

pub const ADD: Self = _

When combining two fragments, add their values together, saturating at 1.0

pub const SUBTRACT: Self = _

When combining two fragments, subtract the source value from the destination value

pub const ALPHA: Self = _

When combining two fragments, add the value of the source times its alpha channel with the value of the destination multiplied by the inverse of the source alpha channel. Has the usual transparency effect: mixes the two colors using a fraction of each one specified by the alpha of the source.

pub const INVERT: Self = _

When combining two fragments, subtract the destination color from a constant color using the source color as weight. Has an invert effect with the constant color as base and source color controlling displacement from the base color. A white source color and a white value results in plain invert. The output alpha is same as destination alpha.

pub const MULTIPLY: Self = _

When combining two fragments, multiply their values together (including alpha)

pub const REPLACE: Self = _

When combining two fragments, choose the source value (including source alpha)

pub const LIGHTEN: Self = _

When combining two fragments, choose the lighter value

pub const DARKEN: Self = _

When combining two fragments, choose the darker value

pub const PREMULTIPLIED: Self = _

When using premultiplied alpha, use this.

You usually want to use this blend mode for drawing canvases containing semi-transparent imagery. For an explanation on this see: https://github.com/ggez/ggez/issues/694#issuecomment-853724926

Trait Implementations

impl Clone for BlendMode

fn clone(&self) -> BlendMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlendMode

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

Formats the value using the given formatter.

impl Hash for BlendMode

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

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<BlendMode> for BlendMode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BlendMode

impl Eq for BlendMode

impl StructuralEq for BlendMode

impl StructuralPartialEq for BlendMode