pointer

Namespaces

Enumerations

enum class MouseViewStatus : uint32_t
Name Value Comments
ENTERED 1u

The stream is directed towards this view.
EXITED 2u

The stream is directed away from this view.

A description of mouse event stream's relationship to this view.

Defined at line 20 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

enum class EventPhase : uint32_t
Name Value Comments
ADD 1u

The device has started tracking the pointer.
CHANGE 2u

The device has reported an update to the pointer state.
REMOVE 3u

The device has stopped tracking the pointer.
CANCEL 4u

The pointer is no longer available.

The possible states of a pointer event. These phases of events in a stream

follow a state machine that starts with the `ADD` phase, followed by zero or

more `CHANGE` phases, and finally terminates with `REMOVE` or `CANCEL`

phase.

```

ADD ---> CHANGE* -+-> REMOVE

|

+-> CANCEL

```

A finite sequence of pointer events that follows this state machine,

starting from the initial state, is called an **interaction**. A closed (or

past) interaction is one where it has reached the terminal state; an open

(or current) interaction is one where it has not.

For a given device pointer, a stream of events is observed as a succession

of zero or more closed interactions (the past history of user engagement),

followed by at most one open interaction (the current user engagement).

When we need to group pointer events by their interaction, an event carries

an **interaction id** that is unique in that pointer stream. This common

reference makes it possible to operate on a closed interaction, as well as

an open interaction.

For example, touch events are typically observed as a succession of

interactions, as fingers engage and disengage with the display.

Defined at line 63 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

enum class TouchInteractionStatus : uint32_t
Name Value Comments
DENIED 1u

The client has been denied ownership of the interaction.
GRANTED 2u

The client has been granted ownership of the interaction.

A description of the interaction's relationship to this client.

Defined at line 89 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

enum class TouchResponseType : uint32_t
Name Value Comments
NO 1u

The client has no further interest in this interaction; it declines
ownership of the interaction. The client will stop receiving events for
this interaction.
MAYBE 2u

The client is interested in this interaction, but needs to see more
events to decide; the client has not yet claimed ownership of this
interaction.
MAYBE_PRIORITIZE 3u

The client is interested in this interaction, but needs to see more
events to decide; the client has not yet claimed ownership of the
interaction. During ownership resolution, it exerts its priority over
lower-priority "maybe" claims, but always loses to a "yes" claim.
MAYBE_SUPPRESS 4u

The client is interested in this interaction, but needs to see more
events to decide; the client has not yet claimed ownership of the
interaction. Moreover, it suppresses lower-priority claims that try to
resolve interaction ownership.
MAYBE_PRIORITIZE_SUPPRESS 5u

The client is interested in this interaction, but needs to see more
events to decide; the client has not yet claimed ownership of the
interaction. Moreover, it suppresses lower-priority claims that try to
resolve interaction ownership. During ownership resolution, it exerts
its priority over lower-priority "maybe" claims, but always loses to a
"yes" claim.
HOLD 6u

The client is interested in this interaction, but needs to see a
subsequent interaction to decide; the client has not yet claimed
ownership of this interaction. It prevents ownership resolution when the
interaction closes.
HOLD_SUPPRESS 7u

The client is interested in this interaction, but needs to see a
subsequent interaction to decide; the client has not yet claimed
ownership of this interaction. It prevents ownership resolution when the
interaction closes. Moreover, it suppresses lower-priority claims that
try to resolve interaction ownership.
YES 8u

The client wishes exclusive access to the remaining events in this
interaction; it claims ownership of this interaction (but that claim may
be granted or denied). During ownership resolution, it yields its
priority to lower-priority "yes" claims.
YES_PRIORITIZE 9u

The client wishes exclusive access to the remaining events in this
interaction; it claims ownership of this interaction (but that claim may
be granted or denied). During ownership resolution, it exerts its
priority over lower-priority "yes" claims.

The possible interaction dispositions that a client can respond with to a

given |TouchPointerSample|. Used as part of a gesture disambiguation scheme.

The responses are based on the idea of an ownership claim on a interaction.

Clients may assert a claim of ownership on an open interaction, but only one

client's claim is granted by the server; other clients' claims are denied.

Defined at line 112 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

Records

Functions

  • zx_status_t Clone (::fuchsia::ui::pointer::MouseViewStatus value, ::fuchsia::ui::pointer::MouseViewStatus * result)

    Defined at line 29 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (::fuchsia::ui::pointer::EventPhase value, ::fuchsia::ui::pointer::EventPhase * result)

    Defined at line 78 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (::fuchsia::ui::pointer::TouchInteractionStatus value, ::fuchsia::ui::pointer::TouchInteractionStatus * result)

    Defined at line 98 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (::fuchsia::ui::pointer::TouchResponseType value, ::fuchsia::ui::pointer::TouchResponseType * result)

    Defined at line 170 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (const ::fuchsia::ui::pointer::MouseEventStreamInfo & _value, ::fuchsia::ui::pointer::MouseEventStreamInfo * _result)

    Defined at line 488 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (const ::fuchsia::ui::pointer::TouchInteractionId & _value, ::fuchsia::ui::pointer::TouchInteractionId * _result)

    Defined at line 629 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (const ::fuchsia::ui::pointer::TouchInteractionResult & _value, ::fuchsia::ui::pointer::TouchInteractionResult * _result)

    Defined at line 656 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (const ::fuchsia::ui::pointer::TouchSourceWatchRequest & _value, ::fuchsia::ui::pointer::TouchSourceWatchRequest * _result)

    Defined at line 799 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (const ::fuchsia::ui::pointer::TouchSourceUpdateResponseRequest & _value, ::fuchsia::ui::pointer::TouchSourceUpdateResponseRequest * _result)

    Defined at line 822 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (const ::fuchsia::ui::pointer::Rectangle & _value, ::fuchsia::ui::pointer::Rectangle * _result)

    Defined at line 1380 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (const ::fuchsia::ui::pointer::ViewParameters & _value, ::fuchsia::ui::pointer::ViewParameters * _result)

    Defined at line 1431 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (const ::fuchsia::ui::pointer::MouseSourceWatchResponse & _value, ::fuchsia::ui::pointer::MouseSourceWatchResponse * _result)

    Defined at line 1768 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h

  • zx_status_t Clone (const ::fuchsia::ui::pointer::TouchSourceWatchResponse & _value, ::fuchsia::ui::pointer::TouchSourceWatchResponse * _result)

    Defined at line 2114 of file fidling/gen/sdk/fidl/fuchsia.ui.pointer/fuchsia.ui.pointer/hlcpp/fuchsia/ui/pointer/cpp/fidl.h