RemoteDp

Artifact: androidx.compose.remote:remote-creation-compose

class RemoteDp : BaseRemoteState

kotlin.Any
↳	androidx.compose.remote.creation.compose.state.BaseRemoteState
	↳	androidx.compose.remote.creation.compose.state.RemoteDp

Represents a Density-independent pixel (Dp) value.

RemoteDp represents a Dp value that can be a constant, a named variable, or a dynamic expression.

Summary

Public companion functions
`RemoteDp`	`createNamedRemoteDp( name: String, defaultValue: Dp, domain: RemoteState.Domain )` Creates a named `RemoteDp` with an initial value.
`RemoteDp`	`createNamedRemoteDp( name: String, domain: RemoteState.Domain, value: () -> RemoteDp )`
`operator RemoteDp`	`invoke(value: Dp)` Creates a `RemoteDp` from a literal `Dp` value.

Public functions
`operator RemoteDp`	`div(other: Float)` Divide a `RemoteDp` by a scalar.
`operator RemoteDp`	`div(other: Int)` Divide a `RemoteDp` by a scalar.
`operator RemoteFloat`	`div(other: RemoteDp)` Divide by another `RemoteDp` to get a scalar.
`operator RemoteDp`	`div(other: RemoteFloat)` Divide a `RemoteDp` by a `RemoteFloat`.
`operator RemoteDp`	`div(other: RemoteInt)` Divide a `RemoteDp` by a `RemoteInt`.
`RemoteBoolean`	`isEqualTo(other: RemoteDp)` Check if this `RemoteDp` is equal to `other`.
`RemoteBoolean`	`isGreaterThan(other: RemoteDp)` Check if this `RemoteDp` is greater than `other`.
`RemoteBoolean`	`isGreaterThanOrEqualTo(other: RemoteDp)` Check if this `RemoteDp` is greater than or equal to `other`.
`RemoteBoolean`	`isLessThan(other: RemoteDp)` Check if this `RemoteDp` is less than `other`.
`RemoteBoolean`	`isLessThanOrEqualTo(other: RemoteDp)` Check if this `RemoteDp` is less than or equal to `other`.
`RemoteBoolean`	`isNotEqualTo(other: RemoteDp)` Check if this `RemoteDp` is not equal to `other`.
`operator RemoteDp`	`minus(other: RemoteDp)` Subtract a `RemoteDp` from another one.
`operator RemoteDp`	`plus(other: RemoteDp)` Add two `RemoteDp`s together.
`operator RemoteDp`	`times(other: Float)` Multiply a `RemoteDp` by a scalar.
`operator RemoteDp`	`times(other: Int)` Multiply a `RemoteDp` by a scalar.
`operator RemoteDp`	`times(other: RemoteFloat)` Multiply a `RemoteDp` by a `RemoteFloat`.
`operator RemoteDp`	`times(other: RemoteInt)` Multiply a `RemoteDp` by a `RemoteInt`.
`RemoteFloat`	`toPx()` Converts a RemoteDp to a RemoteFloat Px using the `RemoteDensity`.
`RemoteFloat`	`toPx(density: RemoteDensity)` Function to convert this `RemoteDp` to a density-independent pixel value.
`operator RemoteDp`	`unaryMinus()` This is the same as multiplying the Dp by -1.0.

Public properties
`open Dp?`	`constantValueOrNull` The constant value or null if there isn't one.

Inherited properties

From androidx.compose.remote.creation.compose.state.RemoteState

`open Dp`	`constantValue` The constant value held by this state.
`open Boolean`	`hasConstantValue` Whether or not this remote state evaluates to a constant value.

Public companion functions

createNamedRemoteDp

Added in 1.0.0-alpha21

fun createNamedRemoteDp(
    name: String,
    defaultValue: Dp,
    domain: RemoteState.Domain = RemoteState.Domain.User
): RemoteDp

Creates a named RemoteDp with an initial value.

Named remote Dps can be set via AndroidRemoteContext.setNamedFloat.

