Struct Pixels 

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

Represents a length in pixels, the base unit of measurement in the UI framework.

Pixels is a value type that represents an absolute length in pixels, which is used for specifying sizes, positions, and distances in the UI. It is the fundamental unit of measurement for all visual elements and layout calculations.

The inner value is an f32, allowing for sub-pixel precision which can be useful for anti-aliasing and animations. However, when applied to actual pixel grids, the value is typically rounded to the nearest integer.

Examples

use gpui::{Pixels, ScaledPixels};

// Define a length of 10 pixels
let length = Pixels::from(10.0);

// Define a length and scale it by a factor of 2
let scaled_length = length.scale(2.0);
assert_eq!(scaled_length, ScaledPixels::from(20.0));

Implementations

impl Pixels

pub const ZERO: Pixels

Represents zero pixels.

pub const MAX: Pixels

The maximum value that can be represented by Pixels.

pub const MIN: Pixels

The minimum value that can be represented by Pixels.

pub fn as_f32(self) -> f32

Returns the raw f32 value of this Pixels.

pub fn floor(&self) -> Pixels

Floors the Pixels value to the nearest whole number.

Returns

Returns a new Pixels instance with the floored value.

pub fn round(&self) -> Pixels

Rounds the Pixels value to the nearest whole number.

Returns

Returns a new Pixels instance with the rounded value.

pub fn ceil(&self) -> Pixels

Returns the ceiling of the Pixels value to the nearest whole number.

Returns

Returns a new Pixels instance with the ceiling value.

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

Scales the Pixels value by a given factor, producing ScaledPixels.

This method is used when adjusting pixel values for display scaling factors, such as high DPI (dots per inch) or Retina displays, where the pixel density is higher and thus requires scaling to maintain visual consistency and readability.

The resulting ScaledPixels represent the scaled value which can be used for rendering calculations where display scaling is considered.

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

Raises the Pixels value to a given power.

Arguments

• exponent - The exponent to raise the Pixels value by.

Returns

Returns a new Pixels instance with the value raised to the given exponent.

pub fn abs(&self) -> Pixels

Returns the absolute value of the Pixels.

Returns

A new Pixels instance with the absolute value of the original Pixels.

pub fn signum(&self) -> f32

Returns the sign of the Pixels value.

Returns

Returns:

• 1.0 if the value is positive
• -1.0 if the value is negative

pub fn to_f64(self) -> f64

Returns the f64 value of Pixels.

Returns

A f64 value of the Pixels.

Trait Implementations

impl Add for Pixels

type Output = Pixels

The resulting type after applying the + operator.

fn add(self, __rhs: Pixels) -> <Pixels as Add>::Output

Performs the + operation.

impl AddAssign for Pixels

fn add_assign(&mut self, __rhs: Pixels)

Performs the += operation.

impl Clone for Pixels

fn clone(&self) -> Pixels

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<(), Error>

Formats the value using the given formatter.

impl Default for Pixels

fn default() -> Pixels

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Pixels, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Pixels

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

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: Pixels) -> <Pixels as Div>::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, ) -> <Pixels as Div<__derive_more_Rhs>>::Output

Performs the / operation.

impl DivAssign for Pixels

fn div_assign(&mut self, rhs: Pixels)

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 Edges<Pixels>

fn from(val: Pixels) -> Edges<Pixels>

Converts to this type from the input type.

impl From<Pixels> for Corners<Pixels>

fn from(val: Pixels) -> Corners<Pixels>

Converts to this type from the input type.

impl From<Pixels> for AbsoluteLength

fn from(pixels: Pixels) -> AbsoluteLength

Converts to this type from the input type.

impl From<Pixels> for DefiniteLength

fn from(pixels: Pixels) -> DefiniteLength

Converts to this type from the input type.

impl From<Pixels> for Length

fn from(pixels: Pixels) -> Length

Converts to this type from the input type.

impl From<Pixels> for AvailableSpace

fn from(pixels: Pixels) -> AvailableSpace

Converts to this type from the input type.

impl From<f32> for Pixels

fn from(pixels: f32) -> Pixels

Converts to this type from the input type.

impl From<f64> for Pixels

fn from(pixels: f64) -> Pixels

Converts to this type from the input type.

impl From<u32> for Pixels

fn from(pixels: u32) -> Pixels

Converts to this type from the input type.

impl From<usize> for Pixels

fn from(pixels: usize) -> Pixels

Converts to this type from the input type.

impl Half for Pixels

fn half(&self) -> Pixels

Returns half of the current value.

impl Hash for Pixels

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

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

Resolves the value at phase, where 0 is from and 1 is to.

impl IsZero for Pixels

fn is_zero(&self) -> bool

Determines if the 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, target: &Pixels, t: f32) -> Pixels

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) -> Pixels

Performs the * operation.

impl Mul<usize> for Pixels

type Output = Pixels

The resulting type after applying the * operator.

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

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: &Pixels) -> 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: &Pixels) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Pixels

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

Performs the % operation.

impl RemAssign for Pixels

fn rem_assign(&mut self, rhs: Pixels)

Performs the %= operation.

impl Serialize for Pixels

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SpringTarget for Pixels

type Output = Pixels

The value supplied to the spring animator.

fn target(&self) -> f32

Returns the target in the spring’s coordinate space.

fn resolve(&self, value: f32) -> <Pixels as SpringTarget>::Output

Projects a spring coordinate into the animated output.

impl StructuralPartialEq for Pixels

impl Sub for Pixels

type Output = Pixels

The resulting type after applying the - operator.

fn sub(self, __rhs: Pixels) -> <Pixels as Sub>::Output

Performs the - operation.

impl SubAssign for Pixels

fn sub_assign(&mut self, __rhs: Pixels)

Performs the -= operation.

impl Sum for Pixels

fn sum<I>(iter: I) -> Pixels

where I: Iterator<Item = Pixels>,

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

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

fn sum<I>(iter: I) -> Pixels

where I: Iterator<Item = &'a Pixels>,

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<Pixels, <Pixels as TryFrom<&str>>::Error>

Performs the conversion.