diff options
| -rw-r--r-- | doc/Guide.md | 5 | ||||
| -rw-r--r-- | doc/images/LUT_example.png | bin | 55969 -> 65568 bytes | |||
| -rw-r--r-- | doc/images/accel_readme_example.png | bin | 50019 -> 65975 bytes | |||
| -rw-r--r-- | doc/images/anisotropy_example.png | bin | 62022 -> 55900 bytes | |||
| -rw-r--r-- | doc/images/classic_example.png | bin | 54866 -> 65169 bytes | |||
| -rw-r--r-- | doc/images/jump_example.png | bin | 47816 -> 59152 bytes | |||
| -rw-r--r-- | doc/images/linear_example.png | bin | 50547 -> 65667 bytes | |||
| -rw-r--r-- | doc/images/motivity_example.png | bin | 50916 -> 63762 bytes | |||
| -rw-r--r-- | doc/images/natural_gain_example.png | bin | 50679 -> 62130 bytes | |||
| -rw-r--r-- | doc/images/power_example.png | bin | 50340 -> 64430 bytes |
10 files changed, 5 insertions, 0 deletions
diff --git a/doc/Guide.md b/doc/Guide.md index 0e52721..a06dc91 100644 --- a/doc/Guide.md +++ b/doc/Guide.md @@ -83,12 +83,17 @@ The authors of this program feel that Whole is the best style for most users, bu ## Features +### Sensitivity Multiplier +As described above, the "sensitivity multiplier" parameter is a multiplier used on the post-calculation output vector. The "Y/X Ratio" parameter is then only applied to the Y component of the output, so that it defines the ratio of vertical to horizontal output sensitivity without acceleration. + ### Gain Switch The acceleration curve styles below (see "Acceleration Styles") each describe a certain shape mathematically. The gain switch determines whether that shape is applied in the sensitivity graph or the gain graph. For styles Linear, Classic, and Power, this setting does not change the possible shapes of the velocity curve - that is, for any particular settings with the gain switch set to Sensitivity, there is a different set of settings that will replicate the exact same velocity curve (output for a given hand motion) with the switch set to Gain. For styles Natural, Jump, and Motivity, this is not true, and the gain switch allows new velocity curves for each style. ### Offsets An offset, sometimes called a threshold, is a speed in counts before acceleration "kicks in". The legacy way of applying an offset is having a multiplier of 1 below and at the offset, and applying the sensitivity of (speed-offset) above. This legacy "sensitivity offset" is not available because it causes a discontinuity in gain at the point of offset, leading to non-smooth feeling at offset cross. The new "gain offset" does a little extra math to simply shift the gain graph by the offset amount without any discontinuity. This feels smoother and has almost no effect on sensitivity. The theory behind "gain offsets" is developed in [this document](https://docs.google.com/document/d/1P6LygpeEazyHfjVmaEygCsyBjwwW2A-eMBl81ZfxXZk). +Offsets are only applicable to the Classic, Linear, and Natural modes, where they are defined in terms of an input speed. Power mode has a special "output offset", where the curve "starts from" some ratio of the sens multiplier, described in its section. + ### Caps A cap is a point after which acceleration is not applied. The legacy way of applying an offset is simply applying the minimum of the cap sensitivity and the calculated sensitivity for any acceleration calculation. Thus, for the legacy "sensitivity cap" the value given is a sensitivity. This cap style is still available but causes a large discontinuity at the point of offset, leading to a non-smooth feeling at cap cross. The new default "gain cap" effectively caps the gain, but for internal calculation reasons, does so for a given speed rather than a given gain value. This feels much smoother but might have a large effect on sensitivity as gain generally raises faster than sensitivity. We recommend that users use a gain cap and simply adjust it to hit at the gain equivalent to the sensitivity they'd like to cap at. The theory behind "gain caps" is developed in [this document](https://docs.google.com/document/d/1FCpkqRxUaCP7J258SupbxNxvdPfljb16AKMs56yDucA). diff --git a/doc/images/LUT_example.png b/doc/images/LUT_example.png Binary files differindex 71f9ce3..96567d1 100644 --- a/doc/images/LUT_example.png +++ b/doc/images/LUT_example.png diff --git a/doc/images/accel_readme_example.png b/doc/images/accel_readme_example.png Binary files differindex 1622011..a23f9e4 100644 --- a/doc/images/accel_readme_example.png +++ b/doc/images/accel_readme_example.png diff --git a/doc/images/anisotropy_example.png b/doc/images/anisotropy_example.png Binary files differindex 6425e68..f8dd09c 100644 --- a/doc/images/anisotropy_example.png +++ b/doc/images/anisotropy_example.png diff --git a/doc/images/classic_example.png b/doc/images/classic_example.png Binary files differindex 58ca915..d51f693 100644 --- a/doc/images/classic_example.png +++ b/doc/images/classic_example.png diff --git a/doc/images/jump_example.png b/doc/images/jump_example.png Binary files differindex 770bab2..1d59134 100644 --- a/doc/images/jump_example.png +++ b/doc/images/jump_example.png diff --git a/doc/images/linear_example.png b/doc/images/linear_example.png Binary files differindex be1410e..29345d1 100644 --- a/doc/images/linear_example.png +++ b/doc/images/linear_example.png diff --git a/doc/images/motivity_example.png b/doc/images/motivity_example.png Binary files differindex 6041ec6..0c2441b 100644 --- a/doc/images/motivity_example.png +++ b/doc/images/motivity_example.png diff --git a/doc/images/natural_gain_example.png b/doc/images/natural_gain_example.png Binary files differindex 3b66dbe..49784e6 100644 --- a/doc/images/natural_gain_example.png +++ b/doc/images/natural_gain_example.png diff --git a/doc/images/power_example.png b/doc/images/power_example.png Binary files differindex 414a252..d41ad52 100644 --- a/doc/images/power_example.png +++ b/doc/images/power_example.png |
