mirrors/ili9341-rs
1
0
Fork 0
mirror of https://github.com/yuri91/ili9341-rs.git synced 2024-11-25 08:00:59 +00:00
Code Issues Projects Releases Wiki Activity

Fix doc text

Browse source
This commit is contained in:
Yuri Iozzelli 2018-03-04 18:44:19 +01:00
parent 08ac46ea1b
commit 6e2f56ac62
1 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/lib.rs
View file

@ -31,10 +31,16 @@ pub enum Orientation {
LandscapeFlipped, LandscapeFlipped,
} }
/// There are two method for drawing to the screen: draw_raw and draw_iter. /// There are two method for drawing to the screen:
/// [draw_raw](struct.Ili9341.html#method.draw_raw) and
/// [draw_iter](struct.Ili9341.html#method.draw_iter).
///
/// In both cases the expected pixel format is rgb565. /// In both cases the expected pixel format is rgb565.
///
/// The hardware makes it efficient to draw rectangles on the screen. /// The hardware makes it efficient to draw rectangles on the screen.
///
/// What happens is the following: /// What happens is the following:
///
/// - A drawing window is prepared (with the 2 opposite corner coordinates) /// - A drawing window is prepared (with the 2 opposite corner coordinates)
/// - The starting point for drawint is the top left corner of this window /// - The starting point for drawint is the top left corner of this window
/// - Every pair of bytes received is intepreted as a pixel value in rgb565 /// - Every pair of bytes received is intepreted as a pixel value in rgb565
@ -179,8 +185,12 @@ where
Ok(()) Ok(())
} }
/// Draw a rectangle on the screen, represented by top-left corner (x0, y0) /// Draw a rectangle on the screen, represented by top-left corner (x0, y0)
/// and bottom-right corner (x1, y1). The border is included. /// and bottom-right corner (x1, y1).
///
/// The border is included.
///
/// This method accepts an iterator of rgb565 pixel values. /// This method accepts an iterator of rgb565 pixel values.
///
/// The iterator is useful to avoid wasting memory by holding a buffer for /// The iterator is useful to avoid wasting memory by holding a buffer for
/// the whole screen when it is not necessary. /// the whole screen when it is not necessary.
pub fn draw_iter<I: IntoIterator<Item=u16>>(&mut self, x0: u16, y0: u16, x1: u16, y1: u16, data: I) -> Result<(), Error<E>> { pub fn draw_iter<I: IntoIterator<Item=u16>>(&mut self, x0: u16, y0: u16, x1: u16, y1: u16, data: I) -> Result<(), Error<E>> {
@ -188,10 +198,15 @@ where
self.write_iter(data) self.write_iter(data)
} }
/// Draw a rectangle on the screen, represented by top-left corner (x0, y0) /// Draw a rectangle on the screen, represented by top-left corner (x0, y0)
/// and bottom-right corner (x1, y1). The border is included. /// and bottom-right corner (x1, y1).
///
/// The border is included.
///
/// This method accepts a raw buffer of bytes that will be copied to the screen /// This method accepts a raw buffer of bytes that will be copied to the screen
/// video memory. The expected format is rgb565, and the two bytes for a pixel /// video memory.
/// are in little endian order. ///
/// The expected format is rgb565, and the two bytes for a pixel
/// are in big endian order.
pub fn draw_raw(&mut self, x0: u16, y0: u16, x1: u16, y1: u16, data: &[u8]) -> Result<(), Error<E>> { pub fn draw_raw(&mut self, x0: u16, y0: u16, x1: u16, y1: u16, data: &[u8]) -> Result<(), Error<E>> {
self.set_window(x0, y0, x1, y1)?; self.set_window(x0, y0, x1, y1)?;
self.write_raw(data) self.write_raw(data)