pub struct PdfPageImageObject<'a> { /* private fields */ }Expand description
A single PdfPageObject of type PdfPageObjectType::Image. The page object defines a single
bitmapped image.
Page objects can be created either attached to a PdfPage (in which case the page object’s
memory is owned by the containing page) or detached from any page (in which case the page
object’s memory is owned by the object). Page objects are not rendered until they are
attached to a page; page objects that are never attached to a page will be lost when they
fall out of scope.
The simplest way to create a page image object that is immediately attached to a page
is to call the PdfPageObjects::create_image_object() function.
Creating a detached page image object offers more scope for customization, but you must
add the object to a containing PdfPage manually. To create a detached page image object,
use the PdfPageImageObject::new() function. The detached page image object can later
be attached to a page by using the PdfPageObjects::add_image_object() function.
Implementations§
source§impl<'a> PdfPageImageObject<'a>
impl<'a> PdfPageImageObject<'a>
sourcepub fn new(
document: &PdfDocument<'a>,
image: &DynamicImage
) -> Result<Self, PdfiumError>
pub fn new(
document: &PdfDocument<'a>,
image: &DynamicImage
) -> Result<Self, PdfiumError>
Creates a new PdfPageImageObject from the given arguments. The returned page object
will not be rendered until it is added to a PdfPage using the
PdfPageObjects::add_image_object() function.
The returned page object will have its width and height both set to 1.0 points. Use the PdfPageObjectCommon::scale() function to apply a horizontal and vertical scale to the object after it is created, or use one of the PdfPageImageObject::new_with_width(), PdfPageImageObject::new_with_height(), or PdfPageImageObject::new_with_size() functions to scale the page object to a specific width and/or height at the time the object is created.
This function is only available when this crate’s image feature is enabled.
sourcepub fn new_with_width(
document: &PdfDocument<'a>,
image: &DynamicImage,
width: PdfPoints
) -> Result<Self, PdfiumError>
pub fn new_with_width(
document: &PdfDocument<'a>,
image: &DynamicImage,
width: PdfPoints
) -> Result<Self, PdfiumError>
Creates a new PdfPageImageObject from the given arguments. The page object will be scaled
horizontally to match the given width; its height will be adjusted to maintain the aspect
ratio of the given image. The returned page object will not be rendered until it is
added to a PdfPage using the PdfPageObjects::add_image_object() function.
This function is only available when this crate’s image feature is enabled.
sourcepub fn new_with_height(
document: &PdfDocument<'a>,
image: &DynamicImage,
height: PdfPoints
) -> Result<Self, PdfiumError>
pub fn new_with_height(
document: &PdfDocument<'a>,
image: &DynamicImage,
height: PdfPoints
) -> Result<Self, PdfiumError>
Creates a new PdfPageImageObject from the given arguments. The page object will be scaled
vertically to match the given height; its width will be adjusted to maintain the aspect
ratio of the given image. The returned page object will not be rendered until it is
added to a PdfPage using the PdfPageObjects::add_image_object() function.
This function is only available when this crate’s image feature is enabled.
sourcepub fn new_with_size(
document: &PdfDocument<'a>,
image: &DynamicImage,
width: PdfPoints,
height: PdfPoints
) -> Result<Self, PdfiumError>
pub fn new_with_size(
document: &PdfDocument<'a>,
image: &DynamicImage,
width: PdfPoints,
height: PdfPoints
) -> Result<Self, PdfiumError>
Creates a new PdfPageImageObject from the given arguments. The page object will be scaled to
match the given width and height. The returned page object will not be rendered until it is
added to a PdfPage using the PdfPageObjects::add_image_object() function.
This function is only available when this crate’s image feature is enabled.
sourcepub fn get_raw_bitmap(&self) -> Result<PdfBitmap<'_>, PdfiumError>
pub fn get_raw_bitmap(&self) -> Result<PdfBitmap<'_>, PdfiumError>
Returns a new PdfBitmap created from the bitmap buffer backing this PdfPageImageObject, ignoring any image filters, image mask, or object transforms applied to this page object.
sourcepub fn get_raw_image(&self) -> Result<DynamicImage, PdfiumError>
pub fn get_raw_image(&self) -> Result<DynamicImage, PdfiumError>
Returns a new Image::DynamicImage created from the bitmap buffer backing
this PdfPageImageObject, ignoring any image filters, image mask, or object
transforms applied to this page object.
This function is only available when this crate’s image feature is enabled.
sourcepub fn get_processed_bitmap(
&self,
document: &PdfDocument<'_>
) -> Result<PdfBitmap<'_>, PdfiumError>
pub fn get_processed_bitmap(
&self,
document: &PdfDocument<'_>
) -> Result<PdfBitmap<'_>, PdfiumError>
Returns a new PdfBitmap created from the bitmap buffer backing this PdfPageImageObject, taking into account any image filters, image mask, and object transforms applied to this page object.
sourcepub fn get_processed_image(
&self,
document: &PdfDocument<'_>
) -> Result<DynamicImage, PdfiumError>
pub fn get_processed_image(
&self,
document: &PdfDocument<'_>
) -> Result<DynamicImage, PdfiumError>
Returns a new Image::DynamicImage created from the bitmap buffer backing
this PdfPageImageObject, taking into account any image filters, image mask, and
object transforms applied to this page object.
This function is only available when this crate’s image feature is enabled.
sourcepub fn get_processed_bitmap_with_width(
&self,
document: &PdfDocument<'_>,
width: Pixels
) -> Result<PdfBitmap<'_>, PdfiumError>
pub fn get_processed_bitmap_with_width(
&self,
document: &PdfDocument<'_>,
width: Pixels
) -> Result<PdfBitmap<'_>, PdfiumError>
Returns a new PdfBitmap created from the bitmap buffer backing this PdfPageImageObject, taking into account any image filters, image mask, and object transforms applied to this page object.
The returned bitmap will be scaled during rendering so its width matches the given target width.
sourcepub fn get_processed_image_with_width(
&self,
document: &PdfDocument<'_>,
width: Pixels
) -> Result<DynamicImage, PdfiumError>
pub fn get_processed_image_with_width(
&self,
document: &PdfDocument<'_>,
width: Pixels
) -> Result<DynamicImage, PdfiumError>
Returns a new Image::DynamicImage created from the bitmap buffer backing
this PdfPageImageObject, taking into account any image filters, image mask, and
object transforms applied to this page object.
The returned image will be scaled during rendering so its width matches the given target width.
This function is only available when this crate’s image feature is enabled.
sourcepub fn get_processed_bitmap_with_height(
&self,
document: &PdfDocument<'_>,
height: Pixels
) -> Result<PdfBitmap<'_>, PdfiumError>
pub fn get_processed_bitmap_with_height(
&self,
document: &PdfDocument<'_>,
height: Pixels
) -> Result<PdfBitmap<'_>, PdfiumError>
Returns a new PdfBitmap created from the bitmap buffer backing this PdfPageImageObject, taking into account any image filters, image mask, and object transforms applied to this page object.
The returned bitmap will be scaled during rendering so its height matches the given target height.
sourcepub fn get_processed_image_with_height(
&self,
document: &PdfDocument<'_>,
height: Pixels
) -> Result<DynamicImage, PdfiumError>
pub fn get_processed_image_with_height(
&self,
document: &PdfDocument<'_>,
height: Pixels
) -> Result<DynamicImage, PdfiumError>
Returns a new Image::DynamicImage created from the bitmap buffer backing
this PdfPageImageObject, taking into account any image filters, image mask, and
object transforms applied to this page object.
The returned image will be scaled during rendering so its height matches the given target height.
This function is only available when this crate’s image feature is enabled.
sourcepub fn get_processed_bitmap_with_size(
&self,
document: &PdfDocument<'_>,
width: Pixels,
height: Pixels
) -> Result<PdfBitmap<'_>, PdfiumError>
pub fn get_processed_bitmap_with_size(
&self,
document: &PdfDocument<'_>,
width: Pixels,
height: Pixels
) -> Result<PdfBitmap<'_>, PdfiumError>
Returns a new [PdfBitmap created from the bitmap buffer backing this PdfPageImageObject, taking into account any image filters, image mask, and object transforms applied to this page object.
The returned bitmap will be scaled during rendering so its width and height match the given target dimensions.
sourcepub fn get_processed_image_with_size(
&self,
document: &PdfDocument<'_>,
width: Pixels,
height: Pixels
) -> Result<DynamicImage, PdfiumError>
pub fn get_processed_image_with_size(
&self,
document: &PdfDocument<'_>,
width: Pixels,
height: Pixels
) -> Result<DynamicImage, PdfiumError>
Returns a new Image::DynamicImage created from the bitmap buffer backing
this PdfPageImageObject, taking into account any image filters, image mask, and
object transforms applied to this page object.
The returned image will be scaled during rendering so its width and height match the given target dimensions.
This function is only available when this crate’s image feature is enabled.
sourcepub fn set_image(&mut self, image: &DynamicImage) -> Result<(), PdfiumError>
pub fn set_image(&mut self, image: &DynamicImage) -> Result<(), PdfiumError>
Applies the byte data in the given Image::DynamicImage to this PdfPageImageObject.
This function is only available when this crate’s image feature is enabled.
sourcepub fn set_bitmap(&mut self, bitmap: &PdfBitmap<'_>) -> Result<(), PdfiumError>
pub fn set_bitmap(&mut self, bitmap: &PdfBitmap<'_>) -> Result<(), PdfiumError>
Applies the byte data in the given PdfBitmap to this PdfPageImageObject.
sourcepub fn horizontal_dpi(&self) -> Result<f32, PdfiumError>
pub fn horizontal_dpi(&self) -> Result<f32, PdfiumError>
Returns the horizontal dots per inch resolution of the image assigned to this PdfPageImageObject, based on the intrinsic resolution of the assigned image and the dimensions of this object.
sourcepub fn vertical_dpi(&self) -> Result<f32, PdfiumError>
pub fn vertical_dpi(&self) -> Result<f32, PdfiumError>
Returns the vertical dots per inch resolution of the image assigned to this PdfPageImageObject, based on the intrinsic resolution of the assigned image and the dimensions of this object.
sourcepub fn bits_per_pixel(&self) -> Result<u8, PdfiumError>
pub fn bits_per_pixel(&self) -> Result<u8, PdfiumError>
Returns the bits per pixel for the image assigned to this PdfPageImageObject.
This value is not available if this object has not been attached to a PdfPage.
sourcepub fn color_space(&self) -> Result<PdfColorSpace, PdfiumError>
pub fn color_space(&self) -> Result<PdfColorSpace, PdfiumError>
Returns the color space for the image assigned to this PdfPageImageObject.
This value is not available if this object has not been attached to a PdfPage.
sourcepub fn filters(&self) -> PdfPageImageObjectFilters<'_>
pub fn filters(&self) -> PdfPageImageObjectFilters<'_>
Returns the collection of image filters currently applied to this PdfPageImageObject.
Trait Implementations§
source§impl<'a> From<PdfPageImageObject<'a>> for PdfPageObject<'a>
impl<'a> From<PdfPageImageObject<'a>> for PdfPageObject<'a>
source§fn from(object: PdfPageImageObject<'a>) -> Self
fn from(object: PdfPageImageObject<'a>) -> Self
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for PdfPageImageObject<'a>
impl<'a> !Send for PdfPageImageObject<'a>
impl<'a> !Sync for PdfPageImageObject<'a>
impl<'a> Unpin for PdfPageImageObject<'a>
impl<'a> !UnwindSafe for PdfPageImageObject<'a>
Blanket Implementations§
source§impl<'a, T> PdfPageObjectCommon<'a> for Twhere
T: PdfPageObjectPrivate<'a>,
impl<'a, T> PdfPageObjectCommon<'a> for Twhere
T: PdfPageObjectPrivate<'a>,
source§fn has_transparency(&self) -> bool
fn has_transparency(&self) -> bool
true if this PdfPageObject contains transparency.source§fn bounds(&self) -> Result<PdfRect, PdfiumError>
fn bounds(&self) -> Result<PdfRect, PdfiumError>
source§fn transform(
&mut self,
a: f64,
b: f64,
c: f64,
d: f64,
e: f64,
f: f64
) -> Result<(), PdfiumError>
fn transform(
&mut self,
a: f64,
b: f64,
c: f64,
d: f64,
e: f64,
f: f64
) -> Result<(), PdfiumError>
source§fn transform_from(
&mut self,
other: &PdfPageObject<'_>
) -> Result<(), PdfiumError>
fn transform_from(
&mut self,
other: &PdfPageObject<'_>
) -> Result<(), PdfiumError>
source§fn get_horizontal_translation(&self) -> PdfPoints
fn get_horizontal_translation(&self) -> PdfPoints
source§fn get_vertical_translation(&self) -> PdfPoints
fn get_vertical_translation(&self) -> PdfPoints
source§fn get_horizontal_scale(&self) -> f64
fn get_horizontal_scale(&self) -> f64
source§fn get_vertical_scale(&self) -> f64
fn get_vertical_scale(&self) -> f64
source§fn get_rotation_counter_clockwise_radians(&self) -> f32
fn get_rotation_counter_clockwise_radians(&self) -> f32
source§fn get_x_axis_skew_radians(&self) -> f32
fn get_x_axis_skew_radians(&self) -> f32
source§fn get_y_axis_skew_radians(&self) -> f32
fn get_y_axis_skew_radians(&self) -> f32
source§fn set_blend_mode(
&mut self,
blend_mode: PdfPageObjectBlendMode
) -> Result<(), PdfiumError>
fn set_blend_mode(
&mut self,
blend_mode: PdfPageObjectBlendMode
) -> Result<(), PdfiumError>
source§fn fill_color(&self) -> Result<PdfColor, PdfiumError>
fn fill_color(&self) -> Result<PdfColor, PdfiumError>
source§fn set_fill_color(&mut self, fill_color: PdfColor) -> Result<(), PdfiumError>
fn set_fill_color(&mut self, fill_color: PdfColor) -> Result<(), PdfiumError>
source§fn stroke_color(&self) -> Result<PdfColor, PdfiumError>
fn stroke_color(&self) -> Result<PdfColor, PdfiumError>
source§fn set_stroke_color(&mut self, stroke_color: PdfColor) -> Result<(), PdfiumError>
fn set_stroke_color(&mut self, stroke_color: PdfColor) -> Result<(), PdfiumError>
source§fn stroke_width(&self) -> Result<PdfPoints, PdfiumError>
fn stroke_width(&self) -> Result<PdfPoints, PdfiumError>
source§fn set_stroke_width(
&mut self,
stroke_width: PdfPoints
) -> Result<(), PdfiumError>
fn set_stroke_width(
&mut self,
stroke_width: PdfPoints
) -> Result<(), PdfiumError>
source§fn line_join(&self) -> Result<PdfPageObjectLineJoin, PdfiumError>
fn line_join(&self) -> Result<PdfPageObjectLineJoin, PdfiumError>
source§fn set_line_join(
&mut self,
line_join: PdfPageObjectLineJoin
) -> Result<(), PdfiumError>
fn set_line_join(
&mut self,
line_join: PdfPageObjectLineJoin
) -> Result<(), PdfiumError>
source§fn line_cap(&self) -> Result<PdfPageObjectLineCap, PdfiumError>
fn line_cap(&self) -> Result<PdfPageObjectLineCap, PdfiumError>
source§fn set_line_cap(
&mut self,
line_cap: PdfPageObjectLineCap
) -> Result<(), PdfiumError>
fn set_line_cap(
&mut self,
line_cap: PdfPageObjectLineCap
) -> Result<(), PdfiumError>
source§fn is_copyable(&self) -> bool
fn is_copyable(&self) -> bool
true if this PdfPageObject can be successfully copied by calling its
try_copy() function. Read moresource§fn try_copy<'b>(
&self,
document: &PdfDocument<'b>
) -> Result<PdfPageObject<'b>, PdfiumError>
fn try_copy<'b>(
&self,
document: &PdfDocument<'b>
) -> Result<PdfPageObject<'b>, PdfiumError>
source§fn width(&self) -> Result<PdfPoints, PdfiumError>
fn width(&self) -> Result<PdfPoints, PdfiumError>
source§fn height(&self) -> Result<PdfPoints, PdfiumError>
fn height(&self) -> Result<PdfPoints, PdfiumError>
source§fn is_inside_rect(&self, rect: &PdfRect) -> bool
fn is_inside_rect(&self, rect: &PdfRect) -> bool
true if the bounds of this PdfPageObject lie entirely within the given rectangle.source§fn does_overlap_rect(&self, rect: &PdfRect) -> bool
fn does_overlap_rect(&self, rect: &PdfRect) -> bool
true if the bounds of this PdfPageObject lie at least partially within
the given rectangle.