IntRect

Added in 1.0.0

Cmn
```
data class IntRect
```

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

Summary

Public companion properties
`IntRect`	`Zero` A rectangle with left, top, right, and bottom edges all at zero.	Cmn

Public constructors
`IntRect(left: Int, top: Int, right: Int, bottom: Int)`	Cmn

Public functions
`Boolean`	`contains(offset: IntOffset)` 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.	Cmn
`IntRect`	`deflate(delta: Int)` Returns a new rectangle with edges moved inwards by the given delta.	Cmn
`IntRect`	`inflate(delta: Int)` Returns a new rectangle with edges moved outwards by the given delta.	Cmn
`IntRect`	`intersect(other: IntRect)` Returns a new rectangle that is the intersection of the given rectangle and this rectangle.	Cmn
`Boolean`	`overlaps(other: IntRect)` Whether `other` has a nonzero area of overlap with this rectangle.	Cmn
`open String`	`toString()`	Cmn
`IntRect`	`translate(offset: IntOffset)` Returns a new rectangle translated by the given offset.	Cmn
`IntRect`	`translate(translateX: Int, translateY: Int)` Returns a new rectangle with translateX added to the x components and translateY added to the y components.	Cmn

Public properties
`Int`	`bottom` The offset of the bottom edge of this rectangle from the y axis.	Cmn
`IntOffset`	`bottomCenter` The offset to the center of the bottom edge of this rectangle.	Cmn
`IntOffset`	`bottomLeft` The offset to the intersection of the bottom and left edges of this rectangle.	Cmn
`IntOffset`	`bottomRight` The offset to the intersection of the bottom and right edges of this rectangle.	Cmn
`IntOffset`	`center` The offset to the point halfway between the left and right and the top and bottom edges of this rectangle.	Cmn
`IntOffset`	`centerLeft` The offset to the center of the left edge of this rectangle.	Cmn
`IntOffset`	`centerRight` The offset to the center of the right edge of this rectangle.	Cmn
`Int`	`height` The distance between the top and bottom edges of this rectangle.	Cmn
`Boolean`	`isEmpty` Whether this rectangle encloses a non-zero area.	Cmn
`Int`	`left` The offset of the left edge of this rectangle from the x axis.	Cmn
`Int`	`maxDimension` The greater of the magnitudes of the `width` and the `height` of this rectangle.	Cmn
`Int`	`minDimension` The lesser of the magnitudes of the `width` and the `height` of this rectangle.	Cmn
`Int`	`right` The offset of the right edge of this rectangle from the x axis.	Cmn
`IntSize`	`size` The distance between the upper-left corner and the lower-right corner of this rectangle.	Cmn
`Int`	`top` The offset of the top edge of this rectangle from the y axis.	Cmn
`IntOffset`	`topCenter` The offset to the center of the top edge of this rectangle.	Cmn
`IntOffset`	`topLeft` The offset to the intersection of the top and left edges of this rectangle.	Cmn
`IntOffset`	`topRight` The offset to the intersection of the top and right edges of this rectangle.	Cmn
`Int`	`width` The distance between the left and right edges of this rectangle.	Cmn

Extension functions
`Rect`	`IntRect.toRect()` Converts an `IntRect` to a `Rect`	Cmn
`Rect`	`IntRect.toAndroidRect()` Creates a new instance of `android.graphics.Rect` with the same bounds specified in the given `IntRect`	android

Public companion properties

Zero

Cmn

Added in 1.0.0

val Zero: IntRect

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

Public constructors

IntRect

Cmn

Added in 1.0.0

IntRect(left: Int, top: Int, right: Int, bottom: Int)

Public functions

contains

Cmn

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.

deflate

Cmn

Added in 1.0.0

fun deflate(delta: Int): IntRect

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

inflate

Cmn

Added in 1.0.0

fun inflate(delta: Int): IntRect

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

intersect

Cmn

Added in 1.0.0

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.

overlaps

Cmn

Added in 1.0.0

fun overlaps(other: IntRect): Boolean

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

toString

Cmn

open fun toString(): String

translate

Cmn

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.

translate

Cmn

Added in 1.0.0

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.

Public properties

bottom

Cmn

Added in 1.0.0

val bottom: Int

The offset of the bottom edge of this rectangle from the y axis.

bottomCenter

Cmn

Added in 1.0.0

val bottomCenter: IntOffset

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

bottomLeft

Cmn

Added in 1.0.0

val bottomLeft: IntOffset

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

bottomRight

Cmn

Added in 1.0.0

val bottomRight: IntOffset

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

center

Cmn

Added in 1.0.0

val center: IntOffset

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

centerLeft

Cmn

Added in 1.0.0

val centerLeft: IntOffset

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

centerRight

Cmn

Added in 1.0.0

val centerRight: IntOffset

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

height

Cmn

Added in 1.0.0

val height: Int

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

isEmpty

Cmn

Added in 1.0.0

val isEmpty: Boolean

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

left

Cmn

Added in 1.0.0

val left: Int

The offset of the left edge of this rectangle from the x axis.

maxDimension

Cmn

Added in 1.0.0

val maxDimension: Int

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

minDimension

Cmn

Added in 1.0.0

val minDimension: Int

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

right

Cmn

Added in 1.0.0

val right: Int

The offset of the right edge of this rectangle from the x axis.

size

Cmn

Added in 1.0.0

val size: IntSize

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

top

Cmn

Added in 1.0.0

val top: Int

The offset of the top edge of this rectangle from the y axis.

topCenter

Cmn

Added in 1.0.0

val topCenter: IntOffset

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

topLeft

Cmn

Added in 1.0.0

val topLeft: IntOffset

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

topRight

Cmn

Added in 1.0.0

val topRight: IntOffset

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

width

Cmn

Added in 1.0.0

val width: Int

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

Extension functions

toRect

Cmn

Artifact: androidx.compose.ui:ui-unit

View Source

fun IntRect.toRect(): Rect

Converts an IntRect to a Rect

toAndroidRect

android

Artifact: androidx.compose.ui:ui-graphics

View Source

fun IntRect.toAndroidRect(): Rect

Creates a new instance of android.graphics.Rect with the same bounds specified in the given IntRect