Add events.md

nerfstudio-project · Oct 11, 2023 · d5cf848 · d5cf848
1 parent 09c78d5
commit d5cf848
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/docs/source/events.md b/docs/source/events.md
@@ -0,0 +1,23 @@
+# Events
+
+We define a small set of event types, which are passed to callback functions
+when events like clicks or GUI updates are triggered.
+
+<!-- prettier-ignore-start -->
+
+.. autoapiclass:: viser.ScenePointerEvent
+   :members:
+   :undoc-members:
+   :inherited-members:
+
+.. autoapiclass:: viser.SceneNodePointerEvent
+   :members:
+   :undoc-members:
+   :inherited-members:
+
+.. autoapiclass:: viser.GuiEvent
+   :members:
+   :undoc-members:
+   :inherited-members:
+
+<!-- prettier-ignore-end -->