We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

    Show / Hide Table of Contents

    Struct Headset

    The headset definition defines the headset as defined by the SDK / Unity.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Microsoft.MixedReality.Toolkit.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public struct Headset

    Properties

    HeadsetSDKType

    The designated hand that the controller is managing, as defined by the SDK / Unity.

    Declaration
    public SDKType HeadsetSDKType { get; set; }
    Property Value
    Type Description
    SDKType

    Id

    The ID assigned to the Headset

    Declaration
    public string Id { get; set; }
    Property Value
    Type Description
    String

    IsOpaque

    Indicates whether or not the headset display is opaque. As defined by the SDK / Unity.

    Declaration
    public bool IsOpaque { get; set; }
    Property Value
    Type Description
    Boolean

    IsPositionAvailable

    Indicates whether or not the headset is currently providing position data.

    Declaration
    public bool IsPositionAvailable { get; set; }
    Property Value
    Type Description
    Boolean

    IsRotationAvailable

    Indicates whether or not the headset is currently providing rotation data.

    Declaration
    public bool IsRotationAvailable { get; set; }
    Property Value
    Type Description
    Boolean

    Position

    Outputs the current position of the headset, as defined by the SDK / Unity.

    Declaration
    public Vector3 Position { get; set; }
    Property Value
    Type Description
    Vector3

    Rotation

    Outputs the current rotation of the headset, as defined by the SDK / Unity.

    Declaration
    public Quaternion Rotation { get; set; }
    Property Value
    Type Description
    Quaternion

    TrackingState

    Outputs the current state of the headset, whether it is tracked or not. As defined by the SDK / Unity.

    Declaration
    public TrackingState TrackingState { get; set; }
    Property Value
    Type Description
    TrackingState
    Back to top Generated by DocFX