InputMgr::GetMouseDeltaY

Defined in: C4Input.h

Returns the mouse movement delta on the y axis.

Prototype

float GetMouseDeltaY(void) const;

Description

The GetMouseDeltaY function returns the mouse movement delta on the y axis. The delta value is expressed in generic units that are scaled to be equivalent across all mouse devices and then multiplied by the current mouse sensitivity. If the kMouseInverted mouse flag is currently set, then the delta value is negated before it is returned.

The mouse movement delta is updated by the Input Manager only when the current input mode includes the kInputMouseActive flag.