Struct glyph_brush::legacy::VariedSection

pub struct VariedSection<'a> {
    pub screen_position: (f32, f32),
    pub bounds: (f32, f32),
    pub z: f32,
    pub layout: Layout<BuiltInLineBreaker>,
    pub text: Vec<SectionText<'a>>,
}

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.

For single font/scale/color sections it may be simpler to use Section.

Example

use glyph_brush::legacy::{SectionText, VariedSection};

let section = VariedSection {
    text: vec![
        SectionText {
            text: "I looked around and it was ",
            ..<_>::default()
        },
        SectionText {
            text: "RED",
            color: [1.0, 0.0, 0.0, 1.0],
            ..<_>::default()
        },
    ],
    ..<_>::default()
};

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.

z: f32

Z values for use in depth testing. Defaults to 0.0

layout: Layout<BuiltInLineBreaker>

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

text: Vec<SectionText<'a>>

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

Implementations

impl<'text> VariedSection<'text>

pub fn to_owned(&self) -> OwnedVariedSection

Trait Implementations

impl<'a> Clone for VariedSection<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for VariedSection<'a>

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

Formats the value using the given formatter.

impl Default for VariedSection<'static>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a OwnedVariedSection> for VariedSection<'a>

fn from(owned: &'a OwnedVariedSection) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&VariedSection<'_>> for SectionGeometry

fn from(section: &VariedSection<'_>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a, 'b> From<&'b VariedSection<'a>> for Cow<'b, VariedSection<'a>>

fn from(owned: &'b VariedSection<'a>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(owned: VariedSection<'a>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl Hash for VariedSection<'_>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for VariedSection<'a>

fn eq(&self, other: &VariedSection<'a>) -> 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<'a> StructuralPartialEq for VariedSection<'a>