Enum Gravity

#[non_exhaustive]
pub enum Gravity {
    South,
    East,
    North,
    West,
    Auto,
}

Gravity represents the orientation of glyphs in a segment of text.

This is useful when rendering vertical text layouts. In those situations, the layout is rotated using a non-identity Matrix, and then glyph orientation is controlled using Gravity.

Not every value in this enumeration makes sense for every usage of Gravity; for example, Auto only can be passed to Context::set_base_gravity() and can only be returned by Context::base_gravity().

See also: GravityHint

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

South

Glyphs stand upright (default)

East

Glyphs are rotated 90 degrees counter-clockwise.

North

Glyphs are upside-down.

West

Glyphs are rotated 90 degrees clockwise.

Auto

Gravity is resolved from the context matrix

Implementations

impl Gravity

pub fn for_matrix(matrix: Option<&Matrix>) -> Gravity

pub fn for_script( script: Script, base_gravity: Gravity, hint: GravityHint, ) -> Gravity

pub fn for_script_and_width( script: Script, wide: bool, base_gravity: Gravity, hint: GravityHint, ) -> Gravity

pub fn to_rotation(self) -> f64

Trait Implementations

impl Clone for Gravity

fn clone(&self) -> Gravity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Gravity

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

Formats the value using the given formatter.

impl From<Gravity> for Value

fn from(v: Gravity) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for Gravity

type Checker = GenericValueTypeChecker<Gravity>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for Gravity

type ParamSpec = ParamSpecEnum

type SetValue = Gravity

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: Gravity) -> ParamSpecEnumBuilder<'_, Gravity>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Gravity

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 Gravity

fn cmp(&self, other: &Gravity) -> 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,

Restrict a value to a certain interval.

impl PartialEq for Gravity

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Gravity

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for Gravity

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for Gravity

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for Gravity

type Type = Gravity

Type to get the Type from.

impl Copy for Gravity

impl Eq for Gravity

impl StructuralPartialEq for Gravity