leyoda/softbuffer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Modified Cargo.toml and README.md to prepare for publication to crates.io

Browse source
This commit is contained in:
David Johnson 2022-01-19 21:57:09 -06:00
parent d8087a68a0
commit 4311b27193
2 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Cargo.toml
View file

@ -1,10 +1,17 @@
[package] [package]
name = "softbuffer" name = "softbuffer"
version = "0.0.1" version = "0.1.0"
edition = "2021" edition = "2021"
authors = ["David Johnson <john01dav@gmail.com>"] authors = ["David Johnson <john01dav@gmail.com>"]
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
description = "Softbuffer integrates with the raw-window-handle crate to allow writing to a window in a cross-platform way while using the very high quality dedicated window management libraries that are available in the Rust ecosystem." description = "Softbuffer integrates with the raw-window-handle crate to allow writing to a window in a cross-platform way while using the very high quality dedicated window management libraries that are available in the Rust ecosystem."
documentation = "https://docs.rs/softbuffer"
readme = "README.md"
homepage = "https://github.com/john01dav/softbuffer"
repository = "https://github.com/john01dav/softbuffer"
keywords = ["framebuffer"]
categories = ["game-development", "graphics", "gui", "multimedia", "rendering"]
exclude = ["examples"]
[dependencies] [dependencies]
thiserror = "1.0.30" thiserror = "1.0.30"

7
README.md
View file

@ -15,7 +15,7 @@ libraries that are available in the Rust ecosystem.
What about [pixels](https://crates.io/crates/pixels)? Pixels accomplishes a very similar goal to softbuffer, What about [pixels](https://crates.io/crates/pixels)? Pixels accomplishes a very similar goal to softbuffer,
however there are two key differences. Pixels provides some capacity for GPU-accelerated post-processing of what is however there are two key differences. Pixels provides some capacity for GPU-accelerated post-processing of what is
displayed, while Softbuffer does not. Due to not having this post-processing, Softbuffer does not rely on the GPU or displayed, while Softbuffer does not. Due to not having this post-processing, Softbuffer does not rely on the GPU or
hardware accelerated graphcis stack in any way, and is thus more portable to installations that do not have access to hardware accelerated graphics stack in any way, and is thus more portable to installations that do not have access to
hardware acceleration (e.g. VMs, older computers, computers with misconfigured drivers). Softbuffer should be used over hardware acceleration (e.g. VMs, older computers, computers with misconfigured drivers). Softbuffer should be used over
pixels when its GPU-accelerated post-processing effects are not needed. pixels when its GPU-accelerated post-processing effects are not needed.
@ -28,8 +28,9 @@ from the minifb library to do platform-specific work.
Platform support: Platform support:
== ==
Some, but not all, platforms supported in [raw-window-handle]() are supported by Softbuffer. Pull requests are welcome Some, but not all, platforms supported in [raw-window-handle](https://crates.io/crates/raw-window-handle) are supported
to add new platforms! by Softbuffer. Pull requests are welcome to add new platforms! **Nonetheless, all major desktop platforms that winit uses
on desktop are supported.**
For now, the priority for new platforms is: For now, the priority for new platforms is:
1) to have at least one platform on each OS working (e.g. one of Win32 or WinRT, or one of Xlib, Xcb, and Wayland) and 1) to have at least one platform on each OS working (e.g. one of Win32 or WinRT, or one of Xlib, Xcb, and Wayland) and