Struct nines::Layout

pub struct Layout<Dst, Src> {
    pub dst: Dst,
    pub src: Src,
    pub style: Style,
}

Describe a layout to render with. You'll probably start with a:

use nines::*;
 
let layout = Layout {
    src: Dimensions {
        outer: Rect::xywh(0, 0, 3, 3),
        inner: Rect::xywh(1, 1, 1, 1),
    },
    dst: Dimensions {
        outer: Rect::xywh(0, 0, 5, 4),
        inner: Rect::xywh(1, 1, 3, 2),
    },
    style: Style::default(), // stretch
};
 
let mut rects = Vec::new();
layout.validate().unwrap().each_dst_src(|dst, src|{
    rects.push((*dst, *src));
});
 
assert_eq!(rects[0].0, Rect::xywh(0, 0, 1, 1));
assert_eq!(rects[1].0, Rect::xywh(1, 0, 3, 1));
// ...
 
assert_eq!(rects[0].1, Rect::xywh(0, 0, 1, 1));
assert_eq!(rects[1].1, Rect::xywh(1, 0, 1, 1));
// ...

Fields

dst: Dst

src: Src

style: Style

Methods

impl<S: Scalar> Layout<Dimensions<S>, Dimensions<S>>

pub fn validate(
    &self
) -> Result<Layout<ValidDimensions<S>, ValidDimensions<S>>, Error>

Validate that dst and src contain valid (non-negative sized, non-NAN) dimensions.

impl<S: Scalar> Layout<ValidDimensions<S>, ValidDimensions<S>>

pub fn each_dst_src(
    &self,
    each_dst_src: impl FnMut(&ValidRect<S>, &ValidRect<S>)
)

Enumerate the destination and source rectangles for a layout.

Trait Implementations

impl<S: Scalar> TryFrom<Layout<Dimensions<S>, Dimensions<S>>> for Layout<ValidDimensions<S>, ValidDimensions<S>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    value: Layout<Dimensions<S>, Dimensions<S>>
) -> Result<Layout<ValidDimensions<S>, ValidDimensions<S>>, Self::Error>

Performs the conversion.