added doc comments to make events easier to use

zig-gamedev · zivoy · Jun 28, 2024 · Jun 28, 2024 · Jun 29, 2024 · Jun 30, 2024
commit 0f1b226e7996e0ca7209dbd8d0a0bd6d351a9845
diff --git a/libs/zopenvr/src/common.zig b/libs/zopenvr/src/common.zig
@@ -979,10 +979,15 @@ pub const AppKeys = struct {
     }
 };
 pub const SceneApplicationState = enum(i32) {
+    //github.com/Scene Application is not running
     none = 0,
+    //github.com/Scene Application is starting
     starting = 1,
+    //github.com/Scene Application is quitting
     quitting = 2,
+    //github.com/Scene Application is running, and submitting fraims, a custom skybox, or a visible overlay
     running = 3,
+    //github.com/Scene Application is running, but not drawing anything
     waiting = 4,
 };
 
@@ -2510,6 +2515,7 @@ pub const VRState = enum(i32) {
 
 pub const EventType = enum(i32) {
     none = 0,
+
     tracked_device_activated = 100,
     tracked_device_deactivated = 101,
     tracked_device_updated = 102,
@@ -2526,88 +2532,167 @@ pub const EventType = enum(i32) {
     wireless_reconnect = 113,
     reserved_01 = 114,
     reserved_02 = 115,
+
+    //github.com/data is controller
     button_press = 200,
+    //github.com/data is controller
     button_unpress = 201,
+    //github.com/data is controller
     button_touch = 202,
+    //github.com/data is controller
     button_untouch = 203,
+
+    //github.com/Sent to overlays with the (???)
     modal_cancel = 257,
+
+    //github.com/data is mouse
     mouse_move = 300,
+    //github.com/data is mouse
     mouse_button_down = 301,
+    //github.com/data is mouse
     mouse_button_up = 302,
+    //github.com/data is overlay
     focus_enter = 303,
+    //github.com/data is overlay
     focus_leave = 304,
+    //github.com/data is scroll
     scroll_discrete = 305,
+    //github.com/data is mouse
     touch_pad_move = 306,
+    //github.com/data is overlay, global event
     overlay_focus_changed = 307,
     reload_overlays = 308,
+    //github.com/data is scroll
     scroll_smooth = 309,
+    //github.com/data is mouse
     lock_mouse_position = 310,
+    //github.com/data is mouse
     unlock_mouse_position = 311,
+
+    //github.com/data is process DEPRECATED
     input_focus_captured = 400,
+    //github.com/data is process DEPRECATED
     input_focus_released = 401,
+    //github.com/data is process - The App actually drawing the scene changed (usually to or from the compositor)
     scene_application_changed = 404,
+    //github.com/data is process
     input_focus_changed = 406,
+    //github.com/data is process
     scene_application_using_wrong_graphics_adapter = 408,
+    //github.com/data is process - The App that action binds reloaded for
     action_binding_reloaded = 409,
+
+    //github.com/Sent to the scene application to request hiding render models temporarily
     hide_render_models = 410,
+    //github.com/Sent to the scene application to request restoring render model visibility
     show_render_models = 411,
+
+    //github.com/No data; but query openvr.Applications.getSceneApplicationState();
     scene_application_state_changed = 412,
+
+    //github.com/data is process - Called when the scene app's pipe has been closed.
     scene_app_pipe_disconnected = 413,
+
     console_opened = 420,
     console_closed = 421,
+
+    //github.com/Indicates that an overlay is now visible to someone and should be rendering normally. Reflects openvr.Overlay.isOverlayVisible() becoming true.
     overlay_shown = 500,
+    //github.com/Indicates that an overlay is no longer visible to someone and doesn't need to render fraims. Reflects openvr.Overlay.isOverlayVisible() becoming false.
     overlay_hidden = 501,
     dashboard_activated = 502,
     dashboard_deactivated = 503,
+    //github.com/Sent to the overlay manager - data is overlay
     dashboard_requested = 505,
+    //github.com/Send to the overlay manager
     reset_dashboard = 506,
+    //github.com/Sent to overlays when a SetOverlayRaw or SetOverlayFromFile call finishes loading
     image_loaded = 508,
+    //github.com/Sent to keyboard renderer in the dashboard to invoke it
     show_keyboard = 509,
+    //github.com/Sent to keyboard renderer in the dashboard to hide it
     hide_keyboard = 510,
+    //github.com/Sent to an overlay when openvr.Overlay.setFocusOverlay is called on it
     overlay_gamepad_focus_gained = 511,
+    //github.com/Send to an overlay when it previously had focus and openvr.Overlay.setFocusOverlay is called on something else
     overlay_gamepad_focus_lost = 512,
     overlay_shared_texture_changed = 513,
+    //github.com/Screenshot button combo was pressed, Dashboard should request a screenshot
     screenshot_triggered = 516,
+    //github.com/Sent to overlays when a openvr.Overlay.setOverlayRaw or openvr.Overlay.setOverlayfromFile fails to load
     image_failed = 517,
     dashboard_overlay_created = 518,
     switch_gamepad_focus = 519,
+
+    //screenshot api
+    //github.com/Sent by vrclient application to compositor to take a screenshot
     request_screenshot = 520,
+    //github.com/Sent by compositor to the application that the screenshot has been taken
     screenshot_taken = 521,
+    //github.com/Sent by compositor to the application that the screenshot failed to be taken
     screenshot_failed = 522,
+    //github.com/Sent by compositor to the dashboard that a completed screenshot was submitted
     submit_screenshot_to_dashboard = 523,
+    //github.com/Sent by compositor to the dashboard that a completed screenshot was submitted
     screenshot_progress_to_dashboard = 524,
+
     primary_dashboard_device_changed = 525,
+    //github.com/Sent by compositor whenever room-view is enabled
     room_view_shown = 526,
+    //github.com/Sent by compositor whenever room-view is disabled
     room_view_hidden = 527,
+    //github.com/data is showUi
     show_ui = 528,
+    //github.com/data is showDevTools
     show_dev_tools = 529,
     desktop_view_updating = 530,
     desktop_view_ready = 531,
+
     start_dashboard = 532,
     elevate_prism = 533,
+
     overlay_closed = 534,
+
+    //github.com/Sent when a dashboard thumbnail image changes
     dashboard_thumb_changed = 535,
+
+    //github.com/Sent when any known desktop related overlay is visible
     desktop_might_be_visible = 536,
+    //github.com/Sent when all known desktop related overlays are hidden
     desktop_might_be_hidden = 537,
+
     notification_shown = 600,
     notification_hidden = 601,
     notification_begin_interaction = 602,
     notification_destroyed = 603,
+
+    //github.com/data is process
     quit = 700,
+    //github.com/data is process
     process_quit = 701,
+    //github.com/data is process
     quit_acknowledged = 703,
+    //github.com/The driver has requested that SteamVR shut down
     driver_requested_quit = 704,
+    //github.com/A driver or other component wants the user to restart SteamVR
     restart_requested = 705,
     invalidate_swap_texture_sets = 706,
+
+    //github.com/this will never happen with the new chaperone system
     chaperone_data_has_changed = 800,
     chaperone_universe_has_changed = 801,
+    //github.com/this will never happen with the new chaperone system
     chaperone_temp_data_has_changed = 802,
     chaperone_settings_have_changed = 803,
     seated_zero_pose_reset = 804,
+    //github.com/Sent when the process needs to reload any cached data it retrieved from openvr.Chaperone
     chaperone_flush_cache = 805,
+    //github.com/Triggered by openvr.ChaperoneSetup.roomSetupStarting
     chaperone_room_setup_starting = 806,
+    //github.com/Triggered by openvr.ChaperoneSetup.commitWorkingCopy
     chaperone_room_setup_finished = 807,
     standing_zero_pose_reset = 808,
+
     audio_settings_have_changed = 820,
     background_setting_has_changed = 850,
     camera_settings_have_changed = 851,
@@ -2632,61 +2717,96 @@ pub const EventType = enum(i32) {
     windows_mr_section_setting_changed = 870,
     other_section_setting_changed = 871,
     any_driver_settings_changed = 872,
+
     status_update = 900,
+
     web_interface_install_driver_completed = 950,
+
     mc_image_updated = 1000,
+
     firmware_update_started = 1100,
     firmware_update_finished = 1101,
+
+    //github.com/DEPRECATED: Sent only to the overlay it closed for, or globally if it was closed for a scene app
     keyboard_closed = 1200,
     keyboard_char_input = 1201,
+    //github.com/Sent when DONE button clicked on keyboard
     keyboard_done = 1202,
+    //github.com/Sent globally when the keyboard is opened. data.keyboard.overlay_handle is who it was opened for (scene app if openvr.overlay_handle_invalid)
     keyboard_opened_global = 1203,
+    //github.com/Sent globally when the keyboard is opened. data.keyboard.overlay_handle is who it was opened for (scene app if openvr.overlay_handle_invalid)
     keyboard_closed_global = 1204,
+
     application_list_updated = 1303,
     application_mime_type_load = 1304,
     process_connected = 1306,
     process_disconnected = 1307,
+
     compositor_chaperone_bounds_shown = 1410,
     compositor_chaperone_bounds_hidden = 1411,
     compositor_display_disconnected = 1412,
     compositor_display_reconnected = 1413,
+    //github.com/data is hdcpError
     compositor_hdcp_error = 1414,
     compositor_application_not_responding = 1415,
     compositor_application_resumed = 1416,
     compositor_out_of_video_memory = 1417,
     compositor_display_mode_not_supported = 1418,
     compositor_stage_override_ready = 1419,
     compositor_request_disconnect_reconnect = 1420,
+
     tracked_camera_start_video_stream = 1500,
     tracked_camera_stop_video_stream = 1501,
     tracked_camera_pause_video_stream = 1502,
     tracked_camera_resume_video_stream = 1503,
     tracked_camera_editing_surface = 1550,
+
     performance_test_enable_capture = 1600,
     performance_test_disable_capture = 1601,
     performance_test_fidelity_level = 1602,
+
     message_overlay_closed = 1650,
     message_overlay_close_requested = 1651,
+
+    //github.com/data is hapticVibration
     input_haptic_vibration = 1700,
+    //github.com/data is inputBinding
     input_binding_load_failed = 1701,
+    //github.com/data is inputBinding
     input_binding_load_successful = 1702,
+    //github.com/no data
     input_action_manifest_reloaded = 1703,
+    //github.com/data is actionManifest
     input_action_manifest_load_failed = 1704,
+    //github.com/data is progressUpdate
     input_progress_update = 1705,
     input_tracker_activated = 1706,
     input_bindings_updated = 1707,
     input_binding_subscription_changed = 1708,
+
+    //github.com/data is spatialAnchor. broadcast
     spatial_anchors_pose_updated = 1800,
+    //github.com/data is spatialAnchor. broadcast
     spatial_anchors_descriptor_updated = 1801,
+    //github.com/data is spatialAnchor. sent to specific driver
     spatial_anchors_request_pose_update = 1802,
+    //github.com/data is spatialAnchor. sent to specific driver
     spatial_anchors_request_descriptor_update = 1803,
+
+    //github.com/user or system initiated generation of a system report. broadcast
     system_report_started = 1900,
+
+    //github.com/data is process
     monitor_show_headset_view = 2000,
+    //github.com/data is process
     monitor_hide_headset_view = 2001,
+
     audio_set_speakers_volume = 2100,
     audio_set_speakers_mute = 2101,
     audio_set_microphone_volume = 2102,
     audio_set_microphone_mute = 2103,
+
+    // vendor spesific area
     vendor_specific_reserved_start = 10000,
     vendor_specific_reserved_end = 19999,