jkl 0.2.1

Asset compression and packing tool
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

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u16)]
pub enum Format {
    /// 8-bit single channel.
    R8,

    /// 8-bit two channels.
    RG8,

    /// 8-bit three channels.
    RGB8,

    /// 8-bit four channels.
    RGBA8,

    /// BC1 (DXT1) block compression format.
    BC1 = 256,

    /// BC2 (DXT3) block compression format.
    BC2,

    /// BC3 (DXT5) block compression format.
    BC3,

    /// BC4 block compression format.
    BC4,

    /// BC5 block compression format.
    BC5,

    /// BC6 block compression format.
    BC6,

    /// BC7 block compression format.
    BC7,
}

impl Format {
    /// Returns width of a block in pixels for the format.
    pub const fn block_width(&self) -> u16 {
        match self {
            Format::R8 | Format::RG8 | Format::RGB8 | Format::RGBA8 => 1,
            Format::BC1
            | Format::BC2
            | Format::BC3
            | Format::BC4
            | Format::BC5
            | Format::BC6
            | Format::BC7 => 4,
        }
    }

    /// Returns height of a block in pixels for the format.
    pub const fn block_height(&self) -> u16 {
        match self {
            Format::R8 | Format::RG8 | Format::RGB8 | Format::RGBA8 => 1,
            Format::BC1
            | Format::BC2
            | Format::BC3
            | Format::BC4
            | Format::BC5
            | Format::BC6
            | Format::BC7 => 4,
        }
    }
}