{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

DpOffset

value public final class DpOffset


A two-dimensional offset using Dp for units

Summary

Nested types

public static class DpOffset.Companion

Public methods

final @NonNull DpOffset
copy(@NonNull Dp x, @NonNull Dp y)

Returns a copy of this DpOffset instance optionally overriding the x or y parameter

final @NonNull Dp

The horizontal aspect of the offset in Dp

final @NonNull Dp

The vertical aspect of the offset in Dp

final @NonNull DpOffset

Subtract a DpOffset from another one.

final @NonNull DpOffset

Add a DpOffset to another one.

@NonNull String

Extension functions

final boolean

false when this is DpOffset.Unspecified.

final boolean

true when this is DpOffset.Unspecified.

final @NonNull DpOffset
DpKt.takeOrElse(
    @NonNull DpOffset receiver,
    @NonNull Function0<@NonNull DpOffset> block
)

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

Public methods

copy

public final @NonNull DpOffset copy(@NonNull Dp x, @NonNull Dp y)

Returns a copy of this DpOffset instance optionally overriding the x or y parameter

getX

public final @NonNull Dp getX()

The horizontal aspect of the offset in Dp

getY

public final @NonNull Dp getY()

The vertical aspect of the offset in Dp

minus

public final @NonNull DpOffset minus(@NonNull DpOffset other)

Subtract a DpOffset from another one.

plus

public final @NonNull DpOffset plus(@NonNull DpOffset other)

Add a DpOffset to another one.

toString

public @NonNull String toString()

Extension functions

DpKt.isSpecified

public final boolean DpKt.isSpecified(@NonNull DpOffset receiver)

false when this is DpOffset.Unspecified.

DpKt.isUnspecified

public final boolean DpKt.isUnspecified(@NonNull DpOffset receiver)

true when this is DpOffset.Unspecified.

DpKt.takeOrElse

public final @NonNull DpOffset DpKt.takeOrElse(
    @NonNull DpOffset receiver,
    @NonNull Function0<@NonNull DpOffset> block
)

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