diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
| commit | 26a029d407be480d791972afb5975cf62c9360a6 (patch) | |
| tree | f435a8308119effd964b339f76abb83a57c29483 /third_party/rust/gpu-alloc-types/README.md | |
| parent | Initial commit. (diff) | |
| download | firefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz firefox-26a029d407be480d791972afb5975cf62c9360a6.zip | |
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/gpu-alloc-types/README.md')
| -rw-r--r-- | third_party/rust/gpu-alloc-types/README.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/third_party/rust/gpu-alloc-types/README.md b/third_party/rust/gpu-alloc-types/README.md new file mode 100644 index 0000000000..8a93d685c1 --- /dev/null +++ b/third_party/rust/gpu-alloc-types/README.md @@ -0,0 +1,51 @@ +# gpu-alloc
+
+[](https://crates.io/crates/gpu-alloc)
+[](https://docs.rs/gpu-alloc)
+[](https://github.com/zakarumych/gpu-alloc/actions?query=workflow%3ARust)
+[](COPYING)
+
+
+
+Implementation agnostic memory allocator for Vulkan like APIs.
+
+This crate is intended to be used as part of safe API implementations.\
+Use with caution. There are unsafe functions all over the place.
+
+## Usage
+
+Start with fetching `DeviceProperties` from `gpu-alloc-<backend>` crate for the backend of choice.\
+Then create `GpuAllocator` instance and use it for all device memory allocations.\
+`GpuAllocator` will take care for all necessary bookkeeping like memory object count limit,
+heap budget and memory mapping.
+
+#### Backends implementations
+
+Backend supporting crates should not depend on this crate.\
+Instead they should depend on `gpu-alloc-types` which is much more stable,
+allowing to upgrade `gpu-alloc` version without `gpu-alloc-<backend>` upgrade.
+
+
+Supported Rust Versions
+
+The minimum supported version is 1.40.
+The current version is not guaranteed to build on Rust versions earlier than the minimum supported version.
+
+`gpu-alloc-erupt` crate requires version 1.48 or higher due to dependency on `erupt` crate.
+
+## License
+
+Licensed under either of
+
+* Apache License, Version 2.0, ([license/APACHE](license/APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+* MIT license ([license/MIT](license/MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+## Contributions
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
+
+## Donate
+
+[](https://www.patreon.com/zakarum)
|