Struct directwrite::font_face::FontFace

#[repr(transparent)]
pub struct FontFace { /* fields omitted */ }

Represents an absolute reference to a font face which contains font face type, appropriate file references, face identification data and various font data such as metrics, names and glyph outlines.

Methods

impl FontFace

pub fn create<'a, 'b>(factory: &'a Factory) -> FontFaceBuilder<'a, 'b>

Initializes a builder for creating a FontFace

pub fn design_glyph_metrics(
    &self,
    glyph_indices: &[u16],
    is_sideways: bool
) -> DWResult<Vec<GlyphMetrics>>

Obtains ideal (resolution-independent) glyph metrics in font design units.

pub fn files(&self) -> DWResult<Vec<FontFile>>

Obtains the font files representing a font face.

pub fn glyph_count(&self) -> u16

Obtains the number of glyphs in the font face.

pub fn glyph_indices(&self, code_points: &[u32]) -> DWResult<Vec<u16>>

Returns the nominal mapping of UCS4 Unicode code points to glyph indices as defined by the font 'CMAP' table.

pub fn glyph_run_outline(
    &self,
    em_size: f32,
    glyph_indices: &[u16],
    glyph_advances: Option<&[f32]>,
    glyph_offsets: Option<&[GlyphOffset]>,
    is_sideways: bool,
    is_rtl: bool,
    geometry_sink: impl GeometrySink
) -> DWResult<()>

Computes the outline of a run of glyphs by calling back to the outline sink interface. If glyph_advances and/or glyph_offsets are provided, they must be the same length as glyph_indices, or the function will panic.

pub fn index(&self) -> u32

Obtains the index of a font face in the context of its font files.

pub fn metrics(&self) -> FontMetrics

Obtains design units and common metrics for the font face. These metrics are applicable to all the glyphs within a font face and are used by applications for layout calculations.

pub fn recommended_rendering_mode(
    &self,
    em_size: f32,
    pixels_per_dip: f32,
    measuring_mode: MeasuringMode,
    params: &RenderingParams
) -> DWResult<UncheckedEnum<RenderingMode>>

Attempt to determine the recommended rendering mode for this font face with the given parameters.

pub fn font_type(&self) -> UncheckedEnum<FontFaceType>

Obtains the file format type of a font face.

pub fn simulations(&self) -> FontSimulations

Obtains the algorithmic style simulation flags of a font face.

pub fn is_symbol_font(&self) -> bool

Determines whether the font is a symbol font.

pub fn gdi_compatible_glyph_metrics(
    &self,
    em_size: f32,
    pixels_per_dip: f32,
    transform: Option<&Matrix3x2f>,
    use_gdi_natural: bool,
    glyph_indices: &[u16],
    is_sideways: bool
) -> DWResult<Vec<GlyphMetrics>>

Obtains glyph metrics in font design units with the return values compatible with what GDI would produce.

pub fn gdi_compatible_metrics(
    &self,
    em_size: f32,
    pixels_per_dip: f32,
    transform: Option<&Matrix3x2f>
) -> DWResult<FontMetrics>

Obtains design units and common metrics for the font face. These metrics are applicable to all the glyphs within a fontface and are used by applications for layout calculations.

pub fn font_table<'a>(
    &'a self,
    tag: impl Into<FontFeatureTag>
) -> Option<FontTable<'a>>

Finds the specified OpenType font table if it exists and returns a pointer to it. The function accesses the underlying font data through the IDWriteFontFileStream interface implemented by the font file loader.

Trait Implementations

impl PartialEq<FontFace> for FontFace

fn eq(&self, other: &FontFace) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FontFace) -> bool

This method tests for !=.

impl Sync for FontFace

impl Clone for FontFace

fn clone(&self) -> FontFace

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Send for FontFace

impl Debug for FontFace

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl ComWrapper for FontFace

type Interface = IDWriteFontFace

The raw interface type from winapi

unsafe fn get_raw(&self) -> *mut IDWriteFontFace

Gets a raw pointer to the interface. Does not increment the reference count

unsafe fn from_raw(ptr: *mut IDWriteFontFace) -> Self

Creates a wrapper from the raw pointer. Takes ownership of the pointer for reference counting purposes.

unsafe fn into_raw(self) -> *mut IDWriteFontFace

Consumes the wrapper without affecting the reference count

unsafe fn from_ptr(ptr: ComPtr<IDWriteFontFace>) -> Self

Creates a wrapper taking ownership of a ComPtr.

unsafe fn into_ptr(self) -> ComPtr<IDWriteFontFace>

Unwraps the wrapper into a ComPtr.