Skip to content

README.md

Latest commit

 

History

History
26 lines (18 loc) · 1.18 KB

README.md

File metadata and controls

26 lines (18 loc) · 1.18 KB
Raw

imaging

Backend-agnostic 2D imaging recording + streaming API.

This crate is no_std by default (uses alloc); enable the std feature when needed.

If you are reading this on docs.rs, start with the guide module for the project-level learning path, backend map, and mental model.

API shape

imaging has two primary public layers:

  • PaintSink + Painter: the borrowed streaming/authoring API used to stream commands directly into scenes, renderers, or backend-native recorders
  • record: the owned, backend-agnostic semantic recording module used for validation, replay, retention, and backend-independent storage

The crate root is intentionally biased toward the borrowed streaming surface and shared drawing vocabulary. Retained scene data and low-level recording payloads live under imaging::record, for example record::Scene, record::Draw, record::Clip, record::Group, and record::GlyphRun. Those retained types are exact recording data, not the preferred authoring surface.

Pre-1.0 note: the streaming surface moved from the old owned Sink shape to the borrowed PaintSink/Painter model so command authoring does not have to construct owned IR payloads up-front.