CompositionSettings.Builder

Builder()

Creates a new Builder.

The default alpha is 1.0f, the default offset is (0.0f, 0.0f), the default scale is (1.0f, 1.0f), the default rounded corner ratio is 0.0f, the default border width ratio is 0, and the default border color is WHITE.

fun build(): CompositionSettings

Builds the CompositionSettings.

fun setAlpha(alpha: @FloatRange(from = 0, to = 1) Float): CompositionSettings.Builder

Sets the alpha. 0 means fully transparent, 1 means fully opaque.

fun setBorderColor(borderColor: @ColorInt Int): CompositionSettings.Builder

Sets the border color.

fun setBorderWidthRatio(borderWidthRatio: @FloatRange(from = 0, to = 1) Float): CompositionSettings.Builder

Sets the border width as a normalized ratio from 0 to 1.

0 means no border. 1 means the border width equals half of the smaller dimension of the frame, which causes the borders to meet at the center and fill the smaller dimension. The ratio is relative to half of the smaller dimension of the frame, consistent with setRoundedCornerRatio.

fun setOffset(
    offsetX: @FloatRange(from = "-1", to = 1) Float,
    offsetY: @FloatRange(from = "-1", to = 1) Float
): CompositionSettings.Builder

Sets the offset.

fun setRoundedCornerRatio(
    roundedCornerRatio: @FloatRange(from = 0, to = 1) Float
): CompositionSettings.Builder

Sets the rounded corner ratio as a normalized value from 0 to 1.

0 means no rounding (sharp corners). 1 means fully rounded (the radius of the rounded corners equals half of the smaller dimension of the frame, making the frame a circle if it's square, or pill-shaped if it's rectangular). Values in between provide partial rounding proportional to half of the smaller dimension of the frame.

fun setScale(scaleX: Float, scaleY: Float): CompositionSettings.Builder

Sets the scale.

fun setZOrder(zOrder: @IntRange(from = 0) Int): CompositionSettings.Builder

Sets the z-order. Larger z-order means rendered later (appears on top). Must be non-negative.