Struct write_fonts::tables::gpos::ValueRecord

#[non_exhaustive]
pub struct ValueRecord {
    pub x_placement: Option<i16>,
    pub y_placement: Option<i16>,
    pub x_advance: Option<i16>,
    pub y_advance: Option<i16>,
    pub x_placement_device: NullableOffsetMarker<DeviceOrVariationIndex>,
    pub y_placement_device: NullableOffsetMarker<DeviceOrVariationIndex>,
    pub x_advance_device: NullableOffsetMarker<DeviceOrVariationIndex>,
    pub y_advance_device: NullableOffsetMarker<DeviceOrVariationIndex>,
    /* private fields */
}

A ValueRecord

GPOS subtables use ValueRecords to describe all the variables and values used to adjust the position of a glyph or set of glyphs. A ValueRecord may define any combination of X and Y values (in design units) to add to (positive values) or subtract from (negative values) the placement and advance values provided in the font. In non-variable fonts, a ValueRecord may also contain an offset to a Device table for each of the specified values. In a variable font, it may also contain an offset to a VariationIndex table for each of the specified values.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

x_placement: Option<i16>

y_placement: Option<i16>

x_advance: Option<i16>

y_advance: Option<i16>

x_placement_device: NullableOffsetMarker<DeviceOrVariationIndex>

y_placement_device: NullableOffsetMarker<DeviceOrVariationIndex>

x_advance_device: NullableOffsetMarker<DeviceOrVariationIndex>

y_advance_device: NullableOffsetMarker<DeviceOrVariationIndex>

Implementations

impl ValueRecord

pub fn new() -> ValueRecord

pub fn with_x_placement(self, val: i16) -> Self

pub fn with_y_placement(self, val: i16) -> Self

pub fn with_x_advance(self, val: i16) -> Self

pub fn with_y_advance(self, val: i16) -> Self

pub fn with_x_placement_device( self, val: impl Into<DeviceOrVariationIndex> ) -> Self

pub fn with_y_placement_device( self, val: impl Into<DeviceOrVariationIndex> ) -> Self

pub fn with_x_advance_device( self, val: impl Into<DeviceOrVariationIndex> ) -> Self

pub fn with_y_advance_device( self, val: impl Into<DeviceOrVariationIndex> ) -> Self

pub fn with_explicit_value_format(self, format: ValueFormat) -> Self

pub fn set_explicit_value_format(&mut self, format: ValueFormat)

Set an explicit ValueFormat, overriding the computed format.

Use this method if you wish to write a ValueFormat that includes explicit null offsets for any of the device or variation index tables.

pub fn format(&self) -> ValueFormat

The ValueFormat of this record.

pub fn encoded_size(&self) -> usize

Return the number of bytes required to encode this value record

Trait Implementations

impl Clone for ValueRecord

fn clone(&self) -> ValueRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValueRecord

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

Formats the value using the given formatter.

impl Default for ValueRecord

fn default() -> ValueRecord

Returns the “default value” for a type.

impl FontWrite for ValueRecord

fn write_into(&self, writer: &mut TableWriter)

Write our data and information about offsets into this TableWriter.

fn table_type(&self) -> TableType

The type of this table.

impl FromObjRef<ValueRecord> for ValueRecord

fn from_obj_ref(from: &ValueRecord, data: FontData<'_>) -> Self

Convert from to an instance of Self, using the provided data to resolve offsets.

impl Hash for ValueRecord

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ValueRecord

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ValueRecord

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ValueRecord

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

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

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

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

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

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

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

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

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 RemapVariationIndices for ValueRecord

fn remap_variation_indices(&mut self, key_map: &VariationIndexRemapping)

Remap any TemporaryDeltaSetIds to their final VariationIndex values

impl Validate for ValueRecord

fn validate_impl(&self, _ctx: &mut ValidationCtx)

Validate this table.

fn validate(&self) -> Result<(), ValidationReport>

Ensure that this table is well-formed, reporting any errors.

impl Eq for ValueRecord

impl StructuralPartialEq for ValueRecord