Skip to main content

Crate beamterm_core

Crate beamterm_core 

Source
Expand description

§Stability Policy

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

CrateTypes exposedRe-exported as
glowglow::Context in method parameters and RenderContext::glbeamterm_core::glow
compact_strCompactString in return types and struct fieldsbeamterm_core::compact_str

These crates are re-exported so that downstream users can depend on beamterm_core::glow and beamterm_core::compact_str without adding separate dependencies or worrying about version mismatches.

Semver policy: A dependency version bump (e.g. glow 0.17 to 0.18) 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 gl::Atlas;
pub use gl::CellData;
pub use gl::CellDynamic;
pub use gl::CellIterator;
pub use gl::CellQuery;
pub use gl::Drawable;
pub use gl::FontAtlas;
pub use gl::GlState;
pub use gl::GlyphSlot;
pub use gl::GlyphTracker;
pub use gl::RenderContext;
pub use gl::SelectionMode;
pub use gl::SelectionTracker;
pub use gl::StaticFontAtlas;
pub use gl::TerminalGrid;
pub use gl::select;
pub use compact_str;
pub use glow;

Modules§

gl
OpenGL rendering engine, atlas management, and terminal grid.

Structs§

CellSize
Dimensions of a terminal cell in pixels.
CursorPosition
A position in the terminal grid, specified by column and row.
FontAtlasData
Font atlas data for GPU-accelerated terminal rendering.
SerializationError
Error returned when font atlas serialization or deserialization fails.
TerminalSize
Dimensions of a terminal grid in cells.
UrlMatch
Result of URL detection containing the query and extracted URL text.

Enums§

DebugSpacePattern
Debug pattern for validating pixel-perfect rendering of cell dimensions.
Error
Error categories for the core rendering engine.
FontStyle
Font style variant encoded in glyph IDs.
GlslVersion
GL shader language target for version injection.
GlyphEffect
Text decoration effect applied to a glyph.

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.