core/androidx.core.graphics/Insets

Insets

An Insets instance holds four integer offsets which describe changes to the four edges of a Rectangle. By convention, positive values move edges towards the centre of the rectangle.

Insets are immutable so may be treated as values.

Properties

bottom

val bottom: Int

left

val left: Int

NONE

@NonNull

val NONE: @NonNull Insets

right

val right: Int

top

val top: Int

Functions

add

@NonNull

open fun add(@NonNull a: @NonNull Insets, @NonNull b: @NonNull Insets): @NonNull Insets

Add two Insets.

equals

open fun equals(o: Any): Boolean

Two Insets instances are equal if they belong to the same class and their fields are pairwise equal.

hashCode

open fun hashCode(): Int

max

@NonNull

open fun max(@NonNull a: @NonNull Insets, @NonNull b: @NonNull Insets): @NonNull Insets

Returns the component-wise maximum of two Insets.

min

@NonNull

open fun min(@NonNull a: @NonNull Insets, @NonNull b: @NonNull Insets): @NonNull Insets

Returns the component-wise minimum of two Insets.

@NonNull

open fun of(@NonNull r: @NonNull Rect): @NonNull Insets

@NonNull

open fun of(left: Int, top: Int, right: Int, bottom: Int): @NonNull Insets

Return an Insets instance with the appropriate values.

subtract

@NonNull

open fun subtract(@NonNull a: @NonNull Insets, @NonNull b: @NonNull Insets): @NonNull Insets

Subtract two Insets.

toCompatInsets

@RequiresApi(api = 29)

@NonNull

open fun toCompatInsets(insets: @NonNull Insets): @NonNull Insets

Return a copy of the given android.graphics.Insets instance, converted to be an Insets instance from AndroidX.

toPlatformInsets

@RequiresApi(value = 29)

open fun toPlatformInsets(): @NonNull Insets

Return a copy this instance, converted to be an android.graphics.Insets instance from the platform.

toString

@NonNull

open fun toString(): @NonNull String

wrap

@RequiresApi(api = 29)

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@NonNull

open fun ~~wrap~~(insets: @NonNull Insets): @NonNull Insets