public class Sandbox.VR.VROverlayObsolete
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.
Obsolete
Unsupported by OpenXR. Please use WorldPanel.
Constructors
Showing 1 constructors
public VROverlay()
No results match this filter.
Methods
Showing 4 methods
protected virtual override void Finalize()
public void SetTransformAbsolute(Transform transform)
Sets the transform to absolute tracking origin
No results match this filter.
Properties
Showing 8 properties
public Color Sandbox.VR.VROverlay.Color { get; set; }
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.
public float Sandbox.VR.VROverlay.Curvature { get; set; }
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).
public Vector2 Sandbox.VR.VROverlay.MouseScale { get; set; }
Sets the mouse scaling factor that is used for mouse events.
public uint Sandbox.VR.VROverlay.SortOrder { get; set; }
Sets the rendering sort order for the overlay.
public Sandbox.Texture Sandbox.VR.VROverlay.Texture { get; set; }
Texture that is rendered on the overlay quad. `Sandbox.TextureBuilder`
No results match this filter.
Metadata
| Field | Value |
|---|---|
| Namespace | Sandbox.VR |
| Type | class |
| Assembly | Sandbox.Engine |
| Doc ID | T:Sandbox.VR.VROverlay |