glifo/src/lib.rs

// Copyright 2026 the Vello Authors
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Glifo provides APIs for efficiently rendering glyphs and paint styles like underline.
//!
//! # Goals
//!
//! Glifo is under rapid development. Consider it experimental for now. Its goals are to:
//!
//! - Provide an API surface that accepts glyphs and their positions and renders them to a surface.
//! - Cache those glyphs so that repeated renders of a glyph are fast.
//! - Support rendering paint styles like underline, strikethrough, and brush color.
//! - Share expensive structs and data between the shaper and renderer like the hinting instance and hinted advance.
//!
//! # Features
//!
//! - `std` (enabled by default): Get floating point functions from the standard library
//!   (likely using your target's libc).
//! - `libm`: Use floating point implementations from `libm`.
//! - `png`: Enables PNG support for drawing bitmap glyphs.
//!
//! At least one of `std` and `libm` is required.

// LINEBENDER LINT SET - lib.rs - v3
// See https://linebender.org/wiki/canonical-lints/
// These lints shouldn't apply to examples or tests.
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
// These lints shouldn't apply to examples.
#![warn(clippy::print_stdout, clippy::print_stderr)]
// Targeting e.g. 32-bit means structs containing usize can give false positives for 64-bit.
#![cfg_attr(target_pointer_width = "64", warn(clippy::trivially_copy_pass_by_ref))]
// END LINEBENDER LINT SET
#![cfg_attr(docsrs, feature(doc_cfg))]
#![no_std]

extern crate alloc;
#[cfg(all(feature = "std", feature = "libm"))]
use core_maths as _;

// Currently used for debugging in `cache.rs`, but only in debug build.
use log as _;
#[cfg(feature = "png")]
use png as _;
#[cfg(feature = "std")]
extern crate std;

use peniko::{self, color, kurbo};
use vello_common::pixmap::Pixmap;

pub mod atlas;
mod colr;
mod glyph;
mod interface;
pub mod renderer;
mod util;

pub use atlas::{
    AtlasCommand, AtlasCommandRecorder, AtlasConfig, AtlasPaint, AtlasSlot, GLYPH_PADDING,
    GlyphAtlas, GlyphCacheConfig, GlyphCacheKey, ImageCache, PendingClearRect, RasterMetrics,
};
pub use glyph::{
    AtlasCacher, FontEmbolden, Glyph, GlyphCaches, GlyphColr, GlyphPrepCache, GlyphPrepCacheMut,
    GlyphRenderError, GlyphRun, GlyphRunBackend, GlyphRunBuilder, GlyphRunRenderer,
    GlyphSkipReason, HintCache, HintKey, NormalizedCoord, OutlineCache, SkippedGlyph,
};
pub use interface::{DrawSink, GlyphRenderer};