openrgb2 0.3.0

OpenRGB SDK client, successor to openrgb
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

//! Support for Effects plugin packets.

use crate::impl_enum_discriminant;
use crate::{DeserFromBuf, ReceivedMessage};

pub(crate) enum EffectsPluginPacket {
    RequestEffectList = 0,
    StartEffect = 20,
    StopEffect = 21,
}

impl_enum_discriminant!(EffectsPluginPacket,
    RequestEffectList: 0,
    StartEffect: 20,
    StopEffect: 21
);

#[derive(Debug)]
pub(crate) struct PluginEffect {
    name: String,
    description: String,
    enabled: bool,
}

impl PluginEffect {
    #[expect(unused, reason = "Plugin effect api todo")]
    pub fn name(&self) -> &str {
        &self.name
    }

    #[expect(unused, reason = "Plugin effect api todo")]
    pub fn description(&self) -> &str {
        &self.description
    }

    #[expect(unused, reason = "Plugin effect api todo")]
    pub fn enabled(&self) -> bool {
        self.enabled
    }
}

impl DeserFromBuf for PluginEffect {
    fn deserialize(buf: &mut ReceivedMessage<'_>) -> crate::OpenRgbResult<Self> {
        let name = buf.read_value()?;
        let description = buf.read_value()?;
        tracing::trace!("buf after desc: {}", buf);
        let enabled = buf.read_u8()? != 0;
        Ok(PluginEffect {
            name,
            description,
            enabled,
        })
    }
}