Struct Pixels 

pub struct Pixels(/* private fields */);

A length in logical pixels, GPUI’s unit for layout, painting and input.

The platform converts logical pixels to device pixels using the display’s scale factor. Thus px(10.) becomes 20 device pixels at scale factor 2. Styles, element bounds, Point and Size values in the UI use Pixels.

GPUI has three pixel types, and they differ in what the number counts:

• Pixels is a logical length. Its value is an f32, so fractions are kept.
• ScaledPixels is a logical length multiplied by the scale factor, from Pixels::scale. It is still an f32 and isn’t rounded. Paint primitives in the scene are in scaled pixels.
• DevicePixels is a whole number of physical pixels on the display. Convert to it with Size::to_device_pixels or Bounds::to_device_pixels, which round each component to the nearest pixel.

Create a Pixels with px or Pixels::from. It supports addition and subtraction with other Pixels, multiplication and division by an f32, and division by another Pixels, which gives a plain f32 ratio.

Examples

use gpui::{Pixels, ScaledPixels, px};

let length = Pixels::from(10.0);
let scaled_length = length.scale(2.0);
assert_eq!(scaled_length, ScaledPixels::from(20.0));
assert_eq!(px(10.) / px(4.), 2.5);

Implementations

impl Pixels

pub const ZERO: Pixels

A length of zero pixels.

pub const MAX: Pixels

The largest finite value that Pixels can hold.

pub const MIN: Pixels

The smallest finite value that Pixels can hold.

pub fn as_f32(self) -> f32

Returns the raw f32 value.

pub fn floor(&self) -> Self

Returns the largest whole number of pixels that is less than or equal to this value.

Examples

assert_eq!(px(2.7).floor(), px(2.));
assert_eq!(px(-2.3).floor(), px(-3.));

pub fn round(&self) -> Self

Returns this value rounded to the nearest whole pixel. Halfway values round away from zero.

Examples

assert_eq!(px(2.4).round(), px(2.));
assert_eq!(px(2.5).round(), px(3.));

pub fn ceil(&self) -> Self

Returns the smallest whole number of pixels that is greater than or equal to this value.

Examples

assert_eq!(px(2.1).ceil(), px(3.));
assert_eq!(px(-2.7).ceil(), px(-2.));

pub fn scale(&self, factor: f32) -> ScaledPixels

Multiplies this value by factor, producing ScaledPixels.

Pass the display’s scale factor, such as 2.0 on a Retina display. The result isn’t rounded.

Examples

assert_eq!(px(10.).scale(1.5), ScaledPixels::from(15.));

pub fn pow(&self, exponent: f32) -> Self

Raises this value to the power exponent.

Examples

assert_eq!(px(3.).pow(2.), px(9.));

pub fn abs(&self) -> Self

Returns the absolute value.

Examples

assert_eq!(px(-3.).abs(), px(3.));

pub fn signum(&self) -> f32

Returns 1.0 for positive values and +0.0, and -1.0 for negative values and -0.0.

The sign is a plain f32, not Pixels.

Examples

assert_eq!(px(-3.).signum(), -1.0);
assert_eq!(px(3.).signum(), 1.0);

pub fn to_f64(self) -> f64

Returns the value as an f64.

Examples

assert_eq!(px(1.5).to_f64(), 1.5);

Trait Implementations

impl Add for Pixels

type Output = Pixels

The resulting type after applying the + operator.

fn add(self, __rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Pixels

fn add_assign(&mut self, __rhs: Self)

Performs the += operation.

impl Clone for Pixels

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Pixels

impl Debug for Pixels

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

Formats the value using the given formatter.

impl Default for Pixels

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Pixels

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Pixels

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

Formats the value using the given formatter.

impl Div for Pixels

type Output = f32

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<__derive_more_Rhs> Div<__derive_more_Rhs> for Pixels

where f32: Div<__derive_more_Rhs, Output = f32>,

type Output = Pixels

The resulting type after applying the / operator.

fn div(self, __rhs: __derive_more_Rhs) -> Self::Output

Performs the / operation.

impl DivAssign for Pixels

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<__derive_more_Rhs> DivAssign<__derive_more_Rhs> for Pixels

where f32: DivAssign<__derive_more_Rhs>,

fn div_assign(&mut self, __rhs: __derive_more_Rhs)

Performs the /= operation.

impl Eq for Pixels

impl From<&Pixels> for f32

fn from(pixels: &Pixels) -> Self

Converts to this type from the input type.

impl From<&Pixels> for u32

fn from(pixels: &Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for Edges<Pixels>

fn from(val: Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for Corners<Pixels>

fn from(val: Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for f32

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for f64

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for u32

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for usize

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for AbsoluteLength

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for DefiniteLength

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for Length

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.

impl From<Pixels> for AvailableSpace

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.

impl From<f32> for Pixels

fn from(pixels: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Pixels

fn from(pixels: f64) -> Self

Converts to this type from the input type.

impl From<u32> for Pixels

fn from(pixels: u32) -> Self

Converts to this type from the input type.

impl From<usize> for Pixels

fn from(pixels: usize) -> Self

Converts to this type from the input type.

impl Half for Pixels

fn half(&self) -> Self

Returns half of this value.

impl Hash for Pixels

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

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 Interpolate for Pixels

fn interpolate(from: Self, to: Self, phase: f32) -> Self

Returns the value at phase, where 0.0 is from and 1.0 is to.

impl IsZero for Pixels

fn is_zero(&self) -> bool

Returns true if this value is zero.

impl JsonSchema for Pixels

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Lerp for Pixels

fn lerp(&self, to: &Self, delta: f32) -> Self

Returns the value delta of the way from self to to.

impl Mul<Pixels> for f32

type Output = Pixels

The resulting type after applying the * operator.

fn mul(self, rhs: Pixels) -> Self::Output

Performs the * operation.

impl Mul<Pixels> for usize

type Output = Pixels

The resulting type after applying the * operator.

fn mul(self, rhs: Pixels) -> Pixels

Performs the * operation.

impl Mul<Pixels> for Rems

type Output = Pixels

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Pixels

type Output = Pixels

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self

Performs the * operation.

impl Mul<usize> for Pixels

type Output = Pixels

The resulting type after applying the * operator.

fn mul(self, rhs: usize) -> Self

Performs the * operation.

impl MulAssign<f32> for Pixels

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Pixels

type Output = Pixels

The resulting type after applying the - operator.

fn neg(self) -> Pixels

Performs the unary - operation.

impl Ord for Pixels

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Pixels

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Pixels

fn partial_cmp(&self, other: &Self) -> 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 Rem for Pixels

type Output = Pixels

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self

Performs the % operation.

impl RemAssign for Pixels

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Serialize for Pixels

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SpringTarget for Pixels

type Output = Pixels

The value that the spring animator receives.

fn target(&self) -> f32

Returns this target as a coordinate for the spring.

fn resolve(&self, value: f32) -> Self::Output

Converts a spring coordinate into the output the animator receives.

impl StructuralPartialEq for Pixels

impl Sub for Pixels

type Output = Pixels

The resulting type after applying the - operator.

fn sub(self, __rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Pixels

fn sub_assign(&mut self, __rhs: Self)

Performs the -= operation.

impl Sum for Pixels

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<'a> Sum<&'a Pixels> for Pixels

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<&str> for Pixels

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.