Jayden/wayvr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add optimization level workaround to README (#8)

Browse Source 
* Split known issues into sub sections

Signed-off-by: Sefa Eyeoglu <contact@scrumplex.net>

* README: Add optimization level workaround for OpenXR segfaults

Signed-off-by: Sefa Eyeoglu <contact@scrumplex.net>

---------

Signed-off-by: Sefa Eyeoglu <contact@scrumplex.net>
This commit is contained in:
Sefa Eyeoglu
2024-02-12 15:20:31 +01:00
committed by GitHub
parent 75da834e4a
commit 0c6e3b9e3b
1 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -89,12 +89,29 @@ We would like to work with you and include additional bindings.
# Known Issues
**OpenXR: Segfault with release build**: If you run into this, please use debug build until we figure this out.
## OpenXR: Segfault with release build
**OpenXR: Overlay opacity**: Translucent overlays are not supported on OpenXR yet.
We are currently not sure what causes this.
If you are affected, you can either revert to using debug builds,
or alternatively add the following to `Cargo.toml` to only do basic optimizations:
**Scroll wheel doesn't work**: This seems to be an issue specific to Electron apps (Discord, Element, Slack, Spotify) on Wayland. Scrolling will work when using these in your web browser.
```toml
[profile.release]
opt-level = 1
```
**WiVRn support**: While WiVRn technically supports EXTX_overlay, I do not recommend using this software with WiVRn at this time, due to WiVRn not being optimized for overlay apps. You will likely get ghosting or stuttering while rotating your head.
## OpenXR: Overlay opacity
**X11 limitations**: DPI scaling and upright screens are not supported on X11.
Translucent overlays are not supported on OpenXR yet.
## Scroll wheel doesn't work
This seems to be an issue specific to Electron apps (Discord, Element, Slack, Spotify) on Wayland. Scrolling will work when using these in your web browser.
## WiVRn support
While WiVRn technically supports EXTX_overlay, I do not recommend using this software with WiVRn at this time, due to WiVRn not being optimized for overlay apps. You will likely get ghosting or stuttering while rotating your head.
## X11 limitations
DPI scaling and upright screens are not supported on X11.