diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 1261331..6777a74 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at fafhrd91@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at graham@wihlidal.ca. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. diff --git a/Cargo.toml b/Cargo.toml index db6da0a..7103f49 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -19,7 +19,6 @@ exclude = [ [badges] travis-ci = { repository = "gwihlidal/vk-sync-rs" } appveyor = { repository = "gwihlidal/vk-sync-rs" } -codecov = { repository = "gwihlidal/vk-sync-rs", branch = "master", service = "github" } maintenance = { status = "actively-developed" } [lib] diff --git a/README.md b/README.md index 8a22408..aedd7ca 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Simplified Vulkan synchronization logic, written in rust. ## Overview -In an effort to make Vulkan synchronization more accessible, this library provides a simplification of core synchronization mechanisms such as pipeline barriers and events. +In an effort to make Vulkan synchronization more accessible, this library provides an efficient simplification of core synchronization mechanisms such as pipeline barriers and events. Rather than the complex maze of enums and bit flags in Vulkan - many combinations of which are invalid or nonsensical - this library collapses this to a much shorter list of ~40 distinct usage types, and a couple of options for handling image layouts. @@ -22,6 +22,20 @@ Additionally, these usage types provide an easier mapping to other graphics APIs Use of other synchronization mechanisms such as semaphores, fences and render passes are not addressed in this library at present. +## Bindings + +There are a number of Vulkan ffi bindings available, and I do plan to support the most common bindings, but for now this library only implements support for [`ash`](https://crates.io/crates/ash). Please add other bindings you need via a pull-request; I would happily accept it. + +## Expressiveness + +Despite the fact that this library is fairly simple, it expresses 99% of what you'd actually ever want to do in practice. Adding the missing expressiveness would result in increased complexity which does not seem worth the trade-off. If you have any pattern you need express, please file an issue! + +Here's a list of known things you cannot express: + +* Execution only dependencies cannot be expressed. These are occasionally useful in conjunction with semaphores, or when trying to be clever with scheduling - but their usage is both limited and fairly tricky to get right anyway. + +* Depth/Stencil Input Attachments can be read in a shader using either `ImageLayout::ShaderReadOnlyOptimal` or `ImageLayout::DepthStencilReadOnlyOptimal` - this library always uses `ImageLayout::DepthStencilReadOnlyOptimal`. It is possible (though highly unlikely) when aliasing images that this results in unnecessary transitions. + ## Usage Add this to your `Cargo.toml`: @@ -46,6 +60,10 @@ Licensed under either of at your option. +## Credits + +This library is heavily based on work by Tobias Hector (https://github.com/Tobski/simple_vulkan_synchronization) + ## Contribution Unless you explicitly state otherwise, any contribution intentionally submitted