DisplayCutout

DisplayCutout

DisplayCutout(
    safeInsets: Insets, 
    boundLeft: Rect?, 
    boundTop: Rect?, 
    boundRight: Rect?, 
    boundBottom: Rect?)

Creates a DisplayCutout instance.

Note that this is only useful for tests. For production code, developers should always use a DisplayCutout obtained from the system.

DisplayCutout

DisplayCutout(
    safeInsets: Insets, 
    boundLeft: Rect?, 
    boundTop: Rect?, 
    boundRight: Rect?, 
    boundBottom: Rect?, 
    waterfallInsets: Insets)

Creates a DisplayCutout instance.

Note that this is only useful for tests. For production code, developers should always use a DisplayCutout obtained from the system.

DisplayCutout

DisplayCutout(
    safeInsets: Rect?, 
    boundingRects: MutableList<Rect!>?)

Deprecated: Use DisplayCutout.DisplayCutout(Insets, Rect, Rect, Rect, Rect) instead.

Creates a DisplayCutout instance.

Note that this is only useful for tests. For production code, developers should always use a DisplayCutout obtained from the system.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getBoundingRectBottom

fun getBoundingRectBottom(): Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the bottom of the screen.

getBoundingRectLeft

fun getBoundingRectLeft(): Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the left of the screen.

getBoundingRectRight

fun getBoundingRectRight(): Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the right of the screen.

getBoundingRectTop

fun getBoundingRectTop(): Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the top of the screen.

getBoundingRects

fun getBoundingRects(): MutableList<Rect!>

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 edge of the device.

Note that there is no bounding rectangle for waterfall cutout since it just represents the curved areas of the display but not the non-functional areas.

getCutoutPath

fun getCutoutPath(): Path?

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

fun getSafeInsetBottom(): Int

Returns the inset from the bottom which avoids the display cutout in pixels.

getSafeInsetLeft

fun getSafeInsetLeft(): Int

Returns the inset from the left which avoids the display cutout in pixels.

getSafeInsetRight

fun getSafeInsetRight(): Int

Returns the inset from the right which avoids the display cutout in pixels.

getSafeInsetTop

fun getSafeInsetTop(): Int

Returns the inset from the top which avoids the display cutout in pixels.

getWaterfallInsets

fun getWaterfallInsets(): Insets

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.

hashCode

fun hashCode(): Int

toString

fun toString(): String