Struct PixelSynthesisFrameParams

All per-frame parameters needed to configure pixel synthesis. Pass an instance of this struct to SetPixelSynthesis(in PixelSynthesisFrameParams).

Inherited Members
Namespace: UnityEngine.XR.OpenXR.Features.Meta
Assembly: Unity.XR.OpenXR.dll
Syntax
public struct PixelSynthesisFrameParams

Fields

appSpaceDeltaOrientation

Orientation component of the delta pose between frames. Set to identity when no artificial locomotion occurred.

Declaration
public Quaternion appSpaceDeltaOrientation
Field Value
Type Description
Quaternion

appSpaceDeltaPosition

Position component of the delta pose between the previous and current frame's app space. Set to zero when no artificial locomotion occurred.

Declaration
public Vector3 appSpaceDeltaPosition
Field Value
Type Description
Vector3

enableUpscaling

Whether to request upscaling as part of pixel synthesis. When SetPixelSynthesis has not been called, defaultEnableUpscaling is used instead. Requires Upscaling support.

Declaration
public bool enableUpscaling
Field Value
Type Description
bool

farZ

Far clip distance in meters. When negative, defaults to Camera.main.farClipPlane.

Declaration
public float farZ
Field Value
Type Description
float

motionVectorOffset

Per-axis offset applied to motion vector texel values to convert to NDC.

Declaration
public Vector2 motionVectorOffset
Field Value
Type Description
Vector2

motionVectorScale

Per-axis scale applied to motion vector texel values to convert to NDC.

Declaration
public Vector2 motionVectorScale
Field Value
Type Description
Vector2

nearZ

Near clip distance in meters. When negative, defaults to Camera.main.nearClipPlane.

Declaration
public float nearZ
Field Value
Type Description
float

resetAggregations

When true, the runtime discards all accumulated temporal state and starts fresh. Set on scene transitions, camera cuts, or teleportation.

Declaration
public bool resetAggregations
Field Value
Type Description
bool

stencilBitMask

Bitmask of stencil bits to compare. Only bits set here are tested.

Declaration
public uint stencilBitMask
Field Value
Type Description
uint

stencilValue

Reference stencil value. Pixels where (stencilBuffer & stencilBitMask) == stencilValue are excluded from temporal accumulation.

Declaration
public uint stencilValue
Field Value
Type Description
uint

Properties

Default

Returns a PixelSynthesisFrameParams pre-filled with sensible defaults. nearZ and farZ are set to -1, which causes SetPixelSynthesis(in PixelSynthesisFrameParams) to read the values from Camera.main at call time. motionVectorScale carries the conversion required for motion vectors produced by the render pipeline; override it only if you write your own. enableUpscaling defaults to false; the inspector field defaultEnableUpscaling overrides this when automatic defaults are applied (i.e. before SetPixelSynthesis(in PixelSynthesisFrameParams) is called).

Declaration
public static PixelSynthesisFrameParams Default { get; }
Property Value
Type Description
PixelSynthesisFrameParams