autd3-core 38.1.0

AUTD3 core traits and types
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

use super::{intensity::Intensity, phase::Phase};

/// A container for the phase and intensity of the ultrasound.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(C)]
pub struct Drive {
    /// The phase of the ultrasound.
    pub phase: Phase,
    /// The intensity of the ultrasound.
    pub intensity: Intensity,
}

impl Drive {
    /// A [`Drive`] with a phase of [`Phase::ZERO`] and an intensity of [`Intensity::MIN`].
    pub const NULL: Self = Self {
        phase: Phase::ZERO,
        intensity: Intensity::MIN,
    };
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_null() {
        assert_eq!(
            Drive {
                phase: Phase::ZERO,
                intensity: Intensity::MIN
            },
            Drive::NULL
        );
    }
}