Go to file
bors[bot] e109587bf0
Merge #221
221: Support VK_KHR_portability_subset r=kvark a=kvark

Our extension IDs were messed up. Good thing to clean them up now, since otherwise nobody would be able to make this work 😅 
Also, the test native example is now fully trying to initialize the portability extension and gather the relevant info. Output on my machine:
```
	vkEnumerateInstanceExtensionProperties: res=0 count=5
	vkEnumeratePhysicalDevices: res=0 count=1
	vkEnumerateDeviceExtensionProperties: res=0 count=3
	gfxGetPhysicalDeviceProperties2KHR
		minVertexInputBindingStrideAlignment = 4
	gfxGetPhysicalDeviceFeatures2KHR
		events = 1
		pointPolygons = 0
		separateStencilMaskRef = 1
		triangleFans = 0
```

Co-authored-by: Dzmitry Malyshau <kvarkus@gmail.com>
2020-09-20 00:57:19 +00:00
.github/workflows Switch CI to github actions 2020-08-25 23:09:09 -04:00
bench Add new benchmarks, fix benching command line 2018-07-27 11:48:32 -04:00
conformance Conformance testing makefile command 2018-04-02 21:58:48 -04:00
etc vkQuake3 screenshot 2019-03-26 23:59:36 -04:00
headers/vulkan Support VK_KHR_portability_subset 2020-09-19 20:54:21 -04:00
libportability Support VK_KHR_portability_subset 2020-09-19 20:54:21 -04:00
libportability-gfx Support VK_KHR_portability_subset 2020-09-19 20:54:21 -04:00
libportability-icd Update gfx with the border color changes 2020-08-23 00:19:05 -04:00
native Support VK_KHR_portability_subset 2020-09-19 20:54:21 -04:00
.gitignore Use git describe to create commit-sha 2018-08-29 12:46:40 -06:00
.monocodus Add monocodus config to disable clang-tidy 2020-09-19 20:54:28 -04:00
bors.toml Switch CI to github actions 2020-08-25 23:09:09 -04:00
Cargo.lock Support VK_KHR_portability_subset 2020-09-19 20:54:21 -04:00
Cargo.toml Build with panic=abort 2018-08-03 23:48:52 -04:00
CMakeLists.txt Update to latest gfx master 2018-01-02 00:47:47 +01:00
LICENSE Initial commit 2017-09-06 21:53:52 -04:00
Makefile Switch CI to github actions 2020-08-25 23:09:09 -04:00
README.md Switch CI to github actions 2020-08-25 23:09:09 -04:00
windows.bat gfx-hal update with swapchain ranges 2019-08-02 22:23:34 -04:00

gfx-portability

Build Status Matrix

This is a prototype library implementing Vulkan Portability Initiative using gfx-hal. See gfx-rs meta issue for backend limitations and further details.

Showcase

Dota2:

Dota2

Quake

VkQuake VkQuake3

RPCS3:

RPCS3-cube RPCS3-scogger

Dolphin:

Dolphin-sb Dolphin-pm Dolphin-mk Dolphin-md

Instructions

Despite the fact it's written in Rust, the produced binaries have standard lining interface compatible with any program (written in the language of your choice). There are multiple ways to link to gfx-portability.

Dynamic linking

Typically, you'd need to create a symbolic link with a name that a target application expects, e.g. libvulkan.dylib -> libportability.dylib.

Check out and build:

git clone --recursive https://github.com/gfx-rs/portability && cd portability
cargo build --manifest-path libportability/Cargo.toml --features <vulkan|dx12|metal>

ICD provider

gfx-portability can be used with Vulkan loader like any other Vulkan driver. In order to use it this way, you need to build libportability-icd and point to it from an ICD json file:

VK_ICD_FILENAMES=portability/libportability-icd/portability-macos-debug.json <some_vulkan_app>

Static linking

For C, you'd need to add crate-type = ["cdylib"] to libportability-gfx/Cargo.toml and build it with the backend of your choice. Note: features of this library are fully-qualified crate names, e.g. features gfx-backend-metal. For rust, just point the cargo dependency to libportability-gfx.

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 variable and set it to the portability library.

set (VULKAN_LOADER "path/to/portability/library")

Then proceed with the normal build instructions.

Vulkan CTS coverage

Please visit our wiki 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>.