From 39c277099bdd3390831d1b38a4da08a362b0f1eb Mon Sep 17 00:00:00 2001
From: Huon Imberger <Plonq@users.noreply.github.com>
Date: Thu, 21 Nov 2024 16:59:13 +1100
Subject: [PATCH] Explain how to disable pan/zoom/orbit by setting sensitivity
 to 0 (#89)

---
 src/lib.rs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/lib.rs b/src/lib.rs
index 02ef8f5..03e7c15 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -180,7 +180,7 @@ pub struct PanOrbitCamera {
     /// Should always be >0 otherwise you'll get stuck at 0.
     /// Defaults to `0.05`.
     pub zoom_lower_limit: f32,
-    /// The sensitivity of the orbiting motion.
+    /// The sensitivity of the orbiting motion. A value of `0.0` disables orbiting.
     /// Defaults to `1.0`.
     pub orbit_sensitivity: f32,
     /// How much smoothing is applied to the orbit motion. A value of `0.0` disables smoothing,
@@ -188,7 +188,7 @@ pub struct PanOrbitCamera {
     /// smoothing.
     /// Defaults to `0.8`.
     pub orbit_smoothness: f32,
-    /// The sensitivity of the panning motion.
+    /// The sensitivity of the panning motion. A value of `0.0` disables panning.
     /// Defaults to `1.0`.
     pub pan_sensitivity: f32,
     /// How much smoothing is applied to the panning motion. A value of `0.0` disables smoothing,
@@ -197,6 +197,7 @@ pub struct PanOrbitCamera {
     /// Defaults to `0.6`.
     pub pan_smoothness: f32,
     /// The sensitivity of moving the camera closer or further way using the scroll wheel.
+    /// A value of `0.0` disables zooming.
     /// Defaults to `1.0`.
     pub zoom_sensitivity: f32,
     /// How much smoothing is applied to the zoom motion. A value of `0.0` disables smoothing,