pub struct TextBundle {
Show 14 fields pub node: Node, pub style: Style, pub text: Text, pub text_layout_info: TextLayoutInfo, pub text_flags: TextFlags, pub calculated_size: ContentSize, pub focus_policy: FocusPolicy, pub transform: Transform, pub global_transform: GlobalTransform, pub visibility: Visibility, pub inherited_visibility: InheritedVisibility, pub view_visibility: ViewVisibility, pub z_index: ZIndex, pub background_color: BackgroundColor,
}
Expand description

A UI node that is text

The positioning of this node is controlled by the UI layout system. If you need manual control, use Text2dBundle.

Fields§

§node: Node

Describes the logical size of the node

§style: Style

Styles which control the layout (size and position) of the node and it’s children In some cases these styles also affect how the node drawn/painted.

§text: Text

Contains the text of the node

§text_layout_info: TextLayoutInfo

Text layout information

§text_flags: TextFlags

Text system flags

§calculated_size: ContentSize

The calculated size based on the given image

§focus_policy: FocusPolicy

Whether this node should block interaction with lower nodes

§transform: Transform

The transform of the node

This component is automatically managed by the UI layout system. To alter the position of the TextBundle, use the properties of the Style component.

§global_transform: GlobalTransform

The global transform of the node

This component is automatically updated by the TransformPropagate systems.

§visibility: Visibility

Describes the visibility properties of the node

§inherited_visibility: InheritedVisibility

Inherited visibility of an entity.

§view_visibility: ViewVisibility

Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering

§z_index: ZIndex

Indicates the depth at which the node should appear in the UI

§background_color: BackgroundColor

The background color that will fill the containing node

Implementations§

source§

impl TextBundle

source

pub fn from_section(value: impl Into<String>, style: TextStyle) -> TextBundle

Create a TextBundle from a single section.

See Text::from_section for usage.

source

pub fn from_sections( sections: impl IntoIterator<Item = TextSection> ) -> TextBundle

Create a TextBundle from a list of sections.

See Text::from_sections for usage.

source

pub const fn with_text_justify(self, justify: JustifyText) -> TextBundle

Returns this TextBundle with a new JustifyText on Text.

source

pub fn with_style(self, style: Style) -> TextBundle

Returns this TextBundle with a new Style.

source

pub const fn with_background_color(self, color: Color) -> TextBundle

Returns this TextBundle with a new BackgroundColor.

source

pub const fn with_no_wrap(self) -> TextBundle

Returns this TextBundle with soft wrapping disabled. Hard wrapping, where text contains an explicit linebreak such as the escape sequence \n, will still occur.

Trait Implementations§

source§

impl Debug for TextBundle

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for TextBundle

source§

fn default() -> TextBundle

Returns the “default value” for a type. Read more
source§

impl<I> From<I> for TextBundle
where I: Into<TextSection>,

source§

fn from(value: I) -> TextBundle

Converts to this type from the input type.
source§

impl Bundle for TextBundle

source§

impl DynamicBundle for TextBundle

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<S> FromSample<S> for S

source§

fn from_sample_(s: S) -> S

source§

impl<T> FromWorld for T
where T: Default,

source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

source§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

source§

impl<T> Settings for T
where T: 'static + Send + Sync,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,