CurvedTextStyle

public class CurvedTextStyle(
    public val background: Color = Color.Unspecified,
    public val color: Color = Color.Unspecified,
    public val fontSize: TextUnit = TextUnit.Unspecified,
    public val fontFamily: FontFamily? = null,
    public val fontWeight: FontWeight? = null,
    public val fontStyle: FontStyle? = null,
    public val fontSynthesis: FontSynthesis? = null,
    public val letterSpacing: TextUnit = TextUnit.Unspecified,
    public val letterSpacingCounterClockwise: TextUnit = TextUnit.Unspecified,
    public val lineHeight: TextUnit = TextUnit.Unspecified,
    public val warpOffset: WarpOffset = WarpOffset.Unspecified,
)

Styling configuration for a curved text.

Sample using different letter spacings for top & bottom text:

Sample using different warping:

Parameters

Functions

merge

public fun merge(other: CurvedTextStyle? = null): CurvedTextStyle

Returns a new curved text style that is a combination of this style and the given other style.

other curved text style's null or inherit properties are replaced with the non-null properties of this curved text style. Another way to think of it is that the "missing" properties of the other style are filled by the properties of this style.

If the given curved text style is null, returns this curved text style.

plus

public operator fun plus(other: CurvedTextStyle): CurvedTextStyle

Plus operator overload that applies a merge.

copy

@Deprecated(
        "This overload is provided for backwards compatibility with Compose for " +
            "Wear OS 1.0. A newer overload is available with additional font parameters.",
        level = DeprecationLevel.HIDDEN,
    )
    public fun copy(
        background: Color = this.background,
        color: Color = this.color,
        fontSize: TextUnit = this.fontSize,
    ): CurvedTextStyle

copy

@Deprecated(
        "This overload is provided for backwards compatibility with Compose for " +
            "Wear OS 1.4. A newer overload is available with additional letter spacing parameters.",
        level = DeprecationLevel.HIDDEN,
    )
    public fun copy(
        background: Color = this.background,
        color: Color = this.color,
        fontSize: TextUnit = this.fontSize,
        fontFamily: FontFamily? = this.fontFamily,
        fontWeight: FontWeight? = this.fontWeight,
        fontStyle: FontStyle? = this.fontStyle,
        fontSynthesis: FontSynthesis? = this.fontSynthesis,
    ): CurvedTextStyle

copy

@Deprecated(
        "This overload is provided for backwards compatibility with Compose for " +
            "Wear OS 1.4. A newer overload is available with additional letter spacing parameters.",
        level = DeprecationLevel.HIDDEN,
    )
    public fun copy(
        background: Color = this.background,
        color: Color = this.color,
        fontSize: TextUnit = this.fontSize,
        fontFamily: FontFamily? = this.fontFamily,
        fontWeight: FontWeight? = this.fontWeight,
        fontStyle: FontStyle? = this.fontStyle,
        fontSynthesis: FontSynthesis? = this.fontSynthesis,
        // We do this so when the user doesn't specify letterSpacing, neither letterSpacing nor
        // letterSpacingCounterClockwise are modified, and when they do specify it we update both.
        letterSpacing: TextUnit = TextUnit.Unspecified,
    ): CurvedTextStyle

copy

@Deprecated(
        "This overload is provided for backwards compatibility with Compose for " +
            "Wear OS 1.5. A newer overload is available with additional warpOffset parameter.",
        level = DeprecationLevel.HIDDEN,
    )
    public fun copy(
        background: Color = this.background,
        color: Color = this.color,
        fontSize: TextUnit = this.fontSize,
        fontFamily: FontFamily? = this.fontFamily,
        fontWeight: FontWeight? = this.fontWeight,
        fontStyle: FontStyle? = this.fontStyle,
        fontSynthesis: FontSynthesis? = this.fontSynthesis,
        letterSpacing: TextUnit = this.letterSpacing,
        letterSpacingCounterClockwise: TextUnit = this.letterSpacingCounterClockwise,
        lineHeight: TextUnit = this.lineHeight,
    ): CurvedTextStyle

copy

public fun copy(
        background: Color = this.background,
        color: Color = this.color,
        fontSize: TextUnit = this.fontSize,
        fontFamily: FontFamily? = this.fontFamily,
        fontWeight: FontWeight? = this.fontWeight,
        fontStyle: FontStyle? = this.fontStyle,
        fontSynthesis: FontSynthesis? = this.fontSynthesis,
        letterSpacing: TextUnit = this.letterSpacing,
        letterSpacingCounterClockwise: TextUnit = this.letterSpacingCounterClockwise,
        lineHeight: TextUnit = this.lineHeight,
        warpOffset: WarpOffset = this.warpOffset,
    ): CurvedTextStyle

equals

override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int

toString

override fun toString(): String

Members

WarpOffset

public class WarpOffset internal constructor(internal val option: Byte)

Used to specify if we want to warp the text, and if so, the offset for warping. Warping the text will cause each character to be modified in shape so that it is thinner when it is closer to the center of the center of the screen and wider when it's further away. This also makes adjacent characters share a line, so this is particularly useful for cursive fonts. When warping is active, this parameter specifies which horizontal line of the text will keep its width.

Properties

isSpecified

public inline val isSpecified: Boolean

false when this is WarpOffset.Unspecified.

isUnspecified

public inline val isUnspecified: Boolean

true when this is WarpOffset.Unspecified.

Functions

toString

override fun toString(): String

takeOrElse

public inline fun takeOrElse(block: () -> WarpOffset): WarpOffset

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

Members

Companion

public companion object

Properties

Unspecified

public val Unspecified: WarpOffset = WarpOffset(0)

Unspecified, used for merging styles

None

public val None: WarpOffset = WarpOffset(1)

Do not warp, use the standard Android rendering

Baseline

public val Baseline: WarpOffset = WarpOffset(2)

Warp using the baseline of the text.

HalfAscent

public val HalfAscent: WarpOffset = WarpOffset(3)

Warp using half the ascent of the text.

HalfOpticalHeight

public val HalfOpticalHeight: WarpOffset = WarpOffset(4)

Warp using the middle point between ascent and descent of the text. This is the default

Ascent

public val Ascent: WarpOffset = WarpOffset(5)

Warp using the ascent of the text.

Descent

public val Descent: WarpOffset = WarpOffset(6)

Warp using the descent of the text.