alex/pixels
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Jay Oster 2019-10-15 18:43:01 -07:00
parent ea4e2aafc1
commit 3102b5b485
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -6,13 +6,13 @@ A tiny hardware-accelerated pixel frame buffer. :crab:
## But why? ## But why?
Rapidly prototype a simple 2D game, pixel-based animations, or an emulator for your favorite platform. Then add shaders to simulate a CRT or just to spice it up with some nice VFX. Rapidly prototype a simple 2D game, pixel-based animations, software renderers, or an emulator for your favorite platform. Then add shaders to simulate a CRT or just to spice it up with some nice VFX.
`pixels` is more than just a library to push pixels to a screen, but less than a full framework. You're in charge of managing a window environment, event loop, and input handling. `pixels` is more than just a library to push pixels to a screen, but less than a full framework. You're in charge of managing a window environment, event loop, and input handling.
## Features ## Features
- Built on modern graphics APIs: DirectX 12, Vulkan, Metal, OpenGL. - Built on modern graphics APIs powered by [`wgpu`](https://crates.io/crates/wgpu): DirectX 12, Vulkan, Metal, OpenGL.
- Use your own custom shaders for special effects. (WIP) - Use your own custom shaders for special effects. (WIP)
- Hardware accelerated scaling on perfect pixel boundaries. - Hardware accelerated scaling on perfect pixel boundaries.
- Supports non-square pixel aspect ratios. (WIP) - Supports non-square pixel aspect ratios. (WIP)
@ -22,7 +22,7 @@ Rapidly prototype a simple 2D game, pixel-based animations, or an emulator for y
To demonstrate `pixels`, I've written a Space Invaders clone. The game logic can be found in the `simple-invaders` crate. The included example uses `simple-invaders` to rasterize the image, and `pixels` to display it. `winit` provides the windowing and event handling. To demonstrate `pixels`, I've written a Space Invaders clone. The game logic can be found in the `simple-invaders` crate. The included example uses `simple-invaders` to rasterize the image, and `pixels` to display it. `winit` provides the windowing and event handling.
```bash ```bash
cargo run --example invaders cargo run --release --example invaders
``` ```
See the [example's README](./examples/invaders) for more information. See the [example's README](./examples/invaders) for more information.