Struct bevy::ui::Size

pub struct Size {
    pub width: Val,
    pub height: Val,
}

A 2-dimensional area defined by a width and height.

It is commonly used to define the size of a text or UI element.

Fields

width: Val

The width of the 2-dimensional area.

height: Val

The height of the 2-dimensional area.

Implementations

impl Size

pub const DEFAULT: Size = Self::AUTO

pub const fn new(width: Val, height: Val) -> Size

Creates a new Size from a width and a height.

Example

let size = Size::new(Val::Px(100.0), Val::Px(200.0));

assert_eq!(size.width, Val::Px(100.0));
assert_eq!(size.height, Val::Px(200.0));

pub const fn all(value: Val) -> Size

Creates a new Size where both sides take the given value.

Example

let size = Size::all(Val::Px(10.));

assert_eq!(size.width, Val::Px(10.0));
assert_eq!(size.height, Val::Px(10.0));

pub const fn width(width: Val) -> Size

Creates a new Size where width takes the given value and its height is Val::Auto.

Example

let size = Size::width(Val::Px(10.));

assert_eq!(size.width, Val::Px(10.0));
assert_eq!(size.height, Val::Auto);

pub const fn height(height: Val) -> Size

Creates a new Size where height takes the given value and its width is Val::Auto.

Example

let size = Size::height(Val::Px(10.));

assert_eq!(size.width, Val::Auto);
assert_eq!(size.height, Val::Px(10.));

pub const AUTO: Size = Self::all(Val::Auto)

Creates a Size where both values are Val::Auto.

pub const UNDEFINED: Size = Self::all(Val::Undefined)

Creates a Size where both values are Val::Undefined.

Trait Implementations

impl Clone for Size

fn clone(&self) -> Size

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Size

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

Formats the value using the given formatter.

impl Default for Size

fn default() -> Size

Returns the “default value” for a type.

impl Div<f32> for Size

type Output = Size

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> <Size as Div<f32>>::Output

Performs the / operation.

impl DivAssign<f32> for Size

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<(Val, Val)> for Size

fn from(vals: (Val, Val)) -> Size

Converts to this type from the input type.

impl<T> From<Size> for Size<T>where T: From<Val>,

fn from(value: Size) -> Size<T>

Converts to this type from the input type.

impl GetTypeRegistration for Sizewhere Val: Reflect,

fn get_type_registration() -> TypeRegistration

impl Mul<f32> for Size

type Output = Size

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> <Size as Mul<f32>>::Output

Performs the * operation.

impl MulAssign<f32> for Size

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl PartialEq<Size> for Size

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for Sizewhere Val: Reflect,

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type.

fn into_any(self: Box<Size, Global>) -> Box<dyn Any + 'static, Global>

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Size, Global>) -> Box<dyn Reflect + 'static, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object.

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.

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

Applies a reflected value to this value.

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

Returns an enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Size, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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

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

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

Debug formatter for the value.

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

Returns a serializable version of the value.

impl Struct for Sizewhere Val: Reflect,

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

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

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.

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.

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.

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<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl Typed for Sizewhere Val: Reflect,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Size

impl StructuralPartialEq for Size