Struct bevy_ui::node_bundles::ButtonBundle
source · pub struct ButtonBundle {Show 14 fields
pub node: Node,
pub button: Button,
pub style: Style,
pub interaction: Interaction,
pub focus_policy: FocusPolicy,
pub background_color: BackgroundColor,
pub border_color: BorderColor,
pub image: UiImage,
pub transform: Transform,
pub global_transform: GlobalTransform,
pub visibility: Visibility,
pub inherited_visibility: InheritedVisibility,
pub view_visibility: ViewVisibility,
pub z_index: ZIndex,
}
Expand description
A UI node that is a button
Extra behaviours
You may add the following components to enable additional behaviours
ImageScaleMode
to enable either slicing or tiling of the texture
Fields§
§node: Node
Describes the logical size of the node
Marker component that signals this node is a button
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.
interaction: Interaction
Describes whether and how the button has been interacted with by the input
focus_policy: FocusPolicy
Whether this node should block interaction with lower nodes
background_color: BackgroundColor
The background color, which serves as a “fill” for this node
When combined with UiImage
, tints the provided image.
border_color: BorderColor
The color of the Node’s border
image: UiImage
The image of the node
transform: Transform
The transform of the node
This component is automatically managed by the UI layout system.
To alter the position of the ButtonBundle
, 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
Trait Implementations§
source§impl Clone for ButtonBundle
impl Clone for ButtonBundle
source§fn clone(&self) -> ButtonBundle
fn clone(&self) -> ButtonBundle
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ButtonBundle
impl Debug for ButtonBundle
source§impl Default for ButtonBundle
impl Default for ButtonBundle
impl Bundle for ButtonBundle
impl DynamicBundle for ButtonBundle
Auto Trait Implementations§
impl !RefUnwindSafe for ButtonBundle
impl Send for ButtonBundle
impl Sync for ButtonBundle
impl Unpin for ButtonBundle
impl !UnwindSafe for ButtonBundle
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<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
.