If you’ve ever opened the SteamVR dashboard mid-game and clicked through to a desktop mirror, a Discord overlay, or a utility like OpenVR Advanced Settings, you’ve used an OpenVR overlay — and the API behind all of them is smaller than you’d expect. This is a getting-started guide to building one, timed to this round’s look at Valve’s latest SteamVR streaming beta: the overlay layer is the part of SteamVR that sits entirely outside of whatever VR application is actually running, which is exactly why it’s such a useful place to build your own tools.
The two overlay types
OpenVR distinguishes a VRApplication_Overlay app — one that only interacts with overlays or the dashboard, never renders a full VR scene — from a conventional VR application that happens to also expose an overlay. Most dashboard utilities are the former: lightweight, don’t need SteamVR’s full rendering pipeline, and can run constantly in the background with minimal overhead.
A dashboard overlay actually consists of two handles: the main overlay (what you see when you click into it) and a thumbnail overlay — the small icon at the bottom of the dashboard users click to switch to your app. Both get created with CreateDashboardOverlay(), and critically: you can’t just call ShowOverlay() on a dashboard overlay the way you would a floating one. Dashboard overlays only become visible when a user opens them from the dashboard UI itself — which also means no Steam developer/partner status is required to ship one.
The basic flow
- Initialize OpenVR in the
VRApplication_Overlaymode rather thanVRApplication_Scene. - Create your overlay(s) with
CreateDashboardOverlay(), getting back a main handle and a thumbnail handle. - Set a texture on the main overlay — this is what renders when a user opens your app from the dashboard. Static image, a render target you update every frame, whatever your use case needs.
- Poll for events with
PollNextOverlayEvent()— this is how you detect clicks, and the event payload includes the mouse position within your overlay’s UV space. - Respond and redraw.
That’s genuinely most of it for a basic dashboard widget. Following a device’s position (to anchor an overlay to a controller, say), drawing camera passthrough output, or wiring up controller input for direct interaction are all extensions of the same core loop — poll, read state, update the texture, repeat.
Where to go from here
The OpenVR repository itself (Valve’s official SDK) is the canonical reference for the full API surface — IVROverlay has calls well beyond what a first project needs. A community Unity-focused tutorial series walks the same initialize → create → draw → poll sequence step by step if C# and Unity’s SteamVR plugin are your stack, and VR Utility Belt’s add-on documentation is a good second reference for how a production overlay app structures update loops and settings persistence.