DisplayCutoutCompat
public final class DisplayCutoutCompat
Represents the area of the display that is not functional for displaying content.
DisplayCutoutCompat instances are immutable.
Summary
Public constructors |
|---|
|
Creates a DisplayCutout instance. |
DisplayCutoutCompat(Creates a DisplayCutout instance. |
DisplayCutoutCompat(Creates a DisplayCutout instance. |
Public methods |
|
|---|---|
boolean |
|
@NonNull List<Rect> |
Returns a list of |
@Nullable Path |
Returns a Path that contains the cutout paths of all sides on the display. |
int |
Returns the inset from the bottom which avoids the display cutout in pixels. |
int |
Returns the inset from the left which avoids the display cutout in pixels. |
int |
Returns the inset from the right which avoids the display cutout in pixels. |
int |
Returns the inset from the top which avoids the display cutout in pixels. |
@NonNull Insets |
Returns the insets representing the curved areas of a waterfall display. |
int |
hashCode() |
@NonNull String |
toString() |
Public constructors
DisplayCutoutCompat
public DisplayCutoutCompat(
@Nullable Rect safeInsets,
@Nullable List<Rect> boundingRects
)
Creates a DisplayCutout instance.
| Parameters | |
|---|---|
@Nullable Rect safeInsets |
the insets from each edge which avoid the display cutout as returned by |
@Nullable List<Rect> boundingRects |
the bounding rects of the display cutouts as returned by |
DisplayCutoutCompat
public DisplayCutoutCompat(
@NonNull Insets safeInsets,
@Nullable Rect boundLeft,
@Nullable Rect boundTop,
@Nullable Rect boundRight,
@Nullable Rect boundBottom,
@NonNull Insets waterfallInsets
)
Creates a DisplayCutout instance.
| Parameters | |
|---|---|
@NonNull Insets safeInsets |
the insets from each edge which avoid the display cutout as returned by |
@Nullable Rect boundLeft |
the left bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0). |
@Nullable Rect boundTop |
the top bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0). |
@Nullable Rect boundRight |
the right bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0). |
@Nullable Rect boundBottom |
the bottom bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0). |
@NonNull Insets waterfallInsets |
the insets for the curved areas in waterfall display. |
DisplayCutoutCompat
public DisplayCutoutCompat(
@NonNull Insets safeInsets,
@Nullable Rect boundLeft,
@Nullable Rect boundTop,
@Nullable Rect boundRight,
@Nullable Rect boundBottom,
@NonNull Insets waterfallInsets,
@Nullable Path cutoutPath
)
Creates a DisplayCutout instance.
| Parameters | |
|---|---|
@NonNull Insets safeInsets |
the insets from each edge which avoid the display cutout as returned by |
@Nullable Rect boundLeft |
the left bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0). |
@Nullable Rect boundTop |
the top bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0). |
@Nullable Rect boundRight |
the right bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0). |
@Nullable Rect boundBottom |
the bottom bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0). |
@NonNull Insets waterfallInsets |
the insets for the curved areas in waterfall display. |
@Nullable Path cutoutPath |
the path of the display cutout. Specifying a path with this constructor is only supported on API 33 and above, even though a real DisplayCutout can have a cutout path on API 31 and above. On API 32 and below, this path is ignored. |
Public methods
getBoundingRects
public @NonNull List<Rect> getBoundingRects()
Returns a list of Rects, each of which is the bounding rectangle for a non-functional area on the display. There will be at most one non-functional area per short edge of the device, and none on the long edges.
getCutoutPath
public @Nullable Path getCutoutPath()
Returns a Path that contains the cutout paths of all sides on the display. To get a cutout path for one specific side, apps can intersect the Path with the Rect obtained from getBoundingRectLeft(), getBoundingRectTop(), getBoundingRectRight() or getBoundingRectBottom().
getSafeInsetBottom
public int getSafeInsetBottom()
Returns the inset from the bottom which avoids the display cutout in pixels.
getSafeInsetLeft
public int getSafeInsetLeft()
Returns the inset from the left which avoids the display cutout in pixels.
getSafeInsetRight
public int getSafeInsetRight()
Returns the inset from the right which avoids the display cutout in pixels.
getSafeInsetTop
public int getSafeInsetTop()
Returns the inset from the top which avoids the display cutout in pixels.
getWaterfallInsets
public @NonNull Insets getWaterfallInsets()
Returns the insets representing the curved areas of a waterfall display. A waterfall display has curved areas along the edges of the screen. Apps should be careful when showing UI and handling touch input in those insets because the curve may impair legibility and can frequently lead to unintended touch inputs.