HolographicFrameScanoutReport Class

Definition

Namespace:

Windows.Graphics.Holographic

Provides performance and timing information about a single scanout to a holographic display.

public ref class HolographicFrameScanoutReport sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 655360)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class HolographicFrameScanoutReport final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 655360)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class HolographicFrameScanoutReport

Public NotInheritable Class HolographicFrameScanoutReport

Inheritance

Object Platform::Object IInspectable HolographicFrameScanoutReport

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10, version 2004 (introduced in 10.0.19041.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v10.0)

Remarks

"Scanout" in this context roughly corresponds to sending a new image to the display hardware. A single HolographicFrame may be scanned out multiple times if there is not a new frame available with its GPU work finished at the next scanout opportunity. There will be an individual HolographicFrameScanoutReport produced for each of these repetitions in this case.

Each HolographicFrameScanoutReport also contains a reference to a corresponding HolographicFrameRenderingReport, accessed with the RenderingReport property, which contains information about the work the application did leading up to the frame being scanned out by the system for the first time. This work only happens once when the frame is first presented, and the result is re-used on each subsequent scanout of the same frame.

Properties

MissedScanoutCount	Gets the number of scanout opportunities that were missed since the last scanout.
RenderingReport	Gets rendering timing information about the HolographicFrame that was scanned out.
SystemRelativeLatchTime	Gets the time that the final decision on which HolographicFrame will be scanned out is made and reprojection begins, if applicable.
SystemRelativePhotonTime	Gets the time that the light from the display hardware for the current scanout is expected to be emitted.
SystemRelativeScanoutStartTime	Gets the time that the image began scanning out to the display hardware.

See also

• HolographicFrameRenderingReport
• HolographicFrame