djkato/egui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs

Browse source
This commit is contained in:
charburgx 2022-12-19 04:27:52 -06:00
parent 191cc70362
commit 3c2e669fe1
1 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
crates/egui/src/layers.rs
View file

@ -113,6 +113,8 @@ impl AreaLayerId {
} }
} }
/// Represents the relative order an element should be displayed
/// Lower values render first, and therefore appear below higher values
#[derive(Clone, Copy, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)] #[derive(Clone, Copy, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))] #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct ZOrder(pub i32); pub struct ZOrder(pub i32);
@ -140,20 +142,22 @@ impl ZOrder {
Self::BELOW_ALL Self::BELOW_ALL
} }
/// Above by one level /// Directly above
pub fn above(self) -> Self { pub fn above(self) -> Self {
self.above_by(1) self.above_by(1)
} }
/// Below by one level /// Directly below
pub fn below(self) -> Self { pub fn below(self) -> Self {
self.below_by(1) self.below_by(1)
} }
/// Above by the number of levels given
pub fn above_by(self, levels: i32) -> Self { pub fn above_by(self, levels: i32) -> Self {
Self(self.0.saturating_add(levels)) Self(self.0.saturating_add(levels))
} }
/// Below by the number of levels given
pub fn below_by(self, levels: i32) -> Self { pub fn below_by(self, levels: i32) -> Self {
Self(self.0.saturating_sub(levels)) Self(self.0.saturating_sub(levels))
} }
@ -166,6 +170,10 @@ impl Default for ZOrder {
} }
/// An identifier for a paint layer which supports Z-indexing /// An identifier for a paint layer which supports Z-indexing
///
/// This says: draw on `area_layer` with index z. This only affects the display
/// order of elements on the same area layer. Order of area layers still takes
/// precedence over z-index.
#[derive(Clone, Copy, Debug, Hash, Eq, PartialEq)] #[derive(Clone, Copy, Debug, Hash, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))] #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct ZLayer { pub struct ZLayer {
@ -181,6 +189,7 @@ impl ZLayer {
} }
} }
/// Use specified Z-level
pub fn from_area_layer_z(area_layer: AreaLayerId, z: ZOrder) -> Self { pub fn from_area_layer_z(area_layer: AreaLayerId, z: ZOrder) -> Self {
Self { area_layer, z } Self { area_layer, z }
} }
@ -203,33 +212,37 @@ impl ZLayer {
Self::from_area_layer_z(self.area_layer, z) Self::from_area_layer_z(self.area_layer, z)
} }
/// Above by one level /// Get the `ZLayer` directly above this one
#[must_use] #[must_use]
pub fn above(self) -> Self { pub fn above(self) -> Self {
self.with_z(self.z.above()) self.with_z(self.z.above())
} }
/// Get the `ZLayer` above this one by `levels` levels
#[must_use] #[must_use]
pub fn above_by(self, levels: i32) -> Self { pub fn above_by(self, levels: i32) -> Self {
self.with_z(self.z.above_by(levels)) self.with_z(self.z.above_by(levels))
} }
/// Below one level /// Get the `ZLayer` directly below this one
#[must_use] #[must_use]
pub fn below(self) -> Self { pub fn below(self) -> Self {
self.with_z(self.z.below()) self.with_z(self.z.below())
} }
/// Get the `ZLayer` below this one by `levels` levels
#[must_use] #[must_use]
pub fn below_by(self, levels: i32) -> Self { pub fn below_by(self, levels: i32) -> Self {
self.with_z(self.z.below_by(levels)) self.with_z(self.z.below_by(levels))
} }
/// `Id` of underlying area layer
#[inline(always)] #[inline(always)]
pub fn id(&self) -> Id { pub fn id(&self) -> Id {
self.area_layer.id self.area_layer.id
} }
/// `Order` of underlying area layer
#[inline(always)] #[inline(always)]
pub fn order(&self) -> Order { pub fn order(&self) -> Order {
self.area_layer.order self.area_layer.order