Skip to main content

Viewport

pub struct Viewport {
    pub extents: Option<[[f32; 2]; 2]>,
    pub viewport_to_context_transform: Option<[f32; 9]>,
}
Expand description

A rectangular region that directs injected events into a target.

The viewport relates a pointer’s position across multiple independent coordinate systems: the context, the viewport, and the dispatch clients. Intuitively, the viewport is how a pointer’s position is mapped to an interactive part of the scene.

A matrix is used to relate the viewport coordinate system to the context coordinate system. A pair of extents defines the viewport’s size in the viewport coordinate system. Together, they define the viewport’s placement in the context coordinate system.

The viewport coordinate system is used to convey a pointer’s coordinates in a scale-invariant way to dispatch clients, so that pointer movement can be interpreted correctly under effects like magnification. The context defines the viewport’s minimal and maximal extents in the viewport coordinate system.

  • The boundary of the viewport, a rectangle, is axis aligned with the viewport coordinate system; however it may otherwise be freely positioned (“float”) within it: there is translation and scaling, but no rotation.
  • Floating gives the injector some choice in how to convey coordinates, such as in Vulkan NDC, or in display pixel coordinates.
  • The viewport rectangle defines a latch region used in dispatch (described below).

A dispatch client receives a pointer’s coordinates in the viewport coordinate system, along with a matrix to convert coordinates from the viewport coordinate system to the dispatch client’s coordinate system.

All fields required.

TODO(https://fxbug.dev/42162296): Rename Viewport, it is used in Flatland.

Fields§

§extents: Option<[[f32; 2]; 2]>§viewport_to_context_transform: Option<[f32; 9]>

Trait Implementations§

Source§

impl Clone for Viewport

Source§

fn clone(&self) -> Viewport

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 Viewport

Source§

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

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

impl Default for Viewport

Source§

fn default() -> Viewport

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

impl<'a, ___E> Encode<Viewport<'static>, ___E> for &'a Viewport
where ___E: Encoder + ?Sized,

Source§

fn encode( self, encoder: &mut ___E, out: &mut MaybeUninit<Viewport<'static>>, _: (), ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.
§

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

Whether the conversion from Self to W is equivalent to copying the raw bytes of Self. Read more
Source§

impl<___E> Encode<Viewport<'static>, ___E> for Viewport
where ___E: Encoder + ?Sized,

Source§

fn encode( self, encoder: &mut ___E, out: &mut MaybeUninit<Viewport<'static>>, _: (), ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.
§

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

Whether the conversion from Self to W is equivalent to copying the raw bytes of Self. Read more
Source§

impl<'de> FromWire<Viewport<'de>> for Viewport

Source§

fn from_wire(wire_: Viewport<'de>) -> Self

Converts the given owned value to this type.
§

const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _

Whether the conversion from W to Self is equivalent to copying the raw bytes of W. Read more
Source§

impl<'de> FromWireRef<Viewport<'de>> for Viewport

Source§

fn from_wire_ref(wire: &Viewport<'de>) -> Self

Converts the given reference to this type.
Source§

impl PartialEq for Viewport

Source§

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

Source§

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

Source§

impl StructuralPartialEq for Viewport

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

§

impl<T, W> FromWireOption<Box<'_, W>> for T
where T: FromWire<W>,

§

fn from_wire_option(wire: Box<'_, W>) -> Option<T>

Converts the given owned value to an option of this type.
§

impl<T, W> FromWireOptionRef<Box<'_, W>> for T
where T: FromWireRef<W>,

§

fn from_wire_option_ref(wire: &Box<'_, W>) -> Option<T>

Converts the given reference to an option of this type.
§

impl<T> InstanceFromServiceTransport<T> for T

§

fn from_service_transport(handle: T) -> T

Converts the given service transport handle of type T to [Self]
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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
§

impl<E> RunsTransport<Mpsc> for E

§

impl<E> RunsTransport<Mpsc> for E
where E: RunsTransport<Mpsc>,