nordic-dev.net/rust-gpu
2
0
Fork 0
mirror of https://github.com/EmbarkStudios/rust-gpu.git synced 2024-11-21 22:34:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add initial platform support docs (#187)

Browse Source 
* Add initial platform support docs

* Update platform-support.md

* Update platform-support.md
This commit is contained in:
XAMPPRocky 2020-11-02 17:07:34 +01:00 committed by GitHub
parent 8d2b8ce5f3
commit 2942967607
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 44 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/src/SUMMARY.md
View File

@ -2,5 +2,6 @@
- [Introduction](./introduction.md)
- [Attribute syntax](./attributes.md)
- [RFCs]()
- [Platform Support](./platform-support.md)
- [RFCs]()
- [001. Resource Binding Syntax](./rfcs/001-resource-binding-syntax.md)

42
docs/src/platform-support.md Normal file
View File

@ -0,0 +1,42 @@
# Platform Support
The `rust-gpu` project currently supports a limited number of platforms and graphics APIs. Right now we're not distributing build artifacts and we're primarily focused on the development of the project, so this is based on the current `main` branch. There are a lot of different configurations and hardware out there to support, this document is intended to document what is currently supported, what we intend to support, and what isn't supported. Over time as the project stabilises and our CI improves, more platforms and APIs will be supported and tested. Currently support for each topic is divided into the following three categories.
- **Primary —** Built and tested on CI.
- **Secondary —** Built but *not fully tested* on CI.
- **Tertiary —** Present in the codebase but not built or tested.
## Operating System
| Operating System | Version | Support | Notes
|-------------------|---------|---------|-------
| Windows | 10+ | Primary | |
| Linux | Ubuntu 18.04+ | Primary | |
| macOS | Catalina (10.15)+ | Secondary | Using [MoltenVK]
[MoltenVK]: https://github.com/KhronosGroup/MoltenVK
## Graphics APIs
| Name | Version | Support | Notes
|-------|---------|---------|-------
| SPIR-V | 1.3+ | Primary |
| Vulkan | 1.1+ | Primary |
| WGPU | 0.6 | Primary | Uses a translation layer to Metal/DX12
| OpenGL | ??? | Tertiary |
## GPU
Currently we don't have specific generations of GPUs for support, as long they support Vulkan 1.1+ with the latest officially installed drivers it should be able build and run the examples. You can check your Vulkan version using the [`vulkaninfo`] command from the `vulkan-sdk`.
##### Drivers
- [**AMD**][amd-drivers]
- **Intel:** [Linux][linux-intel], [macOS][macos-intel], [Windows][windows-intel]
- [**Nvidia**][nvidia-drivers]
[nvidia-drivers]: https://www.nvidia.com/Download/index.aspx?lang=en-us
[amd-drivers]: https://www.amd.com/en/support/kb/faq/gpu-56
[linux-intel]: https://www.intel.com/content/www/us/en/support/articles/000005520/graphics.html
[macOS-intel]: https://www.intel.com/content/www/us/en/support/articles/000022440/graphics.html
[windows-intel]: https://downloadcenter.intel.com/product/80939/Graphics
[`vulkaninfo`]: https://vulkan.lunarg.com/doc/view/latest/windows/vulkaninfo.html