Share via


HolographicFrame Class

Definition

Represents a frame of holographic content that an app must render to all cameras.

public ref class HolographicFrame sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class HolographicFrame final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class HolographicFrame
Public NotInheritable Class HolographicFrame
Inheritance
Object Platform::Object IInspectable HolographicFrame
Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced in v2.0)

Remarks

Each HolographicFrame tracks end-to-end latency from the CreateNextFrame call until the frame is presented. This determines the number of frames the system will look forward for the next frame's prediction.

Version history

Windows version SDK version Value added
1709 16299 GetQuadLayerUpdateParameters
2004 19041 Id

Properties

AddedCameras

Gets the list of HolographicCamera objects that were added since last frame.

CurrentPrediction

Gets the most recent camera location prediction for the current HolographicFrame.

Duration

Gets the duration of time that the frame will be on the screen.

Id

Gets the unique identifier for the HolographicFrame within its parent HolographicSpace.

RemovedCameras

Gets the list of HolographicCamera objects that were removed since last frame.

Methods

GetQuadLayerUpdateParameters(HolographicQuadLayer)

Gets an update payload that lets an application configure a specific quad layer's parameters from this frame forward.

GetRenderingParameters(HolographicCameraPose)

Gets the parameters needed to render the current frame with the specified camera pose.

PresentUsingCurrentPrediction()

Present the current frame for all cameras and then wait until the next frame.

PresentUsingCurrentPrediction(HolographicFramePresentWaitBehavior)

Presents the current frame for all cameras with the specified waiting behavior.

UpdateCurrentPrediction()

Computes an updated prediction for the CurrentPrediction property.

WaitForFrameToFinish()

Blocks the current thread until this frame has finished and is showing on the displays.

Applies to