Struct glyph_brush::Section

pub struct Section<'a> {
    pub text: &'a str,
    pub screen_position: (f32, f32),
    pub bounds: (f32, f32),
    pub scale: Scale,
    pub color: [f32; 4],
    pub z: f32,
    pub layout: Layout<BuiltInLineBreaker>,
    pub font_id: FontId,
}

An object that contains all the info to render a section of text.

For varied font/scale/color sections see VariedSection.

Example

use glyph_brush::Section;

let section = Section {
    text: "Hello glyph_brush",
    ..Section::default()
};

Fields

text: &'a str

Text to render

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.

scale: Scale

Font scale. Defaults to 16

color: [f32; 4]

Rgba color of rendered text. Defaults to black.

z: f32

Z values for use in depth testing. Defaults to 0.0

layout: Layout<BuiltInLineBreaker>

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

font_id: FontId

Font id to use for this section.

It must be known to the GlyphBrush it is being used with, either FontId::default() or the return of add_font.

Trait Implementations

impl<'a> Copy for Section<'a>

impl Default for Section<'static>

fn default() -> Self

Returns the "default value" for a type.

impl<'a> Clone for Section<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> PartialEq<Section<'a>> for Section<'a>

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

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

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

This method tests for !=.

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

fn from(s: &Section<'a>) -> Self

Performs the conversion.

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

fn from(s: Section<'a>) -> Self

Performs the conversion.

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

fn from(section: Section<'a>) -> Self

Performs the conversion.

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

fn from(section: &Section<'a>) -> Self

Performs the conversion.

impl<'a> Debug for Section<'a>

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

Formats the value using the given formatter.