Skip to content

Commit ff1567c

Browse files
authored
Add doc page for WARP configuration (#315)
This adds a simple doc page describing the two useful options for configuring WARP.
1 parent 2894e4d commit ff1567c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/WARP.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Using WARP on Windows
2+
3+
Windows has a software rasterizer implementation called the Windows Advanced
4+
Rasterization Platform (WARP), which is a conforming implementation of DirectX
5+
and Vulkan 1.2.
6+
7+
The offload-test-suite supports running against WARP on Windows by default and
8+
will generate test targets for `check-hlsl-warp-d3d12` and
9+
`check-hlsl-clang-warp-d3d12`.
10+
11+
There are some useful CMake options to tweak the configuration to better utilize
12+
WARP:
13+
14+
* **OFFLOADTEST_WARP_ONLY** - Skips generating d3d test configurations for
15+
non-WARP configurations. This is useful if you're running Windows in a VM and
16+
do not have a physical GPU.
17+
18+
* **WARP_VERSION** - Defaults to `System` which uses the system version of WARP.
19+
This option may also be set to an explicit WARP version, and the configuration
20+
step will pull WARP from NuGet. See the [NuGet package
21+
listing](https://www.nuget.org/packages/Microsoft.Direct3D.WARP) to identify
22+
valid versions.

0 commit comments

Comments
 (0)