DepthEffectLevels


public final class DepthEffectLevels


Jetpack Compose Glimmer components can use DepthEffect to establish a sense of hierarchy. DepthEffectLevels contains different levels of DepthEffect to express this hierarchy. Higher levels contain larger shadows, and represent components with a higher z-order than lower levels. In their baseline state (not focused) most components should have no (null) DepthEffect.

Summary

Public constructors

DepthEffectLevels(
    @NonNull DepthEffect level1,
    @NonNull DepthEffect level2,
    @NonNull DepthEffect level3,
    @NonNull DepthEffect level4,
    @NonNull DepthEffect level5
)

Public methods

boolean
equals(Object other)
final @NonNull DepthEffect

the lowest level of DepthEffect.

final @NonNull DepthEffect

a level of DepthEffect higher than level1 and lower than level3.

final @NonNull DepthEffect

a level of DepthEffect higher than level2 and lower than level4.

final @NonNull DepthEffect

a level of DepthEffect higher than level3 and lower than level5.

final @NonNull DepthEffect

the highest level of DepthEffect.

int
@NonNull String

Public constructors

DepthEffectLevels

Added in 1.0.0-alpha09
public DepthEffectLevels(
    @NonNull DepthEffect level1,
    @NonNull DepthEffect level2,
    @NonNull DepthEffect level3,
    @NonNull DepthEffect level4,
    @NonNull DepthEffect level5
)

Public methods

equals

public boolean equals(Object other)

getLevel1

Added in 1.0.0-alpha09
public final @NonNull DepthEffect getLevel1()

the lowest level of DepthEffect. This level will have the smallest shadows.

getLevel2

Added in 1.0.0-alpha09
public final @NonNull DepthEffect getLevel2()

a level of DepthEffect higher than level1 and lower than level3.

getLevel3

Added in 1.0.0-alpha09
public final @NonNull DepthEffect getLevel3()

a level of DepthEffect higher than level2 and lower than level4.

getLevel4

Added in 1.0.0-alpha09
public final @NonNull DepthEffect getLevel4()

a level of DepthEffect higher than level3 and lower than level5.

getLevel5

Added in 1.0.0-alpha09
public final @NonNull DepthEffect getLevel5()

the highest level of DepthEffect. This level will have the largest shadows.

hashCode

public int hashCode()

toString

public @NonNull String toString()