androidx.compose.ui.unit

fun Constraints(
    minWidth: Int = 0,
    maxWidth: Int = Infinity,
    minHeight: Int = 0,
    maxHeight: Int = Infinity
): Constraints

Create a Constraints. minWidth and minHeight must be positive and maxWidth and maxHeight must be greater than or equal to minWidth and minHeight, respectively, or Infinity.

fun Density(context: Context): Density

Creates a Density for this Context.

fun Density(density: Float, fontScale: Float = 1.0f): Density

A density of the screen. Used for convert Dp to pixels.

inline fun DpOffset(x: Dp, y: Dp): DpOffset

Constructs a DpOffset from x and y position Dp values.

fun DpSize(width: Dp, height: Dp): DpSize

Constructs a DpSize from width and height values.

inline fun IntOffset(x: Int, y: Int): IntOffset

Constructs a IntOffset from x and y position Int values.

fun IntRect(center: IntOffset, radius: Int): IntRect

Construct a rectangle that bounds the given circle

fun IntRect(offset: IntOffset, size: IntSize): IntRect

Construct a rectangle from its left and top edges as well as its width and height.

fun IntRect(topLeft: IntOffset, bottomRight: IntOffset): IntRect

Construct the smallest rectangle that encloses the given offsets, treating them as vectors from the origin.

inline fun IntSize(width: Int, height: Int): IntSize

Constructs an IntSize from width and height Int values.

fun TextUnit(value: Float, type: TextUnitType): TextUnit

Construct a new TextUnit.

fun Velocity(x: Float, y: Float): Velocity

Constructs an Velocity from the given relative x and y velocities.

fun lerp(start: Dp, stop: Dp, fraction: Float): Dp

Linearly interpolate between two Dps.

The fraction argument represents position on the timeline, with 0.0 meaning that the interpolation has not started, returning start (or something equivalent to start), 1.0 meaning that the interpolation has finished, returning stop (or something equivalent to stop), and values in between meaning that the interpolation is at the relevant point on the timeline between start and stop. The interpolation can be extrapolated beyond 0.0 and 1.0, so negative values and values greater than 1.0 are valid.

fun lerp(start: DpOffset, stop: DpOffset, fraction: Float): DpOffset

Linearly interpolate between two DpOffsets.

The fraction argument represents position on the timeline, with 0.0 meaning that the interpolation has not started, returning start (or something equivalent to start), 1.0 meaning that the interpolation has finished, returning stop (or something equivalent to stop), and values in between meaning that the interpolation is at the relevant point on the timeline between start and stop. The interpolation can be extrapolated beyond 0.0 and 1.0, so negative values and values greater than 1.0 are valid.

fun lerp(start: DpSize, stop: DpSize, fraction: Float): DpSize

Linearly interpolate between two DpSizes.

The fraction argument represents position on the timeline, with 0.0 meaning that the interpolation has not started, returning start, 1.0 meaning that the interpolation has finished, returning stop, and values in between meaning that the interpolation is at the relevant point on the timeline between start and stop. The interpolation can be extrapolated beyond 0.0 and 1.0, so negative values and values greater than 1.0 are valid.

fun lerp(start: IntOffset, stop: IntOffset, fraction: Float): IntOffset

Linearly interpolate between two IntOffsets.

The fraction argument represents position on the timeline, with 0.0 meaning that the interpolation has not started, returning start (or something equivalent to start), 1.0 meaning that the interpolation has finished, returning stop (or something equivalent to stop), and values in between meaning that the interpolation is at the relevant point on the timeline between start and stop. The interpolation can be extrapolated beyond 0.0 and 1.0, so negative values and values greater than 1.0 are valid.

fun lerp(start: IntRect, stop: IntRect, fraction: Float): IntRect

Linearly interpolate between two rectangles.

The fraction argument represents position on the timeline, with 0.0 meaning that the interpolation has not started, returning start (or something equivalent to start), 1.0 meaning that the interpolation has finished, returning stop (or something equivalent to stop), and values in between meaning that the interpolation is at the relevant point on the timeline between start and stop. The interpolation can be extrapolated beyond 0.0 and 1.0, so negative values and values greater than 1.0 are valid (and can easily be generated by curves).

Values for fraction are usually obtained from an Animation, such as an AnimationController.

fun lerp(start: TextUnit, stop: TextUnit, fraction: Float): TextUnit

Linearly interpolate between two TextUnits.

The fraction argument represents position on the timeline, with 0.0 meaning that the interpolation has not started, returning start (or something equivalent to start), 1.0 meaning that the interpolation has finished, returning stop (or something equivalent to stop), and values in between meaning that the interpolation is at the relevant point on the timeline between start and stop. The interpolation can be extrapolated beyond 0.0 and 1.0, so negative values and values greater than 1.0 are valid.

inline fun Dp.coerceAtLeast(minimumValue: Dp): Dp

Ensures that this value is not less than the specified minimumValue.

inline fun Dp.coerceAtMost(maximumValue: Dp): Dp

Ensures that this value is not greater than the specified maximumValue.

inline fun Dp.coerceIn(minimumValue: Dp, maximumValue: Dp): Dp

Ensures that this value lies in the specified range minimumValue..maximumValue.

fun Constraints.constrain(otherConstraints: Constraints): Constraints

