Skip to main content

WebWindowState

Struct WebWindowState 

Source
pub struct WebWindowState {
    pub inner_size: Extent<u32, 2>,
    pub outer_size: Extent<u32, 2>,
    pub screen_offset: Distance<i32, 2>,
    pub screen_size: Extent<u32, 2>,
    pub screen_usable_size: Extent<u32, 2>,
    pub dpr: f32,
    pub bpp: u8,
    /* private fields */
}
Available on crate feature web only.
Expand description

🌐 Aggregates the live state of a WebWindow, including geometry and screen context.


📍 sys/os/browser/web


It has a size of 52 Bytes.

§Performance

All fields are fetched in a single JS→Rust call.

Fields§

§inner_size: Extent<u32, 2>

(innerWidth) (innerHeight) The extent in pixels of the content of the browser window including any rendered scrollbars.

§outer_size: Extent<u32, 2>

(outerWidth) (outerHeight) The extent in pixels of the outside of the browser window.

§screen_offset: Distance<i32, 2>

(screenLeft) (screenTop) The window’s offset in pixels from the screen’s top-left origin.

§screen_size: Extent<u32, 2>

(width) (height) The extent of the screen in pixels.

§screen_usable_size: Extent<u32, 2>

(availWidth) (availHeight) The extent of the screen in pixels, minus user interface features displayed.

§dpr: f32

(devicePixelRatio) The device pixel ratio of the resolution in physical pixels to the resolution in CSS pixels.

The value changes with the zoom on desktops yet remains static on mobile devices.

§bpp: u8

(colorDepth) The screen color depth, in bits per single pixel. It could be 8, 16, 24, 32 or 64.

Implementations§

Source§

impl WebWindowState

Source

pub fn new() -> WebWindowState

Available on crate feature unsafe_ffi only.

Returns a new up-to-date WebWindowState.

§Safety
  • JavaScript must write all non-padding fields at correct offsets.
Source

pub fn update(&mut self)

Available on crate feature unsafe_ffi only.

Overwrites this WebWindowState with the latest live metrics.

Source

pub const fn is_valid(&self) -> bool

Validates the internal consistency of window metrics.

Returns true if all these conditions hold:

  • No dimensions are zero (invalid window state)
  • Inner size ≤ outer size (logical constraint)
  • Outer size ≤ screen size (unless multi-monitor)
  • Device pixel ratio is sane (0.2 <= dpr <= 10.0)
  • Screen color depth is plausible (8 <= depth <= 64)
Source

pub const fn chrome_size(&self) -> Extent<u32, 2>

Returns the thickness of the window chrome (frame, scrollbars, etc.) in logical pixels.

This is the difference between the outer and inner window sizes.

Source

pub const fn is_maximized(&self) -> bool

Checks if the window is approximately maximized (fills the available screen space).

Tolerance: The window must be within 1 pixel of the screen’s usable size.

Source

pub const fn is_portrait(&self) -> bool

Checks if the window is in a portrait orientation (height > width).

Source

pub const fn physical_size(&self) -> Extent<u32, 2>

Returns the physical size of the window in hardware pixels, truncating fractional values.

Computed as (inner_size * device_pixel_ratio).

For rounded values, use physical_size_rounded().

Source

pub const fn physical_size_rounded(&self) -> Extent<u32, 2>

Returns the physical size of the window in hardware pixels, rounded to the nearest integer.

Computed as (inner_size * device_pixel_ratio).round().

It’s more accurate and expensive than physical_size().

Source

pub const fn screen_margins(&self) -> [i32; 4]

Returns the window’s distance to each screen edge in logical pixels.

Order: [left, top, right, bottom]. Negative values mean the window is outside the screen.

Trait Implementations§

Source§

impl Clone for WebWindowState

Source§

fn clone(&self) -> WebWindowState

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 WebWindowState

Source§

impl Debug for WebWindowState

Source§

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

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

impl Default for WebWindowState

Source§

fn default() -> WebWindowState

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

impl PartialEq for WebWindowState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StructuralPartialEq for WebWindowState

Auto Trait Implementations§

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

Source§

fn type_id() -> TypeId

Returns the TypeId of Self. Read more
Source§

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more
Source§

fn type_name(&self) -> &'static str

Returns the type name of self. Read more
Source§

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more
Source§

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.
Source§

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.
Source§

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more
Source§

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more
Source§

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Available on crate feature alloc only.
Upcasts Box<self> as Box<dyn Any>. Read more
Source§

fn downcast_ref<T: 'static>(&self) -> Option<&T>

Available on crate feature unsafe_layout and non-crate feature safe_code only.
Returns some shared reference to the inner value if it is of type T. Read more
Source§

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T>

Available on crate feature unsafe_layout and non-crate feature safe_code only.
Returns some exclusive reference to the inner value if it is of type T. 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> ByteSized for T

Source§

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.
Source§

const BYTE_SIZE: usize = _

The size of this type in bytes.
Source§

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.
Source§

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more
Source§

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. 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> Hook for T

Source§

fn hook<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Hooks a mutation step into the value and returns it. Read more
Source§

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Taps into the value for observation and returns it unchanged. 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> MemExt for T
where T: ?Sized,

Source§

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.
Source§

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more
Source§

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more
Source§

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more
Source§

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more
Source§

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more
Source§

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more
Source§

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more
Source§

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more
Source§

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more
Source§

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more
Source§

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more
Source§

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

fn mem_as_bytes(&self) -> &[u8]
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &[u8]. Read more
Source§

fn mem_as_bytes_mut(&mut self) -> &mut [u8]
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &mut [u8]. Read more
Source§

impl<T, R> Morph<R> for T
where T: ?Sized,

Source§

fn morph<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Morphs the value into a new one and returns it. Read more
Source§

fn morph_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Morphs the value by shared reference and returns the result. Read more
Source§

fn morph_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Morphs the value by exclusive reference and returns the result. Read more
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, 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.