Skip to content

docs: explain parley engine shaping pipeline #739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Soundcreates wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: explain parley engine shaping pipeline #739

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions parley_engine/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@
//! ## Features
//!
//! - `std` (enabled by default): This is currently unused and is provided for forward compatibility.
//!
//! ## Typical shaping pipeline
//!
//! A caller normally reuses an [`Analyzer`], [`Analysis`], and [`Shaper`] while
//! laying out text. The analysis must be produced before itemization and
//! shaping, and the same source string must be passed to each stage:
//!
//! ```text
//! analyzer.analyze(text, &options, &mut analysis);
//! for item in analysis.itemize(text, split_after) {
//! shaper.shape_item(text, &analysis, &item, &shape_options, select_font, &mut shaped_text);
//! }
//! ```
//!
//! [`Analysis::itemize`] divides text into runs with compatible bidi and
//! script properties. [`Shaper::shape_item`] then turns each run into glyphs;
//! the `select_font` callback chooses a [`FontInstance`] for each character
//! cluster. Higher-level users should generally prefer `parley`'s
//! [`LayoutContext`](https://docs.rs/parley/latest/parley/struct.LayoutContext.html),
//! which manages these stages and adds style resolution and line layout.

// LINEBENDER LINT SET - lib.rs - v3
// See https://linebender.org/wiki/canonical-lints/
Expand Down
Loading