Enum gfx_glyph::Layout

pub enum Layout<L>where
    L: LineBreaker,{
    SingleLine {
        line_breaker: L,
        h_align: HorizontalAlign,
        v_align: VerticalAlign,
    },
    Wrap {
        line_breaker: L,
        h_align: HorizontalAlign,
        v_align: VerticalAlign,
    },
}

Built-in GlyphPositioner implementations.

Takes generic LineBreaker to indicate the wrapping style. See BuiltInLineBreaker.

Example

let layout = Layout::default().h_align(HorizontalAlign::Right);

Variants

SingleLine

Fields

line_breaker: L

h_align: HorizontalAlign

v_align: VerticalAlign

Renders a single line from left-to-right according to the inner alignment. Hard breaking will end the line, partially hitting the width bound will end the line.

Wrap

Fields

line_breaker: L

h_align: HorizontalAlign

v_align: VerticalAlign

Renders multiple lines from left-to-right according to the inner alignment. Hard breaking characters will cause advancement to another line. A characters hitting the width bound will also cause another line to start.

Implementations

impl Layout<BuiltInLineBreaker>

pub fn default_single_line() -> Layout<BuiltInLineBreaker>

pub fn default_wrap() -> Layout<BuiltInLineBreaker>

impl<L> Layout<L>where L: LineBreaker,

pub fn h_align(self, h_align: HorizontalAlign) -> Layout<L>

Returns an identical Layout but with the input h_align

pub fn v_align(self, v_align: VerticalAlign) -> Layout<L>

Returns an identical Layout but with the input v_align

pub fn line_breaker<L2>(self, line_breaker: L2) -> Layout<L2>where L2: LineBreaker,

Returns an identical Layout but with the input line_breaker

Trait Implementations

impl<L> Clone for Layout<L>where L: Clone + LineBreaker,

fn clone(&self) -> Layout<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L> Debug for Layout<L>where L: Debug + LineBreaker,

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

Formats the value using the given formatter.

impl Default for Layout<BuiltInLineBreaker>

fn default() -> Layout<BuiltInLineBreaker>

Returns the “default value” for a type.

impl<L> GlyphPositioner for Layout<L>where L: LineBreaker,

fn calculate_glyphs<F, S>( &self, fonts: &[F], geometry: &SectionGeometry, sections: &[S] ) -> Vec<SectionGlyph, Global>where F: Font, S: ToSectionText,

Calculate a sequence of positioned glyphs to render. Custom implementations should return the same result when called with the same arguments to allow layout caching.

fn bounds_rect(&self, geometry: &SectionGeometry) -> Rect

Return a screen rectangle according to the requested render position and bounds appropriate for the glyph layout.

fn recalculate_glyphs<F, S, P>( &self, previous: P, change: GlyphChange, fonts: &[F], geometry: &SectionGeometry, sections: &[S] ) -> Vec<SectionGlyph, Global>where F: Font, S: ToSectionText, P: IntoIterator<Item = SectionGlyph>,

Recalculate a glyph sequence after a change.

impl<L> Hash for Layout<L>where L: Hash + LineBreaker,

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

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<L> PartialEq<Layout<L>> for Layout<L>where L: PartialEq<L> + LineBreaker,

fn eq(&self, other: &Layout<L>) -> 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<L> Copy for Layout<L>where L: Copy + LineBreaker,

impl<L> Eq for Layout<L>where L: Eq + LineBreaker,

impl<L> StructuralEq for Layout<L>where L: LineBreaker,

impl<L> StructuralPartialEq for Layout<L>where L: LineBreaker,