decal 0.6.0

Declarative DSL for describing scenes and rendering them to SVG or PNG
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use crate::{
    capabilities::*,
    layout::{
        ImageMeta,
        ImageSource,
        Node,
        NodeKind,
        Typography,
    },
    macros::impl_node_builder,
    paint::{
        Appearance,
        Resource,
    },
    primitives::CrossOrigin,
};
use taffy::prelude::*;

/// Image node.
#[derive(Debug, Default)]
pub struct Image {
    meta: ImageMeta,
    layout: Style,
    visual: Appearance,
    typography: Typography, // unused, only for satisfying the [`Sealed`] trait
    resources: Vec<Resource>,
}

impl_node_builder! {
    Image,
    build(this) {
        Node::new(
            NodeKind::Image(this.meta),
            this.layout,
            this.visual,
            None,
            this.resources
        )
    }
}

impl Image {
    /// Creates a new image node with a fixed intrinsic size.
    ///
    /// # Arguments
    /// - `source`: The [`ImageSource`] value.
    /// - `width`: The intrinsic width of the image.
    /// - `height`: The intrinsic height of the image.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use decal::prelude::*;
    ///
    /// let width: f32 = 64.0;
    /// let height: f32 = 64.0;
    /// let scene = decal! {
    ///     Column {
    ///         Image("<image-href>", width, height)
    ///         Image(ImageSource::svg("<markup>"), width, height)
    ///     }
    /// };
    /// ```
    ///
    /// # Returns
    /// - [`Self`]
    pub fn new<S>(source: S, width: f32, height: f32) -> Self
    where
        S: Into<ImageSource>,
    {
        Self {
            meta: ImageMeta::new(source, width, height),
            layout: Style {
                size: Size {
                    width: Dimension::length(width),
                    height: Dimension::length(height),
                },
                ..Default::default()
            },
            ..Default::default()
        }
    }

    /// Sets the cross-origin policy used when loading the image.
    ///
    /// # Arguments
    /// - `cross_origin`: The [`CrossOrigin`] value.
    ///
    /// # Returns
    /// - [`Self`]
    pub fn cross_origin<T>(mut self, cross_origin: T) -> Self
    where
        T: Into<Option<CrossOrigin>>,
    {
        self.meta.cross_origin = cross_origin.into();
        self
    }
}

impl Hideable for Image {
    fn hidden(mut self, value: bool) -> Self {
        self.layout.display = if value { Display::None } else { Display::Block };
        self
    }
}

impl AspectRatio for Image {}
impl Background for Image {}
impl Border for Image {}
impl RoundedCorners for Image {}
impl Dimensions for Image {}
impl Margin for Image {}
impl Opacity for Image {}
impl Positioned for Image {}
impl Transformation for Image {}
impl SelfAlignment for Image {}
impl Visibility for Image {}
impl FilterEffects for Image {}
impl Blendable for Image {}