Skip to main content

SoftMask

Struct SoftMask 

Source
pub struct SoftMask {
    pub group: Stream,
    pub kind: SoftMaskKind,
    pub backdrop: Rgb,
    pub transfer: Option<Box<[u8; 256]>>,
    pub matrix: Affine,
    pub objects: Vec<PageObject>,
}
Expand description

A soft mask from an /ExtGState’s /SMask.

Fields§

§group: Stream

The group whose rendering becomes the mask.

§kind: SoftMaskKind

Which channel to read.

§backdrop: Rgb

The backdrop the group composites against, in luminosity mode. Opaque black by default.

§transfer: Option<Box<[u8; 256]>>

The transfer applied to each mask value, when /TR supplied one.

§matrix: Affine

The transformation in force when the /ExtGState was applied, which is what places the mask.

§objects: Vec<PageObject>

The group’s own page objects, interpreted from group.

A soft mask’s /G is a form XObject like any other, and what it paints is what the mask is: a luminosity mask reads the group’s rendered luminance, an alpha mask its coverage. Left empty the mask is the /BC backdrop alone — exact for a backdrop-only mask and wrong for every other, which is how it silently blanked or revealed whole objects.

Filled in by the interpreter, which is the only layer with a resolver; load leaves it empty.

Implementations§

Source§

impl SoftMask

Source

pub fn load<R: Resolve>( value: &Object, matrix: Affine, r: &R, functions: &mut FunctionCache, limits: &Limits, diags: &mut Diagnostics, ) -> Option<Self>

Read a /SMask dictionary.

Returns None — meaning no mask — when the value is not a dictionary at all, which is how /SMask /None reaches the correct answer, and when /G is not a stream.

Source

pub fn apply_transfer(&self, value: u8) -> u8

The mask value for one luminosity or alpha byte.

Trait Implementations§

Source§

impl Clone for SoftMask

Source§

fn clone(&self) -> SoftMask

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 SoftMask

Source§

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

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

impl PartialEq for SoftMask

Source§

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

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> 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> 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, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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.