book: Add a graphics example

book/src/SUMMARY.md

@@ -7,6 +7,7 @@
   - [Running in a VM](tutorial/vm.md)
 - [How-to](how_to/introduction.md)
   - [Using Protocols](how_to/protocols.md)
+  - [Drawing to the Screen](how_to/drawing.md)
   - [Crate Features](how_to/crate_features.md)
 - [Concepts](concepts/introduction.md)
   - [Boot Stages](concepts/boot_stages.md)

book/src/how_to/drawing.md

@@ -0,0 +1,38 @@
+# Drawing to the Screen
+
+This example shows how to draw to the screen using the [graphics output protocol].
+The code will a [Sierpiński triangle] using the "chaos game" method.
+
+![screenshot](https://i.imgur.com/0tpjtV6.png)
+
+The core abstraction used here is a linear buffer:
+```rust
+{{#include ../../../uefi-test-runner/examples/sierpinski.rs:buffer}}
+```
+
+This `Buffer` type stores a `Vec` of [`BltPixel`]s, which are BGRX
+32-bit pixels (8 bites each for blue, green, and red, followed by 8
+unused bits of padding). We use the `pixel` method to alter a single
+pixel at a time. This is often not an efficient method; for more complex
+graphics you could use a crate like [`embedded-graphics`].
+
+The `Buffer::blit` method calls the graphics output protocol's `blt`
+method to copy the buffer to the screen.
+
+Most of the rest of the code is just implementing the algorithm for
+drawing the fractal. Here's the full example:
+
+```rust
+{{#include ../../../uefi-test-runner/examples/sierpinski.rs:all}}
+```
+
+You can run this example from the [uefi-rs] repository with:
+```console
+cargo xtask run --example sierpinski
+```
+
+[Sierpiński triangle]: https://en.wikipedia.org/wiki/Sierpiński_triangle#Chaos_game
+[`BltPixel`]: https://docs.rs/uefi/latest/uefi/proto/console/gop/struct.BltPixel.html
+[`embedded-graphics`]: https://crates.io/crates/embedded-graphics
+[graphics output protocol]: https://docs.rs/uefi/latest/uefi/proto/console/gop/index.html
+[uefi-rs]: https://github.com/rust-osdev/uefi-rs

uefi-test-runner/examples/sierpinski.rs

@@ -0,0 +1,135 @@
+// ANCHOR: all
+#![no_main]
+#![no_std]
+#![feature(abi_efiapi)]
+
+extern crate alloc;
+
+use alloc::vec;
+use alloc::vec::Vec;
+use core::mem;
+use uefi::prelude::*;
+use uefi::proto::console::gop::{BltOp, BltPixel, BltRegion, GraphicsOutput};
+use uefi::proto::rng::Rng;
+use uefi::table::boot::BootServices;
+use uefi::Result;
+
+#[derive(Clone, Copy)]
+struct Point {
+    x: f32,
+    y: f32,
+}
+
+impl Point {
+    fn new(x: f32, y: f32) -> Self {
+        Self { x, y }
+    }
+}
+
+// ANCHOR: buffer
+struct Buffer {
+    width: usize,
+    height: usize,
+    pixels: Vec<BltPixel>,
+}
+
+impl Buffer {
+    /// Create a new `Buffer`.
+    fn new(width: usize, height: usize) -> Self {
+        Buffer {
+            width,
+            height,
+            pixels: vec![BltPixel::new(0, 0, 0); width * height],
+        }
+    }
+
+    /// Get a single pixel.
+    fn pixel(&mut self, x: usize, y: usize) -> Option<&mut BltPixel> {
+        self.pixels.get_mut(y * self.width + x)
+    }
+
+    /// Blit the buffer to the framebuffer.
+    fn blit(&self, gop: &mut GraphicsOutput) -> Result {
+        gop.blt(BltOp::BufferToVideo {
+            buffer: &self.pixels,
+            src: BltRegion::Full,
+            dest: (0, 0),
+            dims: (self.width, self.height),
+        })
+    }
+}
+// ANCHOR_END: buffer
+
+/// Get a random `usize` value.
+fn get_random_usize(rng: &mut Rng) -> usize {
+    let mut buf = [0; mem::size_of::<usize>()];
+    rng.get_rng(None, &mut buf).expect("get_rng failed");
+    usize::from_le_bytes(buf)
+}
+
+fn draw_sierpinski(bt: &BootServices) -> Result {
+    // Open graphics output protocol.
+    let gop_handle = bt.get_handle_for_protocol::<GraphicsOutput>()?;
+    let mut gop = bt.open_protocol_exclusive::<GraphicsOutput>(gop_handle)?;
+
+    // Open random number generator protocol.
+    let rng_handle = bt.get_handle_for_protocol::<Rng>()?;
+    let mut rng = bt.open_protocol_exclusive::<Rng>(rng_handle)?;
+
+    // Create a buffer to draw into.
+    let (width, height) = gop.current_mode_info().resolution();
+    let mut buffer = Buffer::new(width, height);
+
+    // Initialize the buffer with a simple gradient background.
+    for y in 0..height {
+        let r = ((y as f32) / ((height - 1) as f32)) * 255.0;
+        for x in 0..width {
+            let g = ((x as f32) / ((width - 1) as f32)) * 255.0;
+            let pixel = buffer.pixel(x, y).unwrap();
+            pixel.red = r as u8;
+            pixel.green = g as u8;
+            pixel.blue = 255;
+        }
+    }
+
+    let size = Point::new(width as f32, height as f32);
+
+    // Define the vertices of a big triangle.
+    let border = 20.0;
+    let triangle = [
+        Point::new(size.x / 2.0, border),
+        Point::new(border, size.y - border),
+        Point::new(size.x - border, size.y - border),
+    ];
+
+    // `p` is the point to draw. Start at the center of the triangle.
+    let mut p = Point::new(size.x / 2.0, size.y / 2.0);
+
+    // Loop forever, drawing the frame after each new point is changed.
+    loop {
+        // Choose one of the triangle's vertices at random.
+        let v = triangle[get_random_usize(&mut rng) % 3];
+
+        // Move `p` halfway to the chosen vertex.
+        p.x = (p.x + v.x) * 0.5;
+        p.y = (p.y + v.y) * 0.5;
+
+        // Set `p` to black.
+        let pixel = buffer.pixel(p.x as usize, p.y as usize).unwrap();
+        pixel.red = 0;
+        pixel.green = 100;
+        pixel.blue = 0;
+
+        // Draw the buffer to the screen.
+        buffer.blit(&mut gop)?;
+    }
+}
+
+#[entry]
+fn main(_handle: Handle, mut system_table: SystemTable<Boot>) -> Status {
+    uefi_services::init(&mut system_table).unwrap();
+    let bt = system_table.boot_services();
+    draw_sierpinski(bt).unwrap();
+    Status::SUCCESS
+}
+// ANCHOR_END: all