Takes otherConstraints and returns the result of coercing them in the current constraints. Note this means that any size satisfying the resulting constraints will satisfy the current constraints, but they might not satisfy the otherConstraints when the two set of constraints are disjoint. Examples (showing only width, height works the same): (minWidth=2, maxWidth=10).constrain(minWidth=7, maxWidth=12) -> (minWidth = 7, maxWidth = 10) (minWidth=2, maxWidth=10).constrain(minWidth=11, maxWidth=12) -> (minWidth=10, maxWidth=10) (minWidth=2, maxWidth=10).constrain(minWidth=5, maxWidth=7) -> (minWidth=5, maxWidth=7)

fun Constraints.constrain(size: IntSize): IntSize

Takes a size and returns the closest size to it that satisfies the constraints.

fun Constraints.constrainHeight(height: Int): Int

Takes a height and returns the closest size to it that satisfies the constraints.

fun Constraints.constrainWidth(width: Int): Int

Takes a width and returns the closest size to it that satisfies the constraints.

fun Constraints.isSatisfiedBy(size: IntSize): Boolean

Takes a size and returns whether it satisfies the current constraints.

fun Constraints.offset(horizontal: Int = 0, vertical: Int = 0): Constraints

Returns the Constraints obtained by offsetting the current instance with the given values.

fun Offset.round(): IntOffset

Round a Offset down to the nearest Int coordinates.

fun Rect.roundToIntRect(): IntRect

Rounds a Rect to an IntRect

fun Size.roundToIntSize(): IntSize

Convert a Size to an IntSize. This rounds Size.width and Size.height to the nearest integer.

inline fun Dp.takeOrElse(block: () -> Dp): Dp

If this Dp then this is returned, otherwise block is executed and its result is returned.

inline fun DpOffset.takeOrElse(block: () -> DpOffset): DpOffset

If this DpOffset isSpecified then this is returned, otherwise block is executed and its result is returned.

inline fun DpSize.takeOrElse(block: () -> DpSize): DpSize

If this DpSize isSpecified then this is returned, otherwise block is executed and its result is returned.

inline fun TextUnit.takeOrElse(block: () -> TextUnit): TextUnit

If this TextUnit then this is returned, otherwise block is executed and its result is returned.

inline operator fun Float.times(other: TextUnit): TextUnit

Multiply a TextUnit by a scalar.

This operation works only if the right operand is not equal to TextUnit.Unspecified. The result of this operation is the same unit type of the given one.

inline operator fun Double.times(other: TextUnit): TextUnit

Multiply a TextUnit by a scalar.

This operation works only if the right operand is not equal to TextUnit.Unspecified. The result of this operation is the same unit type of the given one.

inline operator fun Int.times(other: TextUnit): TextUnit

Multiply a TextUnit by a scalar.

This operation works only if the right operand is not equal to TextUnit.Unspecified. The result of this operation is the same unit type of the given one.

inline operator fun Int.times(size: IntSize): IntSize

Returns an IntSize with size's IntSize.width and IntSize.height multiplied by this.

fun IntSize.toIntRect(): IntRect

Convert a IntSize to a IntRect.

fun Size.toIntSize(): IntSize

Convert a Size to an IntSize. This rounds the width and height values down to the nearest integer.

inline fun IntOffset.toOffset(): Offset

Converts the IntOffset to an Offset.

fun IntRect.toRect(): Rect

Converts an IntRect to a Rect

val DpSize.center: DpOffset

Returns the DpOffset of the center of the rect from the point of 0, 0 with this DpSize.

val IntSize.center: IntOffset

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

val Double.dp: Dp

Create a Dp using a Double: val left = 10.0 val x = left.dp // -- or -- val y = 10.0.dp

val Float.dp: Dp

Create a Dp using a Float: val left = 10f val x = left.dp // -- or -- val y = 10f.dp

val Int.dp: Dp

Create a Dp using an Int: val left = 10 val x = left.dp // -- or -- val y = 10.dp

val Double.em: TextUnit

Creates an EM unit TextUnit

val Float.em: TextUnit

Creates an EM unit TextUnit

val Int.em: TextUnit

Creates an EM unit TextUnit

val DpRect.height: Dp

A height of this Bounds in Dp.

val Dp.isFinite: Boolean

Return true when it is finite or false when it is Dp.Infinity

val Dp.isSpecified: Boolean

false when this is Dp.Unspecified.

val DpOffset.isSpecified: Boolean

false when this is DpOffset.Unspecified.

val DpSize.isSpecified: Boolean

false when this is DpSize.Unspecified.

val TextUnit.isSpecified: Boolean

false when this is TextUnit.Unspecified.

val Dp.isUnspecified: Boolean

true when this is Dp.Unspecified.

val DpOffset.isUnspecified: Boolean

true when this is DpOffset.Unspecified.

val DpSize.isUnspecified: Boolean

true when this is DpSize.Unspecified.

val TextUnit.isUnspecified: Boolean

true when this is TextUnit.Unspecified.

val DpRect.size: DpSize

Returns the size of the DpRect.

val Double.sp: TextUnit

Creates a SP unit TextUnit

val Float.sp: TextUnit

Creates a SP unit TextUnit

val Int.sp: TextUnit

Creates a SP unit TextUnit

val DpRect.width: Dp

A width of this Bounds in Dp.