ludus 0.2.2

headless NES emulator crate
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

/// This represents an audio device we can push samples to.
///
/// The APU will dump its samples into an object implementing
/// this Trait as it generates them.
pub trait AudioDevice {
    fn push_sample(&mut self, sample: f32);
}

/// This represents the width of the display in pixels
pub const NES_WIDTH: usize = 256;
/// This represents the height of the display in pixels
pub const NES_HEIGHT: usize = 240;
const BUFFER_PIXELS: usize = NES_WIDTH * NES_HEIGHT;

/// Represents a buffer of pixels the PPU writes to.
///
/// The pixels can be read as a slice of u32 values in ARGB format, in row order.
///
/// The default value for the pixel buffer is completely transparent.
///
/// This struct is somewhat large, so it should be boxed when included
/// in another struct to avoid blowing up the stack.
pub struct PixelBuffer([u32; BUFFER_PIXELS]);

impl Default for PixelBuffer {
    /// This returns a completely transparent buffer of pixels.
    fn default() -> Self {
        PixelBuffer([0; BUFFER_PIXELS])
    }
}

impl AsRef<[u32]> for PixelBuffer {
    /// This will return the pixels row by row, in ARGB (big endian) format.
    fn as_ref(&self) -> &[u32] {
        &self.0
    }
}

impl PixelBuffer {
    pub(crate) fn write(&mut self, x: usize, y: usize, argb: u32) {
        let index = NES_WIDTH * y + x;
        self.0[index] = argb;
    }
}

/// This represents a video device we can write a pixel buffer to.
/// 
/// When implementing this trait, the device should be scaled to a factor
/// of NES_WIDTH * NES_HEIGHT, and be able to accept a pixel buffer of those
/// dimensions.
pub trait VideoDevice {
    /// Transfer a buffer of pixels onto this device.
    fn blit_pixels(&mut self, pixels: &PixelBuffer);
}