**Figure 1.** Top center display cutout
Android {{ androidPVersionNumber }} supports the following types of cutouts:
+ Top center: Cutout at the center of the top edge
+ Top uncentered: Cutout may be in the corner or slightly off-center
+ Bottom: Cutout at the bottom
+ Dual: One cutout on top and one on the bottom
## Examples and source
The following window manager code at
[PhoneWindowManager.java](https://android.googlesource.com/platform/frameworks/base/+/master/services/core/java/com/android/server/policy/PhoneWindowManager.java){: .external}
shows how display frames are inset to the safe area when
`LAYOUT_IN_DISPLAY_CUTOUT_MODE_ALWAYS` is not set.
```java
// Ensure that windows with a DEFAULT or NEVER display cutout mode are laid out in
// the cutout safe zone.
if (cutoutMode != LAYOUT_IN_DISPLAY_CUTOUT_MODE_ALWAYS) {
final Rect displayCutoutSafeExceptMaybeBars = mTmpDisplayCutoutSafeExceptMaybeBarsRect;
displayCutoutSafeExceptMaybeBars.set(displayFrames.mDisplayCutoutSafe);
if (layoutInScreen && layoutInsetDecor && !requestedFullscreen
&& cutoutMode == LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT) {
// At the top we have the status bar, so apps that are
// LAYOUT_IN_SCREEN | LAYOUT_INSET_DECOR but not FULLSCREEN
// already expect that there's an inset there and we don't need to exclude
// the window from that area.
displayCutoutSafeExceptMaybeBars.top = Integer.MIN_VALUE;
}
if (layoutInScreen && layoutInsetDecor && !requestedHideNavigation
&& cutoutMode == LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT) {
// Same for the navigation bar.
switch (mNavigationBarPosition) {
case NAV_BAR_BOTTOM:
displayCutoutSafeExceptMaybeBars.bottom = Integer.MAX_VALUE;
break;
case NAV_BAR_RIGHT:
displayCutoutSafeExceptMaybeBars.right = Integer.MAX_VALUE;
break;
case NAV_BAR_LEFT:
displayCutoutSafeExceptMaybeBars.left = Integer.MIN_VALUE;
break;
}
}
if (type == TYPE_INPUT_METHOD && mNavigationBarPosition == NAV_BAR_BOTTOM) {
// The IME can always extend under the bottom cutout if the navbar is there.
displayCutoutSafeExceptMaybeBars.bottom = Integer.MAX_VALUE;
}
// Windows that are attached to a parent and laid out in said parent already avoid
// the cutout according to that parent and don't need to be further constrained.
// Floating IN_SCREEN windows get what they ask for and lay out in the full screen.
// They will later be cropped or shifted using the displayFrame in WindowState,
// which prevents overlap with the DisplayCutout.
if (!attachedInParent && !floatingInScreenWindow) {
mTmpRect.set(pf);
pf.intersectUnchecked(displayCutoutSafeExceptMaybeBars);
parentFrameWasClippedByDisplayCutout |= !mTmpRect.equals(pf);
}
// Make sure that NO_LIMITS windows clipped to the display don't extend under the
// cutout.
df.intersectUnchecked(displayCutoutSafeExceptMaybeBars);
}
```
SystemUI renders in the cutout area, and needs to determine where it can draw.
[PhoneStatusBarView.java](https://android.googlesource.com/platform/frameworks/base/+/master/packages/SystemUI/src/com/android/systemui/statusbar/phone/PhoneStatusBarView.java){: .external}
provides an example of a view that determines where the display cutout is, how
big it is, and whether or not the inset from the nav bar avoids the cutout area.
By overriding `onApplyWindowInsets()`, a view can determine where the cutout is
and update its layout accordingly.
```java
@Override
public WindowInsets onApplyWindowInsets(WindowInsets insets) {
if (updateOrientationAndCutout(mLastOrientation)) {
updateLayoutForCutout();
requestLayout();
}
return super.onApplyWindowInsets(insets);
}
```
These methods outline how cutouts are handled in the status bar in all cases
(i.e. top center, top uncentered, bottom, and dual-cutouts in all rotations).
## Requirements
To ensure that apps are not negatively impacted by cutouts, you must ensure
that:
+ The status bar extends to at least the height of the cutout in portrait mode
+ The cutout area must be letterboxed in fullscreen and landscape modes
Your device can have up to one cutout on each short edge (top and bottom).
For more information, see the [CDD](/compatibility/android-cdd#3_8_15_display_cutout).
Note: For apps targeting Android 8.0 or lower, you can provide users with an
option to extend a fullscreen or landscape app into the cutout area (e.g. toggle
in the navigation bar). As this may lead to content getting cut off, the
`layoutInDisplayCutoutMode` activity theme attribute has been backported to
Android 8.1 to allow apps to opt out. If the attribute is set, you may not show
a special mode toggle.
## Implementation
To implement display cutouts on your device, you must configure the following
values for System UI.
| Value | Description |
|---|---|
quick_qs_offset_height
|
Defines the top margin for the quick settings panel. The clock and battery are displayed in the space above the panel. In values-land, set to |
quick_qs_total_height
|
Total height of the quick-quick settings panel (collapsed quick settings panel) when the notification shade is expanded, including the space above the panel containing the clock.
Because of the way quick settings is laid out, the total height of the
quick-quick settings panel (including the offset) must be known statically,
so this value must be adjusted by the same delta
|
status_bar_height_portrait
|
The default height of the status bar from the framework's perspective. In most devices, this defaults to 24dp. When there is a cutout, set this value to the height of the cutout. Can optionally be taller than the cutout if desired. |
status_bar_height_landscape
|
The height of the status bar in landscape. Cutouts are only supported on the short edges of the device, so this will always be an unaltered status bar height. In a device with no cutout, this is equivalent to
|
config_mainBuiltInDisplayCutout
|
The path defining the shape of the cutout. This is a string parsable by
|
config_fillMainBuiltinDisplayCutout
|
A boolean value that determines whether to draw the cutout path (defined above) in software. Can be used to emulate a cutout, or to fill in a physical cutout to achieve anti-aliasing. If true, |