Struct kurbo::Size

source ·

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

Expand description

A 2D size.

Fields§

§width: f64

The width.

§height: f64

The height.

Implementations§

source §

impl Size

source

pub const ZERO: Size = _

A size with zero width or height.

source

pub const fn new(width: f64, height: f64) -> Self

Create a new Size with the provided width and height.

source

pub fn max_side(self) -> f64

Returns the max of width and height.

§Examples

use kurbo::Size;
let size = Size::new(-10.5, 42.0);
assert_eq!(size.max_side(), 42.0);

source

pub fn min_side(self) -> f64

Returns the min of width and height.

§Examples

use kurbo::Size;
let size = Size::new(-10.5, 42.0);
assert_eq!(size.min_side(), -10.5);

source

pub fn area(self) -> f64

The area covered by this size.

source

pub fn is_empty(self) -> bool

Whether this size has zero area.

Note: a size with negative area is not considered empty.

source

pub fn clamp(self, min: Size, max: Size) -> Self

Returns a new size bounded by min and max.

§Examples

use kurbo::Size;

let this = Size::new(0., 100.);
let min = Size::new(10., 10.,);
let max = Size::new(50., 50.);
assert_eq!(this.clamp(min, max), Size::new(10., 50.))

source

pub const fn to_vec2(self) -> Vec2

Convert this size into a Vec2, with width mapped to x and height mapped to y.

source

pub fn round(self) -> Size

Returns a new Size, with width and height rounded to the nearest integer.

§Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).round();
assert_eq!(size_pos.width, 3.0);
assert_eq!(size_pos.height, 4.0);
let size_neg = Size::new(-3.3, -3.6).round();
assert_eq!(size_neg.width, -3.0);
assert_eq!(size_neg.height, -4.0);

source

pub fn ceil(self) -> Size

Returns a new Size, with width and height rounded up to the nearest integer, unless they are already an integer.

§Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).ceil();
assert_eq!(size_pos.width, 4.0);
assert_eq!(size_pos.height, 4.0);
let size_neg = Size::new(-3.3, -3.6).ceil();
assert_eq!(size_neg.width, -3.0);
assert_eq!(size_neg.height, -3.0);

source

pub fn floor(self) -> Size

Returns a new Size, with width and height rounded down to the nearest integer, unless they are already an integer.

§Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).floor();
assert_eq!(size_pos.width, 3.0);
assert_eq!(size_pos.height, 3.0);
let size_neg = Size::new(-3.3, -3.6).floor();
assert_eq!(size_neg.width, -4.0);
assert_eq!(size_neg.height, -4.0);

source

pub fn expand(self) -> Size

Returns a new Size, with width and height rounded away from zero to the nearest integer, unless they are already an integer.

§Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).expand();
assert_eq!(size_pos.width, 4.0);
assert_eq!(size_pos.height, 4.0);
let size_neg = Size::new(-3.3, -3.6).expand();
assert_eq!(size_neg.width, -4.0);
assert_eq!(size_neg.height, -4.0);

source

pub fn trunc(self) -> Size

Returns a new Size, with width and height rounded down towards zero the nearest integer, unless they are already an integer.

§Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).trunc();
assert_eq!(size_pos.width, 3.0);
assert_eq!(size_pos.height, 3.0);
let size_neg = Size::new(-3.3, -3.6).trunc();
assert_eq!(size_neg.width, -3.0);
assert_eq!(size_neg.height, -3.0);