Struct plotters_unstable::prelude::BitMapBackend

pub struct BitMapBackend<'a, P = RGBPixel> where
    P: PixelFormat,  { /* fields omitted */ }

The backend that drawing a bitmap

Implementations

impl<'a> BitMapBackend<'a, RGBPixel>

pub fn new<T>(path: &'a T, (u32, u32)) -> BitMapBackend<'a, RGBPixel> where
    T: AsRef<Path> + ?Sized, 

Create a new bitmap backend

pub fn gif<T>(
    path: T,
    (u32, u32),
    frame_delay: u32
) -> Result<BitMapBackend<'a, RGBPixel>, BitMapBackendError> where
    T: AsRef<Path>, 

Create a new bitmap backend that generate GIF animation

When this is used, the bitmap backend acts similar to a real-time rendering backend. When the program finished drawing one frame, use present function to flush the frame into the GIF file.

• path: The path to the GIF file to create
• dimension: The size of the GIF image
• speed: The amount of time for each frame to display

pub fn with_buffer(buf: &'a mut [u8], (u32, u32)) -> BitMapBackend<'a, RGBPixel>

Create a new bitmap backend which only lives in-memory

When this is used, the bitmap backend will write to a user provided u8 array (or Vec) in RGB pixel format.

Note: This function provides backward compatibility for those code that assumes Plotters uses RGB pixel format and maniuplates the in-memory framebuffer. For more pixel format option, use with_buffer_and_format instead.

• buf: The buffer to operate
• dimension: The size of the image in pixels
• returns: The newly created bitmap backend

impl<'a, P> BitMapBackend<'a, P> where
    P: PixelFormat, 

pub fn with_buffer_and_format(
    buf: &'a mut [u8],
    (u32, u32)
) -> Result<BitMapBackend<'a, P>, BitMapBackendError>

Create a new bitmap backend with a in-memory buffer with specific pixel format.

Note: This can be used as a way to manipulate framebuffer, mmap can be used on the top of this as well.

• buf: The buffer to operate
• dimension: The size of the image in pixels
• returns: The newly created bitmap backend

pub fn split(&mut self, area_size: &[u32]) -> Vec<BitMapBackend<'_, P>>

Split a bitmap backend vertically into several sub drawing area which allows multi-threading rendering.

• area_size: The size of the area
• returns: The splitted backends that can be rendered in parallel

Trait Implementations

impl<'a, P> DrawingBackend for BitMapBackend<'a, P> where
    P: PixelFormat, 

type ErrorType = BitMapBackendError

The error type reported by the backend

fn get_size(&self) -> (u32, u32)

Get the dimension of the drawing backend in pixels

fn ensure_prepared(
    &mut self
) -> Result<(), DrawingErrorKind<BitMapBackendError>>

Ensure the backend is ready to draw

fn present(&mut self) -> Result<(), DrawingErrorKind<BitMapBackendError>>

Finalize the drawing step and present all the changes. This is used as the real-time rendering support. The backend may implement in the following way, when ensure_prepared is called it checks if it needs a fresh buffer and present is called rendering all the pending changes on the screen.

fn draw_pixel(
    &mut self,
    point: (i32, i32),
    color: BackendColor
) -> Result<(), DrawingErrorKind<BitMapBackendError>>

Draw a pixel on the drawing backend - point: The backend pixel-based coordinate to draw - color: The color of the pixel

fn draw_line<S>(
    &mut self,
    from: (i32, i32),
    to: (i32, i32),
    style: &S
) -> Result<(), DrawingErrorKind<<BitMapBackend<'a, P> as DrawingBackend>::ErrorType>> where
    S: BackendStyle, 

Draw a line on the drawing backend - from: The start point of the line - to: The end point of the line - style: The style of the line

fn draw_rect<S>(
    &mut self,
    upper_left: (i32, i32),
    bottom_right: (i32, i32),
    style: &S,
    fill: bool
) -> Result<(), DrawingErrorKind<<BitMapBackend<'a, P> as DrawingBackend>::ErrorType>> where
    S: BackendStyle, 

Draw a rectangle on the drawing backend - upper_left: The coordinate of the upper-left corner of the rect - bottom_right: The coordinate of the bottom-right corner of the rect - style: The style - fill: If the rectangle should be filled

fn blit_bitmap(
    &mut self,
    pos: (i32, i32),
    (u32, u32),
    src: &'b [u8]
) -> Result<(), DrawingErrorKind<<BitMapBackend<'a, P> as DrawingBackend>::ErrorType>>

Blit a bitmap on to the backend.

fn draw_path<S, I>(
    &mut self,
    path: I,
    style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
    I: IntoIterator<Item = (i32, i32)>,
    S: BackendStyle, 

Draw a path on the drawing backend - path: The iterator of key points of the path - style: The style of the path

fn draw_circle<S>(
    &mut self,
    center: (i32, i32),
    radius: u32,
    style: &S,
    fill: bool
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
    S: BackendStyle, 

Draw a circle on the drawing backend - center: The center coordinate of the circle - radius: The radius of the circle - style: The style of the shape - fill: If the circle should be filled

fn fill_polygon<S, I>(
    &mut self,
    vert: I,
    style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
    I: IntoIterator<Item = (i32, i32)>,
    S: BackendStyle, 

fn draw_text<TStyle>(
    &mut self,
    text: &str,
    style: &TStyle,
    pos: (i32, i32)
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
    TStyle: BackendTextStyle, 

Draw a text on the drawing backend - text: The text to draw - style: The text style - pos : The text anchor point

fn estimate_text_size<TStyle>(
    &self,
    text: &str,
    style: &TStyle
) -> Result<(u32, u32), DrawingErrorKind<Self::ErrorType>> where
    TStyle: BackendTextStyle, 

Estimate the size of the horizontal text if rendered on this backend. This is important because some of the backend may not have font ability. Thus this allows those backend reports proper value rather than ask the font rasterizer for that.

impl<'_, P> Drop for BitMapBackend<'_, P> where
    P: PixelFormat, 

fn drop(&mut self)

Executes the destructor for this type.