colstodian 0.1.0-rc.3

An opinionated, practical color management library for games and graphics.
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

use crate::traits::*;

use glam::Vec3;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use core::fmt;

/// Encodes that a color's component values have been premultiplied with its
/// alpha channel.
#[derive(Default)]
pub struct Premultiplied;

impl AlphaState for Premultiplied {
    const STATE: DynamicAlphaState = DynamicAlphaState::Premultiplied;
}

impl ConvertFromAlphaRaw<Separate> for Premultiplied {
    #[inline]
    fn convert_raw(raw: Vec3, alpha: f32) -> Vec3 {
        raw * alpha
    }
}

impl<SrcSpace, SrcAlpha> ColorAlphaConversionQuery<SrcSpace, SrcAlpha> for Premultiplied
where
    SrcSpace: ConvertFromRaw<SrcSpace>,
    SrcAlpha: AlphaState,
    Self: ConvertFromAlphaRaw<SrcAlpha>,
{
    type DstSpace = SrcSpace;
    type DstAlpha = Self;
}

impl fmt::Display for Premultiplied {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Premultiplied")
    }
}

/// Encodes that a color's component values are completely separate from its
/// alpha channel.
#[derive(Default)]
pub struct Separate;

impl AlphaState for Separate {
    const STATE: DynamicAlphaState = DynamicAlphaState::Separate;
}

impl ConvertFromAlphaRaw<Premultiplied> for Separate {
    #[inline]
    fn convert_raw(raw: Vec3, alpha: f32) -> Vec3 {
        if alpha != 0.0 {
            raw / alpha
        } else {
            raw
        }
    }
}

impl<SrcSpace, SrcAlpha> ColorAlphaConversionQuery<SrcSpace, SrcAlpha> for Separate
where
    SrcSpace: ConvertFromRaw<SrcSpace>,
    SrcAlpha: AlphaState,
    Self: ConvertFromAlphaRaw<SrcAlpha>,
{
    type DstSpace = SrcSpace;
    type DstAlpha = Self;
}

impl fmt::Display for Separate {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Separate")
    }
}

/// A dynamic version of a color's alpha state. See docs for [`AlphaState`]
#[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
#[cfg_attr(feature = "with-serde", derive(Serialize, Deserialize))]
pub enum DynamicAlphaState {
    /// See docs for [`Premultiplied`]
    Premultiplied,
    /// See docs for [`Separate`]
    Separate,
}