PolygonShape

public sealed class PolygonShape : Shape

Shape built from rounded polygon geometry.

Create instances using the PolygonShape factory functions or predefined companion factories like regularPolygon and star. Instances created with equal parameters compare equal to enable caching resolved outlines across recompositions.

Shapes cache their resolved outline for their most recent layout size. Sharing a single shape instance across composables with differing sizes is supported, but defining separate instances per size avoids cache thrashing when repeatedly redrawing.

Outlines returned by createOutline are shared between callers and must not be mutated.

Members

Companion

public companion object

Functions

regularPolygon

public fun regularPolygon(
            @IntRange(from = 3) numVertices: Int,
            rounding: CornerRounding = CornerRounding.Unrounded,
        ): PolygonShape

Creates a regular polygon PolygonShape with numVertices vertices, sized to the container's smaller dimension.

Parameters

Throws: IllegalArgumentException

if numVertices is less than 3

star

public fun star(
            @IntRange(from = 2) numPoints: Int,
            innerRadiusRatio: Float = 0.5f,
            outerRounding: CornerRounding = CornerRounding.Unrounded,
            innerRounding: CornerRounding = outerRounding,
        ): PolygonShape

Creates a star PolygonShape with numPoints points on each of the outer and inner radii, sized to the container's smaller dimension.

Parameters

Throws: IllegalArgumentException

if numPoints is less than 2 or innerRadiusRatio is outside the range (0, 1]

pill

public fun pill(@FloatRange(0.0, 1.0) smoothing: Float = 0f): PolygonShape

Creates a pill PolygonShape with rounded ends along the shorter sides of the layout bounds.

Parameters

Throws: IllegalArgumentException

if smoothing is outside the range 0 to 1

pillStar

public fun pillStar(
            @IntRange(from = 2) numPoints: Int,
            innerRadiusRatio: Float = 0.5f,
            vertexSpacing: Float = 0.5f,
            startLocation: Float = 0f,
            outerRounding: CornerRounding = CornerRounding.Unrounded,
            innerRounding: CornerRounding = outerRounding,
        ): PolygonShape

Creates a star PolygonShape with vertices placed along a pill outline.

A pillStar is like a pill except it has inner and outer radii along its pill-shaped outline, just as a star has inner and outer radii along a circular outline. This produces an elongated star shape commonly used for badges, chips, and decorative containers.

Because vertices curve around the semicircular ends of the pill, outer and inner vertices have different spacing along the curved ends depending on innerRadiusRatio. The vertexSpacing parameter controls how vertices are spaced along those curved ends:

vertices will be further apart).

• vertexSpacing = 0f: Spaces inner vertices equally along the curved ends (outer

vertices will be closer together).

• vertexSpacing = 1f: Spaces outer vertices equally along the curved ends (inner

both sets of vertices fall symmetrically along the curved ends.

• vertexSpacing = 0.5f (default): Uses the average of the inner and outer spacing so

Parameters

Throws: IllegalArgumentException

if numPoints is less than 2, or innerRadiusRatio is outside (0, 1], or vertexSpacing or startLocation are outside the range 0 to 1

circle

public fun circle(@IntRange(from = 3) numVertices: Int = 8): PolygonShape

Creates a circular PolygonShape approximated by numVertices rounded vertices.

Parameters

Throws: IllegalArgumentException

if numVertices is less than 3

rectangle

public fun rectangle(rounding: CornerRounding): PolygonShape

Creates a rectangular PolygonShape filling the layout bounds, with the same rounding at every corner.

Parameters

rectangle

public fun rectangle(
            topStartRounding: CornerRounding = CornerRounding.Unrounded,
            topEndRounding: CornerRounding = CornerRounding.Unrounded,
            bottomEndRounding: CornerRounding = CornerRounding.Unrounded,
            bottomStartRounding: CornerRounding = CornerRounding.Unrounded,
        ): PolygonShape

Creates a rectangular PolygonShape filling the layout bounds, with a separate rounding for each corner.

Corner roundings mirror automatically with the layout direction.

Parameters

absoluteRectangle

public fun absoluteRectangle(
            topLeftRounding: CornerRounding = CornerRounding.Unrounded,
            topRightRounding: CornerRounding = CornerRounding.Unrounded,
            bottomRightRounding: CornerRounding = CornerRounding.Unrounded,
            bottomLeftRounding: CornerRounding = CornerRounding.Unrounded,
        ): PolygonShape

Creates an absolute rectangular PolygonShape filling the layout bounds, with a separate rounding for each corner.

Corner roundings do not swap with the layout direction.

Parameters