imbuf 0.3.3

Image buffers that abstract over underlying storage (Vec, Arc, or custom backends). Features copy-on-write semantics for efficient memory usage.
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

use std::num::NonZeroU8;

use crate::{
    ImageChannel,
    dynamic::DynamicImageChannel,
    pixel_elements::{ComptimeSize, PixelSize, RuntimeSize},
};

/// Removes all compile time hints, of how many channels a pixel persists
/// This is primarily used in `DynamicImageChannel`
#[derive(Clone, Copy, Default)]
pub struct DynamicSize<T: PixelTypePrimitive>(std::marker::PhantomData<T>);

impl<T: PixelTypePrimitive> RuntimePixelType for DynamicSize<T> {
    type Primitive = T;
    type PixelSize = RuntimeSize;
}

pub trait PixelTypePrimitive:
    Clone + PartialEq + Send + Sync + 'static + crate::seal::SealedPrimitive
{
    fn into_runtime_channel(i: ImageChannel<DynamicSize<Self>>) -> DynamicImageChannel;

    /// # Errors
    /// Returns `Err` if the dynamic image channel is not compatible with the pixel type.
    fn try_from_dynamic_image(
        channel: DynamicImageChannel,
    ) -> Result<ImageChannel<DynamicSize<Self>>, DynamicImageChannel>;

    fn try_from_dynamic_image_ref(
        channel: &DynamicImageChannel,
    ) -> Option<&ImageChannel<DynamicSize<Self>>>;
    fn try_from_dynamic_image_mut(
        channel: &mut DynamicImageChannel,
    ) -> Option<&mut ImageChannel<DynamicSize<Self>>>;
}

impl PixelTypePrimitive for u8 {
    fn into_runtime_channel(i: ImageChannel<DynamicSize<Self>>) -> DynamicImageChannel {
        DynamicImageChannel::U8(i)
    }

    fn try_from_dynamic_image(
        channel: DynamicImageChannel,
    ) -> Result<ImageChannel<DynamicSize<Self>>, DynamicImageChannel> {
        if let DynamicImageChannel::U8(channel) = channel {
            Ok(channel)
        } else {
            Err(channel)
        }
    }

    fn try_from_dynamic_image_ref(
        channel: &DynamicImageChannel,
    ) -> Option<&ImageChannel<DynamicSize<Self>>> {
        if let DynamicImageChannel::U8(channel) = channel {
            Some(channel)
        } else {
            None
        }
    }

    fn try_from_dynamic_image_mut(
        channel: &mut DynamicImageChannel,
    ) -> Option<&mut ImageChannel<DynamicSize<Self>>> {
        if let DynamicImageChannel::U8(channel) = channel {
            Some(channel)
        } else {
            None
        }
    }
}
impl PixelTypePrimitive for u16 {
    fn into_runtime_channel(i: ImageChannel<DynamicSize<Self>>) -> DynamicImageChannel {
        DynamicImageChannel::U16(i)
    }
    fn try_from_dynamic_image(
        channel: DynamicImageChannel,
    ) -> Result<ImageChannel<DynamicSize<Self>>, DynamicImageChannel> {
        if let DynamicImageChannel::U16(channel) = channel {
            Ok(channel)
        } else {
            Err(channel)
        }
    }

    fn try_from_dynamic_image_ref(
        channel: &DynamicImageChannel,
    ) -> Option<&ImageChannel<DynamicSize<Self>>> {
        if let DynamicImageChannel::U16(channel) = channel {
            Some(channel)
        } else {
            None
        }
    }

    fn try_from_dynamic_image_mut(
        channel: &mut DynamicImageChannel,
    ) -> Option<&mut ImageChannel<DynamicSize<Self>>> {
        if let DynamicImageChannel::U16(channel) = channel {
            Some(channel)
        } else {
            None
        }
    }
}

impl PixelTypePrimitive for f32 {
    fn into_runtime_channel(i: ImageChannel<DynamicSize<Self>>) -> DynamicImageChannel {
        DynamicImageChannel::F32(i)
    }
    fn try_from_dynamic_image(
        channel: DynamicImageChannel,
    ) -> Result<ImageChannel<DynamicSize<Self>>, DynamicImageChannel> {
        if let DynamicImageChannel::F32(channel) = channel {
            Ok(channel)
        } else {
            Err(channel)
        }
    }

    fn try_from_dynamic_image_ref(
        channel: &DynamicImageChannel,
    ) -> Option<&ImageChannel<DynamicSize<Self>>> {
        if let DynamicImageChannel::F32(channel) = channel {
            Some(channel)
        } else {
            None
        }
    }

    fn try_from_dynamic_image_mut(
        channel: &mut DynamicImageChannel,
    ) -> Option<&mut ImageChannel<DynamicSize<Self>>> {
        if let DynamicImageChannel::F32(channel) = channel {
            Some(channel)
        } else {
            None
        }
    }
}

pub trait RuntimePixelType: Clone + Sized + 'static {
    type Primitive: PixelTypePrimitive;
    type PixelSize: PixelSize + Default;
}

pub trait PixelType: RuntimePixelType + Clone + Sized + 'static {
    const ELEMENTS: NonZeroU8;
}

impl<T: PixelTypePrimitive> RuntimePixelType for T {
    type Primitive = T;
    type PixelSize = ComptimeSize<1>;
}

impl<T: PixelTypePrimitive, const PIXEL_ELEMENTS: usize> RuntimePixelType for [T; PIXEL_ELEMENTS] {
    type Primitive = T;
    type PixelSize = ComptimeSize<PIXEL_ELEMENTS>;
}

impl<T: PixelTypePrimitive> PixelType for T {
    const ELEMENTS: NonZeroU8 = NonZeroU8::MIN;
}

impl<T: PixelTypePrimitive, const PIXEL_ELEMENTS: usize> PixelType for [T; PIXEL_ELEMENTS] {
    const ELEMENTS: NonZeroU8 = {
        const {
            assert!(
                PIXEL_ELEMENTS <= 255,
                "PIXEL_ELEMENTS must be less than 256"
            );
            #[allow(clippy::cast_possible_truncation)]
            NonZeroU8::new(PIXEL_ELEMENTS as u8).unwrap()
        }
    };
}