Struct rich_sdl2_ttf_rust::font::Font

pub struct Font<'ttf> { /* fields omitted */ }

A font data structure.

Implementations

impl<'ttf> Font<'ttf>

pub fn new(
    _ttf: &'ttf Ttf,
    file_name: &str,
    point: u32,
    index: Option<usize>
) -> Result<Self>

Constructs a font data from file name and point size. The font face in the font file can be selected by an optional index, which will be 0 if None.

Panics

Panics if file_name is empty.

pub fn glyph(&self, ch: char) -> Option<Glyph<'_>>

Returns the glyph of the font if exists.

pub fn rendered_size(&self, text: &str) -> Result<Size>

Calculates the rendered size of the text, or Err on failure. The height will be same as MetricExt::height.

pub fn rendered_width(
    &self,
    text: &str,
    expected_width: u32
) -> Result<(u32, usize)>

Returns the rendered width in pixels and the numbers of characters until reaching expected_width. Err will be returned on out of memory.

Trait Implementations

impl AttributeExt for Font<'_>

fn faces(&self) -> usize

Returns the numbers of the faces, the sub-font in the font.

fn is_fixed_width(&self) -> bool

Returns whether the font is fixed width.

fn family_name(&self) -> Option<Cow<'_, str>>

Returns the family name of the font.

fn style_name(&self) -> Option<Cow<'_, str>>

Returns the style name of the font.

impl Drop for Font<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl FontSetting for Font<'_>

fn hinting(&self) -> FontHinting

Returns the current hinting of the font.

fn set_hinting(&self, hinting: FontHinting)

Sets the hinting of the font.

fn disable_kerning(&self) -> KerningDisabler<'_>

Disables the font kerning.

fn is_sdf(&self) -> bool

Returns whether the font supports Singed Distance Field.

fn set_sdf(&self, value: bool) -> Result<()>

Sets whether the font supports Singed Distance Field.

impl MetricExt for Font<'_>

fn height(&self) -> u32

Returns the maximum height of the glyph in the font, in pixels.

fn ascent(&self) -> u32

Returns the maximum ascent, the hight above baseline of the glyph in the font, in pixels.

fn descent(&self) -> u32

Returns the maximum ascent, the hight below baseline of the glyph in the font, in pixels.

fn line_skip(&self) -> u32

Returns the line skip height of the font, the recommended height of a rendered line of text, in pixels. It is usually larger than MetricExt::height().

impl RenderExt for Font<'_>

fn render(&self, text: &str, mode: RenderMode) -> Result<TtfSurface>

Renders the text into the TtfSurface, or Err on failure.

fn render_wrapped(
    &self,
    text: &str,
    wrap_length: u32,
    mode: RenderMode
) -> Result<TtfSurface>

Renders the wrapped text into the TtfSurface, or Err on failure.

fn render_glyph(&self, ch: char, mode: RenderMode) -> Result<TtfSurface>

Renders the character into the TtfSurface, or Err on failure.

impl StyleExt for Font<'_>

fn font_style(&self) -> FontStyle

Returns the current font style.

fn set_font_style(&self, style: FontStyle)

Sets the font style.

fn outline_width(&self) -> u32

Returns the current outline width in pixels.

fn set_outline_width(&self, pixels: u32)

Sets the outline width in pixels.

fn set_font_size(&self, points: u32) -> Result<()>

Sets the font size in points, or Err on failure.

fn set_font_size_dpi(&self, points: u32, dpi: Dpi) -> Result<()>

Sets the font size in points and dpi, or Err on failure.