Struct Size2D 

pub struct Size2D {
    pub w: u32,
    pub h: u32,
}

A 2D size with non-negative integer dimensions.

use optic_core::*;

let s = Size2D::from(1920, 1080);
assert_eq!(s.aspect_ratio(), 16.0 / 9.0);

Supports Add, Sub (saturating), and Mul<f32> componentwise. Conversion from/to [u32; 2] and (u32, u32) via Components.

Fields

w: u32

h: u32

Implementations

impl Size2D

pub fn empty() -> Size2D

Zero-size (0, 0).

pub fn from(w: u32, h: u32) -> Self

Construct from explicit width and height.

pub fn shave(&self, n: u32) -> Size2D

Reduce both dimensions by n (saturating).

pub fn aspect_ratio(&self) -> f32

Aspect ratio as w / h (f32). Returns 0 if height is 0.

pub fn is_empty(&self) -> bool

True if either dimension is zero.

pub fn area(&self) -> u64

Area in pixels (w * h as u64).

pub fn min(&self, other: Size2D) -> Size2D

Componentwise minimum.

pub fn max(&self, other: Size2D) -> Size2D

Componentwise maximum.

pub fn fit_within(&self, max: Size2D) -> Size2D

Scale down to fit within max while preserving aspect ratio.

If already within bounds, returns unchanged.

pub fn scaled_to_width(&self, w: u32) -> Size2D

Scale to a specific width, preserving aspect ratio.

pub fn scaled_to_height(&self, h: u32) -> Size2D

Scale to a specific height, preserving aspect ratio.

pub fn to_size3d(&self, depth: u32) -> Size3D

Convert to a Size3D with the given depth.

Trait Implementations

impl Add for Size2D

type Output = Size2D

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Size2D

fn clone(&self) -> Size2D

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Components<u32, 2> for Size2D

fn to_array(self) -> [u32; 2]

Convert to an array of length N.

fn from_array(a: [u32; 2]) -> Self

Construct from an array of length N.

impl Copy for Size2D

impl Debug for Size2D

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

Formats the value using the given formatter.

impl From<(u32, u32)> for Size2D

fn from(t: (u32, u32)) -> Self

Converts to this type from the input type.

impl From<Size2D> for [u32; 2]

fn from(s: Size2D) -> Self

Converts to this type from the input type.

impl From<[u32; 2]> for Size2D

fn from(a: [u32; 2]) -> Self

Converts to this type from the input type.

impl Mul<f32> for Size2D

type Output = Size2D

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Size2D

fn eq(&self, other: &Size2D) -> 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 StructuralPartialEq for Size2D

impl Sub for Size2D

type Output = Size2D

The resulting type after applying the - operator.

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

Performs the - operation.