Struct TextSystem 

pub struct TextSystem { /* private fields */ }

The GPUI text rendering sub system.

Implementations

impl TextSystem

pub fn all_font_names(&self) -> Vec<String>

Get a list of all available font names from the operating system.

pub fn add_fonts(&self, fonts: Vec<Cow<'static, [u8]>>) -> Result<()>

Add a font’s data to the text system.

pub fn get_font_for_id(&self, id: FontId) -> Option<Font>

Get the Font for the Font Id.

pub fn resolve_font(&self, font: &Font) -> FontId

Resolves the specified font, falling back to the default font stack if the font fails to load.

Panics

Panics if the font and none of the fallbacks can be resolved.

pub fn bounding_box(&self, font_id: FontId, font_size: Pixels) -> Bounds<Pixels>

Get the bounding box for the given font and font size. A font’s bounding box is the smallest rectangle that could enclose all glyphs in the font. superimposed over one another.

pub fn typographic_bounds( &self, font_id: FontId, font_size: Pixels, character: char, ) -> Result<Bounds<Pixels>>

Get the typographic bounds for the given character, in the given font and size.

pub fn advance( &self, font_id: FontId, font_size: Pixels, ch: char, ) -> Result<Size<Pixels>>

Get the advance width for the given character, in the given font and size.

pub fn em_width(&self, font_id: FontId, font_size: Pixels) -> Result<Pixels>

Returns the width of an em.

Uses the width of the m character in the given font and size.

pub fn em_advance(&self, font_id: FontId, font_size: Pixels) -> Result<Pixels>

Returns the advance width of an em.

Uses the advance width of the m character in the given font and size.

pub fn ch_width(&self, font_id: FontId, font_size: Pixels) -> Result<Pixels>

Returns the width of an ch.

Uses the width of the 0 character in the given font and size.

pub fn ch_advance(&self, font_id: FontId, font_size: Pixels) -> Result<Pixels>

Returns the advance width of an ch.

Uses the advance width of the 0 character in the given font and size.

pub fn units_per_em(&self, font_id: FontId) -> u32

Get the number of font size units per ‘em square’, Per MDN: “an abstract square whose height is the intended distance between lines of type in the same type size”

pub fn cap_height(&self, font_id: FontId, font_size: Pixels) -> Pixels

Get the height of a capital letter in the given font and size.

pub fn x_height(&self, font_id: FontId, font_size: Pixels) -> Pixels

Get the height of the x character in the given font and size.

pub fn ascent(&self, font_id: FontId, font_size: Pixels) -> Pixels

Get the recommended distance from the baseline for the given font

pub fn descent(&self, font_id: FontId, font_size: Pixels) -> Pixels

Get the recommended distance below the baseline for the given font, in single spaced text.

pub fn baseline_offset( &self, font_id: FontId, font_size: Pixels, line_height: Pixels, ) -> Pixels

Get the recommended baseline offset for the given font and line height.

pub fn line_wrapper( self: &Arc<Self>, font: Font, font_size: Pixels, ) -> LineWrapperHandle

Returns a handle to a line wrapper, for the given font and font size.