CornerRadius
@Immutable inline class CornerRadius
kotlin.Any | |
↳ | androidx.compose.ui.geometry.CornerRadius |
A radius for either circular or elliptical (oval) shapes.
Note consumers should create an instance of this class through the corresponding function constructor as it is represented as an inline class with 2 float parameters packed into a single long to reduce allocation overhead
Summary
Public methods | |
---|---|
operator Float | |
operator Float | |
CornerRadius |
Returns a copy of this Radius instance optionally overriding the radius parameter for the x or y axis |
operator CornerRadius |
Division operator. |
operator CornerRadius |
minus(other: CornerRadius) Binary subtraction operator. |
operator CornerRadius |
plus(other: CornerRadius) Binary addition operator. |
operator CornerRadius |
Multiplication operator. |
String |
toString() |
operator CornerRadius |
Unary negation operator. |
Properties | |
---|---|
Float |
The radius value on the horizontal axis. |
Float |
The radius value on the vertical axis. |
Companion properties | |
---|---|
CornerRadius |
Public methods
component1
@Stable inline operator fun component1(): Float
component2
@Stable inline operator fun component2(): Float
copy
fun copy(
x: Float = this.x,
y: Float = this.y
): CornerRadius
Returns a copy of this Radius instance optionally overriding the radius parameter for the x or y axis
div
@Stable operator fun div(operand: Float): CornerRadius
Division operator.
Returns a radius whose coordinates are the coordinates of the left-hand-side operand (a radius) divided by the scalar right-hand-side operand (a Float).
minus
@Stable operator fun minus(other: CornerRadius): CornerRadius
Binary subtraction operator.
Returns a radius whose x value is the left-hand-side operand's x minus the right-hand-side operand's x and whose y value is the left-hand-side operand's y minus the right-hand-side operand's y.
plus
@Stable operator fun plus(other: CornerRadius): CornerRadius
Binary addition operator.
Returns a radius whose x value is the sum of the x values of the two operands, and whose y value is the sum of the y values of the two operands.
times
@Stable operator fun times(operand: Float): CornerRadius
Multiplication operator.
Returns a radius whose coordinates are the coordinates of the left-hand-side operand (a radius) multiplied by the scalar right-hand-side operand (a Float).
toString
fun toString(): String
unaryMinus
@Stable operator fun unaryMinus(): CornerRadius
Unary negation operator.
Returns a Radius with the distances negated.
Radiuses with negative values aren't geometrically meaningful, but could occur as part of expressions. For example, negating a radius of one pixel and then adding the result to another radius is equivalent to subtracting a radius of one pixel from the other.
Properties
Companion properties
Zero
@Stable val Zero: CornerRadius
A radius with x and y values set to zero.
You can use CornerRadius.Zero with RoundRect to have right-angle corners.