Skip to content

docs(readme): add tested-runtime compatibility table #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mledour merged 1 commit into from
Jul 13, 2026
Merged

docs(readme): add tested-runtime compatibility table #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,27 @@ across SteamVR / WMR / Oculus / Pimax / Varjo without per-runtime
patches. It never modifies the frame content the game submits; it only
observes timings and (optionally) composites its own quad on top.

## Compatibility

The layer is runtime-agnostic — it sits below the game on the OpenXR call
path, so any conformant OpenXR runtime should work. The overlay additionally
needs a D3D11 or D3D12 session and a BGRA8/RGBA8 swapchain format (UNORM or
sRGB); the logging feature has no such requirement.

Verified on real hardware:

| Application | Bridge | OpenXR runtime | Overlay | Logging |
| --- | --- | --- | :---: | :---: |
| OpenVR game | OpenComposite | Pimax OpenXR | ✅ | ✅ |
| OpenXR game | — (native) | Pimax OpenXR | ✅ | ✅ |
| OpenVR game | OpenComposite | SteamVR/OpenXR | ✅ | ✅ |

*Bridge* is the OpenVR→OpenXR translation layer that lets a legacy OpenVR
title run on an OpenXR runtime; native OpenXR games need none. Tested with
Pimax OpenXR 0.1.0 and SteamVR/OpenXR 2.16.7. Other runtimes
(WMR / Oculus / Varjo) are expected to work but haven't been verified yet —
reports welcome.

## Install

Download the latest `Setup.exe` from
Expand Down
Loading