Expand description
Render IR, layout engine, and orchestration for epub-stream.
Structs§
- File
Render Cache Store - File-backed render-page cache store.
- Hanging
Punctuation Config - Hanging punctuation policy.
- Hyphenation
Config - Hyphenation behavior.
- Image
Object Command - Inline image object command.
- Justification
Config - Justification policy.
- Layout
Config - Layout configuration for page construction.
- Layout
Engine - Deterministic layout engine that emits render pages.
- Layout
Session - Incremental wrapper session returned by
RenderEngine::begin. - Never
Cancel - Never-cancel token for default call paths.
- Object
Layout Config - Non-text object layout policy knobs.
- Overlay
Item - Overlay item attached to a page.
- Overlay
Rect - Rectangle for custom overlay slot coordinates.
- Overlay
Size - Logical viewport size for overlay composition.
- Page
Annotation - Structured page annotation.
- Page
Chrome Command - Page-level metadata/chrome marker.
- Page
Chrome Config - Shared page-chrome policy and geometry configuration.
- Page
Metrics - Structured page metrics for progress and navigation.
- Pagination
Profile Id - Stable pagination profile id.
- Rect
Command - Rectangle command.
- Render
Book Page Map - Compact chapter-level rendered page index for locator and remap operations.
- Render
Book Page MapEntry - Compact chapter-level page span used by
RenderBookPageMap. - Render
Config - Per-run configuration used by
RenderEngine::begin. - Render
Engine - Render engine for chapter -> page conversion.
- Render
Engine Options - Render-engine options.
- Render
Intent - Theme-aware render intent.
- Render
Locator Page Target - Resolved rendered page target for locator/href operations.
- Render
Page - Page represented as backend-agnostic draw commands.
- Render
Page Iter - Stable page iterator wrapper returned by
RenderEngine::prepare_chapter_iter. - Render
Page Stream Iter - Streaming page iterator produced by
RenderEngine::prepare_chapter_iter_streaming. - Render
Reading Position Token - Persisted rendered reading position token.
- Resolved
Text Style - Resolved style passed to renderer.
- Rule
Command - Rule draw command.
- Text
Command - Text draw command.
- Typography
Config - Typography policy knobs for layout behavior.
- Widow
Orphan Control - Widow/orphan policy.
Enums§
- Block
Role - Semantic block role for computed styles.
- Cover
Page Mode - Cover-image placement mode for cover-like first-page image resources.
- Dither
Mode - Draw
Command - Layout output commands.
- Float
Support - Grayscale
Mode - Hyphenation
Mode - Justification
Strategy - Justification/alignment strategy.
- Justify
Mode - Justification mode determined during layout.
- Overlay
Content - Overlay content payload.
- Overlay
Slot - Logical overlay slots for app/UI composition.
- Page
Chrome Kind - Kind of page-level metadata/chrome.
- Page
Chrome Text Style - Text style for header/footer chrome rendering.
- Render
Diagnostic - Runtime diagnostics from render preparation/layout.
- Render
Engine Error - Render engine error.
- Render
Locator Target Kind - Deterministic locator resolution kind for rendered page targets.
- Soft
Hyphen Policy - Policy for discretionary soft-hyphen handling.
- SvgMode
Traits§
- Cancel
Token - Cancellation hook for long-running layout operations.
- Overlay
Composer - Overlay composer API for app-driven overlay placement/content.
- Render
Cache Store - Storage hooks for render-page caches.
- Text
Measurer - Optional text measurement hook for glyph-accurate line fitting.
Functions§
- estimate_
fragment_ progress_ in_ html - Estimate normalized chapter progress for an anchor fragment in XHTML bytes.
- remap_
page_ index_ by_ chapter_ progress - Resolve a page index in
new_pagesby chapter progress carried byold_pages[old_page_index]. - resolve_
page_ index_ for_ chapter_ progress - Resolve a chapter progress value (
[0, 1]) into a valid page index.