ScaleFactor

Added in 1.0.0

Cmn
```
value class ScaleFactor
```

Holds 2 dimensional scaling factors for horizontal and vertical axes

Summary

Public companion properties
`ScaleFactor`	`Unspecified` A ScaleFactor whose `scaleX` and `scaleY` parameters are unspecified.	Cmn

Public constructors
`ScaleFactor(packedValue: Long)`	Cmn

Public functions
`inline operator Float`	`component1()`	Cmn
`inline operator Float`	`component2()`	Cmn
`ScaleFactor`	`copy(scaleX: Float, scaleY: Float)` Returns a copy of this ScaleFactor instance optionally overriding the scaleX or scaleY parameters	Cmn
`operator ScaleFactor`	`div(operand: Float)` Division operator.	Cmn
`operator ScaleFactor`	`times(operand: Float)` Multiplication operator.	Cmn
`open String`	`toString()`	Cmn

Public properties
`Long`	`packedValue`	Cmn
`Float`	`scaleX` Returns the scale factor to apply along the horizontal axis	Cmn
`Float`	`scaleY` Returns the scale factor to apply along the vertical axis	Cmn

Extension functions
`inline ScaleFactor`	`ScaleFactor.takeOrElse(block: () -> ScaleFactor)` If this `ScaleFactor` then this is returned, otherwise `block` is executed and its result is returned.	Cmn
`operator Size`	`ScaleFactor.times(size: Size)` Multiplication operator with `Size` with reverse parameter types to maintain commutative properties of multiplication	Cmn

Extension properties
`Boolean`	`ScaleFactor.isSpecified` `false` when this is `ScaleFactor.Unspecified`.	Cmn
`Boolean`	`ScaleFactor.isUnspecified` `true` when this is `ScaleFactor.Unspecified`.	Cmn

Public companion properties

Unspecified

Cmn

Added in 1.0.0

val Unspecified: ScaleFactor

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

Public constructors

ScaleFactor

Cmn

Added in 1.8.0

ScaleFactor(packedValue: Long)

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(scaleX: Float = this.scaleX, scaleY: Float = this.scaleY): ScaleFactor

Returns a copy of this ScaleFactor instance optionally overriding the scaleX or scaleY parameters

div

Cmn

Added in 1.1.0

operator fun div(operand: Float): ScaleFactor

Division operator.

Returns a ScaleFactor with scale x and y values divided by the operand

times

Cmn

Added in 1.1.0

operator fun times(operand: Float): ScaleFactor

Multiplication operator.

Returns a ScaleFactor with scale x and y values multiplied by the operand

toString

Cmn

open fun toString(): String

Public properties

packedValue

Cmn

Added in 1.8.0

val packedValue: Long

scaleX

Cmn

Added in 1.2.0

val scaleX: Float

Returns the scale factor to apply along the horizontal axis

scaleY

Cmn

Added in 1.2.0

val scaleY: Float

Returns the scale factor to apply along the vertical axis

Extension functions

takeOrElse

Cmn

Artifact: androidx.compose.ui:ui

View Source

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

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

times

Cmn

Artifact: androidx.compose.ui:ui

View Source

operator fun ScaleFactor.times(size: Size): Size

Multiplication operator with Size with reverse parameter types to maintain commutative properties of multiplication

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

Extension properties

isSpecified

Cmn

Artifact: androidx.compose.ui:ui

View Source

val ScaleFactor.isSpecified: Boolean

false when this is ScaleFactor.Unspecified.

isUnspecified

Cmn

Artifact: androidx.compose.ui:ui

View Source

val ScaleFactor.isUnspecified: Boolean

true when this is ScaleFactor.Unspecified.