Struct Font

pub struct Font<'ttf_module, 'rwops> { /* private fields */ }

Available on crate feature dep_sdl2 only.

A loaded TTF font.

Implementations

impl<'ttf, 'r> Font<'ttf, 'r>

pub fn render<'a, 'b>(&'a self, text: &'b str) -> PartialRendering<'a, 'b>

Starts specifying a rendering of the given UTF-8-encoded text.

pub fn render_latin1<'a, 'b>( &'a self, text: &'b [u8], ) -> PartialRendering<'a, 'b>

Starts specifying a rendering of the given Latin-1-encoded text.

pub fn render_char(&self, ch: char) -> PartialRendering<'_, 'static>

Starts specifying a rendering of the given UTF-8-encoded character.

pub fn size_of(&self, text: &str) -> Result<(u32, u32), FontError>

Returns the width and height of the given text when rendered using this font.

pub fn size_of_latin1(&self, text: &[u8]) -> Result<(u32, u32), FontError>

Returns the width and height of the given text when rendered using this font.

pub fn size_of_char(&self, ch: char) -> Result<(u32, u32), FontError>

Returns the width and height of the given text when rendered using this font.

pub fn get_style(&self) -> FontStyle

Returns the font’s style flags.

pub fn set_style(&mut self, styles: FontStyle)

Sets the font’s style flags.

pub fn get_outline_width(&self) -> u16

Returns the width of the font’s outline.

pub fn set_outline_width(&mut self, width: u16)

Sets the width of the font’s outline.

pub fn get_hinting(&self) -> Hinting

Returns the font’s freetype hints.

pub fn set_hinting(&mut self, hinting: Hinting)

Sets the font’s freetype hints.

pub fn get_kerning(&self) -> bool

Returns whether the font is kerning.

pub fn set_kerning(&mut self, kerning: bool)

Sets whether the font should use kerning.

pub fn height(&self) -> i32

Get font maximum total height.

pub fn ascent(&self) -> i32

Returns the font’s highest ascent (height above base).

pub fn descent(&self) -> i32

Returns the font’s lowest descent (height below base). This is a negative number.

pub fn recommended_line_spacing(&self) -> i32

Returns the recommended line spacing for text rendered with this font.

pub fn face_count(&self) -> u16

Returns the number of faces in this font.

pub fn face_is_fixed_width(&self) -> bool

Returns whether the font is monospaced.

pub fn face_family_name_borrowed(&self) -> Option<&'ttf CStr>

Returns the family name of the current font face without doing any heap allocations.

pub fn face_family_name(&self) -> Option<String>

Returns the family name of the current font face.

pub fn face_style_name_borrowed(&self) -> Option<&'ttf CStr>

Returns the name of the current font face without doing any heap allocations.

pub fn face_style_name(&self) -> Option<String>

Returns the name of the current font face.

pub fn find_glyph(&self, ch: char) -> Option<u16>

Returns the index of the given character in this font face.

pub fn find_glyph_metrics(&self, ch: char) -> Option<GlyphMetrics>

Returns the glyph metrics of the given character in this font face.

Trait Implementations

impl<'ttf, 'r> Drop for Font<'ttf, 'r>

fn drop(&mut self)

Executes the destructor for this type.