RemoteColor

public open class RemoteColor
internal constructor(
    @get:Suppress("AutoBoxing") public override val constantValueOrNull: Color?,
    internal override val cacheKey: RemoteStateCacheKey,
    alpha: RemoteFloat?,
    red: RemoteFloat?,
    green: RemoteFloat?,
    blue: RemoteFloat?,
    internal val idProvider: (creationState: RemoteComposeCreationState) -> Int,
) : BaseRemoteState<Color>()

Represents a color that can be used with canvas APIs.

RemoteColor represents a color value that can be a constant, a named variable, or a dynamic expression (e.g., a color interpolation).

Secondary Constructors

@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public constructor(
    alpha: RemoteFloat,
    red: RemoteFloat,
    green: RemoteFloat,
    blue: RemoteFloat,
) : this(
    constantValueOrNull = constantColorOrNull(alpha, red, green, blue),
    alpha = alpha,
    red = red,
    green = green,
    blue = blue,
    cacheKey = RemoteOperationCacheKey.create(OperationKey.FromArgb, alpha, red, green, blue),
    idProvider = { creationState ->
        creationState.getOrPutVariableId(
            RemoteOperationCacheKey.create(OperationKey.FromArgb, alpha, red, green, blue)
        ) {
            creationState.document
                .addColorExpression(
                    alpha.getFloatIdForCreationState(creationState),
                    red.getFloatIdForCreationState(creationState),
                    green.getFloatIdForCreationState(creationState),
                    blue.getFloatIdForCreationState(creationState),
                )
                .toInt()
        }
    },
)

internal constructor(
    cacheKey: RemoteStateCacheKey,
    idProvider: (creationState: RemoteComposeCreationState) -> Int,
) : this(
    constantValueOrNull = null,
    cacheKey = cacheKey,
    alpha = null,
    red = null,
    green = null,
    blue = null,
    idProvider = idProvider,
)

@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public constructor(
    color: Color
) : this(
    constantValueOrNull = color,
    alpha = color.alpha.rf,
    red = color.red.rf,
    green = color.green.rf,
    blue = color.blue.rf,
    cacheKey = RemoteConstantCacheKey(color.toArgb()),
    idProvider = { creationState -> creationState.document.addColor(color.toArgb()) },
)

Constructor for creating a RemoteColor from a Color value. This creates a constant remote color that is added to the remote document.

Parameters

@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public constructor(@ColorInt color: Int) : this(Color(color))

Constructor for creating a RemoteColor from a direct ARGB integer color value. This creates a constant remote color that is added to the remote document.

Parameters

Properties

alpha

public val alpha: RemoteFloat

Returns a RemoteFloat that evaluates to the alpha of this RemoteColor in the range [0..1].

red

public val red: RemoteFloat

Returns a RemoteFloat that evaluates to the red of this RemoteColor in the range [0..1].

green

public val green: RemoteFloat

Returns a RemoteFloat that evaluates to the green of this RemoteColor in the range [0..1].

blue

public val blue: RemoteFloat

Returns a RemoteFloat that evaluates to the blue of this RemoteColor in the range [0..1].

hue

public val hue: RemoteFloat

Returns a RemoteFloat that evaluates to the hue of this RemoteColor in the range [0..1].

saturation

public val saturation: RemoteFloat

Returns a RemoteFloat that evaluates to the saturation of this RemoteColor in the range [0..1].

brightness

public val brightness: RemoteFloat

Returns a RemoteFloat that evaluates to the brightness of this RemoteColor in the range [0..1].

Functions

times

@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public operator fun times(other: RemoteColor): RemoteColor

Computes the pairwise product of this RemoteColor with other.

Parameters

Returns

copy

public fun copy(
        alpha: RemoteFloat? = null,
        red: RemoteFloat? = null,
        green: RemoteFloat? = null,
        blue: RemoteFloat? = null,
    ): RemoteColor

Creates a copy of this RemoteColor with the ability to override individual ARGB components. If a component is not specified, it defaults to the corresponding component of the original RemoteColor.

Parameters

Returns

Companion Object

Methods

public operator fun invoke(value: Color): RemoteColor

Creates a RemoteColor from a literal Color value.

Parameters

Returns

@JvmStatic
public fun createNamedRemoteColor(
    name: String,
    defaultValue: Color,
    domain: RemoteState.Domain = RemoteState.Domain.User,
): RemoteColor

Creates a named RemoteColor with an initial value.

Named remote colors can be set via AndroidRemoteContext.setNamedColor.

Parameters

Returns

public fun hsv(
            hue: RemoteFloat,
            saturation: RemoteFloat,
            value: RemoteFloat,
            alpha: RemoteFloat = 1.rf,
        ): RemoteColor

Creates a RemoteColor from remote hue, saturation, and value (brightness) components. The resulting color is expressed as a RemoteColor expression that combines these inputs.

Parameters

Returns

@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public fun fromAHSV(
    alpha: Int,
    hue: RemoteFloat,
    saturation: RemoteFloat,
    value: RemoteFloat,
): RemoteColor

Creates a RemoteColor from a fixed alpha value and remote hue, saturation, and value (brightness) components. This allows creating a remote color with a constant opacity and dynamic HSV.

Parameters

Returns

public fun rgb(
            red: RemoteFloat,
            green: RemoteFloat,
            blue: RemoteFloat,
            alpha: RemoteFloat = 1.rf,
        ): RemoteColor

Creates a RemoteColor from remote alpha, red, green, and blue components.

Parameters

Returns

@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public fun rgb(alpha: Float, red: Float, green: Float, blue: Float): RemoteColor

Creates a RemoteColor from alpha, red, green, and blue components.

Parameters

Returns