Struct glow_glyph::Section
source · [−]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>,
}
Expand description
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
sourceimpl<'a, X> 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<'_, X2>, Global>) -> Section<'_, X2>
Trait Implementations
sourceimpl<'_, '_, X> From<&'_ Section<'_, X>> for SectionGeometry
impl<'_, '_, X> From<&'_ Section<'_, X>> for SectionGeometry
sourcefn from(section: &Section<'_, X>) -> SectionGeometry
fn from(section: &Section<'_, X>) -> SectionGeometry
Converts to this type from the input type.
sourceimpl<'a, '_> From<&'_ VariedSection<'a>> for Section<'a, Extra>
impl<'a, '_> From<&'_ VariedSection<'a>> for Section<'a, Extra>
sourcefn from(s: &VariedSection<'a>) -> Section<'a, Extra>
fn from(s: &VariedSection<'a>) -> Section<'a, Extra>
Converts to this type from the input type.
sourceimpl<'a> From<&'a OwnedVariedSection> for Section<'a, Extra>
impl<'a> From<&'a OwnedVariedSection> for Section<'a, Extra>
sourcefn from(owned: &'a OwnedVariedSection) -> Section<'a, Extra>
fn from(owned: &'a OwnedVariedSection) -> Section<'a, Extra>
Converts to this type from the input type.
sourceimpl<'a> From<VariedSection<'a>> for Section<'a, Extra>
impl<'a> From<VariedSection<'a>> for Section<'a, Extra>
sourcefn from(s: VariedSection<'a>) -> Section<'a, Extra>
fn from(s: VariedSection<'a>) -> Section<'a, Extra>
Converts to this type from the input type.
impl<'a, X> StructuralPartialEq for Section<'a, X>
Auto Trait Implementations
impl<'a, X> RefUnwindSafe for Section<'a, X> where
X: RefUnwindSafe,
impl<'a, X> Send for Section<'a, X> where
X: Send,
impl<'a, X> Sync for Section<'a, X> where
X: Sync,
impl<'a, X> Unpin for Section<'a, X> where
X: Unpin,
impl<'a, X> UnwindSafe for Section<'a, X> where
X: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more