tetanes_core/
lib.rs

1#![doc = include_str!("../README.md")]
2#![doc(
3    html_favicon_url = "https://github.com/lukexor/tetanes/blob/main/assets/linux/icon.png?raw=true",
4    html_logo_url = "https://github.com/lukexor/tetanes/blob/main/assets/linux/icon.png?raw=true"
5)]
6#![cfg_attr(docsrs, feature(doc_auto_cfg))]
7
8pub mod action;
9pub mod apu;
10pub mod bus;
11pub mod cart;
12pub mod debug;
13pub mod fs;
14pub mod time;
15#[macro_use]
16pub mod common;
17pub mod control_deck;
18pub mod cpu;
19pub mod error;
20pub mod genie;
21pub mod input;
22pub mod mapper;
23pub mod mem;
24pub mod ppu;
25pub mod sys;
26pub mod video;
27
28pub mod prelude {
29    //! The prelude re-exports all the common structs/enums used for basic NES emulation.
30
31    pub use crate::{
32        action::Action,
33        apu::{Apu, Channel},
34        cart::Cart,
35        common::{Clock, ClockTo, NesRegion, Regional, Reset, ResetKind, Sample},
36        control_deck::{Config, ControlDeck, HeadlessMode},
37        cpu::Cpu,
38        genie::GenieCode,
39        input::{FourPlayer, Input, Player},
40        mapper::{MappedRead, MappedWrite, Mapper, MapperRevision, Mirrored},
41        mem::RamState,
42        ppu::{Mirroring, Ppu},
43        video::Frame,
44    };
45}