Rect

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

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

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

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

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

Properties

width

public inline val width: Float

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

height

public inline val height: Float

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

size

public val size: Size

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

isInfinite

public val isInfinite: Boolean

Whether any of the coordinates of this rectangle are equal to positive infinity.

isFinite

public val isFinite: Boolean

Whether all coordinates of this rectangle are finite.

isEmpty

public val isEmpty: Boolean

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

minDimension

public val minDimension: Float

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

maxDimension

public val maxDimension: Float

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

topLeft

public val topLeft: Offset

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

topCenter

public val topCenter: Offset

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

topRight

public val topRight: Offset

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

centerLeft

public val centerLeft: Offset

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

center

public val center: Offset

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

See also Size.center.

centerRight

public val centerRight: Offset

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

bottomLeft

public val bottomLeft: Offset

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

bottomCenter

public val bottomCenter: Offset

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

bottomRight

public val bottomRight: Offset

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

Functions

translate

public fun translate(offset: Offset): Rect

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.

translate

public fun translate(translateX: Float, translateY: Float): Rect

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

inflate

public fun inflate(delta: Float): Rect

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

deflate

@Stable public fun deflate(delta: Float): Rect

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

intersect

public fun intersect(other: Rect): Rect

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 Rect will have a negative width or height.

intersect

public fun intersect(
        otherLeft: Float,
        otherTop: Float,
        otherRight: Float,
        otherBottom: Float,
    ): Rect

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 Rect will have a negative width or height.

overlaps

public fun overlaps(other: Rect): Boolean

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

contains

public operator fun contains(offset: Offset): 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.

Members

Companion

public companion object

Properties

Zero

@Stable public val Zero: Rect = Rect(0.0f, 0.0f, 0.0f, 0.0f)

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