IntRect

data class IntRect(
    /** The offset of the left edge of this rectangle from the x axis. */
    @Stable val left: Int,

    /** The offset of the top edge of this rectangle from the y axis. */
    @Stable val top: Int,

    /** The offset of the right edge of this rectangle from the x axis. */
    @Stable val right: Int,

    /** The offset of the bottom edge of this rectangle from the y axis. */
    @Stable val bottom: Int,
)

An immutable, 2D, axis-aligned, integer bounds rectangle whose coordinates are relative to a given origin.

Properties

val width: Int

The distance between the left and right edges of this rectangle.

val height: Int

The distance between the top and bottom edges of this rectangle.

val size: IntSize

The distance between the upper-left corner and the lower-right corner of this rectangle.

val isEmpty: Boolean

Whether this rectangle encloses a non-zero area. Negative areas are considered empty.

val minDimension: Int

The lesser of the magnitudes of the width and the height of this rectangle.

val maxDimension: Int

The greater of the magnitudes of the width and the height of this rectangle.

val topLeft: IntOffset

The offset to the intersection of the top and left edges of this rectangle.

val topCenter: IntOffset

The offset to the center of the top edge of this rectangle.

val topRight: IntOffset

The offset to the intersection of the top and right edges of this rectangle.

val centerLeft: IntOffset

The offset to the center of the left edge of this rectangle.

val center: IntOffset

The offset to the point halfway between the left and right and the top and bottom edges of this rectangle.

See also IntSize.center.

val centerRight: IntOffset

The offset to the center of the right edge of this rectangle.

val bottomLeft: IntOffset

The offset to the intersection of the bottom and left edges of this rectangle.

val bottomCenter: IntOffset

The offset to the center of the bottom edge of this rectangle.

val bottomRight: IntOffset

The offset to the intersection of the bottom and right edges of this rectangle.

Functions

fun translate(offset: IntOffset): IntRect

Returns a new rectangle translated by the given offset.

To translate a rectangle by separate x and y components rather than by an Offset, consider translate.

fun translate(translateX: Int, translateY: Int): IntRect

Returns a new rectangle with translateX added to the x components and translateY added to the y components.

fun inflate(delta: Int): IntRect

Returns a new rectangle with edges moved outwards by the given delta.

fun deflate(delta: Int): IntRect

Returns a new rectangle with edges moved inwards by the given delta.

fun intersect(other: IntRect): IntRect

Returns a new rectangle that is the intersection of the given rectangle and this rectangle. The two rectangles must overlap for this to be meaningful. If the two rectangles do not overlap, then the resulting IntRect will have a negative width or height.

fun overlaps(other: IntRect): Boolean

Whether other has a nonzero area of overlap with this rectangle.

fun contains(offset: IntOffset): Boolean

Whether the point specified by the given offset (which is assumed to be relative to the origin) lies between the left and right and the top and bottom edges of this rectangle.

Rectangles include their top and left edges but exclude their bottom and right edges.

Companion Object

Properties

val Zero: IntRect

A rectangle with left, top, right, and bottom edges all at zero.