Pixels

Struct Pixels 

Source
pub struct Pixels(/* private fields */);
Expand description

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§

Source§

impl Pixels

Source

pub const ZERO: Pixels

Represents zero pixels.

Source

pub const MAX: Pixels

The maximum value that can be represented by Pixels.

Source

pub const MIN: Pixels

The minimum value that can be represented by Pixels.

Source

pub fn floor(&self) -> Self

Floors the Pixels value to the nearest whole number.

§Returns

Returns a new Pixels instance with the floored value.

Source

pub fn round(&self) -> Self

Rounds the Pixels value to the nearest whole number.

§Returns

Returns a new Pixels instance with the rounded value.

Source

pub fn ceil(&self) -> Self

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

§Returns

Returns a new Pixels instance with the ceiling value.

Source

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.

Source

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

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.

Source

pub fn abs(&self) -> Self

Returns the absolute value of the Pixels.

§Returns

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

Source

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
Source

pub fn to_f64(self) -> f64

Returns the f64 value of Pixels.

§Returns

A f64 value of the Pixels.

Trait Implementations§

Source§

impl Add for Pixels

Source§

type Output = Pixels

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl AddAssign for Pixels

Source§

fn add_assign(&mut self, rhs: Pixels)

Performs the += operation. Read more
Source§

impl Clone for Pixels

Source§

fn clone(&self) -> Pixels

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Pixels

Source§

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

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

impl Default for Pixels

Source§

fn default() -> Pixels

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

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Pixels

Source§

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

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

impl<__RhsT> Div<__RhsT> for Pixels
where f32: Div<__RhsT, Output = f32>,

Source§

type Output = Pixels

The resulting type after applying the / operator.
Source§

fn div(self, rhs: __RhsT) -> Pixels

Performs the / operation. Read more
Source§

impl Div for Pixels

Source§

type Output = f32

The resulting type after applying the / operator.
Source§

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

Performs the / operation. Read more
Source§

impl<__RhsT> DivAssign<__RhsT> for Pixels
where f32: DivAssign<__RhsT>,

Source§

fn div_assign(&mut self, rhs: __RhsT)

Performs the /= operation. Read more
Source§

impl DivAssign for Pixels

Source§

fn div_assign(&mut self, rhs: Self)

Performs the /= operation. Read more
Source§

impl From<&Pixels> for f32

Source§

fn from(pixels: &Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<&Pixels> for u32

Source§

fn from(pixels: &Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for AbsoluteLength

Source§

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for AvailableSpace

Source§

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for Corners<Pixels>

Source§

fn from(val: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for DefiniteLength

Source§

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for Edges<Pixels>

Source§

fn from(val: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for Length

Source§

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for f32

Source§

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for f64

Source§

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for u32

Source§

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<Pixels> for usize

Source§

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.
Source§

impl From<f32> for Pixels

Source§

fn from(pixels: f32) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for Pixels

Source§

fn from(pixels: f64) -> Self

Converts to this type from the input type.
Source§

impl From<u32> for Pixels

Source§

fn from(pixels: u32) -> Self

Converts to this type from the input type.
Source§

impl From<usize> for Pixels

Source§

fn from(pixels: usize) -> Self

Converts to this type from the input type.
Source§

impl Half for Pixels

Source§

fn half(&self) -> Self

Returns half of the current value. Read more
Source§

impl Hash for Pixels

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

Source§

fn is_zero(&self) -> bool

Determines if the value is zero. Read more
Source§

impl JsonSchema for Pixels

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl Mul<Pixels> for Rems

Source§

type Output = Pixels

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl Mul<Pixels> for f32

Source§

type Output = Pixels

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl Mul<Pixels> for usize

Source§

type Output = Pixels

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl Mul<f32> for Pixels

Source§

type Output = Pixels

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl Mul<usize> for Pixels

Source§

type Output = Pixels

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl MulAssign<f32> for Pixels

Source§

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation. Read more
Source§

impl Neg for Pixels

Source§

type Output = Pixels

The resulting type after applying the - operator.
Source§

fn neg(self) -> Pixels

Performs the unary - operation. Read more
Source§

impl Negate for Pixels

Source§

fn negate(self) -> Self

Returns the negation of the given value
Source§

impl Ord for Pixels

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Pixels

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Pixels

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 · 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 · 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 · 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 · 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 Rem for Pixels

Source§

type Output = Pixels

The resulting type after applying the % operator.
Source§

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

Performs the % operation. Read more
Source§

impl RemAssign for Pixels

Source§

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation. Read more
Source§

impl Serialize for Pixels

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Sub for Pixels

Source§

type Output = Pixels

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl SubAssign for Pixels

Source§

fn sub_assign(&mut self, rhs: Pixels)

Performs the -= operation. Read more
Source§

impl TryFrom<&str> for Pixels

Source§

type Error = Error

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

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

Performs the conversion.
Source§

impl Copy for Pixels

Source§

impl Eq for Pixels

Source§

impl StructuralPartialEq for Pixels

Auto Trait Implementations§

§

impl Freeze for Pixels

§

impl RefUnwindSafe for Pixels

§

impl Send for Pixels

§

impl Sync for Pixels

§

impl Unpin for Pixels

§

impl UnwindSafe for Pixels

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<K> MapSeekTarget<K> for K
where K: Ord,

Source§

fn cmp_cursor(&self, cursor_location: &K) -> Ordering

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

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> ToSmolStr for T
where T: Display + ?Sized,

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T, Rhs> NumAssignOps<Rhs> for T
where T: AddAssign<Rhs> + SubAssign<Rhs> + MulAssign<Rhs> + DivAssign<Rhs> + RemAssign<Rhs>,