Skip to main content

GlyphDrawingOptions

Struct GlyphDrawingOptions 

Source
pub struct GlyphDrawingOptions { /* private fields */ }
Expand description

Options that influence how a single glyph is drawn, independent of variable-font axis configuration: which CPAL palette to use for color glyphs, and which bitmap strike size to prefer for bitmap-based glyphs.

All properties are optional. None means “use the font’s default” (palette 0 for color glyphs; no bitmap strike preference). Concerns specific to variable fonts (axis coordinates, named instances) live on FontVariationSettings.

A record with init-only properties: a value is built from GlyphDrawingOptions::new with GlyphDrawingOptions::with_palette_index and GlyphDrawingOptions::with_pixel_size, which validate as the property initialisers do.

Implementations§

Source§

impl GlyphDrawingOptions

Source

pub const DEFAULT: GlyphDrawingOptions

The instance representing “use the font’s defaults”.

Source

pub const fn new() -> GlyphDrawingOptions

Creates options that use the font’s defaults.

Source

pub fn palette_index(&self) -> Option<i32>

Gets the optional CPAL palette index used to resolve colors for COLR v0 / COLR v1 glyphs.

When None, the font’s default palette (palette 0) is used.

Source

pub fn with_palette_index(self, value: Option<i32>) -> GlyphDrawingOptions

Returns a copy of the options with the given palette index.

§Panics

When the value is negative (ArgumentOutOfRangeException).

Source

pub fn pixel_size(&self) -> Option<i32>

Gets the optional pixel size used to select a bitmap strike from sbix, CBDT or EBDT tables.

When None, no bitmap strike is selected and the font’s outline (or color-layer) representation is used instead.

Source

pub fn with_pixel_size(self, value: Option<i32>) -> GlyphDrawingOptions

Returns a copy of the options with the given pixel size.

§Panics

When the value is less than 1 (ArgumentOutOfRangeException).

Trait Implementations§

Source§

impl Clone for GlyphDrawingOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for GlyphDrawingOptions

Source§

impl Debug for GlyphDrawingOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GlyphDrawingOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for GlyphDrawingOptions

Source§

impl Hash for GlyphDrawingOptions

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for GlyphDrawingOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GlyphDrawingOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyValue for T
where T: PartialEq + 'static,

Source§

fn any_value_as_any(&self) -> &(dyn Any + 'static)

Source§

fn any_value_eq(&self, other: &(dyn AnyValue + 'static)) -> bool

Source§

fn any_value_type_name(&self) -> &'static str

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ClassDefaults for T
where T: ?Sized,

Source§

fn static_constructor()

The static constructor of a type: work done once per thread, after the properties of the type are registered and before its first instance exists (class handlers, affects_render, metadata overrides). Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PropertyValue for T
where T: Clone + PartialEq + 'static,

Source§

impl<T> ResourceKeyObject for T
where T: Eq + Hash + 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Source§

fn dyn_eq(&self, other: &(dyn ResourceKeyObject + 'static)) -> bool

Source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Source§

fn key_type_name(&self) -> &'static str

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.