Struct MousePointerSample

pub struct MousePointerSample {
    pub device_id: Option<u32>,
    pub position_in_viewport: Option<[f32; 2]>,
    pub scroll_v: Option<i64>,
    pub scroll_h: Option<i64>,
    pub pressed_buttons: Option<Vec<u8>>,
    pub relative_motion: Option<[f32; 2]>,
    pub scroll_v_physical_pixel: Option<f64>,
    pub scroll_h_physical_pixel: Option<f64>,
    pub is_precision_scroll: Option<bool>,
    /* private fields */
}

A description of each sampled data point in a mouse event stream.

MousePointerSample may bundle multiple state changes into one event. For example, if user scrolls mouse wheel and presses the left buttton down at the same time, client may receive scroll and button state changes together in 1 event, or receive button change and scroll change in separate events.

Fields

device_id: Option<u32>

An identifier for the mouse device that issues a mouse event stream. Required.

position_in_viewport: Option<[f32; 2]>

The position of this event, in the viewport’s coordinate system. Required.

scroll_v: Option<i64>

Relative vertical scrolling displacement by detent.

scroll_h: Option<i64>

Relative horizontal scrolling displacement by detent.

pressed_buttons: Option<Vec<u8>>

Identifiers of currently pressed buttons.

relative_motion: Option<[f32; 2]>

The relative movement performed, independent of the viewport’s coordinate system.

scroll_v_physical_pixel: Option<f64>

Recommended vertical scrolling displacement by physical pixel, it is computed with accelerator, detent / mm to pixel ratio, etc.

scroll_h_physical_pixel: Option<f64>

Recommended horizontal scrolling displacement by physical pixel, it is computed with accelerator, detent / mm to pixel ratio, etc.

is_precision_scroll: Option<bool>

Indicated if the scroll event is from a precision scroll device (HI_RES mouse or touchpad). Clients may want to play interpolation animations on non precision scroll device for smooth scrolling.

Trait Implementations

impl Clone for MousePointerSample

fn clone(&self) -> MousePointerSample

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MousePointerSample

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<MousePointerSample, D> for MousePointerSample

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for MousePointerSample

fn default() -> MousePointerSample

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<MousePointerSample, D> for &MousePointerSample

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for MousePointerSample

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TypeMarker for MousePointerSample

type Owned = MousePointerSample

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for MousePointerSample

type Borrowed<'a> = &'a MousePointerSample

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for MousePointerSample

impl StructuralPartialEq for MousePointerSample