ltk_primitives 0.3.5

Primitive types and helpers for League Toolkit
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

use byteorder::{ByteOrder, ReadBytesExt, WriteBytesExt};
use std::io::{self, Read, Write};

/// Generic RGBA Color struct
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd, Default)]
pub struct Color<T = f32> {
    pub r: T,
    pub g: T,
    pub b: T,
    pub a: T,
}

impl<T> AsRef<Color<T>> for Color<T> {
    fn as_ref(&self) -> &Color<T> {
        self
    }
}

impl<T> Color<T> {
    pub const fn new(r: T, g: T, b: T, a: T) -> Self {
        Self { r, g, b, a }
    }

    pub const fn to_array(&self) -> [T; 4]
    where
        T: Copy,
    {
        [self.r, self.g, self.b, self.a]
    }
}

impl Color<u8> {
    pub const ONE: Color<u8> = Color::new(255, 255, 255, 255);

    /// Writes color as RGBA u8 (4 bytes)
    pub fn to_writer(&self, writer: &mut (impl Write + ?Sized)) -> io::Result<()> {
        writer.write_u8(self.r)?;
        writer.write_u8(self.g)?;
        writer.write_u8(self.b)?;
        writer.write_u8(self.a)?;
        Ok(())
    }

    /// Writes color as BGRA u8 (4 bytes)
    pub fn to_writer_bgra(&self, writer: &mut (impl Write + ?Sized)) -> io::Result<()> {
        writer.write_u8(self.b)?;
        writer.write_u8(self.g)?;
        writer.write_u8(self.r)?;
        writer.write_u8(self.a)?;
        Ok(())
    }

    /// Writes color as RGB u8 (3 bytes, no alpha)
    pub fn to_writer_rgb(&self, writer: &mut (impl Write + ?Sized)) -> io::Result<()> {
        writer.write_u8(self.r)?;
        writer.write_u8(self.g)?;
        writer.write_u8(self.b)?;
        Ok(())
    }

    /// Reads color as RGBA u8 (4 bytes)
    #[inline]
    pub fn from_reader(reader: &mut (impl Read + ?Sized)) -> io::Result<Self> {
        Ok(Self {
            r: reader.read_u8()?,
            g: reader.read_u8()?,
            b: reader.read_u8()?,
            a: reader.read_u8()?,
        })
    }

    /// Reads color as BGRA u8 (4 bytes) - common in DirectX formats
    #[inline]
    pub fn from_reader_bgra(reader: &mut (impl Read + ?Sized)) -> io::Result<Self> {
        let b = reader.read_u8()?;
        let g = reader.read_u8()?;
        let r = reader.read_u8()?;
        let a = reader.read_u8()?;
        Ok(Self { r, g, b, a })
    }

    /// Reads color as RGB u8 (3 bytes, alpha defaults to 255)
    #[inline]
    pub fn from_reader_rgb(reader: &mut (impl Read + ?Sized)) -> io::Result<Self> {
        Ok(Self {
            r: reader.read_u8()?,
            g: reader.read_u8()?,
            b: reader.read_u8()?,
            a: 255,
        })
    }

    /// Convert to normalized f32 color
    #[inline]
    pub fn to_f32(self) -> Color<f32> {
        Color {
            r: self.r as f32 / 255.0,
            g: self.g as f32 / 255.0,
            b: self.b as f32 / 255.0,
            a: self.a as f32 / 255.0,
        }
    }
}

impl Color<f32> {
    pub const ONE: Color<f32> = Color::new(1.0, 1.0, 1.0, 1.0);

    /// Writes color as RGBA f32 (16 bytes)
    pub fn to_writer<E: ByteOrder>(&self, writer: &mut (impl Write + ?Sized)) -> io::Result<()> {
        writer.write_f32::<E>(self.r)?;
        writer.write_f32::<E>(self.g)?;
        writer.write_f32::<E>(self.b)?;
        writer.write_f32::<E>(self.a)?;
        Ok(())
    }

    /// Reads color as RGBA f32 (16 bytes)
    #[inline]
    pub fn from_reader<E: ByteOrder, R: Read + ?Sized>(reader: &mut R) -> io::Result<Self> {
        Ok(Self {
            r: reader.read_f32::<E>()?,
            g: reader.read_f32::<E>()?,
            b: reader.read_f32::<E>()?,
            a: reader.read_f32::<E>()?,
        })
    }

    /// Convert to u8 color (clamped to [0, 255])
    #[inline]
    pub fn to_u8(self) -> Color<u8> {
        Color {
            r: (self.r.clamp(0.0, 1.0) * 255.0) as u8,
            g: (self.g.clamp(0.0, 1.0) * 255.0) as u8,
            b: (self.b.clamp(0.0, 1.0) * 255.0) as u8,
            a: (self.a.clamp(0.0, 1.0) * 255.0) as u8,
        }
    }
}

impl From<Color<u8>> for Color<f32> {
    fn from(c: Color<u8>) -> Self {
        c.to_f32()
    }
}

impl From<Color<f32>> for Color<u8> {
    fn from(c: Color<f32>) -> Self {
        c.to_u8()
    }
}