SpatialPointerPose.IsHeadCapturedBySystem Property

Definition

Namespace:

Windows.UI.Input.Spatial

Gets whether the user's head gaze is being captured by system UI at the moment (preventing gaze-driven presses from being delivered to the view associated with this SpatialPointerPose).

public:
 property bool IsHeadCapturedBySystem { bool get(); };

bool IsHeadCapturedBySystem();

public bool IsHeadCapturedBySystem { get; }

var boolean = spatialPointerPose.isHeadCapturedBySystem;

Public ReadOnly Property IsHeadCapturedBySystem As Boolean

Property Value

Boolean

bool

Whether head gaze is being captured by the system.

Windows requirements

Device family	Windows 10, version 1903 (introduced in 10.0.18362.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v8.0)

Remarks

While the user's head gaze is targeting non-modal interactive system UI, gaze-driven presses such as taps and speech "select" keywords are delivered to that system UI rather than to the visible immersive view.

If an app continues to show its gaze cursor while head gaze is captured, users may believe such presses will activate the app's UI. Instead, they'll activate the system UI, which can cause confusion.

While this property is true, an app can hide its gaze cursor, letting users know that gaze-driven presses are not currently active within the app.