Struct pdf_writer::writers::SoftMask

pub struct SoftMask<'a> { /* private fields */ }

Writer for a soft mask dictionary.

This struct is created by ExtGraphicsState::soft_mask.

Implementations

impl<'a> SoftMask<'a>

pub fn subtype(&mut self, subtype: MaskType) -> &mut Self

Write the S attribute to set the soft mask subtype. Required.

pub fn group(&mut self, group: Ref) -> &mut Self

Write the G attribute to set the transparency group XObject. The group has to have a color space set in the /CS attribute if the mask subtype is Luminosity. Required.

pub fn backdrop(&mut self, color: impl IntoIterator<Item = f32>) -> &mut Self

Write the BC attribute to set the background color for the transparency group. Only applicable if the mask subtype is Luminosity. Has to be set in the group’s color space.

pub fn transfer_function(&mut self, function: Ref) -> &mut Self

Write the TR attribute, a function that maps from the group’s output values to the mask opacity.

Methods from Deref<Target = Dict<'a>>

pub fn len(&self) -> i32

The number of written pairs.

pub fn is_empty(&self) -> bool

Whether no pairs have been written so far.

pub fn insert(&mut self, key: Name<'_>) -> Obj<'_>

Start writing a pair with an arbitrary value.

pub fn pair<T: Primitive>(&mut self, key: Name<'_>, value: T) -> &mut Self

Write a pair with a primitive value.

This is a shorthand for dict.insert(key).primitive(value).

pub fn pairs<'n, T: Primitive>( &mut self, pairs: impl IntoIterator<Item = (Name<'n>, T)> ) -> &mut Self

Write a sequence of pairs with primitive values.

Trait Implementations

impl<'a> Deref for SoftMask<'a>

type Target = Dict<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for SoftMask<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, 'any> Rewrite<'a> for SoftMask<'any>

type Output = SoftMask<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for SoftMask<'a>

fn start(obj: Obj<'a>) -> Self

Start writing the object.