Struct plotters_bitmap::BitMapBackend [−][src]
pub struct BitMapBackend<'a, P: PixelFormat = RGBPixel> { /* fields omitted */ }
Expand description
The backend that drawing a bitmap
Implementations
impl<'a> BitMapBackend<'a, RGBPixel>
[src]
impl<'a> BitMapBackend<'a, RGBPixel>
[src]pub fn new<T: AsRef<Path> + ?Sized>(path: &'a T, (w, h): (u32, u32)) -> Self
[src]
pub fn new<T: AsRef<Path> + ?Sized>(path: &'a T, (w, h): (u32, u32)) -> Self
[src]Create a new bitmap backend
pub fn gif<T: AsRef<Path>>(
path: T,
(w, h): (u32, u32),
frame_delay: u32
) -> Result<Self, BitMapBackendError>
[src]
pub fn gif<T: AsRef<Path>>(
path: T,
(w, h): (u32, u32),
frame_delay: u32
) -> Result<Self, BitMapBackendError>
[src]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 createdimension
: The size of the GIF imagespeed
: The amount of time for each frame to display
pub fn with_buffer(buf: &'a mut [u8], (w, h): (u32, u32)) -> Self
[src]
pub fn with_buffer(buf: &'a mut [u8], (w, h): (u32, u32)) -> Self
[src]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
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 operatedimension
: The size of the image in pixels- returns: The newly created bitmap backend
impl<'a, P: PixelFormat> BitMapBackend<'a, P>
[src]
impl<'a, P: PixelFormat> BitMapBackend<'a, P>
[src]pub fn with_buffer_and_format(
buf: &'a mut [u8],
(w, h): (u32, u32)
) -> Result<Self, BitMapBackendError>
[src]
pub fn with_buffer_and_format(
buf: &'a mut [u8],
(w, h): (u32, u32)
) -> Result<Self, BitMapBackendError>
[src]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 operatedimension
: The size of the image in pixels- returns: The newly created bitmap backend
Trait Implementations
impl<'a, P: PixelFormat> DrawingBackend for BitMapBackend<'a, P>
[src]
impl<'a, P: PixelFormat> DrawingBackend for BitMapBackend<'a, P>
[src]type ErrorType = BitMapBackendError
type ErrorType = BitMapBackendError
The error type reported by the backend
fn ensure_prepared(
&mut self
) -> Result<(), DrawingErrorKind<BitMapBackendError>>
[src]
fn ensure_prepared(
&mut self
) -> Result<(), DrawingErrorKind<BitMapBackendError>>
[src]Ensure the backend is ready to draw
fn present(&mut self) -> Result<(), DrawingErrorKind<BitMapBackendError>>
[src]
fn present(&mut self) -> Result<(), DrawingErrorKind<BitMapBackendError>>
[src]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. Read more
fn draw_pixel(
&mut self,
point: BackendCoord,
color: BackendColor
) -> Result<(), DrawingErrorKind<BitMapBackendError>>
[src]
fn draw_pixel(
&mut self,
point: BackendCoord,
color: BackendColor
) -> Result<(), DrawingErrorKind<BitMapBackendError>>
[src]Draw a pixel on the drawing backend Read more
fn draw_line<S: BackendStyle>(
&mut self,
from: (i32, i32),
to: (i32, i32),
style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>>
[src]
fn draw_line<S: BackendStyle>(
&mut self,
from: (i32, i32),
to: (i32, i32),
style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>>
[src]Draw a line on the drawing backend Read more
fn draw_rect<S: BackendStyle>(
&mut self,
upper_left: (i32, i32),
bottom_right: (i32, i32),
style: &S,
fill: bool
) -> Result<(), DrawingErrorKind<Self::ErrorType>>
[src]
fn draw_rect<S: BackendStyle>(
&mut self,
upper_left: (i32, i32),
bottom_right: (i32, i32),
style: &S,
fill: bool
) -> Result<(), DrawingErrorKind<Self::ErrorType>>
[src]Draw a rectangle on the drawing backend Read more
fn blit_bitmap<'b>(
&mut self,
pos: BackendCoord,
(sw, sh): (u32, u32),
src: &'b [u8]
) -> Result<(), DrawingErrorKind<Self::ErrorType>>
[src]
fn blit_bitmap<'b>(
&mut self,
pos: BackendCoord,
(sw, sh): (u32, u32),
src: &'b [u8]
) -> Result<(), DrawingErrorKind<Self::ErrorType>>
[src]Blit a bitmap on to the backend. Read more
fn draw_path<S, I>(
&mut self,
path: I,
style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
S: BackendStyle,
I: IntoIterator<Item = (i32, i32)>,
[src]
fn draw_path<S, I>(
&mut self,
path: I,
style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
S: BackendStyle,
I: IntoIterator<Item = (i32, i32)>,
[src]Draw a path on the drawing backend Read more
fn draw_circle<S>(
&mut self,
center: (i32, i32),
radius: u32,
style: &S,
fill: bool
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
S: BackendStyle,
[src]
fn draw_circle<S>(
&mut self,
center: (i32, i32),
radius: u32,
style: &S,
fill: bool
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
S: BackendStyle,
[src]Draw a circle on the drawing backend Read more
fn fill_polygon<S, I>(
&mut self,
vert: I,
style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
S: BackendStyle,
I: IntoIterator<Item = (i32, i32)>,
[src]
&mut self,
vert: I,
style: &S
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
S: BackendStyle,
I: IntoIterator<Item = (i32, i32)>,
fn draw_text<TStyle>(
&mut self,
text: &str,
style: &TStyle,
pos: (i32, i32)
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
TStyle: BackendTextStyle,
[src]
fn draw_text<TStyle>(
&mut self,
text: &str,
style: &TStyle,
pos: (i32, i32)
) -> Result<(), DrawingErrorKind<Self::ErrorType>> where
TStyle: BackendTextStyle,
[src]Draw a text on the drawing backend Read more
fn estimate_text_size<TStyle>(
&self,
text: &str,
style: &TStyle
) -> Result<(u32, u32), DrawingErrorKind<Self::ErrorType>> where
TStyle: BackendTextStyle,
[src]
fn estimate_text_size<TStyle>(
&self,
text: &str,
style: &TStyle
) -> Result<(u32, u32), DrawingErrorKind<Self::ErrorType>> where
TStyle: BackendTextStyle,
[src]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. Read more
impl<P: PixelFormat> Drop for BitMapBackend<'_, P>
[src]
impl<P: PixelFormat> Drop for BitMapBackend<'_, P>
[src]Auto Trait Implementations
impl<'a, P> RefUnwindSafe for BitMapBackend<'a, P> where
P: RefUnwindSafe,
P: RefUnwindSafe,
impl<'a, P> Send for BitMapBackend<'a, P> where
P: Send,
P: Send,
impl<'a, P> Sync for BitMapBackend<'a, P> where
P: Sync,
P: Sync,
impl<'a, P> Unpin for BitMapBackend<'a, P> where
P: Unpin,
P: Unpin,