Enum directwrite::enums::FontStretch

#[repr(u32)]
pub enum FontStretch {
    Undefined,
    UltraCondensed,
    ExtraCondensed,
    Condensed,
    SemiCondensed,
    Normal,
    SemiExpanded,
    Expanded,
    ExtraExpanded,
    UltraExpanded,
}

Represents the degree to which a font has been stretched compared to a font's normal aspect ratio.The enumerated values correspond to the usWidthClass definition in the OpenType specification. The usWidthClass represents an integer value between 1 and 9—lower values indicate narrower widths; higher values indicate wider widths.

A font stretch describes the degree to which a font form is stretched from its normal aspect ratio, which is the original width to height ratio specified for the glyphs in the font. The following illustration shows an example of Normal and Condensed stretches for the Rockwell Bold typeface.

Variants

Undefined

Predefined font stretch : Not known (0).

UltraCondensed

Predefined font stretch : Ultra-condensed (1).

ExtraCondensed

Predefined font stretch : Extra-condensed (2).

Condensed

Predefined font stretch : Condensed (3).

SemiCondensed

Predefined font stretch : Semi-condensed (4).

Normal

Predefined font stretch : Normal (5).

SemiExpanded

Predefined font stretch : Semi-expanded (6).

Expanded

Predefined font stretch : Expanded (7).

ExtraExpanded

Predefined font stretch : Extra-expanded (8).

UltraExpanded

Predefined font stretch : Ultra-expanded (9).

Methods

impl FontStretch

pub fn to_u32(self) -> u32

Convert this enum to its underlying value.

pub fn from_u32(val: u32) -> Option<Self>

Attempt to convert this enum from an underlying value. Returns None if the value is not valid for this enumeration.

Trait Implementations

impl PartialEq<FontStretch> for FontStretch

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

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

#[must_use]

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

This method tests for !=.

impl Ord for FontStretch

fn cmp(&self, other: &FontStretch) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Clone for FontStretch

fn clone(&self) -> FontStretch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for FontStretch

impl Copy for FontStretch

impl PartialOrd<FontStretch> for FontStretch

fn partial_cmp(&self, other: &FontStretch) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Hash for FontStretch

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for FontStretch

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

Formats the value using the given formatter.

impl CheckedEnum for FontStretch

type Storage = u32

fn try_from_storage(val: Self::Storage) -> Option<Self>

fn to_storage(self) -> Self::Storage