Skip to main content

Dp

Struct Dp 

Source
#[repr(transparent)]
pub struct Dp(pub f32);
Expand description

Density-independent pixels. Authoring APIs (Modifier, layout) take this.

Compose parity (Dp.kt): value class, Hairline/Infinity/Unspecified, isSpecified, arithmetic, coerce*, lerp.

Tuple Fields§

§0: f32

Implementations§

Source§

impl Dp

Source

pub const ZERO: Dp

Source

pub const HAIRLINE: Dp

Compose Dp.Hairline (0.dp: takes no space, draws 1 px).

Source

pub const INFINITY: Dp

Source

pub const UNSPECIFIED: Dp

Compose Dp.Unspecified (NaN sentinel).

Source

pub const fn from_px_raw(v: f32) -> Dp

Source

pub const fn value(self) -> f32

Raw value in dp.

Source

pub fn is_specified(self) -> bool

false for Dp::UNSPECIFIED.

Source

pub fn is_unspecified(self) -> bool

true for Dp::UNSPECIFIED.

Source

pub fn take_or_else(self, block: impl FnOnce() -> Dp) -> Dp

Return self if specified, else block(). (Compose takeOrElse.)

Source

pub fn is_finite(self) -> bool

Source

pub fn abs(self) -> Dp

Absolute value (mirrors f32::abs).

Source

pub fn min(self, other: Dp) -> Dp

Minimum of two Dps (mirrors f32::min).

Source

pub fn max(self, other: Dp) -> Dp

Maximum of two Dps (mirrors f32::max).

Source

pub fn clamp(self, min: Dp, max: Dp) -> Dp

Clamp within [min, max] (mirrors f32::clamp).

Source

pub fn coerce_in(self, min: Dp, max: Dp) -> Dp

Source

pub fn coerce_at_least(self, min: Dp) -> Dp

Source

pub fn coerce_at_most(self, max: Dp) -> Dp

Source

pub fn to_px(self) -> Px

Convert to physical pixels with the ambient Density * UiScale.

Source

pub fn to_px_with_scale(self, scale: f32) -> Px

Convert to physical pixels with an explicit scale.

Source

pub fn round_to_px(self) -> i32

Round to whole pixels with the ambient scale (Compose roundToPx).

Source

pub fn to_sp(self) -> Sp

Compose FontScalingLinear.Dp.toSp: value / fontScale.

Source

pub fn to_bits(self) -> u32

Normalized bits for hashing / scope! inputs (like f32::to_bits, with -0.0/NaN normalized).

Trait Implementations§

Source§

impl Add for Dp

Source§

type Output = Dp

The resulting type after applying the + operator.
Source§

fn add(self, other: Dp) -> Dp

Performs the + operation. Read more
Source§

impl Clone for Dp

Source§

fn clone(&self) -> Dp

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Dp

Source§

impl Debug for Dp

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Dp

Source§

fn default() -> Dp

Returns the “default value” for a type. Read more
Source§

impl Display for Dp

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Div for Dp

Divide by another Dp to get a scalar (Compose Dp.div(Dp): Float).

Source§

type Output = f32

The resulting type after applying the / operator.
Source§

fn div(self, other: Dp) -> f32

Performs the / operation. Read more
Source§

impl Div<f32> for Dp

Source§

type Output = Dp

The resulting type after applying the / operator.
Source§

fn div(self, other: f32) -> Dp

Performs the / operation. Read more
Source§

impl From<Dp> for f32

Source§

fn from(v: Dp) -> Self

Converts to this type from the input type.
Source§

impl From<f32> for Dp

Standard conversions so generic code can use .into(). Setters intentionally keep taking Dp/Sp directly (no impl Into<Dp> params) so call sites stay explicit: 16.dp() or Dp(16.0).

Source§

fn from(v: f32) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for Dp

Source§

fn from(v: f64) -> Self

Converts to this type from the input type.
Source§

impl From<i32> for Dp

Source§

fn from(v: i32) -> Self

Converts to this type from the input type.
Source§

impl From<u32> for Dp

Source§

fn from(v: u32) -> Self

Converts to this type from the input type.
Source§

impl Hash for Dp

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Mul<Dp> for f32

Source§

type Output = Dp

The resulting type after applying the * operator.
Source§

fn mul(self, other: Dp) -> Dp

Performs the * operation. Read more
Source§

impl Mul<f32> for Dp

Source§

type Output = Dp

The resulting type after applying the * operator.
Source§

fn mul(self, other: f32) -> Dp

Performs the * operation. Read more
Source§

impl Neg for Dp

Source§

type Output = Dp

The resulting type after applying the - operator.
Source§

fn neg(self) -> Dp

Performs the unary - operation. Read more
Source§

impl PartialEq for Dp

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Dp

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Dp

Source§

impl Sub for Dp

Source§

type Output = Dp

The resulting type after applying the - operator.
Source§

fn sub(self, other: Dp) -> Dp

Performs the - operation. Read more

Auto Trait Implementations§

§

impl Freeze for Dp

§

impl RefUnwindSafe for Dp

§

impl Send for Dp

§

impl Sync for Dp

§

impl Unpin for Dp

§

impl UnsafeUnpin for Dp

§

impl UnwindSafe for Dp

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.