Show / Hide Table of Contents

    Class SteamVR_Overlay

    Inheritance
    System.Object
    UnityEngine.Object
    UnityEngine.Component
    UnityEngine.Behaviour
    UnityEngine.MonoBehaviour
    SteamVR_Overlay
    Inherited Members
    UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)
    UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)
    UnityEngine.MonoBehaviour.CancelInvoke()
    UnityEngine.MonoBehaviour.CancelInvoke(System.String)
    UnityEngine.MonoBehaviour.IsInvoking(System.String)
    UnityEngine.MonoBehaviour.IsInvoking()
    UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)
    UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)
    UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)
    UnityEngine.MonoBehaviour.StartCoroutine(System.String)
    UnityEngine.MonoBehaviour.StopCoroutine(System.String)
    UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)
    UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)
    UnityEngine.MonoBehaviour.StopAllCoroutines()
    UnityEngine.MonoBehaviour.print(System.Object)
    UnityEngine.MonoBehaviour.useGUILayout
    UnityEngine.Behaviour.enabled
    UnityEngine.Behaviour.isActiveAndEnabled
    UnityEngine.Component.GetComponent(System.Type)
    UnityEngine.Component.GetComponent<T>()
    UnityEngine.Component.GetComponent(System.String)
    UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)
    UnityEngine.Component.GetComponentInChildren(System.Type)
    UnityEngine.Component.GetComponentInChildren<T>()
    UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)
    UnityEngine.Component.GetComponentsInChildren(System.Type)
    UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)
    UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)
    UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponentsInChildren<T>()
    UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponentInParent(System.Type)
    UnityEngine.Component.GetComponentInParent<T>()
    UnityEngine.Component.GetComponentsInParent(System.Type)
    UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)
    UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)
    UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponentsInParent<T>()
    UnityEngine.Component.GetComponents(System.Type)
    UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)
    UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponents<T>()
    UnityEngine.Component.CompareTag(System.String)
    UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)
    UnityEngine.Component.SendMessageUpwards(System.String, System.Object)
    UnityEngine.Component.SendMessageUpwards(System.String)
    UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)
    UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
    UnityEngine.Component.SendMessage(System.String, System.Object)
    UnityEngine.Component.SendMessage(System.String)
    UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)
    UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
    UnityEngine.Component.BroadcastMessage(System.String, System.Object)
    UnityEngine.Component.BroadcastMessage(System.String)
    UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)
    UnityEngine.Component.transform
    UnityEngine.Component.gameObject
    UnityEngine.Component.tag
    UnityEngine.Component.rigidbody
    UnityEngine.Component.rigidbody2D
    UnityEngine.Component.camera
    UnityEngine.Component.light
    UnityEngine.Component.animation
    UnityEngine.Component.constantForce
    UnityEngine.Component.renderer
    UnityEngine.Component.audio
    UnityEngine.Component.guiText
    UnityEngine.Component.networkView
    UnityEngine.Component.guiElement
    UnityEngine.Component.guiTexture
    UnityEngine.Component.collider
    UnityEngine.Component.collider2D
    UnityEngine.Component.hingeJoint
    UnityEngine.Component.particleEmitter
    UnityEngine.Component.particleSystem
    UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
    UnityEngine.Object.Destroy(UnityEngine.Object)
    UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
    UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
    UnityEngine.Object.FindObjectsOfType(System.Type)
    UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
    UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
    UnityEngine.Object.DestroyObject(UnityEngine.Object)
    UnityEngine.Object.FindSceneObjectsOfType(System.Type)
    UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
    UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
    UnityEngine.Object.ToString()
    UnityEngine.Object.GetInstanceID()
    UnityEngine.Object.GetHashCode()
    UnityEngine.Object.Equals(System.Object)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
    UnityEngine.Object.Instantiate(UnityEngine.Object)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
    UnityEngine.Object.Instantiate<T>(T)
    UnityEngine.Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectOfType(System.Type)
    UnityEngine.Object.FindObjectOfType<T>()
    UnityEngine.Object.name
    UnityEngine.Object.hideFlags
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Valve.VR
    Assembly: Assembly-CSharp.dll
    Syntax
    public class SteamVR_Overlay : MonoBehaviour

    Fields

    alpha

    Declaration
    [Tooltip("Opacity")]
    [Range(0F, 1F)]
    public float alpha
    Field Value
    Type Description
    System.Single

    antialias

    Declaration
    public bool antialias
    Field Value
    Type Description
    System.Boolean

    curved

    Declaration
    public bool curved
    Field Value
    Type Description
    System.Boolean

    curvedRange

    Declaration
    public Vector2 curvedRange
    Field Value
    Type Description
    UnityEngine.Vector2

    distance

    Declaration
    [Tooltip("Distance from surface.")]
    public float distance
    Field Value
    Type Description
    System.Single

    highquality

    Declaration
    public bool highquality
    Field Value
    Type Description
    System.Boolean

    inputMethod

    Declaration
    public VROverlayInputMethod inputMethod
    Field Value
    Type Description
    VROverlayInputMethod

    mouseScale

    Declaration
    public Vector2 mouseScale
    Field Value
    Type Description
    UnityEngine.Vector2

    scale

    Declaration
    [Tooltip("Size of overlay view.")]
    public float scale
    Field Value
    Type Description
    System.Single

    texture

    Declaration
    public Texture texture
    Field Value
    Type Description
    UnityEngine.Texture

    uvOffset

    Declaration
    public Vector4 uvOffset
    Field Value
    Type Description
    UnityEngine.Vector4

    Properties

    instance

    Declaration
    public static SteamVR_Overlay instance { get; }
    Property Value
    Type Description
    SteamVR_Overlay

    key

    Declaration
    public static string key { get; }
    Property Value
    Type Description
    System.String

    Methods

    ComputeIntersection(Vector3, Vector3, ref SteamVR_Overlay.IntersectionResults)

    Declaration
    public bool ComputeIntersection(Vector3 source, Vector3 direction, ref SteamVR_Overlay.IntersectionResults results)
    Parameters
    Type Name Description
    UnityEngine.Vector3 source
    UnityEngine.Vector3 direction
    SteamVR_Overlay.IntersectionResults results
    Returns
    Type Description
    System.Boolean

    PollNextEvent(ref VREvent_t)

    Declaration
    public bool PollNextEvent(ref VREvent_t pEvent)
    Parameters
    Type Name Description
    VREvent_t pEvent
    Returns
    Type Description
    System.Boolean

    UpdateOverlay()

    Declaration
    public void UpdateOverlay()
    In This Article
    • Fields
      • alpha
      • antialias
      • curved
      • curvedRange
      • distance
      • highquality
      • inputMethod
      • mouseScale
      • scale
      • texture
      • uvOffset
    • Properties
      • instance
      • key
    • Methods
      • ComputeIntersection(Vector3, Vector3, ref SteamVR_Overlay.IntersectionResults)
      • PollNextEvent(ref VREvent_t)
      • UpdateOverlay()
    Back to top Copyright (c) Valve Corporation, All rights reserved.