Skip to content

Commit

Permalink
improve readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
hmaarrfk committed Dec 31, 2024
1 parent 8e305a0 commit f82b810
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,21 @@ Testing locally is possible, however pixel perfect results will differ from
those on the CIs due to discrepencies in hardware, and driver (we use llvmpipe)
versions.

If you want to force the usage of LLVMPIPE to speed up local testing you
may do so with the WGPUPY_WGPU_ADAPTER_NAME environment variable
On linux, it is possible to force to force the usage of LLVMPIPE in the test suite
and compare the generated results of screenshots. Beware, the results on your machine
may differ to those on the CI. We always include the CI screenshots in the test suite
to improve the repeatability of the tests.

If you have access to a linux machine with llvmpipe installed, you may run the
example pixel comparison testing by setting the WGPUPY_WGPU_ADAPTER_NAME
environment variable appropriately. For example


```
WGPUPY_WGPU_ADAPTER_NAME=llvmpipe pytest -v examples/
```

The `WGPUPY_WGPU_ADAPTER_NAME` variable is modeled after the
https://github.com/gfx-rs/wgpu?tab=readme-ov-file#environment-variables
and should only be used for testing the wgpupy library itself.
It is not part of the supported wgpy-py interface.

0 comments on commit f82b810

Please sign in to comment.