frameio

package

v0.1.1 Latest Latest Go to latest Published: Oct 7, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/RevoTale/esp32-e-paper-manager

Links

Open Source Insights

Documentation ¶

Overview ¶

Package frameio defines the bounded BZM1 local process-pipe frame format. It is not a device/network protocol and carries no authentication or revision.

Index ¶

Variables
func Decode(data []byte) (display.Frame, error)
func Read(r io.Reader) (display.Frame, error)
func Reader(frame display.Frame) (io.Reader, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrFrame = errors.New("frameio: invalid packed frame")

Functions ¶

func Decode ¶

func Decode(data []byte) (display.Frame, error)

Decode borrows a complete in-memory BZM1 record, avoiding a second copy of already bounded worker output. Callers retain the backing bytes unchanged.

func Read ¶

func Read(r io.Reader) (display.Frame, error)

Read owns returned pixels. Validate geometry before allocating and require EOF after one complete frame. The pipe owner must enforce a process deadline.

func Reader ¶

func Reader(frame display.Frame) (io.Reader, error)

Reader borrows immutable frame storage until fully consumed; no pixel copy.

Types ¶

This section is empty.

Source Files ¶

View all Source files

frame.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL