Skip to content


aleiby edited this page Jan 6, 2017 · 9 revisions


The vr::IVROverlay interface provides access to draw 2D images over the 3D scene no matter which application is running. Provided functions allow the application to control how each overlay is presented, what it contains, and to receive events.

The most common type is a Dashboard overlay, which adds a tab to the VR Dashboard. The user can select one active tab and the application is signaled when that happens. Simulated mouse events from the user pointing a tracked controller at the dashboard are sent to the application through events. See the helloworldoverlay sample for an example.

Each overlay has a unique VROverlayHandle_t. This handle is used to set attributes, receive events, and render into the overlay. There are several circumstances where an overlay is not known or is otherwise invalid. In those cases the handle will be equal to k_ulOverlayHandleInvalid.

Interface Functions

The vr::IVROverlay interface provides the following functions:

Clone this wiki locally