Skip to main content

RemappedFrameBuffer

Struct RemappedFrameBuffer 

Source
pub struct RemappedFrameBuffer<F, M: PixelRemapper>(/* private fields */);
Expand description

Coordinate-remapping wrapper for any framebuffer

This is a generic wrapper around any framebuffer implementation that remaps pixel coordinates before forwarding them to the inner framebuffer. It can be used for:

  • Tiling multiple panels into a larger virtual display (see ChainTopRightDown)
  • Scan-pattern remapping for panels with non-standard row interleaving (e.g. 1/16 scan on 64×64 panels — see QuarterScan)

Unlike TiledFrameBuffer, this wrapper uses only two type parameters and works with all four framebuffer types (plain, latched, bitplane::plain, bitplane::latched).

§Type Parameters

  • F — The underlying framebuffer type
  • M — The pixel remapping strategy (see implementors of PixelRemapper)

§Example with tiled plain framebuffer

use hub75_framebuffer::{compute_frame_count, compute_rows};
use hub75_framebuffer::plain::DmaFrameBuffer;
use hub75_framebuffer::tiling::{RemappedFrameBuffer, ChainTopRightDown, compute_tiled_cols};

const TILED_COLS: usize = 3;
const TILED_ROWS: usize = 3;
const ROWS: usize = 32;
const PANEL_COLS: usize = 64;
const FB_COLS: usize = compute_tiled_cols(PANEL_COLS, TILED_ROWS, TILED_COLS);
const BITS: u8 = 2;
const NROWS: usize = compute_rows(ROWS);
const FRAME_COUNT: usize = compute_frame_count(BITS);

type FBType = DmaFrameBuffer<ROWS, FB_COLS, NROWS, BITS, FRAME_COUNT>;
type Remapper = ChainTopRightDown<ROWS, PANEL_COLS, TILED_ROWS, TILED_COLS>;
type Display = RemappedFrameBuffer<FBType, Remapper>;

let mut fb = Display::new();
// fb is a 192×96 virtual canvas

§Example with tiled bitplane framebuffer

use hub75_framebuffer::bitplane::plain::DmaFrameBuffer;
use hub75_framebuffer::tiling::{RemappedFrameBuffer, ChainTopRightDown, compute_tiled_cols};

const TILED_COLS: usize = 3;
const TILED_ROWS: usize = 3;
const ROWS: usize = 32;
const NROWS: usize = ROWS / 2;
const PANEL_COLS: usize = 64;
const FB_COLS: usize = compute_tiled_cols(PANEL_COLS, TILED_ROWS, TILED_COLS);
const PLANES: usize = 8;

type FBType = DmaFrameBuffer<NROWS, FB_COLS, PLANES>;
type Remapper = ChainTopRightDown<ROWS, PANEL_COLS, TILED_ROWS, TILED_COLS>;
type Display = RemappedFrameBuffer<FBType, Remapper>;

let mut fb = Display::new();
// fb is a 192×96 virtual canvas backed by a bitplane framebuffer

Implementations§

Source§

impl<F: Default, M: PixelRemapper> RemappedFrameBuffer<F, M>

Source

pub fn new() -> Self

Create a new remapped framebuffer that takes ownership of a default-constructed inner framebuffer and remaps any pixel writes through the given PixelRemapper.

Trait Implementations§

Source§

impl<F: Debug, M: Debug + PixelRemapper> Debug for RemappedFrameBuffer<F, M>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<F: Default, M: PixelRemapper> Default for RemappedFrameBuffer<F, M>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<F: DrawTarget<Error = Infallible, Color = Color>, M: PixelRemapper> DrawTarget for RemappedFrameBuffer<F, M>

Source§

type Color = Rgb888

The pixel color type the targetted display supports.
Source§

type Error = !

Error type to return when a drawing operation fails. Read more
Source§

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>
where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order. Read more
Source§

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>
where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors. Read more
Source§

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color. Read more
Source§

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color. Read more
Source§

impl<F: FrameBuffer, M: PixelRemapper> FrameBuffer for RemappedFrameBuffer<F, M>

Source§

const BCM_SEQUENCE: [BcmLenReps; 10] = F::BCM_SEQUENCE

