Struct 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 INFINITY: Size

A size with width and height set to f64::INFINITY.

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_zero_area(self) -> bool

Whether this size has zero area.

Source

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

Returns the component-wise minimum of self and other.

§Examples

use kurbo::Size;

let this = Size::new(0., 100.);
let other = Size::new(10., 10.);

assert_eq!(this.min(other), Size::new(0., 10.));

Source

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

Returns the component-wise maximum of self and other.

§Examples

use kurbo::Size;

let this = Size::new(0., 100.);
let other = Size::new(10., 10.);

assert_eq!(this.max(other), Size::new(10., 100.));

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 towards zero to 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);

Source

pub fn aspect_ratio_width(self) -> f64

Returns the aspect ratio of a rectangle with this size.

The aspect ratio is the ratio of the width to the height.

If the height is 0, the output will be sign(self.width) * infinity. If the width and height are both 0, then the output will be NaN.

Source

pub fn aspect_ratio(self) -> f64

👎Deprecated since 0.12.0: You should use aspect_ratio_width instead, as this method returns a potentially unexpected value.

Returns the inverse of the aspect ratio of a rectangle with this size.

Aspect ratios are usually defined as the ratio of the width to the height, but this method incorrectly returns the ratio of height to width. You should generally prefer aspect_ratio_width.

If the width is 0, the output will be sign(self.height) * infinity. If the width and height are both 0, then the output will be NaN.

Source