Struct ZIndex

pub struct ZIndex(pub u32);

Position of a widget inside an UiNodeList render operation.

When two widgets have the same index their logical position defines the render order.

Examples

Create a Z-index that causes the widget to render in front of all siblings that don’t set Z-index.

let highlight_z = ZIndex::DEFAULT + 1;

Tuple Fields

0: u32

Implementations

impl ZIndex

pub const BACK: ZIndex = _

Widget is rendered first causing all overlapping siblings to render on top of it.

The value is 0.

pub const DEFAULT: ZIndex = _

Z-index of widgets that don’t set the index.

The value is u32::MAX / 2.

pub const FRONT: ZIndex = _

Widget is rendered after all siblings causing it to render on top.

pub fn saturating_add(self, other: impl Into<ZIndex>) -> ZIndex

Computes other above self, caps at FRONT.

This is the default ZIndex addition, equivalent to self + other.

pub fn saturating_sub(self, other: impl Into<ZIndex>) -> ZIndex

Computes other below self, stops at BACK.

This is the default ZIndex subtraction, equivalent to self - other.

Trait Implementations

impl<Z> Add<Z> for ZIndex

where Z: Into<ZIndex>,

type Output = ZIndex

The resulting type after applying the + operator.

fn add(self, rhs: Z) -> <ZIndex as Add<Z>>::Output

Performs the + operation.

impl<Z> AddAssign<Z> for ZIndex

where Z: Into<ZIndex>,

fn add_assign(&mut self, rhs: Z)

Performs the += operation.

impl Clone for ZIndex

fn clone(&self) -> ZIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZIndex

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

Formats the value using the given formatter.

impl Default for ZIndex

fn default() -> ZIndex

Returns the “default value” for a type.

impl Div<Factor> for ZIndex

type Output = ZIndex

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> <ZIndex as Div<Factor>>::Output

Performs the / operation.

impl DivAssign<Factor> for ZIndex

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl From<u32> for ZIndex

fn from(index: u32) -> ZIndex

Converts to this type from the input type.

impl Hash for ZIndex

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoVar<ZIndex> for u32

type Var = LocalVar<ZIndex>

Variable type that will wrap the T value.

fn into_var(self) -> <u32 as IntoVar<ZIndex>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl Mul<Factor> for ZIndex

type Output = ZIndex

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> <ZIndex as Mul<Factor>>::Output

Performs the * operation.

impl MulAssign<Factor> for ZIndex

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl Ord for ZIndex

fn cmp(&self, other: &ZIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ZIndex

fn eq(&self, other: &ZIndex) -> 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 PartialOrd for ZIndex

fn partial_cmp(&self, other: &ZIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Z> Sub<Z> for ZIndex

where Z: Into<ZIndex>,

type Output = ZIndex

The resulting type after applying the - operator.

fn sub(self, rhs: Z) -> <ZIndex as Sub<Z>>::Output

Performs the - operation.

impl<Z> SubAssign<Z> for ZIndex

where Z: Into<ZIndex>,

fn sub_assign(&mut self, rhs: Z)

Performs the -= operation.

impl Transitionable for ZIndex

fn lerp(self, to: &ZIndex, step: Factor) -> ZIndex

Sample the linear interpolation from self -> to by step.

impl Copy for ZIndex

impl Eq for ZIndex

impl IntoValue<ZIndex> for u32

impl StructuralPartialEq for ZIndex