HolographicDisplay HolographicDisplay HolographicDisplay HolographicDisplay 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.]
Provides metadata for a display to which a holographic view must render each frame from that frame's pose.

public : sealed class HolographicDisplay : IHolographicDisplaypublic sealed class HolographicDisplay : IHolographicDisplayPublic NotInheritable Class HolographicDisplay Implements IHolographicDisplay// 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 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Preview.Holographic.HolographicContract (introduced v1) Windows.Foundation.UniversalApiContract (introduced v4)

Properties

AdapterId AdapterId AdapterId AdapterId

Gets the identifier of the graphics adapter to be used when displaying holographic content to this HolographicDisplay.

public : HolographicAdapterId AdapterId { get; }public HolographicAdapterId AdapterId { get; }Public ReadOnly Property AdapterId As HolographicAdapterId// You can use this property in JavaScript.
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

DisplayName DisplayName DisplayName DisplayName

Gets a friendly name for this display that can be displayed to the user.

public : PlatForm::String DisplayName { get; }public string DisplayName { get; }Public ReadOnly Property DisplayName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The friendly name.

Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

IsOpaque IsOpaque IsOpaque IsOpaque

Gets whether this display is occluded, blocking the user's view of the physical world around them.

public : PlatForm::Boolean IsOpaque { get; }public bool IsOpaque { get; }Public ReadOnly Property IsOpaque As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Whether this display is occluded.

Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

IsStereo IsStereo IsStereo IsStereo

Gets whether this display requires separate rendering for the left and right eyes.

public : PlatForm::Boolean IsStereo { get; }public bool IsStereo { get; }Public ReadOnly Property IsStereo As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Whether this display is stereo.

Remarks

While actual Mixed Reality headsets are always stereo, an app will sometimes be asked to render to a mono HolographicDisplay, such as within the Mixed Reality emulator or during remoting to a desktop monitor.

MaxViewportSize MaxViewportSize MaxViewportSize MaxViewportSize

Gets the maximum viewport size that an app will ever be asked to render to for this display.

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

The maximum viewport size.

Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

An app can use this maximum size to pre-allocate secondary buffers for its own use during rendering.

Note that this maximum viewport size will exceed the physical resolution of the headset's screen for displays with lens distortion.

RefreshRate RefreshRate RefreshRate RefreshRate

Prerelease. Gets the refresh rate at which an app must present content to this holographic display.

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

The refresh rate.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

Note that this refresh rate may be lower than the display panel's maximum refresh rate. This can occur if the holographic compositor is configured to operate at a lower refresh rate, based on the system's hardware.

SpatialLocator SpatialLocator SpatialLocator SpatialLocator

Gets a spatial locator that can be used to create frames of reference relative to this display.

public : SpatialLocator SpatialLocator { get; }public SpatialLocator SpatialLocator { get; }Public ReadOnly Property SpatialLocator As SpatialLocator// You can use this property in JavaScript.
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Methods

GetDefault() GetDefault() GetDefault() GetDefault()

Gets the default display that represents the user's primary Mixed Reality headset.

public : static HolographicDisplay GetDefault()public static HolographicDisplay GetDefault()Public Static Function GetDefault() As HolographicDisplay// You can use this method in JavaScript.
Returns
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

This will be null when HolographicSpace.IsAvailable is false, representing a Desktop which does not have a headset attached.