Expand description
§Stability Policy
beamterm-core’s public API includes types from the following third-party crates:
| Crate | Types exposed | Re-exported as |
|---|---|---|
glow | glow::Context in method parameters and RenderContext::gl | beamterm_core::glow |
compact_str | CompactString in return types and struct fields | beamterm_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§
- Cell
Size - Dimensions of a terminal cell in pixels.
- Cursor
Position - A position in the terminal grid, specified by column and row.
- Font
Atlas Data - Font atlas data for GPU-accelerated terminal rendering.
- Serialization
Error - Error returned when font atlas serialization or deserialization fails.
- Terminal
Size - Dimensions of a terminal grid in cells.
- UrlMatch
- Result of URL detection containing the query and extracted URL text.
Enums§
- Debug
Space Pattern - Debug pattern for validating pixel-perfect rendering of cell dimensions.
- Error
- Error categories for the core rendering engine.
- Font
Style - Font style variant encoded in glyph IDs.
- Glsl
Version - GL shader language target for version injection.
- Glyph
Effect - 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.