Struct luminance_glyph::Section

pub struct Section<'a, X = Extra> {
    pub screen_position: (f32, f32),
    pub bounds: (f32, f32),
    pub layout: Layout<BuiltInLineBreaker>,
    pub text: Vec<Text<'a, X>, Global>,
}

An object that contains all the info to render a varied section of text. That is one including many parts with differing fonts/scales/colors bowing to a single layout.

Example

use glyph_brush::{HorizontalAlign, Layout, Text, Section};

let section = Section::default()
    .add_text(Text::new("The last word was ").with_color([0.0, 0.0, 0.0, 1.0]))
    .add_text(Text::new("RED").with_color([1.0, 0.0, 0.0, 1.0]))
    .with_layout(Layout::default().h_align(HorizontalAlign::Center));

Extra

Extra text section data is stored in a generic type, default Extra. To use custom extra data ensure your custom type implements Debug, Clone, PartialEq & Hash.

Fields

screen_position: (f32, f32)

Position on screen to render text, in pixels from top-left. Defaults to (0, 0).

bounds: (f32, f32)

Max (width, height) bounds, in pixels from top-left. Defaults to unbounded.

layout: Layout<BuiltInLineBreaker>

Built in layout, can be overridden with custom layout logic see queue_custom_layout

text: Vec<Text<'a, X>, Global>

Text to render, rendered next to one another according the layout.

Implementations

impl<'a, X> Section<'a, X>

pub fn new() -> Section<'a, X>

impl<'a, X> Section<'a, X>

pub fn with_screen_position<P>(self, position: P) -> Section<'a, X> where
    P: Into<(f32, f32)>, 

pub fn with_bounds<P>(self, bounds: P) -> Section<'a, X> where
    P: Into<(f32, f32)>, 

pub fn with_layout<L>(self, layout: L) -> Section<'a, X> where
    L: Into<Layout<BuiltInLineBreaker>>, 

pub fn add_text<T>(self, text: T) -> Section<'a, X> where
    T: Into<Text<'a, X>>, 

pub fn with_text<X2>(self, text: Vec<Text<'b, X2>, Global>) -> Section<'b, X2>

impl<'text, X> Section<'text, X> where
    X: Clone, 

pub fn to_owned(&self) -> OwnedSection<X>

Trait Implementations

impl<'a, X> Clone for Section<'a, X> where
    X: Clone, 

pub fn clone(&self) -> Section<'a, X>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, X> Debug for Section<'a, X> where
    X: Debug, 

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

Formats the value using the given formatter.

impl Default for Section<'static, Extra>

pub fn default() -> Section<'static, Extra>

Returns the "default value" for a type.

impl<'_, '_, X> From<&'_ Section<'_, X>> for SectionGeometry

pub fn from(section: &Section<'_, X>) -> SectionGeometry

Performs the conversion.

impl<'a, '_> From<&'_ Section<'a>> for Section<'a, Extra>

pub fn from(s: &Section<'a>) -> Section<'a, Extra>

Performs the conversion.

impl<'a, '_> From<&'_ VariedSection<'a>> for Section<'a, Extra>

pub fn from(s: &VariedSection<'a>) -> Section<'a, Extra>

Performs the conversion.

impl<'a> From<&'a OwnedSection<Extra>> for Section<'a, Extra>

pub fn from(owned: &'a OwnedSection<Extra>) -> Section<'a, Extra>

Performs the conversion.

impl<'a> From<&'a OwnedVariedSection> for Section<'a, Extra>

pub fn from(owned: &'a OwnedVariedSection) -> Section<'a, Extra>

Performs the conversion.

impl<'a> From<Section<'a>> for Section<'a, Extra>

pub fn from(s: Section<'a>) -> Section<'a, Extra>

Performs the conversion.

impl<'a> From<VariedSection<'a>> for Section<'a, Extra>

pub fn from(s: VariedSection<'a>) -> Section<'a, Extra>

Performs the conversion.

impl<'_, X> Hash for Section<'_, X> where
    X: Hash, 

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a, X> PartialEq<Section<'a, X>> for Section<'a, X> where
    X: PartialEq<X>, 

pub fn eq(&self, other: &Section<'a, X>) -> bool

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

pub fn ne(&self, other: &Section<'a, X>) -> bool

This method tests for !=.

impl<'a, X> StructuralPartialEq for Section<'a, X>