Skip to content

Commit 99cd2d5

Browse files
committed
add comments for public api
1 parent adb406a commit 99cd2d5

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

Packages/com.unity.inputsystem/InputSystem/Plugins/XR/GenericXRDevice.cs

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,39 @@ public class XRHMD : TrackedDevice
3232
///
3333
/// </remarks>
3434

35+
/// <summary>
36+
/// Accessor for left eye position.
37+
/// </summary>
3538
[InputControl(noisy = true)]
3639
public Vector3Control leftEyePosition { get; protected set; }
40+
41+
/// <summary>
42+
/// Accessor for left eye rotation.
43+
/// </summary>
3744
[InputControl(noisy = true)]
3845
public QuaternionControl leftEyeRotation { get; protected set; }
3946
[InputControl(noisy = true)]
47+
48+
/// <summary>
49+
/// Accessor for right eye position.
50+
/// </summary>
4051
public Vector3Control rightEyePosition { get; protected set; }
4152
[InputControl(noisy = true)]
53+
54+
/// <summary>
55+
/// Accessor for right eye rotation.
56+
/// </summary>
4257
public QuaternionControl rightEyeRotation { get; protected set; }
58+
59+
/// <summary>
60+
/// Accessor for center eye position.
61+
/// </summary>
4362
[InputControl(noisy = true)]
4463
public Vector3Control centerEyePosition { get; protected set; }
64+
65+
/// <summary>
66+
/// Accessor for center eye rotation.
67+
/// </summary>
4568
[InputControl(noisy = true)]
4669
public QuaternionControl centerEyeRotation { get; protected set; }
4770

@@ -118,6 +141,11 @@ protected override void FinishSetup()
118141
/// </summary>
119142
public class XRControllerWithRumble : XRController
120143
{
144+
/// <summary>
145+
/// Sends an impulse command with the given amplitude and duration.
146+
/// </summary>
147+
/// <param name="amplitude"> Amplitude of the impulse.</param>
148+
/// <param name="duration"> Duration of the impulse.</param>
121149
public void SendImpulse(float amplitude, float duration)
122150
{
123151
var command = SendHapticImpulseCommand.Create(0, amplitude, duration);

0 commit comments

Comments
 (0)