img-gen-spec 0.2.1

An API to create image generator specifications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

use super::{Border, ColorKind};

#[cfg(feature = "pyo3")]
use pyo3::prelude::*;

use serde::{Deserialize, Serialize};

/// An enum to represent the possible options in specifying which [`Rectangle::corners`] to render rounded.
#[cfg_attr(
    feature = "pyo3",
    pyclass(eq, eq_int, module = "img_gen", from_py_object)
)]
#[derive(Debug, PartialEq, Clone, Copy, Serialize, Deserialize)]
pub enum Corners {
    /// The ``"top left"`` corner of the `Rectangle`.
    #[serde(alias = "top left")]
    TopLeft,

    /// The ``"top right"`` corner of the `Rectangle`.
    #[serde(alias = "top right")]
    TopRight,

    /// The ``"bottom left"`` corner of the `Rectangle`.
    #[serde(alias = "bottom left")]
    BottomLeft,

    /// The ``"bottom right"`` corner of the `Rectangle`.
    #[serde(alias = "bottom right")]
    BottomRight,
}

impl Corners {
    /// All rectangle corners in display order.
    pub const ALL: [Self; 4] = [
        Corners::TopLeft,
        Corners::TopRight,
        Corners::BottomLeft,
        Corners::BottomRight,
    ];
}

/// An attribute to represent a rectangle rendered in the layer.
///
/// The size of the rectangle is specified by the layer's size.
#[cfg_attr(
    feature = "pyo3",
    pyclass(module = "img_gen", get_all, set_all, from_py_object)
)]
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct Rectangle {
    /// The [`Border`] (if specified) to render around the rectangle.
    pub border: Option<Border>,

    /// The color used to fill the rectangle.
    #[serde(default = "ColorKind::transparent_default")]
    pub color: ColorKind,

    /// The radius of the rendered [`Rectangle::corners`].
    ///
    /// The renderer shall limit this value if it is
    /// greater than half the minimum of the rectangle's width or height
    /// (see [`Layer::size`](value@crate::Layer::size)).
    #[serde(default)]
    pub radius: f32,

    /// A list of the [`Corners`] in which the `radius` is applied.
    ///
    /// Any [`Corners`] not in this list will not be rounded.
    #[serde(default)]
    pub corners: Vec<Corners>,
}