Enum ElevationIndex 

pub enum ElevationIndex {
    Background,
    Surface,
    EditorSurface,
    ElevatedSurface,
    ModalSurface,
}

Today, elevation is primarily used to add shadows to elements, and set the correct background for elements like buttons.

Elevation can be thought of as the physical closeness of an element to the user. Elements with lower elevations are physically further away on the z-axis and appear to be underneath elements with higher elevations.

In the future, a more complete approach to elevation may be added.

Variants

Background

On the layer of the app background. This is under panels, panes, and other surfaces.

Surface

The primary surface – Contains panels, panes, containers, etc.

EditorSurface

The same elevation as the primary surface, but used for the editable areas, like buffers

ElevatedSurface

A surface that is elevated above the primary surface. but below washes, models, and dragged elements.

ModalSurface

A surface above the ElevationIndex::ElevatedSurface that is used for dialogs, alerts, modals, etc.

Implementations

impl ElevationIndex

pub fn shadow(self, cx: &App) -> Vec<BoxShadow>

Returns an appropriate shadow for the given elevation index.

pub fn bg(&self, cx: &mut App) -> Hsla

Returns the background color for the given elevation index.

pub fn on_elevation_bg(&self, cx: &App) -> Hsla

Returns a color that is appropriate a filled element on this elevation

pub fn darker_bg(&self, cx: &App) -> Hsla

Attempts to return a darker background color than the current elevation index’s background.

If the current background color is already dark, it will return a lighter color instead.

Trait Implementations

impl Clone for ElevationIndex

fn clone(&self) -> ElevationIndex

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ElevationIndex

impl Debug for ElevationIndex

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ElevationIndex

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ElevationIndex

impl PartialEq for ElevationIndex

fn eq(&self, other: &ElevationIndex) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ElevationIndex