Struct bevy::ui::node_bundles::TextBundle
source · 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
impl TextBundle
sourcepub fn from_section(value: impl Into<String>, style: TextStyle) -> TextBundle
pub fn from_section(value: impl Into<String>, style: TextStyle) -> TextBundle
Create a TextBundle
from a single section.
See Text::from_section
for usage.
sourcepub fn from_sections(
sections: impl IntoIterator<Item = TextSection>
) -> TextBundle
pub fn from_sections( sections: impl IntoIterator<Item = TextSection> ) -> TextBundle
Create a TextBundle
from a list of sections.
See Text::from_sections
for usage.
sourcepub const fn with_text_justify(self, justify: JustifyText) -> TextBundle
pub const fn with_text_justify(self, justify: JustifyText) -> TextBundle
Returns this TextBundle
with a new JustifyText
on Text
.
sourcepub fn with_style(self, style: Style) -> TextBundle
pub fn with_style(self, style: Style) -> TextBundle
Returns this TextBundle
with a new Style
.
sourcepub const fn with_background_color(self, color: Color) -> TextBundle
pub const fn with_background_color(self, color: Color) -> TextBundle
Returns this TextBundle
with a new BackgroundColor
.
sourcepub const fn with_no_wrap(self) -> TextBundle
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
impl Debug for TextBundle
source§impl Default for TextBundle
impl Default for TextBundle
source§fn default() -> TextBundle
fn default() -> TextBundle
source§impl<I> From<I> for TextBundlewhere
I: Into<TextSection>,
impl<I> From<I> for TextBundlewhere
I: Into<TextSection>,
source§fn from(value: I) -> TextBundle
fn from(value: I) -> TextBundle
impl Bundle for TextBundle
impl DynamicBundle for TextBundle
Auto Trait Implementations§
impl !RefUnwindSafe for TextBundle
impl Send for TextBundle
impl Sync for TextBundle
impl Unpin for TextBundle
impl !UnwindSafe for TextBundle
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSync for T
source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.