IXrBackend

interface

csharp

public interface IXrBackend

A way of reaching the machine's headset, if it has one.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

Shaped like IAudioBackend, and for the same reasons. IsAvailable answers "could this process actually open a session" without throwing, because no headset is the ordinary case — a CI runner, a developer's laptop, a machine whose runtime is installed but has no device plugged in. A game that offers VR asks and offers it or does not.

Constructing a backend must be safe with no runtime installed. Selection constructs every candidate, so a missing libopenxr_loader makes the backend report itself unavailable rather than taking the process down with a DllNotFoundException.

Fields and properties (3)

string Name
What to call it in a log — OpenXR, Null.
bool IsAvailable
Whether this process could open a session through it.
string UnavailableReason
Why not, when it is not. Empty when it is.

Methods (4)

bool TryGetSystem(out XrSystemInfo system)
What the runtime says about the attached headset.
XrVulkanRequirements GetVulkanRequirements()
What the runtime needs of the Vulkan device before one is created.
nint GetVulkanPhysicalDevice(nint vulkanInstance)
Which physical device the runtime insists on.
IXrSession CreateSession(in XrVulkanBinding binding, in XrSessionOptions options, IXrImageImporter? importer = null)
Opens a session.

Used by (2)

NullXrBackendVixen.Xr
OpenXrBackendVixen.Xr.OpenXR