4 releases (2 breaking)
0.3.0 | Oct 27, 2022 |
---|---|
0.2.0 | Oct 23, 2022 |
0.1.1 | Oct 23, 2022 |
0.1.0 | Oct 23, 2022 |
#671 in Embedded development
29KB
294 lines
stockbook
Stockbook embeds 1-bit raster images in your code at compile time.
Designed primarily for #![no_std]
usage, in embedded or other program-memory-constrained environments. Compatible with avr-progmem
.
[dependencies]
stockbook = "0.3.0
The main functionality of Stockbook is the stamp!
macro, which lets you include data similarly to how include_bytes!
does, but from an image, specifically a 1-bit black and white image. The macro returns a Stamp
type, which just holds the image's width, height, and a static reference to the pixel data. The pixel data is represented internally as an array of bytes, in which individual bits correspond to individual pixels.
Example
File assets/star.png
(scaled x8 for preview, originally 12x12 px):
File src/lib.rs
:
use stockbook::{stamp, Color, Stamp};
static STAR_SPRITE: Stamp = stamp!("assets/star.png");
pub fn draw_star() {
for (x, y, color) in STAR_SPRITE.pixels() {
match color {
Color::Black => {}, // Treat as transparent
Color::White => draw_pixel_at(x, y),
}
}
}
fn draw_pixel_at(x: usize, y: usize) {
/* ... */
}
Supported formats
Stockbook uses the image crate under the hood. See its own list of supported formats for more details.
Feature flags
progmem
— wraps all pixel data ofStamp
s inavr_progmem::wrapper::ProgMem
s. Combined with theavr
target architecture, this allows you to keep most of the data in program memory without the need to copy it to RAM. A no-op for non-avr
target architectures.
Unstable features
Although this library works on stable
, any changes to images referenced by the stamp!
macro might not be detected because of caching. Therefore, until track_path
API (Tracking Issue) stabilizes, it is recommended to use the nightly
toolchain, however functionality behind this feature is unstable and may change or stop compiling at any time.
License
This software is licensed under the MIT license.
See the LICENSE file for more details.
Dependencies
~6.5MB
~97K SLoC