optic-core 0.0.3

Shared types, geometry, errors, and ANSI logging for Optic engine
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

/// Polygon rasterization mode.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum PolyMode {
    Points,
    WireFrame,
    Filled,
}

/// Face culling direction.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum Cull {
    Clock,
    AntiClock,
}

/// Primitive topology for draw calls.
#[derive(Copy, Clone, Debug, Default, PartialEq)]
pub enum DrawMode {
    Points,
    Lines,
    #[default]
    Triangles,
    Strip,
}

/// Texture image format, encoding channel count and bit depth.
///
/// Each variant carries the per-channel bit depth (e.g. `RGBA(8)` = 4×8-bit).
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum ImgFormat {
    R(u8),
    RG(u8),
    RGB(u8),
    RGBA(u8),
}

impl ImgFormat {
    /// Number of color channels (1–4).
    pub fn channels(&self) -> u8 {
        match self {
            ImgFormat::R(_) => 1,
            ImgFormat::RG(_) => 2,
            ImgFormat::RGB(_) => 3,
            ImgFormat::RGBA(_) => 4,
        }
    }
    /// Bits per channel.
    pub fn bit_depth(&self) -> u8 {
        *match self {
            ImgFormat::R(bd) => bd,
            ImgFormat::RG(bd) => bd,
            ImgFormat::RGB(bd) => bd,
            ImgFormat::RGBA(bd) => bd,
        }
    }
    /// Total bytes per pixel (channels × bit_depth / 8).
    pub fn pixel_size(&self) -> u8 {
        self.channels() * self.bit_depth() / 8
    }
    /// Construct from channel count and bit depth.
    ///
    /// Channels ≥ 4 produce `RGBA`. Unknown channels default to `RGBA`.
    pub fn from(channels: u8, bit_depth: u8) -> ImgFormat {
        match channels {
            1 => ImgFormat::R(bit_depth),
            2 => ImgFormat::RG(bit_depth),
            3 => ImgFormat::RGB(bit_depth),
            _ => ImgFormat::RGBA(bit_depth),
        }
    }
}

/// Texture filter (minification/magnification) mode.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum ImgFilter {
    Closest,
    Linear,
}

/// Texture wrap (addressing) mode.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum ImgWrap {
    Repeat,
    Extend,
    Clip,
}

/// Vertex attribute data type.
#[derive(Clone, Debug, PartialEq)]
pub enum ATTRType {
    U8,
    I8,
    U16,
    I16,
    U32,
    I32,
    F32,
    F64,
}