Struct plotters::element::BitMapElement

pub struct BitMapElement<'a, Coord, P: PixelFormat = RGBPixel> { /* private fields */ }

The element that contains a bitmap on it

Implementations

impl<'a, Coord, P: PixelFormat> BitMapElement<'a, Coord, P>

pub fn new(pos: Coord, size: (u32, u32)) -> Self

Create a new empty bitmap element. This can be use as the draw and blit pattern.

• pos: The left upper coordinate for the element
• size: The size of the bitmap

pub fn with_owned_buffer(
    pos: Coord,
    size: (u32, u32),
    buf: Vec<u8>
) -> Option<Self>

Create a new bitmap element with an pre-allocated owned buffer, this function will take the ownership of the buffer.

• pos: The left upper coordinate of the elelent
• size: The size of the bitmap
• buf: The buffer to use
• returns: The newly created image element, if the buffer isn’t fit the image dimension, this will returns an None.

pub fn with_mut(pos: Coord, size: (u32, u32), buf: &'a mut [u8]) -> Option<Self>

Create a new bitmap element with a mut borrow to an existing buffer

• pos: The left upper coordinate of the elelent
• size: The size of the bitmap
• buf: The buffer to use
• returns: The newly created image element, if the buffer isn’t fit the image dimension, this will returns an None.

pub fn with_ref(pos: Coord, size: (u32, u32), buf: &'a [u8]) -> Option<Self>

Create a new bitmap element with a shared borrowed buffer. This means if we want to modifiy the content of the image, the buffer is automatically copied

• pos: The left upper coordinate of the elelent
• size: The size of the bitmap
• buf: The buffer to use
• returns: The newly created image element, if the buffer isn’t fit the image dimension, this will returns an None.

pub fn copy_to<Coord2>(&self, pos: Coord2) -> BitMapElement<'_, Coord2, P>

Copy the existing bitmap element to another location

• pos: The new location to copy

pub fn move_to(&mut self, pos: Coord)

Move the existing bitmap element to a new position

• pos: The new position

pub fn as_bitmap_backend(&mut self) -> BitMapBackend<'_, P>

Make the bitmap element as a bitmap backend, so that we can use plotters drawing functionality on the bitmap element

Trait Implementations

impl<'a, Coord, DB: DrawingBackend> Drawable<DB, BackendCoordOnly> for BitMapElement<'a, Coord>

fn draw<I: Iterator<Item = BackendCoord>>(
    &self,
    points: I,
    backend: &mut DB,
    _: (u32, u32)
) -> Result<(), DrawingErrorKind<DB::ErrorType>>

Actually draws the element. The key points is already translated into the image coordinate and can be used by DC directly

impl<'a, Coord> From<(Coord, DynamicImage)> for BitMapElement<'a, Coord, BGRXPixel>

fn from((pos, image): (Coord, DynamicImage)) -> Self

Converts to this type from the input type.

impl<'a, Coord> From<(Coord, DynamicImage)> for BitMapElement<'a, Coord, RGBPixel>

fn from((pos, image): (Coord, DynamicImage)) -> Self

Converts to this type from the input type.

impl<'a, 'b, Coord> PointCollection<'a, Coord, BackendCoordOnly> for &'a BitMapElement<'b, Coord>

type Point = &'a Coord

The item in point iterator

type IntoIter = Once<&'a Coord>

The point iterator

fn point_iter(self) -> Self::IntoIter

framework to do the coordinate mapping