Struct genpdf::elements::Image

pub struct Image { /* fields omitted */ }

An image to embed in the PDF.

Only available if the images feature is enabled.

This struct is a wrapper around the configurations printpdf::Image exposes.

Supported Formats

All formats supported by the image should be supported by this crate. The BMP, JPEG and PNG formats are well tested and known to work. Yet it is currently not possible to render images with transparency, see printpdf issue #98.

Note that only the GIF, JPEG, PNG, PNM, TIFF and BMP formats are enabled by default. If you want to use other formats, you have to add the image crate as a dependency and activate the required feature.

Example

use std::convert::TryFrom;
use genpdf::elements;
let image = elements::Image::from_path("examples/images/test_image.jpg")
      .expect("Failed to load test image")
      .with_alignment(genpdf::Alignment::Center) // Center the image on the page.
      .with_scale(genpdf::Scale::new(0.5, 2)); // Squeeze and then stretch upwards.

Implementations

impl Image

pub fn from_dynamic_image(data: DynamicImage) -> Result<Self, Error>

Creates a new image from an already loaded image.

pub fn from_reader<R>(reader: R) -> Result<Self, Error> where
    R: BufRead,
    R: Read,
    R: Seek, 

Creates a new image from the given reader.

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, Error>

Creates a new image by reading from the given path.

pub fn set_position(&mut self, position: impl Into<Position>)

Translates the image over to position.

pub fn with_position(self, position: impl Into<Position>) -> Self

Translates the image over to position and returns it.

pub fn set_scale(&mut self, scale: impl Into<Scale>)

Scales the image.

pub fn with_scale(self, scale: impl Into<Scale>) -> Self

Scales the image and returns it.

pub fn set_alignment(&mut self, alignment: impl Into<Alignment>)

Sets the alignment to use for this image.

pub fn with_alignment(self, alignment: impl Into<Alignment>) -> Self

Sets the alignment to use for this image and returns it.

pub fn set_clockwise_rotation(&mut self, rotation: impl Into<Rotation>)

Sets the clockwise rotation of the image around the bottom left corner.

pub fn with_clockwise_rotation(self, rotation: impl Into<Rotation>) -> Self

Sets the clockwise rotation of the image around the bottom left corner and then returns the image.

pub fn set_dpi(&mut self, dpi: f64)

Sets the expected DPI of the encoded image.

pub fn with_dpi(self, dpi: f64) -> Self

Sets the expected DPI of the encoded image and returns it.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Element for Image

fn render(
    &mut self,
    _context: &Context,
    area: Area<'_>,
    _style: Style
) -> Result<RenderResult, Error>

Renders this element to the given area using the given style and font cache.

fn framed(self) -> FramedElement<Self> where
    Self: Sized, 

Draws a frame around this element.

fn padded(self, padding: impl Into<Margins>) -> PaddedElement<Self> where
    Self: Sized, 

Adds a padding to this element.

fn styled(self, style: impl Into<Style>) -> StyledElement<Self> where
    Self: Sized, 

Sets the default style for this element and its children.