MouseControl

enum

Core/Vixen.Input/Controls/InputControl.cs:14

csharp

public enum MouseControl

A control on a mouse.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

Buttons are named by role rather than by side — Primary is the button under the index finger, which the OS has already swapped for a left-handed pointer configuration by the time the event reaches us. The motion controls are deltas per frame, not positions: a camera bound to DeltaX must keep working in relative cursor mode, where the pointer has no position at all.

Fields and properties (12)

None
No control.
Primary
The main button: select, click, drag.
Secondary
The context-menu button.
Middle
The wheel pressed in.
Extra1
The first thumb button, conventionally "back".
Extra2
The second thumb button, conventionally "forward".
DeltaX
Horizontal motion this frame, in logical points. Positive is right.
DeltaY
Vertical motion this frame, in logical points. Positive is down.
ScrollX
Horizontal scroll this frame, in wheel notches.
ScrollY
Vertical scroll this frame, in wheel notches. Positive is up.
PositionX
The pointer's horizontal position within the window, in logical points.
PositionY
The pointer's vertical position within the window, in logical points.

Used by (9)

InputActionTestsVixen.Input.Tests
InputControlVixen.Input
InputControlPathVixen.Input
InputControlPathTestsVixen.Input.Tests
InputDeviceSetVixen.Input
InputKeyTestsVixen.Input.Tests
MouseDeviceVixen.Input
PlatformInputVixen.App.Hosting
PlatformInputTestsVixen.App.Tests