Enum pdfium_render::page_object::PdfPageObjectBlendMode

pub enum PdfPageObjectBlendMode {
    Normal,
    Multiply,
    Screen,
    Overlay,
    Darken,
    Lighten,
    ColorDodge,
    ColorBurn,
    HardLight,
    SoftLight,
    Difference,
    Exclusion,
    HSLColor,
    HSLHue,
    HSLLuminosity,
    HSLSaturation,
}

The method used to combine overlapping colors when painting one PdfPageObject on top of another.

The color being newly painted is the source color;the existing color being painted onto is the backdrop color.

A formal definition of these blend modes can be found in Section 7.2.4 of the PDF Reference Manual, version 1.7, on page 520.

Variants

Normal

Selects the source color, ignoring the backdrop.

Multiply

Multiplies the backdrop and source color values. The resulting color is always at least as dark as either of the two constituent colors. Multiplying any color with black produces black; multiplying with white leaves the original color unchanged. Painting successive overlapping objects with a color other than black or white produces progressively darker colors.

Screen

Multiplies the complements of the backdrop and source color values, then complements the result. The result color is always at least as light as either of the two constituent colors. Screening any color with white produces white; screening with black leaves the original color unchanged. The effect is similar to projecting multiple photographic slides simultaneously onto a single screen.

Overlay

Multiplies or screens the colors, depending on the backdrop color value. Source colors overlay the backdrop while preserving its highlights and shadows. The backdrop color is not replaced but is mixed with the source color to reflect the lightness or darkness of the backdrop.

Darken

Selects the darker of the backdrop and source colors. The backdrop is replaced with the source where the source is darker; otherwise, it is left unchanged.

Lighten

Selects the lighter of the backdrop and source colors. The backdrop is replaced with the source where the source is lighter; otherwise, it is left unchanged.

ColorDodge

Brightens the backdrop color to reflect the source color. Painting with black produces no changes.

ColorBurn

Darkens the backdrop color to reflect the source color. Painting with white produces no change.

HardLight

Multiplies or screens the colors, depending on the source color value. The effect is similar to shining a harsh spotlight on the backdrop.

SoftLight

Darkens or lightens the colors, depending on the source color value. The effect is similar to shining a diffused spotlight on the backdrop.

Difference

Subtracts the darker of the two constituent colors from the lighter color. Painting with white inverts the backdrop color; painting with black produces no change.

Exclusion

Produces an effect similar to that of the Difference mode but lower in contrast. Painting with white inverts the backdrop color; painting with black produces no change.

HSLColor

Preserves the luminosity of the backdrop color while adopting the hue and saturation of the source color.

HSLHue

Preserves the luminosity and saturation of the backdrop color while adopting the hue of the source color.

HSLLuminosity

Preserves the hue and saturation of the backdrop color while adopting the luminosity of the source color.

HSLSaturation

Preserves the luminosity and hue of the backdrop color while adopting the saturation of the source color.

Trait Implementations

impl Clone for PdfPageObjectBlendMode

fn clone(&self) -> PdfPageObjectBlendMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PdfPageObjectBlendMode

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

Formats the value using the given formatter.

impl PartialEq<PdfPageObjectBlendMode> for PdfPageObjectBlendMode

fn eq(&self, other: &PdfPageObjectBlendMode) -> 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 PdfPageObjectBlendMode

impl StructuralPartialEq for PdfPageObjectBlendMode