Struct MathParams 

pub struct MathParams {

    pub x_height: Dim,
    pub quad: Dim,
    pub axis_height: Dim,
    pub accent_base_height: Dim,
    pub flattened_accent_base_height: Dim,
    pub fraction_rule_thickness: Dim,
    pub fraction_numerator_shift_up: Dim,
    pub fraction_numerator_display_style_shift_up: Dim,
    pub fraction_denominator_shift_down: Dim,
    pub fraction_denominator_display_style_shift_down: Dim,
    pub fraction_numerator_gap_min: Dim,
    pub fraction_num_display_style_gap_min: Dim,
    pub fraction_denominator_gap_min: Dim,
    pub fraction_denom_display_style_gap_min: Dim,
    pub superscript_shift_up: Dim,
    pub superscript_shift_up_cramped: Dim,
    pub subscript_shift_down: Dim,
    pub sub_superscript_gap_min: Dim,
    pub space_after_script: Dim,
    pub radical_vertical_gap: Dim,
    pub radical_display_style_vertical_gap: Dim,
    pub radical_rule_thickness: Dim,
    pub radical_extra_ascender: Dim,
    pub radical_kern_before_degree: Dim,
    pub radical_kern_after_degree: Dim,
    pub radical_degree_bottom_raise_percent: i16,
    pub overbar_vertical_gap: Dim,
    pub overbar_rule_thickness: Dim,
    pub overbar_extra_ascender: Dim,
    pub underbar_vertical_gap: Dim,
    pub underbar_rule_thickness: Dim,
    pub underbar_extra_descender: Dim,
    pub upper_limit_gap_min: Dim,
    pub upper_limit_baseline_rise_min: Dim,
    pub lower_limit_gap_min: Dim,
    pub lower_limit_baseline_drop_min: Dim,
    pub display_operator_min_height: Dim,
    pub script_percent_scale_down: i16,
    pub script_script_percent_scale_down: i16,
    pub units_per_em: u16,
}

MATH-table parameters used by the layout engine.

Examples

use latex_rust::{MathFont, MathParams, MathStyle};

let font = MathFont::stix_two_math().unwrap();
let p = MathParams::from_font(&font).unwrap();
assert!(!p.axis_height.is_zero());
assert!(!p.em(MathStyle::Text).is_zero());

Fields

x_height: Dim

σ1: x-height (em).

quad: Dim

σ2: quad / em width.

axis_height: Dim

σ6 / σ22: math axis height.

accent_base_height: Dim

Accent base height.

flattened_accent_base_height: Dim

Flattened accent base height (cramped / tall bases).

fraction_rule_thickness: Dim

σ8: default rule thickness (fraction / radical bar).

fraction_numerator_shift_up: Dim

σ10 analogue: numerator shift (text).

fraction_numerator_display_style_shift_up: Dim

σ9 analogue: numerator shift (display).

fraction_denominator_shift_down: Dim

σ12 analogue: denominator shift (text).

fraction_denominator_display_style_shift_down: Dim

σ11 analogue: denominator shift (display).

fraction_numerator_gap_min: Dim

Minimum gap num ↔ rule (text).

fraction_num_display_style_gap_min: Dim

Minimum gap num ↔ rule (display).

fraction_denominator_gap_min: Dim

Minimum gap rule ↔ den (text).

fraction_denom_display_style_gap_min: Dim

Minimum gap rule ↔ den (display).

superscript_shift_up: Dim

σ14 analogue: superscript shift (text).

superscript_shift_up_cramped: Dim

σ15 analogue: superscript shift cramped.

subscript_shift_down: Dim

σ16 analogue: subscript shift.

sub_superscript_gap_min: Dim

Minimum gap between sub and sup.

space_after_script: Dim

Space after a script.

radical_vertical_gap: Dim

Radical vertical gap (text).

radical_display_style_vertical_gap: Dim

Radical vertical gap (display).

radical_rule_thickness: Dim

Radical rule thickness.

radical_extra_ascender: Dim

Extra ascender above radical rule.

radical_kern_before_degree: Dim

Kern before a radical degree.

radical_kern_after_degree: Dim

Kern after a radical degree.

radical_degree_bottom_raise_percent: i16

Degree bottom raise percent (integer 0–100).

overbar_vertical_gap: Dim

Overbar gap.

overbar_rule_thickness: Dim

Overbar rule thickness.

overbar_extra_ascender: Dim

Overbar extra ascender.

underbar_vertical_gap: Dim

Underbar gap.

underbar_rule_thickness: Dim

Underbar rule thickness.

underbar_extra_descender: Dim

Underbar extra descender.

upper_limit_gap_min: Dim

Upper limit gap min.

upper_limit_baseline_rise_min: Dim

Upper limit baseline rise min.

lower_limit_gap_min: Dim

Lower limit gap min.

lower_limit_baseline_drop_min: Dim

Lower limit baseline drop min.

display_operator_min_height: Dim

Display operator min height (font units, as Dim em).

script_percent_scale_down: i16

Script scale (percent, e.g. 70).

script_script_percent_scale_down: i16

Scriptscript scale (percent, e.g. 55).

units_per_em: u16

unitsPerEm.

Implementations

impl MathParams

pub fn from_font(font: &MathFont) -> Result<Self, Error>

Load MATH constants from font. Missing MATH is Error::Unsupported.

Errors

Error::Unsupported if the face has no MATH table or constants.

pub fn scale(&self, style: MathStyle) -> Dim

Scale factor for style (1, script%, or scriptscript%).

pub fn em(&self, style: MathStyle) -> Dim

Current em (quad * scale).

pub fn mu(&self, style: MathStyle) -> Dim

One mu at style (em / 18).

Trait Implementations

impl Clone for MathParams

fn clone(&self) -> MathParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MathParams

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

Formats the value using the given formatter.