Struct directwrite::font_collection::FontCollection

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

An object that encapsulates a set of fonts, such as the set of fonts installed on the system, or the set of fonts in a particular directory. The font collection API can be used to discover what font families and fonts are available, and to obtain some metadata about the fonts.

Methods

impl FontCollection

pub fn create<'a, K>(factory: &'a Factory) -> FontCollectionBuilder<'a, K> where
    K: FontKey, 

Construct a builder for a FontCollection. You'll need a CollectionLoaderHandle and its associated Key type.

pub fn system_font_collection(
    factory: &Factory,
    check_for_updates: bool
) -> DWResult<FontCollection>

Gets the FontCollection for System-installed fonts. This represents all of the fonts installed on the user's system.

pub fn find_family_by_name(&self, family_name: &str) -> Option<u32>

Finds the font family with the specified family name and returns its index

pub fn family_count(&self) -> u32

Gets the number of font families in the collection

pub fn family(&self, index: u32) -> Option<FontFamily>

Gets a FontFamily object given a zero-based font family index

pub fn all_families<'a>(&'a self) -> impl Iterator<Item = FontFamily> + 'a

Get an iterator of all font families in this collection

pub fn font_from_face(&self, face: &FontFace) -> Option<Font>

Gets the font object that corresponds to the same physical font as the specified font face object. The specified physical font must belong to the font collection.

Trait Implementations

impl PartialEq<FontCollection> for FontCollection

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

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

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

This method tests for !=.

impl Sync for FontCollection

impl Clone for FontCollection

fn clone(&self) -> FontCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Send for FontCollection

impl Debug for FontCollection

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

Formats the value using the given formatter.

impl ComWrapper for FontCollection

type Interface = IDWriteFontCollection

The raw interface type from winapi

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

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

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

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

unsafe fn into_raw(self) -> *mut IDWriteFontCollection

Consumes the wrapper without affecting the reference count

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

Creates a wrapper taking ownership of a ComPtr.

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

Unwraps the wrapper into a ComPtr.