Struct bevy::ui::Style

[−]

pub struct Style {Show 21 fields
    pub display: Display,
    pub position_type: PositionType,
    pub direction: Direction,
    pub flex_direction: FlexDirection,
    pub flex_wrap: FlexWrap,
    pub align_items: AlignItems,
    pub align_self: AlignSelf,
    pub align_content: AlignContent,
    pub justify_content: JustifyContent,
    pub position: Rect<Val>,
    pub margin: Rect<Val>,
    pub padding: Rect<Val>,
    pub border: Rect<Val>,
    pub flex_grow: f32,
    pub flex_shrink: f32,
    pub flex_basis: Val,
    pub size: Size<Val>,
    pub min_size: Size<Val>,
    pub max_size: Size<Val>,
    pub aspect_ratio: Option<f32>,
    pub overflow: Overflow,
}

Expand description

Describes the style of a UI node

It uses the Flexbox system.

Note: Bevy’s UI is upside down compared to how Flexbox normally works, to stay consistent with engine paradigms about layouting from the upper left corner of the display

Fields

display: Display

Whether to arrange this node and its children with flexbox layout

position_type: PositionType

Whether to arrange this node relative to other nodes, or positioned absolutely

direction: Direction

Which direction the content of this node should go

flex_direction: FlexDirection

Whether to use column or row layout

flex_wrap: FlexWrap

How to wrap nodes

align_items: AlignItems

How items are aligned according to the cross axis

align_self: AlignSelf

Like align_items but for only this item

align_content: AlignContent

How to align each line, only applies if flex_wrap is set to FlexWrap::Wrap and there are multiple lines of items

justify_content: JustifyContent

How items align according to the main axis

position: Rect<Val>

The position of the node as descrided by its Rect

margin: Rect<Val>

The margin of the node

padding: Rect<Val>

The padding of the node

border: Rect<Val>

The border of the node

flex_grow: f32

Defines how much a flexbox item should grow if there’s space available

flex_shrink: f32

How to shrink if there’s not enough space available

flex_basis: Val

The initial size of the item

size: Size<Val>

The size of the flexbox

min_size: Size<Val>

The minimum size of the flexbox

max_size: Size<Val>

The maximum size of the flexbox

aspect_ratio: Option<f32>

The aspect ratio of the flexbox

overflow: Overflow

How to handle overflow

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Component for Style where
    Style: 'static,
    Style: Send,
    Style: Sync,

type Storage = TableStorage

impl Debug for Style

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

Formats the value using the given formatter. Read more

impl Default for Style

fn default() -> Style

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

impl GetTypeRegistration for Style

fn get_type_registration() -> TypeRegistration

impl PartialEq<Style> for Style

fn eq(&self, other: &Style) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &Style) -> bool

This method tests for !=.

impl Reflect for Style

fn type_name(&self) -> &str

Returns the type name of the underlying type. Read more

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>ⓘNotable traits for Box<F, A>`impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;`

Clones the value as a Reflect trait object. Read more

fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>

Performs a type-checked assignment of a reflected value to this value. Read more

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value. Read more

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type. Read more

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type. Read more

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value. Read more

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type). Read more

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result. Read more

impl Struct for Style

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect. Read more

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect. Read more

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect. Read more

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect. Read more

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>ⓘNotable traits for FieldIter<'a>`impl<'a> Iterator for FieldIter<'a> type Item = &'a (dyn Reflect + 'static);`

Returns an iterator over the values of the struct’s fields.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl StructuralPartialEq for Style

Auto Trait Implementations

impl RefUnwindSafe for Style

impl Send for Style

impl Sync for Style

impl Unpin for Style

impl UnwindSafe for Style

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> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<F, A>`impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;`

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. Read more

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

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

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. Read more

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. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

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

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

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

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

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

Creates Self using data from the given World

impl<S> GetField for S where
S: Struct,

fn get_field<T>(&self, name: &str) -> Option<&T> where
T: Reflect,

Returns a reference to the value of the field named name, downcast to T. Read more

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T> where
T: Reflect,

Returns a mutable reference to the value of the field named name, downcast to T. Read more

impl<T> GetPath for T where
T: Reflect,

fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a reference to the value specified by path. Read more

fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a mutable reference to the value specified by path. Read more

fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,

Returns a statically typed reference to the value specified by path.

fn get_path_mut<T>(
 &'r mut self,
 path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
 T: Reflect,

Returns a statically typed mutable reference to the value specified by path. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

source

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

source

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

const: unstable · 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>ⓘNotable traits for Box<F, A>`impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;`

impl<T> Upcast<T> for T

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` 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>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

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

Struct bevy::ui::Style

Fields

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

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

impl Component for Style where Style: 'static, Style: Send, Style: Sync,

type Storage = TableStorage

impl Debug for Style

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

impl Default for Style

fn default() -> Style

impl GetTypeRegistration for Style

fn get_type_registration() -> TypeRegistration

impl PartialEq<Style> for Style

fn eq(&self, other: &Style) -> bool

fn ne(&self, other: &Style) -> bool

impl Reflect for Style

fn type_name(&self) -> &str

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

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

fn set( &mut self, value: Box<dyn Reflect + 'static, Global>) -> Result<(), Box<dyn Reflect + 'static, Global>>

fn apply(&mut self, value: &(dyn Reflect + 'static))

fn reflect_ref(&self) -> ReflectRef<'_>

fn reflect_mut(&mut self) -> ReflectMut<'_>

fn serializable(&self) -> Option<Serializable<'_>>

fn reflect_hash(&self) -> Option<u64>

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

impl Struct for Style

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

fn name_at(&self, index: usize) -> Option<&str>

fn field_len(&self) -> usize

fn iter_fields(&self) -> FieldIter<'_>ⓘNotable traits for FieldIter<'a>impl<'a> Iterator for FieldIter<'a> type Item = &'a (dyn Reflect + 'static);

fn clone_dynamic(&self) -> DynamicStruct

impl StructuralPartialEq for Style

Auto Trait Implementations

impl RefUnwindSafe for Style

impl Send for Style

impl Sync for Style

impl Unpin for Style

impl UnwindSafe for Style

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

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

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

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

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

impl<S> GetField for S where S: Struct,

fn get_field<T>(&self, name: &str) -> Option<&T> where T: Reflect,

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T> where T: Reflect,

impl<T> GetPath for T where T: Reflect,

fn path( &'r self, path: &'p str) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

fn path_mut( &'r mut self, path: &'p str) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where T: Reflect,

fn get_path_mut<T>( &'r mut self, path: &'p str) -> Result<&'r mut T, ReflectPathError<'p>> where T: Reflect,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl Component for Style where
Style: 'static,
Style: Send,
Style: Sync,

fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>

fn iter_fields(&self) -> FieldIter<'_>ⓘNotable traits for FieldIter<'a>`impl<'a> Iterator for FieldIter<'a> type Item = &'a (dyn Reflect + 'static);`

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

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

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

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

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

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

impl<S> GetField for S where
S: Struct,

fn get_field<T>(&self, name: &str) -> Option<&T> where
T: Reflect,

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T> where
T: Reflect,

impl<T> GetPath for T where
T: Reflect,

fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,

fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

impl<T> ToOwned for T where
T: Clone,

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

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