Struct Paste

pub struct Paste<'img, 'mask, P: Pixel> {
    pub position: (u32, u32),
    pub image: &'img Image<P>,
    pub mask: Option<&'mask Image<BitPixel>>,
    pub overlay: Option<OverlayMode>,
}

Pastes or overlays an image on top of another image.

Fields

position: (u32, u32)

The position of the image to paste.

image: &'img Image<P>

A reference to the image to paste, or the foreground image.

mask: Option<&'mask Image<BitPixel>>

A refrence to an image that masks or filters out pixels based on the values of its own corresponding pixels.

Currently this ony supports images with the BitPixel type. If you want to mask alpha values, see Image::mask_alpha.

If this is None, all pixels will be overlaid on top of the image.

overlay: Option<OverlayMode>

The overlay mode of the image, or None to inherit from the background image.

Implementations

impl<'img, 'mask, P: Pixel> Paste<'img, 'mask, P>

pub const fn new(image: &'img Image<P>) -> Self

Creates a new image paste with from the given image with the position default to (0, 0).

pub const fn with_position(self, x: u32, y: u32) -> Self

Sets the position of where to paste the image at. The position is where the top-left corner of the image will be pasted.

pub fn with_mask(self, mask: &'mask Image<BitPixel>) -> Self

Sets the mask image to use. Currently this is only limited to BitPixel images.

This must have the same dimensions as the base foreground image! You will receive a panic if this is not the case.

Panics

• The mask image has different dimensions than the foreground image.

pub unsafe fn with_mask_unchecked(self, mask: &'mask Image<BitPixel>) -> Self

Sets the mask image to use. Currently this is only limited to BitPixel images.

Safety

This should have the same dimensions as the base foreground image! This method does not check for that though, however if this is not the case, you may get undescriptive panics later. Use Paste::with_mask instead if you are not 100% sure that the mask dimensions are valid.

pub const fn with_overlay_mode(self, mode: OverlayMode) -> Self

Sets the overlay mode of the image.

Trait Implementations

impl<'img, 'mask, P: Clone + Pixel> Clone for Paste<'img, 'mask, P>

fn clone(&self) -> Paste<'img, 'mask, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'img, 'mask, P: Pixel> Draw<P> for Paste<'img, 'mask, P>

fn draw<I: DerefMut<Target = Image<P>>>(&self, image: I)

Draws the object to the given image.