Api Sandbox VR VROverlay
class

VROverlay

public class VROverlay

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. This makes them ideal for HUDs or menus, or anything else that should be local to the HMD or tracked devices.If you need something in the world, consider using WorldPanel and WorldInput instead.

Attributes

[ Obsolete ]

Constructors

VROverlay()

Properties

Name Type Description
Visible Boolean Shows or hides the VR overlay.
Transform Transform Sets the transform to absolute tracking origin
SortOrder UInt32 Sets the rendering sort order for the overlay.
Width Single The width of the overlay quad. By default overlays are rendered on a quad that is 1 meter across.
Curvature Single 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).
Color 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.
Texture Texture Texture that is rendered on the overlay quad. TextureBuilder
MouseScale Vector2 Sets the mouse scaling factor that is used for mouse events.

Methods

virtual Void Dispose()

Destroys this overlay.

Void SetTransformAbsolute(Transform transform)

Sets the transform to absolute tracking origin

Assembly: Sandbox.Engine Namespace: Sandbox.VR Full Name: Sandbox.VR.VROverlay