Enum gfx_glyph::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: L
h_align: HorizontalAlign
v_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: L
h_align: HorizontalAlign
v_align: VerticalAlign

Methods

impl Layout<BuiltInLineBreaker>

fn default_single_line() -> Self

fn default_wrap() -> Self

impl<L: LineBreaker> Layout<L>

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

Returns an identical Layout but with the input h_align

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

Returns an identical Layout but with the input v_align

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

Returns an identical Layout but with the input line_breaker

impl<L: LineBreaker> Layout<L>

fn calculate_glyphs_and_leftover<'a>(
    &self,
    font_map: &HashMap<FontId, Font>,
    section: &SectionGlyphInfo<'a>
) -> (Vec<GlyphedSectionText>, Option<LayoutLeftover<'a>>)

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

fn hash<__HL: Hasher>(&self, __arg_0: &mut __HL)

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

fn eq(&self, __arg_0: &Layout<L>) -> bool

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

fn ne(&self, __arg_0: &Layout<L>) -> bool

This method tests for !=.

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

fn calculate_glyphs<'a, G: Into<SectionGlyphInfo<'a>>>(
    &self,
    font_map: &HashMap<FontId, Font>,
    section: G
) -> Vec<GlyphedSectionText>

Calculate a sequence of positioned glyphs to render. Custom implementations should always return the same result when called with the same arguments. If not consider disabling cache_glyph_positioning.

fn bounds_rect<'a, G: Into<SectionGlyphInfo<'a>>>(
    &self,
    section: G
) -> Rect<f32>

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