Struct pdf_writer::writers::ExtGraphicsState

pub struct ExtGraphicsState<'a> { /* fields omitted */ }

Writer for a dictionary with additional parameters for the graphics state.

This struct is created by PdfWriter::ext_graphics and ShadingPattern::ext_graphics.

Implementations

impl<'a> ExtGraphicsState<'a>

pub fn line_width(&mut self, width: f32) -> &mut Self

LW: Set the line width. PDF 1.3+.

pub fn line_cap(&mut self, cap: LineCapStyle) -> &mut Self

LC: Set the line cap style. PDF 1.3+.

pub fn line_join(&mut self, join: LineJoinStyle) -> &mut Self

LJ: Set the line join style. PDF 1.3+.

pub fn miter_limit(&mut self, limit: f32) -> &mut Self

ML: Set the miter limit. PDF 1.3+.

pub fn dash_pattern(
    &mut self,
    pattern: impl IntoIterator<Item = f32>,
    phase: f32
) -> &mut Self

D: Set the dash pattern. PDF 1.3+.

pub fn rendering_intent(&mut self, intent: RenderingIntent) -> &mut Self

RI: Set the rendering intent. PDF 1.3+.

pub fn overprint(&mut self, overprint: bool) -> &mut Self

OP: Set the overprint mode for all operations, except if an op entry is present. If so, only influence the stroking operations. PDF 1.2+.

pub fn overprint_fill(&mut self, overprint: bool) -> &mut Self

op: Set the overprint mode for fill operations. PDF 1.3+.

pub fn font(&mut self, font: Name<'_>, size: f32) -> &mut Self

Font: Set the font. PDF 1.3+.

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

BG: Set the black generation function.

pub fn black_generation_default(&mut self) -> &mut Self

BG2: Set the black-generation function back to the function that has been in effect at the beginning of the page. PDF 1.3+.

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

UCR: Set the undercolor removal function.

pub fn undercolor_removal_default(&mut self) -> &mut Self

UCR2: Set the undercolor removal function back to the function that has been in effect at the beginning of the page. PDF 1.3+.

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

TR: Set the transfer function.

pub fn transfer_default(&mut self) -> &mut Self

TR2: Set the transfer function back to the function that has been in effect at the beginning of the page. PDF 1.3+.

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

HT: Set the halftone.

pub fn halftone_default(&mut self) -> &mut Self

HT: Set the halftone back to the halftone that has been in effect at the beginning of the page.

pub fn flatness(&mut self, tolerance: f32) -> &mut Self

FL: Set the flatness tolerance. PDF 1.3+.

pub fn smoothness(&mut self, tolerance: f32) -> &mut Self

SM: Set the smoothness tolerance. PDF 1.3+.

pub fn stroke_adjustment(&mut self, adjust: bool) -> &mut Self

SA: Set automatic stroke adjustment.

pub fn blend_mode(&mut self, mode: BlendMode) -> &mut Self

BM: Set the blend mode. PDF 1.4+.

pub fn soft_mask(&mut self) -> SoftMask<'_>

SMask: Set the soft mask using a dictionary. PDF 1.4+.

pub fn soft_mask_name(&mut self, mask: Name<'_>) -> &mut Self

SMask: Set the soft mask using a name. PDF 1.4+.

pub fn stroking_alpha(&mut self, alpha: f32) -> &mut Self

CA: Set the stroking alpha constant. PDF 1.4+.

pub fn non_stroking_alpha(&mut self, alpha: f32) -> &mut Self

ca: Set the non-stroking alpha constant. PDF 1.4+.

pub fn alpha_source(&mut self, source: bool) -> &mut Self

AIS: Set the alpha source flag. CA and ca values as well as the SMask will be interpreted as shape instead of opacity. PDF 1.4+.

pub fn text_knockout(&mut self, knockout: bool) -> &mut Self

TK: Set the text knockout flag. PDF 1.4+.

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

pub fn len(&self) -> i32

The number of written pairs.

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 ExtGraphicsState<'a>

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for ExtGraphicsState<'a>

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

Mutably dereferences the value.

impl<'a> Writer<'a> for ExtGraphicsState<'a>

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

Start writing the object.