DepthEffect


class DepthEffect


The depth effect establishes a sense of hierarchy by using shadows to occlude content underneath. It consists of two shadow layers, layer1 and layer2. layer2 is drawn on top of layer1:

 _________________
|    _________    |
|   | content |   |
|   |_________|   |
|   ___________   |
|  |  layer 2  |  |
|  |___________|  |
|  _____________  |
| |   layer 1   | |
| |_____________| |
|_________________|

GlimmerTheme.depthEffectLevels provides theme defined depth effect levels that should be used to add depth to surfaces.

Higher level components apply the depth effect automatically when needed. The depth effect can also be configured through surface. To manually render depth shadows for advanced use-cases, see the depthEffect.

Summary

Public constructors

DepthEffect(layer1: Shadow, layer2: Shadow)

Public functions

open operator Boolean
equals(other: Any?)
open Int

Public properties

Shadow

the 'base' Shadow layer, drawn first

Shadow

the second Shadow layer, drawn on top of layer1

Public constructors

DepthEffect

Added in 1.0.0-alpha09
DepthEffect(layer1: Shadow, layer2: Shadow)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

layer1

Added in 1.0.0-alpha09
val layer1Shadow

the 'base' Shadow layer, drawn first

layer2

Added in 1.0.0-alpha09
val layer2Shadow

the second Shadow layer, drawn on top of layer1