IntSize

Artifact: androidx.compose.ui:ui-unit

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  value class IntSize

---

A two-dimensional size class used for measuring in Int pixels.

To create an IntSize, call the top-level function that accepts a width/height pair of dimensions:

val size = IntSize(width, height)

The primary constructor of IntSize is intended to be used with the packedValue property to allow storing sizes in arrays or collections of primitives without boxing.

Summary

Nested types
object IntSize.Companion

Public companion properties
IntSize	Zero IntSize with a zero (0) width and height.	Cmn

Public functions
inline operator Int	component1()	Cmn
inline operator Int	component2()	Cmn
operator IntSize	div(other: Int) Returns an IntSize scaled by dividing width and height by other	Cmn
operator IntSize	times(other: Int) Returns an IntSize scaled by multiplying width and height by other	Cmn
open String	toString()	Cmn

Public properties
Int	height The vertical aspect of the size in Int pixels.	Cmn
Long	packedValue Long value encoding the width and height components of the IntSize.	Cmn
Int	width The horizontal aspect of the size in Int pixels.	Cmn

Extension functions
IntRect	IntSize.toIntRect() Convert a IntSize to a IntRect.	Cmn
Size	IntSize.toSize()	Cmn

Extension properties
IntOffset	IntSize.center Returns the IntOffset of the center of the rect from the point of 0, 0 with this IntSize.	Cmn

Public companion properties

Zero

Cmn

Added in 1.0.0

val Zero: IntSize

IntSize with a zero (0) width and height.

Public functions

component1

Cmn

Added in 1.1.0

inline operator fun component1(): Int

component2

Cmn

Added in 1.1.0

inline operator fun component2(): Int

div

Cmn

Added in 1.1.0

operator fun div(other: Int): IntSize

Returns an IntSize scaled by dividing width and height by other

times

Cmn

Added in 1.1.0

operator fun times(other: Int): IntSize

Returns an IntSize scaled by multiplying width and height by other

toString

Cmn

open fun toString(): String

Public properties

height

Cmn

Added in 1.2.0

val height: Int

The vertical aspect of the size in Int pixels.

packedValue

Cmn

Added in 1.8.0-alpha01

val packedValue: Long

Long value encoding the width and height components of the IntSize. Encoded values can be obtained by using the packedValue property of existing IntSize instances.

width

Cmn

Added in 1.2.0

val width: Int

The horizontal aspect of the size in Int pixels.

Extension functions

toIntRect

Cmn

Artifact: androidx.compose.ui:ui-unit

View Source

fun IntSize.toIntRect(): IntRect

Convert a IntSize to a IntRect.

toSize

Cmn

Artifact: androidx.compose.ui:ui-unit

View Source

fun IntSize.toSize(): Size

Extension properties

center

Cmn

Artifact: androidx.compose.ui:ui-unit

View Source

val IntSize.center: IntOffset

Returns the IntOffset of the center of the rect from the point of 0, 0 with this IntSize.