vkd3d-proton

vkd3d-proton is a fork of VKD3D, which aims to implement the full Direct3D 12 API on top of Vulkan. The project serves as the development effort for Direct3D 12 support in Proton.

Upstream

The original project is available at WineHQ.

Priorities

Performance and game compatibility are important targets, at the expense of compatibility with older drivers and systems. Modern Vulkan extensions and features are aggressively made use of to improve game performance and compatibility. It is recommended to use the very latest drivers you can get your hands on for the best experience. Backwards compatibility with the vkd3d standalone API is not a goal of this project.

Drivers

There are some hard requirements on drivers to be able to implement D3D12 in a reasonably performant way.

• Vulkan 1.3
• Descriptor indexing with at least 1000000 UpdateAfterBind descriptors for all types except UniformBuffer. Essentially all features in VkPhysicalDeviceDescriptorIndexingFeatures must be supported.
• Further, the following device features are required:
  • samplerMirrorClampToEdge
  • shaderDrawParameters
• VK_EXT_robustness2
• VK_KHR_push_descriptor

Some notable extensions that should be supported for optimal or correct behavior. These extensions will likely become mandatory later.

• VK_EXT_image_view_min_lod

VK_EXT_mutable_descriptor_type (or the vendor VALVE alias) and VK_EXT_descriptor_buffer are also highly recommended, but not mandatory.

AMD (RADV)

For AMD, RADV is the recommended driver and the one that sees most testing on AMD GPUs. Version 26.1+ is recommended. The absolute minimum requirement at the moment is Mesa 22.0, but may not work correctly in some cases due to ancient workarounds that have been removed over time.

NOTE: For ancient Mesa versions, use the v2.6 release.

NVIDIA

The Vulkan beta drivers generally contain the latest driver fixes that we identify while getting games to work. The latest drivers (stable, beta or Vulkan beta tracks) are always preferred, especially when descriptor heap is enabled. If you're having problems, always try the latest drivers. At minimum, 595 series drivers are recommended.

Intel

Get the latest possible Mesa. There is no known cutoff.

QCOM (Turnip)

Get the latest possible Mesa. There is no known cutoff.

---

Cloning the repo

To clone the repo you should run:

git clone --recursive https://github.com/HansKristian-Work/vkd3d-proton

in order to pull in all the submodules which are needed for building.

Building vkd3d-proton

Requirements:

• wine (for widl) [for native builds]
  • On Windows this may be substituted for Strawberry Perl as it ships widl and is easy to find and install -- although this dependency may be eliminated in the future.
• Meson build system (at least version 0.49)
• glslang compiler
• Mingw-w64 compiler, headers and tools (at least version 7.0) [for cross-builds for d3d12.dll which are default]

Building:

The simple way

Inside the vkd3d-proton directory, run:

./package-release.sh master /your/target/directory --no-package

This will create a folder vkd3d-master in /your/target/directory, which contains both 32-bit and 64-bit versions of vkd3d-proton, which can be set up in the same way as the release versions as noted above.

If you want to build natively (ie. for libvkd3d-proton.so), pass --native to the build script. This option will make it build using your system's compilers.

In order to preserve the build directories for development, pass --dev-build to the script. This option implies --no-package. After making changes to the source code, you can then do the following to rebuild vkd3d-proton:

# change to build.86 for 32-bit
ninja -C /your/target/directory/build.64 install

Compiling manually (cross for d3d12.dll, default)

# 64-bit build.
meson --cross-file build-win64.txt --buildtype release --prefix /your/vkd3d-proton/directory build.64
ninja -C build.64 install

# 32-bit build
meson --cross-file build-win32.txt --buildtype release --prefix /your/vkd3d-proton/directory build.86
ninja -C build.86 install

Compiling manually (native)

# 64-bit build.
meson --buildtype release --prefix /your/vkd3d-proton/directory build.64
ninja -C build.64 install

# 32-bit build
CC="gcc -m32" CXX="g++ -m32" \
PKG_CONFIG_PATH="/usr/lib32/pkgconfig:/usr/lib/i386-linux-gnu/pkgconfig:/usr/lib/pkgconfig" \
meson --buildtype release --prefix /your/vkd3d-proton/directory build.86
ninja -C build.86 install

Cross-compilation build for aarch64

First, setup a distrobox using Steam's runtime for it.

distrobox create --image registry.gitlab.steamos.cloud/steamrt/steamrt4/sdk/arm64-on-amd64 --name aarch64
distrobox enter aarch64
# Inside container
sudo apt install mingw-w64-tools
meson setup build-aarch64 \
  --buildtype release \
  --cross-file /usr/share/meson/cross/aarch64-linux-gnu-gcc.txt \
  --cross-file ./build-widl.txt \
  -Denable_extras=true \
  -Denable_tests=true \
  --prefix /tmp/vkd3d-proton-aarch64
ninja -C build-aarch64 install
cp build-aarch64/tests/d3d12 /tmp/vkd3d-proton-aarch64/bin

Building on Windows

NOTE: Building directly on Windows (instead of cross compiling) is only expected to be used for testing and development. The primary use case is to develop tests and run them against native drivers, not to run real applications. This requires decent debugger support, so MSVC is supported as a compiler, although we do not stress test these builds at all.

This is the beginning of the README. Read the rest at the original. Read the full README ↗