OpenXRFrameSynthesisExtension
The OpenXR Frame synthesis extension allows for advanced reprojection at low(er) framerates.
The OpenXR Frame synthesis extension allows for advanced reprojection at low(er) framerates.
This class implements the OpenXR Frame synthesis extension. When enabled in the project settings and supported by the XR runtime in use, frame synthesis uses advanced reprojection techniques to inject additional frames so that your XR experience hits the full frame rate of the device.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
OpenXRFrameSynthesisExtensionConstructor
public OpenXRFrameSynthesisExtension();Properties2
EnabledProperty
public bool Enabled { get; set; }Enable frame synthesis. When true motion vector and depth data is provided to the XR runtime.
RelaxFrameIntervalProperty
public bool RelaxFrameInterval { get; set; }If true this informs the XR runtime we will be providing frames at a greatly reduced rate. Enable this when you expect your application to run at low framerates and wish to inject multiple reprojected frames.
Methods6
GetRelaxFrameIntervalbool
public bool GetRelaxFrameInterval();boolIsAvailablebool
public bool IsAvailable();Returns true if frame synthesis is enabled in the project settings and the current XR runtime supports frame synthesis. The value returned will only be valid once OpenXR has been initialized.
boolIsEnabledbool
public bool IsEnabled();boolSetEnabledvoid
public void SetEnabled(bool enable);| Name | Type | Default |
|---|---|---|
enable | bool | — |
SetRelaxFrameIntervalvoid
public void SetRelaxFrameInterval(bool relaxFrameInterval);| Name | Type | Default |
|---|---|---|
relaxFrameInterval | bool | — |
SkipNextFramevoid
public void SkipNextFrame();Queues the next frame to be skipped when supplying motion vector and depth data. Call this after teleporting your player or a similar action has moved the player to prevent incorrect reprojection results due to this movement.