1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
//! *The PICO-8 font to use with [`embedded-graphics`](https://docs.rs/embedded-graphics).* //! //! [](https://travis-ci.org/althonos/embedded-picofont/branches) //! [](https://codecov.io/gh/althonos/embedded-picofont) //! [](https://choosealicense.com/licenses/mit/) //! [](https://github.com/althonos/embedded-picofont) //! [](https://crates.io/crates/embedded-picofont) //! [](https://docs.rs/embedded-picofont) //! [](https://github.com/althonos/embedded-picofont/blob/master/CHANGELOG.md) //! [](https://github.com/althonos/embedded-picofont/issues) //! //! # Overview //! //! This crate provides the super tiny 4x6 font of the PICO-8 fantasy console: //! //! <img src="https://www.lexaloffle.com/gfx/pico8_font.png" style="width:100%;image-rendering:-moz-crisp-edges;image-rendering:-o-crisp-edges;image-rendering:-webkit-optimize-contrast;image-rendering: crisp-edges;-ms-interpolation-mode: nearest-neighbor;"> //! //! Please note the PICO-8 itself only use the uppercase characters, as the lowercase //! chars can get *really* hard to read if the display is not upscaled. As such, it //! is advised to only use this font to display uppercase characters. //! //! # Usage //! //! Use the [`text_pico`] macro to create a `Drawable` text from a string: //! ```rust //! use embedded_graphics::prelude::*; //! use embedded_picofont::{text_pico, FontPico}; //! let text: FontPico<u8> = text_pico!("Hello world!"); //! ``` //!  //! //! The PICO-8 also has wide characters: these can be displayed using two smaller //! characters in the `128..255` char range: //! ```rust //! use embedded_graphics::prelude::*; //! use embedded_picofont::{text_pico, FontPico}; //! let text: FontPico<u8> = text_pico!("PRESS \u{96}\u{97} TO GO BACK"); //! ``` //!  //! //! See the [`embedded-graphics` documentation](https://docs.rs/embedded-graphics/) //! for more information on how to use this crate. //! //! # License //! //! * The [original PICO-8 font](https://www.lexaloffle.com/pico-8.php?page=faq) //! is available under the [CC-0 license](https://creativecommons.org/share-your-work/public-domain/cc0/). //! * This crate is released under the [MIT License](https://opensource.org/licenses/mit-license.php). //! #![no_std] use embedded_graphics::fonts::font_builder::FontBuilder; use embedded_graphics::fonts::font_builder::FontBuilderConf; #[derive(Debug, Copy, Clone)] /// The [`FontBuilderConf`] implemtation for the PICO-8 font. /// /// [`FontBuilderConf`]: https://docs.rs/embedded-graphics/latest/embedded_graphics/fonts/font_builder/trait.FontBuilderConf.html pub struct FontPicoConf; impl FontBuilderConf for FontPicoConf { const FONT_IMAGE: &'static [u8] = include_bytes!(concat!(env!("OUT_DIR"), "/font.raw")); const CHAR_HEIGHT: u32 = 6; const CHAR_WIDTH: u32 = 4; const FONT_IMAGE_WIDTH: u32 = 128; fn char_offset(c: char) -> u32 { if c <= '\u{7f}' { return (c as u32) * 2; } else if c <= '\u{b3}' { return c as u32 + 0x80; } ('?' as u32) * 2 } } /// The 4x6 pixel monospace font used by the PICO-fantasy 8 console. /// /// # Examples /// /// ## Write some text to the screen at the default `(0, 0)` position /// /// ```rust /// use embedded_graphics::prelude::*; /// use embedded_picofont::FontPico; /// use embedded_picofont::text_pico; /// # use embedded_graphics::mock_display::Display; /// # let mut display = Display::default(); /// /// // Use struct methods directly /// display.draw(FontPico::render_str("Hello Rust!")); /// /// // Use a macro instead /// display.draw(text_pico!("Hello Rust!")); /// ``` /// /// ## Translate text by (20px, 30px) /// /// ```rust /// use embedded_graphics::prelude::*; /// use embedded_picofont::FontPico; /// # use embedded_graphics::mock_display::Display; /// # let mut display = Display::default(); /// /// display.draw( /// FontPico::render_str("Hello Rust!").translate(Coord::new(20, 30)) /// ); /// ``` /// /// ## Add some styling to the text /// /// Use [any method provided by the `WithStyle` trait](https://docs.rs/embedded-graphics/latest/embedded_graphics/style/trait.WithStyle.html#required-methods). /// Properties like `fill` or `stroke` passed to the `text_pico` macro are converted into method /// calls verbatim. /// /// ```rust /// use embedded_graphics::prelude::*; /// use embedded_picofont::text_pico; /// use embedded_picofont::FontPico; /// # use embedded_graphics::mock_display::Display; /// # let mut display = Display::default(); /// /// display.draw(text_pico!( /// "Hello Rust!", /// fill = Some(1u8), /// stroke = Some(0u8) /// )); /// /// display.draw( /// FontPico::render_str("Hello Rust!") /// .translate(Coord::new(20, 30)) /// .fill(Some(1u8)) /// .stroke(Some(0u8)), /// ); /// ``` pub type FontPico<'a, C> = FontBuilder<'a, C, FontPicoConf>; #[macro_export] /// Render text using the [`FontPico`] font. /// /// ```rust /// use embedded_graphics::prelude::*; /// use embedded_picofont::{text_pico, FontPico}; /// /// let text: FontPico<u8> = text_pico!("Hello world!"); /// let styled_text: FontPico<u8> = text_pico!( /// "Hello world!", /// stroke = Some(10u8), /// ); /// ``` /// /// Style properties like `stroke` map to the method calls on the [`WithStyle`]. /// trait. /// /// [`FontPico`]: ./type.FontPico.html /// [`WithStyle`]: https://docs.rs/embedded-graphics/latest/embedded_graphics/style/trait.WithStyle.html macro_rules! text_pico { ($text:expr $(, $style_key:ident = $style_value:expr )* $(,)?) => {{ #[allow(unused_imports)] use embedded_graphics::style::WithStyle; $crate::FontPico::render_str($text) $( .$style_key($style_value) )* }}; }