• Cmn
    value class Size

Holds a 2D floating-point size.

You can think of this as an Offset from the origin.

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

val size = Size(width, height)

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

Summary

Nested types

Public companion properties
Size

A size whose width and height are unspecified.
Cmn
Size

An empty size, one with a zero width and a zero height.
Cmn

Public constructors
Size(packedValue: Long)
Cmn

Public functions
inline operator Float
Cmn
inline operator Float
Cmn
Size
copy(width: Float, height: Float)

Returns a copy of this Size instance optionally overriding the width or height parameter
Cmn
operator Size
div(operand: Float)

Division operator.
Cmn
Boolean

Whether this size encloses a non-zero area.
Cmn
operator Size
times(operand: Float)

Multiplication operator.
Cmn
open String
Cmn

Public properties
Float
Cmn
Float

The greater of the magnitudes of the width and the height.
Cmn
Float

The lesser of the magnitudes of the width and the height.
Cmn
Long

Long value encoding the width and height components of the Size.
Cmn
Float
Cmn

Extension functions
IntSize

Convert a Size to an IntSize.
Cmn
IntSize

Convert a Size to an IntSize.
Cmn
operator Size
Size.div(scaleFactor: ScaleFactor)

Division operator with Size
Cmn
operator Size
Size.times(scaleFactor: ScaleFactor)

Multiplication operator with Size.
Cmn
inline Size
Size.takeOrElse(block: () -> Size)

If this Size isSpecified then this is returned, otherwise block is executed and its result is returned.
Cmn
Rect

Convert a Size to a Rect.
Cmn

Extension properties
Offset

Returns the Offset of the center of the rect from the point of 0, 0 with this Size.
Cmn
Boolean

false when this is Size.Unspecified.
Cmn
Boolean

true when this is Size.Unspecified.
Cmn

Public companion properties

Unspecified

Cmn
Added in 1.0.0
val Unspecified: Size

A size whose width and height are unspecified. This is a sentinel value used to initialize a non-null parameter. Access to width or height on an unspecified size is not allowed.

Zero

Cmn
Added in 1.0.0
val Zero: Size

An empty size, one with a zero width and a zero height.

Public constructors

Size

Cmn
Added in 1.8.0-alpha06
Size(packedValue: Long)
Parameters
packedValue: Long

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

Public functions

component1

Cmn
Added in 1.1.0
inline operator fun component1(): Float

component2

Cmn
Added in 1.1.0
inline operator fun component2(): Float

copy

Cmn
Added in 1.2.0
fun copy(
    width: Float = unpackFloat1(packedValue),
    height: Float = unpackFloat2(packedValue)
): Size

Returns a copy of this Size instance optionally overriding the width or height parameter

div

Cmn
Added in 1.1.0
operator fun div(operand: Float): Size

Division operator.

Returns a Size whose dimensions are the dimensions of the left-hand-side operand (a Size) divided by the scalar right-hand-side operand (a Float).

isEmpty

Cmn
Added in 1.1.0
fun isEmpty(): Boolean

Whether this size encloses a non-zero area.

Negative areas are considered empty.

times

Cmn
Added in 1.1.0
operator fun times(operand: Float): Size

Multiplication operator.

Returns a Size whose dimensions are the dimensions of the left-hand-side operand (a Size) multiplied by the scalar right-hand-side operand (a Float).

toString

Cmn 
open fun toString(): String

Public properties

height

Cmn
Added in 1.2.0
val height: Float

maxDimension

Cmn
Added in 1.2.0
val maxDimension: Float

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

minDimension

Cmn
Added in 1.2.0
val minDimension: Float

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

packedValue

Cmn
Added in 1.8.0-alpha06
val packedValue: Long

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

width

Cmn
Added in 1.2.0
val width: Float

Extension functions

roundToIntSize

Cmn 
fun Size.roundToIntSize(): IntSize

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

toIntSize

Cmn 
fun Size.toIntSize(): IntSize

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

div

Cmn 
operator fun Size.div(scaleFactor: ScaleFactor): Size

Division operator with Size

Return a new Size with the width and height divided by ScaleFactor.scaleX and ScaleFactor.scaleY respectively

times

Cmn 
operator fun Size.times(scaleFactor: ScaleFactor): Size

Multiplication operator with Size.

Return a new Size with the width and height multiplied by the ScaleFactor.scaleX and ScaleFactor.scaleY respectively

takeOrElse

Cmn 
inline fun Size.takeOrElse(block: () -> Size): Size

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

toRect

Cmn 
fun Size.toRect(): Rect

Convert a Size to a Rect.

Extension properties

center

Cmn 
val Size.center: Offset

Returns the Offset of the center of the rect from the point of 0, 0 with this Size.

isSpecified

Cmn 
val Size.isSpecified: Boolean

false when this is Size.Unspecified.

isUnspecified

Cmn 
val Size.isUnspecified: Boolean

true when this is Size.Unspecified.