Struct pdf_writer::writers::Shading

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

Writer for a shading dictionary. PDF 1.3+.

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

Implementations

impl<'a> Shading<'a>

pub fn shading_type(&mut self, shading_type: ShadingType) -> &mut Self

Write the /ShadingType attribute.

Sets the type of shading. The available and required attributes change depending on this. Required.

pub fn color_space(&mut self) -> ColorSpace<'_>

Write the /ColorSpace attribute.

Sets the color space of the shading function. May not be a Pattern space. Required.

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

Write the /Background attribute.

Sets the background color of the area to be shaded. The background iterator must contain exactly as many elements as the current color space has dimensions.

pub fn bbox(&mut self, bbox: Rect) -> &mut Self

Write the /BBox attribute.

Sets the bounding box of the shading in the target coordinate system.

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

Write the /AntiAlias attribute.

Sets whether to anti-alias the shading.

pub fn domain(&mut self, domain: [f32; 4]) -> &mut Self

Write the /Domain attribute.

Sets the domain of the shading function in a rectangle. Can be used for function, axial, or radial shadings. Will otherwise default to [x_min = 0, x_max = 1, y_min = 0, y_max = 1]

pub fn matrix(&mut self, matrix: [f32; 6]) -> &mut Self

Write the /Matrix attribute.

Maps the shading domain rectangle to the target coordinate system. Can be used for function shadings. Will otherwise default to the identity matrix.

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

Write the /Function attribute.

Sets the 2-in function to use for shading. Required.

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

Write the /Coords attribute.

Sets the coordinates of the start and end of the axis in terms of the target coordinate system. Required for axial (4 items) and radial (6 items; centers and radii) shadings.

pub fn extend(&mut self, extend: [bool; 2]) -> &mut Self

Write the /Extend attribute.

Set whether the shading should extend beyond either side of the axis / circles. Can be used for axial and radial shadings.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Shading<'a>

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

Mutably dereferences the value.

impl<'a> Writer<'a> for Shading<'a>

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

Start writing the object.