Display mask API

Represents the area of the display that is not functional for displaying content.

APIs in the Surface Duo SDK interact with the Surface Duo device, and should not be called when your app is running on other devices. Before calling these APIs, you should check whether your app is running on a Surface Duo device. Use the IsDualScreenDevice code snippet to perform this check.

DisplayMask has been updated to return a bounding rectangle relative to the display metrics based on the app context. This affects how the API behaves when your app is running on a single screen vs. running spanned across two screens. (A service that created a view at any point will fall into one of these two categories.)

• When running on a single screen:

  • Windows and display metrics are in relation to that single display.
  • The DisplayMask returns an empty list. It will not intersect with the window.

• When running spanned across two screens:

  • Window and display metrics are in relation to both displays, including the display mask.
  • The DisplayMask bounding rectangle will identify the area under the hardware hinge in relation to the app window (DisplayMask = hinge mask rectangle).

  For more info, see the Surface Duo Blog.

val displayMask: DisplayMask = DisplayMask.fromResourcesRect(this)
val masks: List<Rect> = displayMask.getBoundingRectsForRotation(rotation) // pass in orientation (test with 0)
var mask = Rect()
if (!masks.isEmpty()) {
    mask = masks[0]
    // layout around masked area
}

DisplayMask displayMask = DisplayMask.fromResourcesRect(context);

List<Rect> masks = displayMask.getBoundingRectsForRotation(rotation); // pass in orientation (test with 0)
Rect mask = new Rect();
if(!masks.isEmpty()) {
    mask = masks.get(0);
    // layout around masked area
}