mirror of
https://github.com/italicsjenga/portability.git
synced 2024-11-26 00:41:33 +11:00
60 lines
2.5 KiB
Markdown
60 lines
2.5 KiB
Markdown
## gfx-portability
|
|
[](https://travis-ci.org/gfx-rs/portability)
|
|
[](https://gitter.im/gfx-rs/portability)
|
|
|
|
This is a prototype library implementing [Vulkan Portability Initiative](https://www.khronos.org/blog/khronos-announces-the-vulkan-portability-initiative) using gfx-rs [low-level core](http://gfx-rs.github.io/2017/07/24/low-level.html). See gfx-rs [meta issue](https://github.com/gfx-rs/gfx/issues/1354) for backend limitations and further details.
|
|
|
|
## Vulkan CTS coverage
|
|
|
|
| gfx-rs Backend | Total cases | Pass | Fail | Quality warning | Compatibility warning | Not supported | Resource error | Internal error | Timeout | Crash |
|
|
| -------- | ---- | ---- | --- | -- | - | ---- | - | - | - | - |
|
|
| *Vulkan* | 7759 | 2155 | 131 | 34 | 0 | 5439 | 0 | 0 | 0 | 0 |
|
|
| *DX12* | 3576 | 1258 | 70 | 0 | 0 | 2248 | 0 | 0 | 0 | 0 |
|
|
| *Metal* | 7687 | 2072 | 112 | 39 | 0 | 5464 | 0 | 0 | 0 | 0 |
|
|
|
|
Current blockers:
|
|
- *Vulkan*: "api.command_buffers.render_pass_continue" (secondary render passes).
|
|
- *DX12*: lack of `VkBufferView` implementation.
|
|
- *Metal*: "api.buffer_view.access.suballocation.buffer_view_memory_test_complete" (missing R32Uint support).
|
|
|
|
|
|
Please visit [our wiki](https://github.com/gfx-rs/portability/wiki/Vulkan-CTS-status) for CTS hookup instructions. Once everything is set, you can generate the new results by calling `make cts` on Unix systems. When investigating a particular failure, it's handy to do `make cts debug=<test_name>`, which runs a single test under system debugger (gdb/lldb). For simply inspecting the log output, one can also do `make cts pick=<test_name>`.
|
|
|
|
## Check out
|
|
```
|
|
git clone --recursive https://github.com/gfx-rs/portability && cd portability
|
|
```
|
|
|
|
## Build
|
|
|
|
### Makefile (Unix)
|
|
```
|
|
make
|
|
```
|
|
|
|
### CMake (Window)
|
|
Build the Rust library (portability implementation):
|
|
|
|
```
|
|
cargo build --manifest-path libportability/Cargo.toml --features <vulkan|dx12|metal>
|
|
```
|
|
|
|
Build the native example:
|
|
|
|
```
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
cmake --build . --target native_test
|
|
```
|
|
|
|
## Running Samples
|
|
|
|
### LunarG (API-Samples)
|
|
After building `portability` as shown above, grab a copy from https://github.com/LunarG/VulkanSamples.
|
|
Manually override the [`VULKAN_LOADER`](https://github.com/LunarG/VulkanSamples/blob/master/API-Samples/CMakeLists.txt#L189-L194) variable and set it to the portability library.
|
|
```
|
|
set (VULKAN_LOADER "path/to/portability/library")
|
|
```
|
|
Then proceed with the normal build instructions.
|