Fixing comments

This commit is contained in:
Ryan Kennedy 2020-03-25 16:50:35 -05:00
parent 865fecb71d
commit 699855669b
2 changed files with 5 additions and 6 deletions

View file

@ -87,6 +87,10 @@ impl GraphicsWriter<Color16> for Graphics640x480x16 {
} }
} }
/// **Note:** This method is provided for convenience, but has terrible
/// performance since it needs to ensure the correct `WriteMode` per pixel
/// drawn. If you need to draw more then one pixel, consider using a method
/// such as `draw_line`.
fn set_pixel(&self, x: usize, y: usize, color: Color16) { fn set_pixel(&self, x: usize, y: usize, color: Color16) {
self.set_write_mode_2(); self.set_write_mode_2();
self._set_pixel(x, y, color); self._set_pixel(x, y, color);

View file

@ -185,16 +185,11 @@ pub trait TextWriter: Screen {
pub trait GraphicsWriter<Color> { pub trait GraphicsWriter<Color> {
/// Clears the screen by setting all pixels to the specified `color`. /// Clears the screen by setting all pixels to the specified `color`.
fn clear_screen(&self, color: Color); fn clear_screen(&self, color: Color);
/// /// Draws a line from `start` to `end` with the specified `color`. /// Draws a line from `start` to `end` with the specified `color`.
fn draw_line(&self, start: Point<isize>, end: Point<isize>, color: Color); fn draw_line(&self, start: Point<isize>, end: Point<isize>, color: Color);
/// Draws a character at the given `(x, y)` coordinant to the specified `color`. /// Draws a character at the given `(x, y)` coordinant to the specified `color`.
fn draw_character(&self, x: usize, y: usize, character: char, color: Color); fn draw_character(&self, x: usize, y: usize, character: char, color: Color);
/// Sets the given pixel at `(x, y)` to the given `color`. /// Sets the given pixel at `(x, y)` to the given `color`.
///
/// **Note:** This method is provided for convenience, but has terrible
/// performance since it needs to ensure the correct `WriteMode` per pixel
/// drawn. If you need to draw more then one pixel, consider using a method
/// such as `draw_line`.
fn set_pixel(&self, x: usize, y: usize, color: Color); fn set_pixel(&self, x: usize, y: usize, color: Color);
/// Sets the graphics device to a `VideoMode`. /// Sets the graphics device to a `VideoMode`.
fn set_mode(&self); fn set_mode(&self);