Summary
<para>VR overlays draw over the top of the 3D scene, they will not be affected by lighting,
post processing effects or anything else in the world.<br />
This makes them ideal for HUDs or menus, or anything else that should be local to the
HMD or tracked devices.</para><para>If you need something in the world, consider using WorldPanel
and WorldInput instead.</para>
Properties
| Color |
Sets the color tint of the overlay quad. Use 0.0 to 1.0 per channel.
Sets the alpha of the overlay quad. Use 1.0 for 100 percent opacity to 0.0 for 0 percent opacity.
|
| Curvature |
Use to draw overlay as a curved surface. Curvature is a percentage from (0..1] where 1 is a fully closed cylinder.
For a specific radius, curvature can be computed as: overlay.width / (2 PI r).
|
| MouseScale |
Sets the mouse scaling factor that is used for mouse events.
|
| SortOrder |
Sets the rendering sort order for the overlay.
|
| Texture |
Texture that is rendered on the overlay quad.
Sandbox.TextureBuilder |
| Transform |
Sets the transform to absolute tracking origin
|
| Visible |
Shows or hides the VR overlay.
|
| Width |
The width of the overlay quad.
By default overlays are rendered on a quad that is 1 meter across.
|
Methods