#include "overlay.hpp" #include "overlay_texture.hpp" #include "angle_fade.hpp" #include "gestures.hpp" #include "laser_setting.hpp" #include "panel_surface.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace frameyap { namespace { // The ARM64 SDK defaults to /data/work on Frame. Respect explicit overrides, // otherwise use the user's standard OpenVR registry when it exists. void configure_registry() { if (std::getenv("VR_PATHREG_OVERRIDE")) return; const char* config = std::getenv("XDG_CONFIG_HOME"); const char* home = std::getenv("HOME"); if ((!config || !*config) && !home) return; auto root = std::filesystem::path(config && *config ? config : std::string(home) + "/.config"); auto registry = root / "openvr/openvrpaths.vrpath"; if (root.is_absolute() && std::filesystem::is_regular_file(registry)) ::setenv("VR_PATHREG_OVERRIDE", registry.c_str(), 0); } constexpr int W = PanelSurface::width, H = PanelSurface::height; constexpr int CW = PanelSurface::body.w, CH = PanelSurface::body.h; Matrix34 matrix(const vr::HmdMatrix34_t& value) { Matrix34 result{}; for (int r = 0; r < 3; ++r) for (int c = 0; c < 4; ++c) result[r][c] = value.m[r][c]; return result; } constexpr std::array action_names{{"left_grip", "right_grip", "ptt", "cancel", "insert", "enter", "quick_chat"}}; void overlay_check(vr::EVROverlayError err, vr::IVROverlay* api, const char* op) { if (err != vr::VROverlayError_None) throw std::runtime_error(std::string(op) + ": " + api->GetOverlayErrorNameFromEnum(err)); } std::filesystem::path absolute_file(const std::filesystem::path& p) { auto result = std::filesystem::absolute(p); if (!std::filesystem::is_regular_file(result)) throw std::runtime_error("Missing file: " + result.string()); return result; } template std::vector vulkan_extensions(Query query) { const auto size = query(nullptr, 0); if (!size) return {}; if (size > 65536) throw std::runtime_error("OpenVR Vulkan extension list is too large"); std::vector buffer(size, '\0'); const auto written = query(buffer.data(), size); if (!written || written > size || buffer[written - 1] != '\0') throw std::runtime_error("OpenVR Vulkan extension list changed or is invalid"); std::istringstream words(std::string(buffer.data(), written - 1)); std::vector result; for (std::string name; words >> name;) result.push_back(std::move(name)); return result; } std::string battery_text(const std::optional& level) { if (!level) return "n/a"; return std::to_string(level->percent) + "%" + (level->charging ? " charging" : ""); } } // namespace struct Overlay::Impl { vr::IVRSystem* system = nullptr; vr::IVROverlay* overlay = nullptr; vr::IVRInput* input = nullptr; vr::VROverlayHandle_t handle = vr::k_ulOverlayHandleInvalid; std::unique_ptr gpu_texture; vr::VRActionSetHandle_t action_set = vr::k_ulInvalidActionSetHandle; std::array actions{}; struct Persistence { std::filesystem::path settings_path, laser_settings_path; bool save_failed = false, debug_save_failed = false, auto_save_failed = false; bool layout_save_failed = false, mic_save_failed = false, laser_change_failed = false; bool persist_mount = true; } persistence; Mount mount; bool lasers_anytime = false; Config config; PanelSurface surface; Panel panel; std::vector model_actions; StatusIndicators indicators; std::chrono::steady_clock::time_point batteries_read{}; bool world_ready = false, placed = false, has_texture = false, shown = false; float published_alpha = -1.f; float size_scale = 1.f; bool placement_dirty = false; Matrix34 canvas_pose{}; struct DragState { Matrix34 canvas{}; PanelDrag panel; PanelDragKind kind = PanelDragKind::Grab; unsigned cursor = 0; vr::TrackedDeviceIndex_t device = vr::k_unTrackedDeviceIndexInvalid; bool trigger_observed = false; float scale = 1.f; std::chrono::steady_clock::time_point started{}; } dragging; vr::HmdMatrix34_t world_transform{}; std::optional applied_mount; vr::TrackedDeviceIndex_t anchor = vr::k_unTrackedDeviceIndexInvalid; DoubleTap left; GripRecord right; std::array edges{}; std::array poses{}; bool grip_capture = false, ptt_capture = false; bool focus = true; struct Diagnostics { vr::EVRInputError action_update_error = vr::VRInputError_None; unsigned pointer_downs = 0, pointer_ups = 0, pointer_actions = 0, pointer_resets = 0; unsigned texture_uploads = 0, show_calls = 0, hide_calls = 0; unsigned overlay_shown_events = 0, overlay_hidden_events = 0, image_loaded_events = 0, image_failed_events = 0; unsigned overlay_focus_events = 0, global_focus_events = 0, input_focus_captured_events = 0; std::string last_pointer_event = "none"; } diagnostics; Impl(const std::string& assets, const std::string& font, std::optional requested, bool persist) : persistence{default_mount_settings_path(), default_laser_settings_path()}, mount(requested ? *requested : load_mount(persistence.settings_path)), lasers_anytime(load_lasers_anytime(persistence.laser_settings_path)), config(load_config(default_config_path())), surface(resolve_font(assets, font.empty() ? config.font : font), mount, config.theme, config.gradient) { persistence.persist_mount = persist; const auto action_path = absolute_file(action_manifest(assets, config)); absolute_file(std::filesystem::path(assets) / "bindings_knuckles.json"); try { configure_registry(); vr::EVRInitError err = vr::VRInitError_None; system = vr::VR_Init(&err, vr::VRApplication_Overlay); if (err != vr::VRInitError_None || !system) throw std::runtime_error(std::string("OpenVR overlay init: ") + vr::VR_GetVRInitErrorAsEnglishDescription(err)); overlay = vr::VROverlay(); input = vr::VRInput(); if (!overlay || !input) throw std::runtime_error("OpenVR overlay/input interface unavailable"); auto* compositor = vr::VRCompositor(); if (!compositor) throw std::runtime_error("OpenVR Vulkan compositor interface unavailable"); const auto extensions = vulkan_extensions([&](char* out, uint32_t size) { return compositor->GetVulkanInstanceExtensionsRequired(out, size); }); gpu_texture = std::make_unique(W, H, extensions, [&](VkInstance instance) { uint64_t physical = 0; system->GetOutputDevice(&physical, vr::TextureType_Vulkan, instance); return reinterpret_cast(physical); }, [&](VkPhysicalDevice physical) { return vulkan_extensions([&](char* out, uint32_t size) { return compositor->GetVulkanDeviceExtensionsRequired(physical, out, size); }); }); // The manifest launches a shell launcher, then execs this binary. // Associate manually launched instances with our registered app key too. auto* applications = vr::VRApplications(); if (applications && applications->IsApplicationInstalled("local.frameyap.overlay") && applications->IdentifyApplication(static_cast(::getpid()), "local.frameyap.overlay") != vr::VRApplicationError_None) throw std::runtime_error("Could not identify the registered FrameYap application"); if (input->SetActionManifestPath(action_path.c_str()) != vr::VRInputError_None) throw std::runtime_error("Could not set OpenVR action manifest path"); if (input->GetActionSetHandle("/actions/frameyap", &action_set) != vr::VRInputError_None) throw std::runtime_error("Could not find FrameYap action set"); for (size_t i = 0; i < action_names.size(); ++i) if (input->GetActionHandle((std::string("/actions/frameyap/in/") + action_names[i]).c_str(), &actions[i]) != vr::VRInputError_None) throw std::runtime_error(std::string("Could not find action ") + action_names[i]); overlay_check(overlay->CreateOverlay("local.frameyap.overlay.panel", "FrameYap", &handle), overlay, "CreateOverlay"); overlay_check(overlay->SetOverlayWidthInMeters(handle, 0.85f), overlay, "SetOverlayWidthInMeters"); overlay_check(overlay->SetOverlayInputMethod(handle, vr::VROverlayInputMethod_Mouse), overlay, "SetOverlayInputMethod"); // This separate preference requests system-wide laser mouse mode only while the // panel is visible; it may affect interaction with a running game. if (lasers_anytime && overlay->SetOverlayFlag(handle, vr::VROverlayFlags_MakeOverlaysInteractiveIfVisible, true) != vr::VROverlayError_None) { lasers_anytime = false; persistence.laser_change_failed = true; } surface.set_lasers_anytime(lasers_anytime); surface.set_advanced_debug(config.advanced_debug); surface.set_auto_insert(config.auto_insert); surface.set_close_mic_when_idle(config.close_mic_when_idle); surface.set_layout_locked(config.lock_layout); surface.set_clock_24h(config.clock_24h); surface.set_date_format(config.date_format); surface.set_version(std::string(FRAMEYAP_VERSION) + (std::string(FRAMEYAP_GIT_INFO).empty() ? "" : " " FRAMEYAP_GIT_INFO)); overlay_check(overlay->SetOverlayFlag(handle, vr::VROverlayFlags_VisibleInDashboard, true), overlay, "VisibleInDashboard"); vr::HmdVector2_t mouse_scale{{float(W), float(H)}}; overlay_check(overlay->SetOverlayMouseScale(handle, &mouse_scale), overlay, "SetOverlayMouseScale"); update_intersection_mask(); system->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding, 0, poses.data(), uint32_t(poses.size())); place(); draw(Panel{"Disabled", "", "Record to start local worker", false, false}); std::cout << input_mode_status() << std::endl; } catch (...) { cleanup(); throw; } } ~Impl() { cleanup(); } void update_intersection_mask() { const auto regions = surface.input_regions(); std::vector mask(regions.size()); for (size_t i = 0; i < mask.size(); ++i) { const auto b = regions[i]; mask[i].m_nPrimitiveType = vr::OverlayIntersectionPrimitiveType_Rectangle; // Mask rectangles are TOP-left pixel coordinates. Mouse events are // bottom-left GL coordinates; flipping this mask makes the outside // scale corner unclickable while the body happens to cover Grab. mask[i].m_Primitive.m_Rectangle = {float(b.x), float(b.y), float(b.w), float(b.h)}; } overlay_check(overlay->SetOverlayIntersectionMask(handle, mask.data(), uint32_t(mask.size())), overlay, "SetOverlayIntersectionMask"); } void cleanup() { if (overlay && handle != vr::k_ulOverlayHandleInvalid) { overlay->HideOverlay(handle); overlay->DestroyOverlay(handle); handle = vr::k_ulOverlayHandleInvalid; } if (system) { vr::VR_Shutdown(); system = nullptr; overlay = nullptr; input = nullptr; } // OpenVR retains client-side resources for submitted Vulkan images. // Its shutdown must finish before their device/instance are destroyed. gpu_texture.reset(); } void visibility() { float alpha = 1.f; if (placed && applied_mount && (*applied_mount == Mount::LeftWrist || *applied_mount == Mount::RightWrist)) { alpha = tracked(anchor) && tracked(vr::k_unTrackedDeviceIndex_Hmd) ? wrist_view_opacity_relative(canvas_pose, matrix(poses[anchor].mDeviceToAbsoluteTracking), matrix(poses[vr::k_unTrackedDeviceIndex_Hmd].mDeviceToAbsoluteTracking)) : 0.f; } // Keep geometry/texture stationary; opacity is a compositor property, // not an upload. At zero, hide the interactive overlay as well. alpha = std::round(alpha * 255.f) / 255.f; if (alpha != published_alpha) { overlay_check(overlay->SetOverlayAlpha(handle, alpha), overlay, "SetOverlayAlpha"); published_alpha = alpha; } const bool wanted = placed && has_texture && alpha > 0.f; if (wanted == shown) return; overlay_check(wanted ? overlay->ShowOverlay(handle) : overlay->HideOverlay(handle), overlay, "Overlay visibility"); if (wanted) ++diagnostics.show_calls; else ++diagnostics.hide_calls; shown = wanted; } void place() { Mount effective = mount; vr::TrackedDeviceIndex_t target = vr::k_unTrackedDeviceIndex_Hmd; if (mount == Mount::LeftWrist || mount == Mount::RightWrist) { target = system->GetTrackedDeviceIndexForControllerRole(mount == Mount::LeftWrist ? vr::TrackedControllerRole_LeftHand : vr::TrackedControllerRole_RightHand); if (target >= poses.size() || !poses[target].bPoseIsValid || !system->IsTrackedDeviceConnected(target)) effective = Mount::World; } if (effective == Mount::World && applied_mount && *applied_mount != Mount::World) world_ready = false; // a fresh world fallback near the wearer, not an old room location std::string note = persistence.mic_save_failed ? "Mic preference not saved; using it only for this session." : persistence.layout_save_failed ? "Layout lock not saved; using it only for this session." : persistence.auto_save_failed ? "Auto insert preference not saved; using it only for this session." : persistence.debug_save_failed ? "Debug preference not saved; using it only for this session." : persistence.laser_change_failed ? "SteamVR declined the laser mode change." : persistence.save_failed ? "Preference could not be saved; using it for this session." : ""; if (effective != mount) note = persistence.save_failed ? "Wrist untracked; world fallback. Preference not saved." : "Wrist not tracked - using world space until it returns."; if (effective == Mount::World && !world_ready) { const auto& hmd = poses[vr::k_unTrackedDeviceIndex_Hmd]; Matrix34 pose{}; for (int r = 0; r < 3; ++r) for (int c = 0; c < 4; ++c) pose[r][c] = hmd.mDeviceToAbsoluteTracking.m[r][c]; const auto world = hmd.bPoseIsValid && hmd.bDeviceIsConnected ? world_mount_pose(pose) : std::nullopt; if (!world) { placed = false; surface.set_placement_note("Waiting for headset tracking to place the menu."); visibility(); return; } for (int r = 0; r < 3; ++r) for (int c = 0; c < 4; ++c) world_transform.m[r][c] = (*world)[r][c]; world_ready = true; applied_mount.reset(); } surface.set_placement_note(note); const bool relocated = applied_mount != effective || anchor != target; if (relocated || placement_dirty) { const float base_width = mount_width(effective, config.wrist); if (relocated) { surface.reset_pointers(); dragging.panel.reset(); auto pose = effective == Mount::World ? matrix(world_transform) : relative_mount_pose(effective, config.wrist); pose = resized_mount_pose(pose, base_width, size_scale, float(CH) / CW); // Preserve main-panel dimensions when adding transparent margins. const float meters_per_pixel = base_width * size_scale / CW; const float dx = (W - CW) * .5f * meters_per_pixel; const float dy = -(H - CH) * .5f * meters_per_pixel; for (int r = 0; r < 3; ++r) pose[r][3] += pose[r][0] * dx + pose[r][1] * dy; canvas_pose = pose; } // After a grab, keep the full released pose. Never rebuild it from // a planar offset or configured orientation on the next poll. vr::HmdMatrix34_t transform{}; for (int r = 0; r < 3; ++r) for (int c = 0; c < 4; ++c) transform.m[r][c] = canvas_pose[r][c]; if (effective == Mount::World) overlay_check(overlay->SetOverlayTransformAbsolute(handle, vr::TrackingUniverseStanding, &transform), overlay, "SetOverlayTransformAbsolute"); else overlay_check(overlay->SetOverlayTransformTrackedDeviceRelative(handle, target, &transform), overlay, "SetOverlayTransformTrackedDeviceRelative"); overlay_check(overlay->SetOverlayWidthInMeters(handle, base_width * size_scale * W / CW), overlay, "SetOverlayWidthInMeters"); applied_mount = effective; anchor = target; placement_dirty = false; } placed = true; visibility(); } bool tracked(vr::TrackedDeviceIndex_t device) const { return device < poses.size() && poses[device].bPoseIsValid && poses[device].bDeviceIsConnected; } std::optional drag_source() const { if (!tracked(dragging.device) || !applied_mount) return {}; auto pose = matrix(poses[dragging.device].mDeviceToAbsoluteTracking); if (*applied_mount != Mount::World) { if (!tracked(anchor)) return {}; pose = relative_pose(matrix(poses[anchor].mDeviceToAbsoluteTracking), pose); } return pose; } void begin_drag(PanelDragKind kind, const vr::VREvent_t& event) { if (config.lock_layout) { surface.reset_pointers(); dragging.panel.reset(); return; } dragging.device = event.trackedDeviceIndex; dragging.cursor = event.data.mouse.cursorIndex; // Single-cursor overlay: some runtime mouse events omit the source. // The dashboard's primary device is the only supported fallback, never // a guessed left/right hand or a source chosen by proximity. if (dragging.cursor == 0 && (dragging.device == vr::k_unTrackedDeviceIndexInvalid || dragging.device == vr::k_unTrackedDeviceIndex_Hmd)) dragging.device = overlay->GetPrimaryDashboardDevice(); dragging.kind = kind; const auto source = drag_source(); const float w = applied_mount ? mount_width(*applied_mount, config.wrist) * size_scale * W / CW : 0.f; if (!source || system->GetTrackedDeviceClass(dragging.device) != vr::TrackedDeviceClass_Controller || !dragging.panel.begin(kind, canvas_pose, w, w * H / W, event.data.mouse.x / W, 1.f - event.data.mouse.y / H, *source)) { surface.reset_pointers(); dragging.panel.reset(); diagnostics.last_pointer_event = "drag source unavailable"; return; } dragging.scale = size_scale; dragging.canvas = canvas_pose; dragging.started = std::chrono::steady_clock::now(); vr::VRControllerState_t state{}; dragging.trigger_observed = system->GetControllerState(dragging.device, &state, sizeof(state)) && (state.ulButtonPressed & vr::ButtonMaskFromId(vr::k_EButton_SteamVR_Trigger)); diagnostics.last_pointer_event = std::string(kind == PanelDragKind::Grab ? "grab" : "scale") + " device=" + std::to_string(dragging.device) + " trigger-watch=" + (dragging.trigger_observed ? "Y" : "N"); } void update_drag() { if (!dragging.panel.active()) return; const auto source = drag_source(); vr::VRControllerState_t state{}; const bool trigger_released = dragging.trigger_observed && (!system->GetControllerState(dragging.device, &state, sizeof(state)) || !(state.ulButtonPressed & vr::ButtonMaskFromId(vr::k_EButton_SteamVR_Trigger))); // Without a readable release watchdog, never keep manipulating after // the pointer leaves our hit region: an outside MouseUp is not assured. const bool lost_unwatched_pointer = !dragging.trigger_observed && !overlay->IsHoverTargetOverlay(handle); if (!surface.dragging(dragging.cursor) || !shown || !focus || !source || trigger_released || lost_unwatched_pointer || std::chrono::steady_clock::now() - dragging.started > std::chrono::seconds(15)) { surface.reset_pointers(); dragging.panel.reset(); return; } const auto change = dragging.panel.update(*source); if (!change) { surface.reset_pointers(); dragging.panel.reset(); return; } const float scale = dragging.kind == PanelDragKind::Scale ? std::clamp(dragging.scale * change->factor, .5f, 2.f) : size_scale; const auto pose = dragging.kind == PanelDragKind::Grab ? change->pose : resized_mount_pose(dragging.canvas, mount_width(*applied_mount, config.wrist) * dragging.scale * W / CW, scale / dragging.scale, float(H) / W); if (scale != size_scale || pose != canvas_pose) { size_scale = scale; canvas_pose = pose; placement_dirty = true; } } bool available(UiAction action) const { return surface.available(action); } std::optional device_battery(vr::TrackedDeviceIndex_t index) const { if (index == vr::k_unTrackedDeviceIndexInvalid || !system->IsTrackedDeviceConnected(index)) return {}; vr::ETrackedPropertyError error = vr::TrackedProp_Success; if (!system->GetBoolTrackedDeviceProperty(index, vr::Prop_DeviceProvidesBatteryStatus_Bool, &error) || error != vr::TrackedProp_Success) return {}; const float level = system->GetFloatTrackedDeviceProperty(index, vr::Prop_DeviceBatteryPercentage_Float, &error); if (error != vr::TrackedProp_Success || !std::isfinite(level) || level < 0.f || level > 1.f) return {}; const bool charging = system->GetBoolTrackedDeviceProperty(index, vr::Prop_DeviceIsCharging_Bool, &error); return BatteryLevel{int(std::lround(level * 100.f)), error == vr::TrackedProp_Success && charging}; } void update_indicators() { indicators.dashboard_open = overlay->IsDashboardVisible(); const auto now = std::chrono::steady_clock::now(); if (now - batteries_read >= std::chrono::seconds(5) || batteries_read == decltype(now){}) { batteries_read = now; indicators.left = device_battery(system->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_LeftHand)); indicators.right = device_battery(system->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_RightHand)); // A standalone headset may report its battery only through Linux. indicators.head = device_battery(vr::k_unTrackedDeviceIndex_Hmd); if (!indicators.head) indicators.head = system_battery(); } surface.set_indicators(indicators); } void draw(const Panel& p) { panel = p; surface.set_clock_time(std::time(nullptr)); update_indicators(); if (surface.render(p, PanelSurface::Clock::now(), shown)) { gpu_texture->upload(surface.pixels()); auto texture = gpu_texture->texture(); overlay_check(overlay->SetOverlayTexture(handle, &texture), overlay, "SetOverlayTexture (Vulkan)"); ++diagnostics.texture_uploads; has_texture = true; } visibility(); } void reset_input(std::vector& result) { left.reset(); const bool lost_grip = right.reset() == GripRecord::Change::Cancel || grip_capture; grip_capture = false; const bool lost_ptt = edges[0].reset() || ptt_capture; ptt_capture = false; if (lost_grip || lost_ptt) result.push_back(UiAction::Cancel); for (size_t i = 1; i < edges.size(); ++i) edges[i].reset(); surface.reset_pointers(); } int32_t action_priority() const { return config.experimental_input_priority ? vr::k_nActionSetOverlayGlobalPriorityMin : 0; } std::string input_mode_status() const { // Read the runtime permission separately: requesting a priority does not // enable SteamVR's global setting or prove delivery of controller input. vr::EVRSettingsError settings_error = vr::VRSettingsError_None; auto* settings = vr::VRSettings(); const bool allowed = settings && settings->GetBool(vr::k_pch_SteamVR_Section, vr::k_pch_SteamVR_AllowGlobalActionSetPriority, &settings_error); const char* permission = !settings || settings_error != vr::VRSettingsError_None ? "unavailable" : allowed ? "enabled" : "disabled"; bool laser_flag = false; const auto laser_error = overlay->GetOverlayFlag(handle, vr::VROverlayFlags_MakeOverlaysInteractiveIfVisible, &laser_flag); return std::string("Input priority-request=") + (config.experimental_input_priority ? "experimental" : "normal") + " (" + std::to_string(action_priority()) + ") SteamVR-global-input=" + permission + "\nMode dashboard=" + (overlay->IsDashboardVisible() ? "Y" : "N") + " lasers-anytime=" + (laser_error == vr::VROverlayError_None ? (laser_flag ? "Y" : "N") : "n/a") + " system-input-available=" + (system->IsInputAvailable() ? "Y" : "N") + " panel-shown=" + (shown ? "Y" : "N") + " focus-gate=" + (focus ? "Y" : "N") + "\nBattery L=" + battery_text(indicators.left) + " HMD=" + battery_text(indicators.head) + " R=" + battery_text(indicators.right); } // Bound actions are accepted only with a connected tracked source. A held input // following loss of activity must return to neutral before generating an edge. std::pair digital(size_t index) { vr::InputDigitalActionData_t data{}; if (input->GetDigitalActionData(actions[index], &data, sizeof(data), vr::k_ulInvalidInputValueHandle) != vr::VRInputError_None || !data.bActive || data.activeOrigin == vr::k_ulInvalidInputValueHandle) return {false, false}; vr::InputOriginInfo_t origin{}; if (input->GetOriginTrackedDeviceInfo(data.activeOrigin, &origin, sizeof(origin)) != vr::VRInputError_None || origin.trackedDeviceIndex == vr::k_unTrackedDeviceIndexInvalid || origin.trackedDeviceIndex >= poses.size() || !system->IsTrackedDeviceConnected(origin.trackedDeviceIndex) || !poses[origin.trackedDeviceIndex].bPoseIsValid) return {false, false}; if (index < 2) { const auto role = index == 0 ? vr::TrackedControllerRole_LeftHand : vr::TrackedControllerRole_RightHand; if (system->GetTrackedDeviceIndexForControllerRole(role) != origin.trackedDeviceIndex) return {false, false}; } return {true, data.bState}; } std::vector poll() { std::vector result; system->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding, 0, poses.data(), uint32_t(poses.size())); place(); vr::VREvent_t event{}; while (system->PollNextEvent(&event, sizeof(event))) { if (event.eventType == vr::VREvent_Quit) result.push_back(UiAction::Quit); if (event.eventType == vr::VREvent_OverlayFocusChanged) ++diagnostics.global_focus_events; if (event.eventType == vr::VREvent_InputFocusCaptured) ++diagnostics.input_focus_captured_events; if (event.eventType == vr::VREvent_SeatedZeroPoseReset || event.eventType == vr::VREvent_ChaperoneUniverseHasChanged) { world_ready = false; applied_mount.reset(); surface.reset_pointers(); } if (event.eventType == vr::VREvent_TrackedDeviceDeactivated || event.eventType == vr::VREvent_InputFocusCaptured) reset_input(result); } while (overlay->PollNextOverlayEvent(handle, &event, sizeof(event))) { switch (event.eventType) { case vr::VREvent_Quit: case vr::VREvent_OverlayClosed: result.push_back(UiAction::Quit); break; case vr::VREvent_OverlayHidden: ++diagnostics.overlay_hidden_events; focus = false; reset_input(result); if (panel.recording) result.push_back(UiAction::Cancel); break; case vr::VREvent_OverlayShown: ++diagnostics.overlay_shown_events; focus = true; reset_input(result); break; case vr::VREvent_ImageLoaded: ++diagnostics.image_loaded_events; break; case vr::VREvent_ImageFailed: ++diagnostics.image_failed_events; break; case vr::VREvent_OverlayGamepadFocusLost: surface.reset_pointers(); ++diagnostics.pointer_resets; diagnostics.last_pointer_event = "gamepad focus lost"; break; case vr::VREvent_OverlayFocusChanged: ++diagnostics.overlay_focus_events; // This global focus notification also fires when the dashboard // laser enters our overlay. Do not erase a press between down/up; // a release must still hit the same enabled control. diagnostics.last_pointer_event = "overlay focus changed"; break; case vr::VREvent_MouseMove: // Manipulation uses the captured controller ray, not coordinates // fed back from a changing overlay or a batch of stale mouse hits. break; case vr::VREvent_MouseButtonDown: ++diagnostics.pointer_downs; diagnostics.last_pointer_event = "down button=" + std::to_string(event.data.mouse.button); if (event.data.mouse.button == vr::VRMouseButton_Left) if (auto kind = surface.pointer_down(event.data.mouse.cursorIndex, event.data.mouse.x, H - event.data.mouse.y)) begin_drag(*kind, event); break; case vr::VREvent_MouseButtonUp: ++diagnostics.pointer_ups; diagnostics.last_pointer_event = "up button=" + std::to_string(event.data.mouse.button); if (event.data.mouse.button == vr::VRMouseButton_Left) { auto event_result = surface.pointer_up(event.data.mouse.cursorIndex, event.data.mouse.x, H - event.data.mouse.y); if (event_result.action || event_result.mount || event_result.recenter || event_result.lasers_anytime || event_result.open_bindings || event_result.advanced_debug || event_result.auto_insert || event_result.close_mic_when_idle || event_result.lock_layout || event_result.clock_24h || event_result.date_format || event_result.model_action) ++diagnostics.pointer_actions; if (event_result.action) result.push_back(*event_result.action); if (event_result.model_action) { model_actions.push_back(*event_result.model_action); reset_input(result); // revoke held PTT, delivery and stale pointer approval return result; } if (event_result.clock_24h) { config.clock_24h = *event_result.clock_24h; persistence.save_failed = persistence.persist_mount && !save_clock_24h(default_config_path(), config.clock_24h); surface.set_clock_24h(config.clock_24h); reset_input(result); return result; } if (event_result.date_format) { config.date_format = *event_result.date_format; persistence.save_failed = persistence.persist_mount && !save_date_format(default_config_path(), config.date_format); surface.set_date_format(config.date_format); reset_input(result); return result; } if (event_result.lock_layout) { config.lock_layout = *event_result.lock_layout; surface.set_layout_locked(config.lock_layout); update_intersection_mask(); persistence.layout_save_failed = persistence.persist_mount && !save_lock_layout(default_config_path(), config.lock_layout); reset_input(result); dragging.panel.reset(); return result; } if (event_result.close_mic_when_idle) { config.close_mic_when_idle = *event_result.close_mic_when_idle; persistence.mic_save_failed = persistence.persist_mount && !save_close_mic_when_idle(default_config_path(), config.close_mic_when_idle); surface.set_close_mic_when_idle(config.close_mic_when_idle); reset_input(result); // a setting change invalidates held actions return result; } if (event_result.auto_insert) { config.auto_insert = *event_result.auto_insert; persistence.auto_save_failed = persistence.persist_mount && !save_auto_insert(default_config_path(), config.auto_insert); surface.set_auto_insert(config.auto_insert); reset_input(result); // setting change invalidates held actions return result; } if (event_result.advanced_debug) { config.advanced_debug = *event_result.advanced_debug; persistence.debug_save_failed = persistence.persist_mount && !save_advanced_debug(default_config_path(), config.advanced_debug); surface.set_advanced_debug(config.advanced_debug); reset_input(result); // Runtime observes the change before handling this batch, // restarts its worker and invalidates pending work/actions. return result; } if (event_result.open_bindings) { // The editor changes input ownership. Invalidate held gestures // and pointer presses; never turn the returning release into input. reset_input(result); const auto error = input->OpenBindingUI(nullptr, action_set, vr::k_ulInvalidInputValueHandle, false); surface.set_binding_note(error == vr::VRInputError_None ? "SteamVR binding editor requested." : "SteamVR could not open bindings. Try its controller settings."); } if (event_result.lasers_anytime) { const bool enabled = *event_result.lasers_anytime; if (overlay->SetOverlayFlag(handle, vr::VROverlayFlags_MakeOverlaysInteractiveIfVisible, enabled) == vr::VROverlayError_None) { lasers_anytime = enabled; persistence.laser_change_failed = false; surface.set_lasers_anytime(enabled); persistence.save_failed = persistence.persist_mount && !save_lasers_anytime(persistence.laser_settings_path, enabled); } else { persistence.laser_change_failed = true; } } if (event_result.mount) { mount = *event_result.mount; persistence.save_failed = persistence.persist_mount && !save_mount(persistence.settings_path, mount); world_ready = false; applied_mount.reset(); } if (event_result.recenter) { world_ready = false; applied_mount.reset(); } } break; default: break; } } update_drag(); place(); if (dragging.panel.active()) { // A controller used to manipulate the panel must not also authorize // Record/Insert/Enter. Require neutral rearm after the drag ends. left.reset(); right.reset(); if (grip_capture || ptt_capture) result.push_back(UiAction::Cancel); grip_capture = ptt_capture = false; for (auto& edge : edges) edge.reset(); return result; } vr::VRActiveActionSet_t set{}; set.ulActionSet = action_set; set.ulRestrictedToDevice = vr::k_ulInvalidInputValueHandle; // Explicit opt-in affects only sources bound to our existing action set. // Keep requesting it across dashboard/laser states: those are what the // experiment compares. SteamVR's separate permission gate is never changed here. set.nPriority = action_priority(); diagnostics.action_update_error = input->UpdateActionState(&set, sizeof(set), 1); if (diagnostics.action_update_error != vr::VRInputError_None) { reset_input(result); return result; } auto [la, ld] = digital(0); auto [ra, rd] = digital(1); const auto now = DoubleTap::Clock::now(); if (left.update(la && focus, ld, available(UiAction::Enter), now)) result.push_back(UiAction::Enter); switch (right.update(ra && focus && !panel.quick_open, rd, now)) { case GripRecord::Change::Begin: grip_capture = true; result.push_back(UiAction::BeginRecord); break; case GripRecord::Change::End: grip_capture = false; result.push_back(UiAction::EndRecord); break; case GripRecord::Change::Cancel: grip_capture = false; result.push_back(UiAction::Cancel); break; case GripRecord::Change::None: break; } constexpr std::array mapped{{UiAction::Record, UiAction::Cancel, UiAction::Insert, UiAction::Enter, UiAction::QuickChat}}; for (size_t i = 0; i < edges.size(); ++i) { auto [active, down] = digital(i + 2); if (i == 0 && (!active || !focus || !panel.enabled || panel.quick_open) && edges[i].reset()) { ptt_capture = false; result.push_back(UiAction::Cancel); } auto change = edges[i].update(active && focus && ((panel.enabled && (i != 0 || !panel.quick_open)) || i == 1), down); if (i == 0) { if (change == NeutralEdge::Change::Down) { ptt_capture = true; result.push_back(UiAction::BeginRecord); } else if (change == NeutralEdge::Change::Up) { ptt_capture = false; result.push_back(UiAction::EndRecord); } } else if (change == NeutralEdge::Change::Down && available(mapped[i])) { result.push_back(mapped[i]); } } return result; } }; Overlay::Overlay(const std::string& assets, const std::string& font, std::optional mount, bool persist_mount) : impl_(std::make_unique(assets, font, mount, persist_mount)) {} Overlay::~Overlay() = default; std::vector Overlay::poll() { return impl_->poll(); } std::vector Overlay::take_model_actions() { auto result = std::move(impl_->model_actions); impl_->model_actions.clear(); return result; } void Overlay::draw(const Panel& panel) { impl_->draw(panel); } bool Overlay::advanced_debug() const { return impl_->config.advanced_debug; } bool Overlay::auto_insert() const { return impl_->config.auto_insert; } bool Overlay::close_mic_when_idle() const { return impl_->config.close_mic_when_idle; } const std::vector& Overlay::quick_inputs() const { return impl_->config.quick_inputs; } std::string Overlay::controls_status() { // Compare the same actions across modes, before and after our pose/role gate. // IsInputAvailable and a successful UpdateActionState are not delivery proof. std::string result = impl_->input_mode_status() + " update=" + std::to_string(int(impl_->diagnostics.action_update_error)); for (size_t i = 0; i < action_names.size(); ++i) { vr::InputDigitalActionData_t data{}; const auto error = impl_->input->GetDigitalActionData(impl_->actions[i], &data, sizeof(data), vr::k_ulInvalidInputValueHandle); const auto [accepted, down] = impl_->digital(i); result += std::string("\nAction ") + action_names[i] + " err=" + std::to_string(int(error)) + " active=" + (data.bActive ? "Y" : "N") + " down=" + (data.bState ? "Y" : "N") + " pose-role-accepted=" + (accepted ? "Y" : "N") + " gated-down=" + (down ? "Y" : "N"); } return result; } std::string Overlay::pointer_status() const { return "Pointer down=" + std::to_string(impl_->diagnostics.pointer_downs) + " up=" + std::to_string(impl_->diagnostics.pointer_ups) + " hits=" + std::to_string(impl_->diagnostics.pointer_actions) + " resets=" + std::to_string(impl_->diagnostics.pointer_resets) + " last=" + impl_->diagnostics.last_pointer_event + "\nOverlay renderer=Vulkan textureUploads=" + std::to_string(impl_->diagnostics.texture_uploads) + " showCalls=" + std::to_string(impl_->diagnostics.show_calls) + " hideCalls=" + std::to_string(impl_->diagnostics.hide_calls) + " shownEvents=" + std::to_string(impl_->diagnostics.overlay_shown_events) + " hiddenEvents=" + std::to_string(impl_->diagnostics.overlay_hidden_events) + " imageLoaded=" + std::to_string(impl_->diagnostics.image_loaded_events) + " imageFailed=" + std::to_string(impl_->diagnostics.image_failed_events) + " overlayFocus=" + std::to_string(impl_->diagnostics.overlay_focus_events) + " globalFocus=" + std::to_string(impl_->diagnostics.global_focus_events) + " inputCaptured=" + std::to_string(impl_->diagnostics.input_focus_captured_events); } int registration(const std::string& manifest, bool remove, bool autostart) { try { const auto path = absolute_file(manifest); // Utility initialization does not load hardware drivers. Call only for an // explicitly requested registration, never at static initialization. configure_registry(); if (!vr::VR_IsRuntimeInstalled()) throw std::runtime_error("OpenVR runtime not installed"); vr::EVRInitError err = vr::VRInitError_None; auto* system = vr::VR_Init(&err, vr::VRApplication_Utility); if (err != vr::VRInitError_None || !system) throw std::runtime_error(std::string("OpenVR utility init: ") + vr::VR_GetVRInitErrorAsEnglishDescription(err)); struct Shutdown { ~Shutdown() { vr::VR_Shutdown(); } } shutdown; auto* apps = vr::VRApplications(); if (!apps) throw std::runtime_error("OpenVR applications interface unavailable"); constexpr const char* key = "local.frameyap.overlay"; if (remove) { // Only remove the supplied manifest; never touch other applications. auto e = apps->RemoveApplicationManifest(path.c_str()); if (e != vr::VRApplicationError_None) throw std::runtime_error(apps->GetApplicationsErrorNameFromEnum(e)); } else { auto e = apps->AddApplicationManifest(path.c_str(), false); if (e != vr::VRApplicationError_None) throw std::runtime_error(apps->GetApplicationsErrorNameFromEnum(e)); if (autostart) { e = apps->SetApplicationAutoLaunch(key, true); if (e != vr::VRApplicationError_None) throw std::runtime_error(apps->GetApplicationsErrorNameFromEnum(e)); } } if (apps->IsApplicationInstalled(key) == remove) throw std::runtime_error("OpenVR registration state did not match the requested operation"); std::cout << (remove ? "Unregistered " : "Registered ") << key; if (!remove) std::cout << " (autolaunch=" << (apps->GetApplicationAutoLaunch(key) ? "on" : "off") << ")"; std::cout << '\n'; return 0; } catch (const std::exception& e) { std::cerr << "FrameYap registration: " << e.what() << '\n'; return 1; } } } // namespace frameyap