Enum glyph_brush_layout::Layout

pub enum Layout<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

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.

Fields of SingleLine

line_breaker: Lh_align: HorizontalAlignv_align: VerticalAlign

Wrap

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.

Fields of Wrap

line_breaker: Lh_align: HorizontalAlignv_align: VerticalAlign

Methods

impl Layout<BuiltInLineBreaker>

pub fn default_single_line() -> Self

pub fn default_wrap() -> Self

impl<L: LineBreaker> Layout<L>

pub fn h_align(self, h_align: HorizontalAlign) -> Self

Returns an identical Layout but with the input h_align

pub fn v_align(self, v_align: VerticalAlign) -> Self

Returns an identical Layout but with the input v_align

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

Returns an identical Layout but with the input line_breaker

Trait Implementations

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

fn calculate_glyphs<'font, F: FontMap<'font>>(
    &self,
    font_map: &F,
    geometry: &SectionGeometry,
    sections: &[SectionText]
) -> Vec<(PositionedGlyph<'font>, Color, FontId)>

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<f32>

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

fn recalculate_glyphs<'font, F>(
    &self,
    previous: Cow<Vec<(PositionedGlyph<'font>, Color, FontId)>>,
    change: GlyphChange,
    fonts: &F,
    geometry: &SectionGeometry,
    sections: &[SectionText]
) -> Vec<(PositionedGlyph<'font>, Color, FontId)> where
    F: FontMap<'font>, 

Recalculate a glyph sequence after a change.

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

impl Default for Layout<BuiltInLineBreaker>

fn default() -> Self

Returns the "default value" for a type.

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

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

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: &Layout<L>) -> bool

This method tests for !=.

impl<L: Copy + LineBreaker> Copy for Layout<L>

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

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, 

Feeds a slice of this type into the given [Hasher].

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

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

Formats the value using the given formatter.