Struct fidl_fuchsia_ui_pointerinjector::Config

pub struct Config {
    pub device_id: Option<u32>,
    pub device_type: Option<DeviceType>,
    pub context: Option<Context>,
    pub target: Option<Target>,
    pub viewport: Option<Viewport>,
    pub dispatch_policy: Option<DispatchPolicy>,
    pub scroll_v_range: Option<Axis>,
    pub scroll_h_range: Option<Axis>,
    pub buttons: Option<Vec<u8>>,
    pub relative_motion_range: Option<[Axis; 2]>,
    /* private fields */
}

A specification for an injector |Device|.

All fields required.

Fields

device_id: Option<u32>

An identifier for the pointer device that issues pointer event streams.

device_type: Option<DeviceType>

A characterization of the pointer device.

context: Option<Context>

The scope and coordinate system of the injector |Device|.

Note: To avoid circular injection scenarios, |context| must be a strict ancestor of |target|.

target: Option<Target>

The region where dispatch is attempted for injected events.

Note: To avoid circular injection scenarios, |target| must be a strict descendant of |context|.

viewport: Option<Viewport>

The initial viewport for injected events. Subsequent modifications to the viewport can also be sent synchronously with injected events.

dispatch_policy: Option<DispatchPolicy>

A specification of the UI clients in |target| that may have injected events dispatched to them.

For example, if |dispatch_policy| is |EXCLUSIVE|, then only |target| may have injected events dispatched to it, regardless of other factors, such as surface occlusion by clients inside and outside of |target|.

scroll_v_range: Option<Axis>

Range of vertical scroll values issued by the device.

scroll_h_range: Option<Axis>

Range of horizontal scroll values issued by the device.

buttons: Option<Vec<u8>>

Mouse button identifiers issued by the device, in priority order.

The priority order of mouse buttons is a policy choice enacted by the injector. This priority order is conveyed verbatim to UI clients via [fuchsia.ui.pointer.MouseDeviceInfo.buttons], so button priority is shared consistently between multiple UI clients. For example, to swap the left-side (0x1) and right-side (0x2) physical buttons from their traditional roles of primary and secondary mouse buttons, the injector can specify [0x2, 0x1, … ] in this [buttons] vector.

Note that preserving the physical button ID is also a policy choice. If preserved, a discerning UI client can distinguish between the ground truth (which physical button was pressed) versus the desired interpretation (what priority does that physical button have, on the current system).

relative_motion_range: Option<[Axis; 2]>

Range of X and Y motion by a mouse device.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Decode<Config> for Config

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<'_>, offset: usize, depth: Depth ) -> Result<()>

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

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl Encode<Config> for &mut Config

unsafe fn encode( self, encoder: &mut Encoder<'_>, 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 Config

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl ResourceTypeMarker for Config

type Borrowed<'a> = &'a mut Config

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

fn take_or_borrow<'a>( value: &'a mut <Self as TypeMarker>::Owned ) -> Self::Borrowed<'a>

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for Config

type Owned = Config

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 Standalone for Config

impl StructuralPartialEq for Config