Crate beamterm_renderer

Expand description

§Stability Policy

beamterm-renderer’s public API includes types from the following third-party crates:

Crate	Types exposed	Re-exported as
`glow`	`glow::Context` via `Terminal::gl()`	`beamterm_renderer::glow`
`compact_str`	`CompactString` in return types	`beamterm_renderer::compact_str`
`web_sys`	`HtmlCanvasElement` via `Terminal::canvas()`	`beamterm_renderer::web_sys`
`js_sys`	`Array`, `Function` in WASM bindings	`beamterm_renderer::js_sys`
`wasm_bindgen`	`JsValue` in WASM bindings	`beamterm_renderer::wasm_bindgen`

These crates are re-exported so that downstream users can depend on beamterm-renderer’s re-exports without adding separate dependencies or worrying about version mismatches.

Semver policy: A dependency version bump is only considered a beamterm breaking change if the type signatures used in beamterm’s public API actually change. A version bump that preserves the same type signatures is a compatible update.

Re-exports§

pub use beamterm_core::compact_str;
pub use beamterm_core::glow;
pub use js_sys;
pub use wasm_bindgen;
pub use web_sys;

Modules§

mouse: Mouse input handling for the beamterm terminal renderer.
wasm

Structs§

CellData: Data for a single terminal cell including character and colors.
CellQuery: Configuration for querying and extracting text from terminal cells.
CellSize: Dimensions of a terminal cell in pixels.
CursorPosition: A position in the terminal grid, specified by column and row.
FontAtlas: Type-erased wrapper around any Atlas implementation.
FontAtlasData: Font atlas data for GPU-accelerated terminal rendering.
GlyphTracker: Tracks glyphs that were requested but not found in the font atlas.
RenderContext: Rendering context that provides access to GL state.
Renderer: High-level WebGL2 renderer for terminal-style applications.
SelectionTracker: Tracks the active text selection in the terminal grid.
SerializationError: Error returned when font atlas serialization or deserialization fails.
StaticFontAtlas: A texture atlas containing font glyphs for efficient GL text rendering.
Terminal: High-performance WebGL2 terminal renderer.
TerminalBuilder: Builder for configuring and creating a Terminal.
TerminalDebugApi: Debug API exposed to browser console for terminal inspection.
TerminalGrid: A high-performance terminal grid renderer using instanced rendering.
TerminalSize: Dimensions of a terminal grid in cells.
UrlMatch: Result of URL detection containing the query and extracted URL text.

Enums§

CellIterator: Zero-allocation iterator over terminal cell indices.
DebugSpacePattern: Debug pattern for validating pixel-perfect rendering of cell dimensions.
Error: Error categories.
FontStyle: Font style variant encoded in glyph IDs.
GlslVersion: GL shader language target for version injection.
GlyphEffect: Text decoration effect applied to a glyph.
GlyphSlot: Classifies a glyph’s texture slot by width category.
SelectionMode: Defines how cells are selected in the terminal grid.

Traits§

Atlas: Trait defining the interface for font atlases.
Drawable: Trait for objects that can be rendered.

Functions§

find_url_at_cursor: Detects an HTTP/HTTPS URL at or around the given cursor position.
is_double_width: Checks if a grapheme is double-width (emoji or fullwidth character).
is_emoji: Checks if a grapheme is an emoji that should use color font rendering.
select: Creates a new cell query with the specified selection mode.