Skip to content

Commit 3f5295c

Browse files
committed
update changelog/readme/crate docs to include TiledFrameBuffer
1 parent 62a1e31 commit 3f5295c

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
## [Unreleased] - ReleaseDate
1111

12+
### Added
13+
14+
* New `tiling::TiledFrameBuffer` wrapper that lets you chain multiple HUB75
15+
panels into one large virtual canvas ([#10](https://github.com/liebman/hub75-framebuffer/pull/10))
16+
1217
## [0.3.0] - 2025-07-16
1318

1419
* update to `esp-hal` `1.0.0-rc.1` [#9](https://github.com/liebman/hub75-framebuffer/pull/9)

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@ documentation contains an extensive primer.
3939
| `plain` | none | 16 bit (14 used) | high | Simplest, wires exactly like a standard HUB75 matrix. |
4040
| `latched` | **external latch gate** (see below) | 8 bit | ×½ of `plain` | Lower memory footprint, but needs a tiny glue-logic board. |
4141

42+
## Multiple Panels
43+
44+
- Use `tiling::TiledFrameBuffer` to drive several HUB75 panels as one large display.
45+
- Combine it with a pixel-remapping policy like `ChainTopRightDown` and any of
46+
the framebuffers above (plain or latched).
47+
- The wrapper exposes a single `embedded-graphics` canvas, so a 3 × 3 stack of
48+
64 × 32 panels simply looks like a 192 × 96 screen while all coordinate translation happens transparently.
49+
4250
### The latch circuit
4351

4452
The *latched* implementation assumes a small external circuit that holds the

src/lib.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,14 @@
4949
//! - Support different color depths through Binary Code Modulation (BCM)
5050
//! - Implement the `ReadBuffer` trait for DMA compatibility
5151
//!
52+
//! ## Multiple Panels (Tiled FrameBuffer)
53+
//! Use [`tiling::TiledFrameBuffer`] to drive several HUB75 panels as one large
54+
//! virtual display. Combine it with a pixel-remapping policy such as
55+
//! [`tiling::ChainTopRightDown`] and any of the framebuffer flavours above
56+
//! (`plain` or `latched`). The wrapper exposes a single `embedded-graphics`
57+
//! canvas, so for example a 3 × 3 stack of 64 × 32 panels simply looks like a
58+
//! 192 × 96 screen while all coordinate translation happens transparently.
59+
//!
5260
//! ## Available Feature Flags
5361
//!
5462
//! ### `skip-black-pixels` Feature (disabled by default)

0 commit comments

Comments
 (0)