IntOffset

public class IntOffset(public val packedValue: Long)

A two-dimensional position using Int pixels for units.

To create an IntOffset, call the top-level function that accepts an x/y pair of coordinates:

val offset = IntOffset(x, y)

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

Parameters

Properties

x

public val x: Int

The horizontal aspect of the position in Int pixels.

y

public val y: Int

The vertical aspect of the position in Int pixels.

Functions

component1

@Stable public inline operator fun component1(): Int

component2

@Stable public inline operator fun component2(): Int

copy

public fun copy(x: Int = unpackInt1(packedValue), y: Int = unpackInt2(packedValue)): IntOffset

Returns a copy of this IntOffset instance optionally overriding the x or y parameter

minus

public operator fun minus(other: IntOffset): IntOffset

Subtract a IntOffset from another one.

plus

public operator fun plus(other: IntOffset): IntOffset

Add a IntOffset to another one.

unaryMinus

public operator fun unaryMinus(): IntOffset

Returns a new IntOffset representing the negation of this point.

times

public operator fun times(operand: Float): IntOffset

Multiplication operator.

Returns an IntOffset whose coordinates are the coordinates of the left-hand-side operand (an IntOffset) multiplied by the scalar right-hand-side operand (a Float). The result is rounded to the nearest integer.

div

public operator fun div(operand: Float): IntOffset

Division operator.

Returns an IntOffset whose coordinates are the coordinates of the left-hand-side operand (an IntOffset) divided by the scalar right-hand-side operand (a Float). The result is rounded to the nearest integer.

rem

public operator fun rem(operand: Int): IntOffset

Modulo (remainder) operator.

Returns an IntOffset whose coordinates are the remainder of dividing the coordinates of the left-hand-side operand (an IntOffset) by the scalar right-hand-side operand (an Int).

Members

Companion

public companion object

Properties

Zero

public val Zero: IntOffset

Max

public val Max: IntOffset