HolographicFrame HolographicFrame HolographicFrame HolographicFrame Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents a frame of holographic content that an app must render to all cameras.

public : sealed class HolographicFrame : IHolographicFramepublic sealed class HolographicFrame : IHolographicFramePublic NotInheritable Class HolographicFrame Implements IHolographicFrame// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows Holographic Extension SDK Preview (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Preview.Holographic.HolographicContract (introduced v1) Windows.Foundation.UniversalApiContract (introduced v2)

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.

Properties

AddedCameras AddedCameras AddedCameras AddedCameras

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

public : IVectorView<HolographicCamera> AddedCameras { get; }public IReadOnlyList<HolographicCamera> AddedCameras { get; }Public ReadOnly Property AddedCameras As IReadOnlyList<HolographicCamera>// You can use this property in JavaScript.
Value
IVectorView<HolographicCamera> IReadOnlyList<HolographicCamera> IReadOnlyList<HolographicCamera> IReadOnlyList<HolographicCamera>

A collection of HolographicCamera objects that were added.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Remarks

Cameras only show up in this list after they surface in the CameraAdded event to //! let apps initialize any per-camera buffers on a background thread.

CurrentPrediction CurrentPrediction CurrentPrediction CurrentPrediction

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

public : HolographicFramePrediction CurrentPrediction { get; }public HolographicFramePrediction CurrentPrediction { get; }Public ReadOnly Property CurrentPrediction As HolographicFramePrediction// You can use this property in JavaScript.
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Duration Duration Duration Duration

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

public : TimeSpan Duration { get; }public TimeSpan Duration { get; }Public ReadOnly Property Duration As TimeSpan// You can use this property in JavaScript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

The time span.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

RemovedCameras RemovedCameras RemovedCameras RemovedCameras

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

public : IVectorView<HolographicCamera> RemovedCameras { get; }public IReadOnlyList<HolographicCamera> RemovedCameras { get; }Public ReadOnly Property RemovedCameras As IReadOnlyList<HolographicCamera>// You can use this property in JavaScript.
Value
IVectorView<HolographicCamera> IReadOnlyList<HolographicCamera> IReadOnlyList<HolographicCamera> IReadOnlyList<HolographicCamera>

A collection of HolographicCamera objects that were removed.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Methods

GetQuadLayerUpdateParameters(HolographicQuadLayer) GetQuadLayerUpdateParameters(HolographicQuadLayer) GetQuadLayerUpdateParameters(HolographicQuadLayer) GetQuadLayerUpdateParameters(HolographicQuadLayer)

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

public : HolographicQuadLayerUpdateParameters GetQuadLayerUpdateParameters(HolographicQuadLayer layer)public HolographicQuadLayerUpdateParameters GetQuadLayerUpdateParameters(HolographicQuadLayer layer)Public Function GetQuadLayerUpdateParameters(layer As HolographicQuadLayer) As HolographicQuadLayerUpdateParameters// You can use this method in JavaScript.
Parameters
Returns
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

To display quad layers, an app creates the necessary HolographicQuadLayer instances and adds them to a HolographicCamera's mutable QuadLayers list. To synchronize a retained quad layer update with a given immediate-mode holographic frame, an app requests an HolographicQuadLayerUpdateParameters instance from that frame by calling HolographicFrame.GetQuadLayerUpdateParameters. Any updates requested on that HolographicQuadLayerUpdateParameters instance will apply starting in that frame.

GetRenderingParameters(HolographicCameraPose) GetRenderingParameters(HolographicCameraPose) GetRenderingParameters(HolographicCameraPose) GetRenderingParameters(HolographicCameraPose)

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

public : HolographicCameraRenderingParameters GetRenderingParameters(HolographicCameraPose cameraPose)public HolographicCameraRenderingParameters GetRenderingParameters(HolographicCameraPose cameraPose)Public Function GetRenderingParameters(cameraPose As HolographicCameraPose) As HolographicCameraRenderingParameters// You can use this method in JavaScript.
Parameters
Returns
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

PresentUsingCurrentPrediction() PresentUsingCurrentPrediction() PresentUsingCurrentPrediction() PresentUsingCurrentPrediction()

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

public : HolographicFramePresentResult PresentUsingCurrentPrediction()public HolographicFramePresentResult PresentUsingCurrentPrediction()Public Function PresentUsingCurrentPrediction() As HolographicFramePresentResult// You can use this method in JavaScript.
Returns
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Remarks

This method will make use of the Direct3D device you provided to the HolographicSpace. If you've specified the D3D11_CREATE_DEVICE_SINGLETHREADED flag on your device, be sure to call this method from your single Direct3D thread to avoid undefined behavior.

See Also

PresentUsingCurrentPrediction(HolographicFramePresentWaitBehavior) PresentUsingCurrentPrediction(HolographicFramePresentWaitBehavior) PresentUsingCurrentPrediction(HolographicFramePresentWaitBehavior) PresentUsingCurrentPrediction(HolographicFramePresentWaitBehavior)

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

public : HolographicFramePresentResult PresentUsingCurrentPrediction(HolographicFramePresentWaitBehavior waitBehavior)public HolographicFramePresentResult PresentUsingCurrentPrediction(HolographicFramePresentWaitBehavior waitBehavior)Public Function PresentUsingCurrentPrediction(waitBehavior As HolographicFramePresentWaitBehavior) As HolographicFramePresentResult// You can use this method in JavaScript.
Parameters
Returns
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Remarks

This method will make use of the Direct3D device you provided to the HolographicSpace. If you've specified the D3D11_CREATE_DEVICE_SINGLETHREADED flag on your device, be sure to call this method from your single Direct3D thread to avoid undefined behavior.

See Also

UpdateCurrentPrediction() UpdateCurrentPrediction() UpdateCurrentPrediction() UpdateCurrentPrediction()

Computes an updated prediction for the CurrentPrediction property.

public : void UpdateCurrentPrediction()public void UpdateCurrentPrediction()Public Function UpdateCurrentPrediction() As void// You can use this method in JavaScript.
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

WaitForFrameToFinish() WaitForFrameToFinish() WaitForFrameToFinish() WaitForFrameToFinish()

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

public : void WaitForFrameToFinish()public void WaitForFrameToFinish()Public Function WaitForFrameToFinish() As void// You can use this method in JavaScript.
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Remarks

Note that the default wait behavior of PresentUsingCurrentPrediction already waits for the frame to finish.