diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2019-11-22 19:36:57 +0100 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2019-11-22 19:36:57 +0100 |
| commit | a7dba612f03e58d7bd9527499d893987986b347c (patch) | |
| tree | b8c3d8f997b714aa368bd6eaecf14065f7645c77 /native/src/size.rs | |
| parent | ba56a561b254c9a5f3d23cb54d23dc311759ab4c (diff) | |
| download | iced-a7dba612f03e58d7bd9527499d893987986b347c.tar.gz iced-a7dba612f03e58d7bd9527499d893987986b347c.tar.bz2 iced-a7dba612f03e58d7bd9527499d893987986b347c.zip | |
Write docs for `iced` and `iced_native`
Diffstat (limited to 'native/src/size.rs')
| -rw-r--r-- | native/src/size.rs | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/native/src/size.rs b/native/src/size.rs index bd909292..30e2a57e 100644 --- a/native/src/size.rs +++ b/native/src/size.rs @@ -1,5 +1,6 @@ use std::f32; +/// An amount of space in 2 dimensions. #[derive(Debug, Clone, Copy, PartialEq)] pub struct Size { /// The width. @@ -9,13 +10,26 @@ pub struct Size { } impl Size { + /// A [`Size`] with zero width and height. + /// + /// [`Size`]: struct.Size.html pub const ZERO: Size = Size::new(0., 0.); + + /// A [`Size`] with infinite width and height. + /// + /// [`Size`]: struct.Size.html pub const INFINITY: Size = Size::new(f32::INFINITY, f32::INFINITY); + /// A [`Size`] of infinite width and height. + /// + /// [`Size`]: struct.Size.html pub const fn new(width: f32, height: f32) -> Self { Size { width, height } } + /// Increments the [`Size`] to account for the given padding. + /// + /// [`Size`]: struct.Size.html pub fn pad(&self, padding: f32) -> Self { Size { width: self.width + padding * 2.0, |