Skip to content

Commit

Permalink
Update README with info about framebuffer changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ry755 committed Feb 1, 2021
1 parent 927ab44 commit 45d950f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ Texas Instruments TMS9918A VDP emulator library for Rust

![TMS9918A](https://upload.wikimedia.org/wikipedia/commons/d/de/TMS9918A_02.jpg)

tms9918a_emu uses the [minifb](https://github.com/emoon/rust_minifb) crate to emulate a [Texas Instruments TMS9918A](https://en.wikipedia.org/wiki/Texas_Instruments_TMS9918) video display processor in a window.
tms9918a_emu emulates a [Texas Instruments TMS9918A](https://en.wikipedia.org/wiki/Texas_Instruments_TMS9918) video display processor and provides a basic framebuffer as `Vec<u32>` which can be used with other creates, such as [minifb](https://github.com/emoon/rust_minifb), to create a window.

High-level functions are provided as well as low-level functions, making it easy to control the VDP without needing to use the control and data ports.

This emulator is a work-in-progress and currently only supports the Graphics I and Text video modes, and sprites are unsupported in all modes. In its current state, this emulator is more of a TMS9918 (non-A variant) emulator.

## Example
This is a small [example program](examples/high_level_text/src/main.rs) which uses Text mode to display a hello world message, showing how to use the high-level functions:
This is a small [example program](examples/high_level_text/src/main.rs) which uses Text mode to display a hello world message in a minifb window, showing how to use the high-level functions:
![High-level Text mode example](examples/high_level_text/images/screenshot.png)

A similar [example program](examples/low_level_text/src/main.rs) is available which shows how to use the low-level functions to display the same hello world message.
Expand Down

0 comments on commit 45d950f

Please sign in to comment.