Parameters
`name: String`	A unique name to identify this state within its `domain`.
`defaultValue: Dp`	The initial `Dp` value for the named remote Dp.
`domain: RemoteState.Domain = RemoteState.Domain.User`	The domain for the named state. Defaults to `RemoteState.Domain.User`.

Returns
`RemoteDp`	A `RemoteDp` representing the named Dp.

createNamedRemoteDp

Added in 1.0.0-alpha21

fun createNamedRemoteDp(
    name: String,
    domain: RemoteState.Domain = RemoteState.Domain.User,
    value: () -> RemoteDp
): RemoteDp

invoke

Added in 1.0.0-alpha21

operator fun invoke(value: Dp): RemoteDp

Creates a RemoteDp from a literal Dp value.

Parameters
`value: Dp`	The `Dp` value.

Returns
`RemoteDp`	A `RemoteDp` representing the constant Dp.

Public functions

div

Added in 1.0.0-alpha21

operator fun div(other: Float): RemoteDp

Divide a RemoteDp by a scalar.

div

Added in 1.0.0-alpha21

operator fun div(other: Int): RemoteDp

Divide a RemoteDp by a scalar.

div

Added in 1.0.0-alpha21

operator fun div(other: RemoteDp): RemoteFloat

Divide by another RemoteDp to get a scalar.

div

Added in 1.0.0-alpha21

operator fun div(other: RemoteFloat): RemoteDp

Divide a RemoteDp by a RemoteFloat.

div

Added in 1.0.0-alpha21

operator fun div(other: RemoteInt): RemoteDp

Divide a RemoteDp by a RemoteInt.

isEqualTo

Added in 1.0.0-alpha21

fun isEqualTo(other: RemoteDp): RemoteBoolean

Check if this RemoteDp is equal to other.

isGreaterThan

Added in 1.0.0-alpha21

fun isGreaterThan(other: RemoteDp): RemoteBoolean

Check if this RemoteDp is greater than other.

isGreaterThanOrEqualTo

Added in 1.0.0-alpha21

fun isGreaterThanOrEqualTo(other: RemoteDp): RemoteBoolean

Check if this RemoteDp is greater than or equal to other.

isLessThan

Added in 1.0.0-alpha21

fun isLessThan(other: RemoteDp): RemoteBoolean

Check if this RemoteDp is less than other.

isLessThanOrEqualTo

Added in 1.0.0-alpha21

fun isLessThanOrEqualTo(other: RemoteDp): RemoteBoolean

Check if this RemoteDp is less than or equal to other.

isNotEqualTo

Added in 1.0.0-alpha21

fun isNotEqualTo(other: RemoteDp): RemoteBoolean

Check if this RemoteDp is not equal to other.

minus

Added in 1.0.0-alpha21

operator fun minus(other: RemoteDp): RemoteDp

Subtract a RemoteDp from another one.

plus

Added in 1.0.0-alpha21

operator fun plus(other: RemoteDp): RemoteDp

Add two RemoteDps together.

times

Added in 1.0.0-alpha21

operator fun times(other: Float): RemoteDp

Multiply a RemoteDp by a scalar.

times

Added in 1.0.0-alpha21

operator fun times(other: Int): RemoteDp

Multiply a RemoteDp by a scalar.

times

Added in 1.0.0-alpha21

operator fun times(other: RemoteFloat): RemoteDp

Multiply a RemoteDp by a RemoteFloat.

times

Added in 1.0.0-alpha21

operator fun times(other: RemoteInt): RemoteDp

Multiply a RemoteDp by a RemoteInt.

toPx

Added in 1.0.0-alpha21

fun toPx(): RemoteFloat

Converts a RemoteDp to a RemoteFloat Px using the RemoteDensity.

toPx

Added in 1.0.0-alpha21

fun toPx(density: RemoteDensity): RemoteFloat

Function to convert this RemoteDp to a density-independent pixel value. It multiplies the current float value by the screen\'s density.

unaryMinus

Added in 1.0.0-alpha21

operator fun unaryMinus(): RemoteDp

This is the same as multiplying the Dp by -1.0.

Public properties

constantValueOrNull

open val constantValueOrNull: Dp?

The constant value or null if there isn't one.