Struct Margin

pub struct Margin {
    pub left: f32,
    pub right: f32,
    pub top: f32,
    pub bottom: f32,
}

A value for all four sides of a rectangle, often used to express padding or spacing.

Can be added and subtracted to/from Rects.

Fields

left: f32

right: f32

top: f32

bottom: f32

Implementations

impl Margin

pub const ZERO: Self = _

pub const fn same(margin: f32) -> Self

The same margin on every side.

pub const fn symmetric(x: f32, y: f32) -> Self

Margins with the same size on opposing sides

pub fn sum(&self) -> Vec2

Total margins on both sides

pub const fn left_top(&self) -> Vec2

pub const fn right_bottom(&self) -> Vec2

pub fn is_same(&self) -> bool

Are the margin on every side the same?

pub fn expand_rect(&self, rect: Rect) -> Rect

👎Deprecated: Use rect + margin instead

pub fn shrink_rect(&self, rect: Rect) -> Rect

👎Deprecated: Use rect - margin instead

Trait Implementations

impl Add<Margin> for Rect

Rect + Margin

type Output = Rect

The resulting type after applying the + operator.

fn add(self, margin: Margin) -> Self

Performs the + operation.

impl Add<f32> for Margin

Margin + f32

type Output = Margin

The resulting type after applying the + operator.

fn add(self, v: f32) -> Self

Performs the + operation.

impl Add for Margin

Margin + Margin

type Output = Margin

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign<Margin> for Rect

Rect += Margin

fn add_assign(&mut self, margin: Margin)

Performs the += operation.

impl AddAssign<f32> for Margin

Margind += f32

fn add_assign(&mut self, v: f32)

Performs the += operation.

impl Clone for Margin

fn clone(&self) -> Margin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Margin

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

Formats the value using the given formatter.

impl Default for Margin

fn default() -> Margin

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Margin

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<f32> for Margin

Margin / f32

type Output = Margin

The resulting type after applying the / operator.

fn div(self, v: f32) -> Self

Performs the / operation.

impl DivAssign<f32> for Margin

Margin /= f32

fn div_assign(&mut self, v: f32)

Performs the /= operation.

impl From<Vec2> for Margin

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl From<f32> for Margin

fn from(v: f32) -> Self

Converts to this type from the input type.

impl Mul<f32> for Margin

Margin * f32

type Output = Margin

The resulting type after applying the * operator.

fn mul(self, v: f32) -> Self

Performs the * operation.

impl MulAssign<f32> for Margin

Margin *= f32

fn mul_assign(&mut self, v: f32)

Performs the *= operation.

impl PartialEq for Margin

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Margin

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Margin> for Rect

Rect - Margin

type Output = Rect

The resulting type after applying the - operator.

fn sub(self, margin: Margin) -> Self

Performs the - operation.

impl Sub<f32> for Margin

Margin - f32

type Output = Margin

The resulting type after applying the - operator.

fn sub(self, v: f32) -> Self

Performs the - operation.

impl Sub for Margin

Margin - Margin

type Output = Margin

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl SubAssign<Margin> for Rect

Rect -= Margin

fn sub_assign(&mut self, margin: Margin)

Performs the -= operation.

impl SubAssign<f32> for Margin

Margin -= f32

fn sub_assign(&mut self, v: f32)

Performs the -= operation.

impl Copy for Margin

impl StructuralPartialEq for Margin