Skip to main content

Module control_hints

Module control_hints 

Expand description

Control hints: a small lit card that teaches one control at the moment it is useful, beside where it is done, and goes the moment it is done.

A host registers its set of hints as data (HintSpec): when each is useful (Cue), what must hold while it shows, which of the person’s actions mean they know it, and the gesture its picture shows. It feeds the person’s actions in as they happen (Coach::observe, usually from performed), and every frame says what holds and whether now is a quiet moment (Quiet). The Coach decides; HintLayer draws.

The rules every hint keeps:

  • A hint whose action the person already did never shows: experts see nothing. One that is on screen acknowledges it and goes.
  • One hint at a time, and at most one beginning a minute; none while the person types, is in a call or follows someone.
  • An unanswered hint goes on its own after coach::IGNORED_AFTER and may come back once, much later. No buttons, no counter, no scrim.
  • What is learned is the person’s own record (Learned), kept with their profile so another device does not teach it again; one setting turns hints off.

Modules§

coach
When a control hint shows, goes, and is learned: a pure schedule over what the host observed, with no drawing and no clock of its own.
performed
What the person just did with the desktop’s own controls, as the widgets that carried it out report it.

Structs§

Coach
The schedule of a set of hints over the signals S a host observes.
Current
The hint on screen.
HintLayer
A host’s set of control hints, scheduled and drawn.
HintLook
What the host’s frame says about the person and the screen.
HintPlace
How a hint shows right now, as its host places it.
HintSpec
One control hint, as data.
Learned
The person’s record of control hints.
Timing
How long the phases that end on their own take, from the motion (crate::motion::Beckon) under the current reduced-motion choice.

Enums§

Cue
A moment a hint is useful.
Gesture
The gesture a hint’s picture shows, drawn with vector shapes and looped while it shows.
Phase
Where the hint on screen is in its life.
Quiet
Why no hint may begin now.