Static (len, reps) of the segments in one sequence, in scan order. Read more
Source§

const BCM_SEQUENCE_LEN: usize = F::BCM_SEQUENCE_LEN

Number of BCM segments in one sequence, i.e. the number of meaningful entries in BCM_SEQUENCE.
Source§

const BCM_SEQUENCE_COUNT: usize = F::BCM_SEQUENCE_COUNT

Number of times the sequence repeats in one complete panel refresh: NROWS for row-major framebuffers (one sequence per row), 1 for frame-major and threshold framebuffers (the sequence covers the whole frame).
Source§

const BCM_SEGMENTS_PER_GROUP: usize = F::BCM_SEGMENTS_PER_GROUP

Number of consecutive segments that a driver may chain into a single DMA transfer. Must divide BCM_SEQUENCE_LEN: groups never straddle a sequence boundary. Read more
Source§

type Word = <F as FrameBuffer>::Word

The DMA word type used by this framebuffer (u8 for latched, u16 for direct-drive). Driver implementations can use this to enforce that pin configurations match the framebuffer at compile time.
Source§

fn bcm_segment_ptr(&self, index: usize) -> *const u8

Returns the byte pointer for the index-th BCM segment. Read more
Source§

const BCM_SEGMENT_COUNT: usize = _

Total number of BCM segments streamed for one complete panel refresh (all rows, all planes). Read more
Source§

fn bcm_segment_count(&self) -> usize

Total number of BCM segments streamed for one complete panel refresh. Read more
Source§

fn bcm_segment(&self, index: usize) -> BcmSegment

Returns the index-th BCM segment. Read more
Source§

fn bcm_segments_per_group(&self) -> usize

Number of consecutive segments that form one transfer group. Read more
Source§

impl<F: FrameBufferOperations + FrameBuffer, M: PixelRemapper> FrameBufferOperations for RemappedFrameBuffer<F, M>

Source§

fn erase(&mut self)

Erase pixel colors while preserving control bits. This is much faster than format() and is the typical way to clear the display.
Source§

fn set_pixel(&mut self, p: Point, color: Color)

Set a pixel in the framebuffer.
Source§

impl<F: MutableFrameBuffer, M: PixelRemapper> MutableFrameBuffer for RemappedFrameBuffer<F, M>

Source§

impl<F: DrawTarget<Error = Infallible, Color = Color>, M: PixelRemapper> OriginDimensions for RemappedFrameBuffer<F, M>

Source§

fn size(&self) -> Size

Returns the size of the bounding box.

Auto Trait Implementations§

§

impl<F, M> Freeze for RemappedFrameBuffer<F, M>
where F: Freeze, PhantomData<M>: Freeze,

§

impl<F, M> RefUnwindSafe for RemappedFrameBuffer<F, M>

§

impl<F, M> Send for RemappedFrameBuffer<F, M>
where F: Send, PhantomData<M>: Send,

§

impl<F, M> Sync for RemappedFrameBuffer<F, M>
where F: Sync, PhantomData<M>: Sync,

§

impl<F, M> Unpin for RemappedFrameBuffer<F, M>
where F: Unpin, PhantomData<M>: Unpin,

§

impl<F, M> UnsafeUnpin for RemappedFrameBuffer<F, M>

§

impl<F, M> UnwindSafe for RemappedFrameBuffer<F, M>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> Dimensions for T

Source§

fn bounding_box(&self) -> Rectangle

Returns the bounding box.
Source§

impl<T> DrawTargetExt for T
where T: DrawTarget,

Source§

fn translated(&mut self, offset: Point) -> Translated<'_, T>

Creates a translated draw target based on this draw target. Read more
Source§

fn cropped(&mut self, area: &Rectangle) -> Cropped<'_, T>

Creates a cropped draw target based on this draw target. Read more
Source§

fn clipped(&mut self, area: &Rectangle) -> Clipped<'_, T>

Creates a clipped draw target based on this draw target. Read more
Source§

fn color_converted<C>(&mut self) -> ColorConverted<'_, T, C>
where C: PixelColor + Into<<T as DrawTarget>::Color>,

Creates a color conversion draw target. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.