forked from stride3d/stride
/
OpenVR.cs
497 lines (419 loc) · 20.9 KB
/
OpenVR.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
// Copyright (c) .NET Foundation and Contributors (https://dotnetfoundation.org/ & https://stride3d.net) and Silicon Studio Corp. (https://www.siliconstudio.co.jp)
// Distributed under the MIT license. See the LICENSE.md file in the project root for more information.
#if STRIDE_GRAPHICS_API_DIRECT3D11
using System;
using System.Text;
using SharpDX.Direct3D11;
using Valve.VR;
using Stride.Core;
using Stride.Core.Mathematics;
using Stride.Graphics;
using System.Runtime.CompilerServices;
using System.Diagnostics;
namespace Stride.VirtualReality
{
internal static class OpenVR
{
/// <summary>Bypasses definite assignment rules for a given reference.
/// <para>A thin wrapper around <see cref="Unsafe.SkipInit{T}(out T)"/> for the sole purpose of making it usable in an expression.</para></summary>
/// <typeparam name="T">The type of the reference.</typeparam>
/// <param name="value">The reference whose initialization should be skipped.</param>
/// <returns>The reference to <paramref name="value"/>.</returns>
/// <remarks>Take care to ensure that the struct has been initialized appropriately, otherwise the struct's fields could contain uninitialized data from the stack.</remarks>
private static ref T SkipInit<T>(out T value)
{
Unsafe.SkipInit(out value);
return ref value;
}
public class Controller
{
// This helper can be used in a variety of ways. Beware that indices may change
// as new devices are dynamically added or removed, controllers are physically
// swapped between hands, arms crossed, etc.
public enum Hand
{
Left,
Right,
}
public static int GetDeviceIndex(Hand hand)
{
var currentIndex = 0;
for (uint index = 0; index < DevicePoses.Length; index++)
{
if (Valve.VR.OpenVR.System.GetTrackedDeviceClass(index) == ETrackedDeviceClass.Controller)
{
if (hand == Hand.Left && Valve.VR.OpenVR.System.GetControllerRoleForTrackedDeviceIndex(index) == ETrackedControllerRole.LeftHand)
{
return currentIndex;
}
if (hand == Hand.Right && Valve.VR.OpenVR.System.GetControllerRoleForTrackedDeviceIndex(index) == ETrackedControllerRole.RightHand)
{
return currentIndex;
}
currentIndex++;
}
}
return -1;
}
public class ButtonMask
{
public const ulong System = (1ul << (int)EVRButtonId.k_EButton_System); // reserved
public const ulong ApplicationMenu = (1ul << (int)EVRButtonId.k_EButton_ApplicationMenu);
public const ulong Grip = (1ul << (int)EVRButtonId.k_EButton_Grip);
public const ulong Axis0 = (1ul << (int)EVRButtonId.k_EButton_Axis0);
public const ulong Axis1 = (1ul << (int)EVRButtonId.k_EButton_Axis1);
public const ulong Axis2 = (1ul << (int)EVRButtonId.k_EButton_Axis2);
public const ulong Axis3 = (1ul << (int)EVRButtonId.k_EButton_Axis3);
public const ulong Axis4 = (1ul << (int)EVRButtonId.k_EButton_Axis4);
public const ulong Touchpad = (1ul << (int)EVRButtonId.k_EButton_SteamVR_Touchpad);
public const ulong Trigger = (1ul << (int)EVRButtonId.k_EButton_SteamVR_Trigger);
}
public enum ButtonId
{
ButtonSystem = 0,
ButtonApplicationMenu = 1,
ButtonGrip = 2,
ButtonDPadLeft = 3,
ButtonDPadUp = 4,
ButtonDPadRight = 5,
ButtonDPadDown = 6,
ButtonA = 7,
ButtonProximitySensor = 31,
ButtonAxis0 = 32,
ButtonAxis1 = 33,
ButtonAxis2 = 34,
ButtonAxis3 = 35,
ButtonAxis4 = 36,
ButtonSteamVrTouchpad = 32,
ButtonSteamVrTrigger = 33,
ButtonDashboardBack = 2,
ButtonMax = 64,
}
public Controller(int controllerIndex)
{
var currentIndex = 0;
for (uint index = 0; index < DevicePoses.Length; index++)
{
if (Valve.VR.OpenVR.System.GetTrackedDeviceClass(index) == ETrackedDeviceClass.Controller)
{
if (currentIndex == controllerIndex)
{
ControllerIndex = index;
break;
}
currentIndex++;
}
}
}
internal uint ControllerIndex;
internal VRControllerState_t State;
internal VRControllerState_t PreviousState;
public bool GetPress(ulong buttonMask) { return (State.ulButtonPressed & buttonMask) != 0; }
public bool GetPressDown(ulong buttonMask) { return (State.ulButtonPressed & buttonMask) != 0 && (PreviousState.ulButtonPressed & buttonMask) == 0; }
public bool GetPressUp(ulong buttonMask) { return (State.ulButtonPressed & buttonMask) == 0 && (PreviousState.ulButtonPressed & buttonMask) != 0; }
public bool GetPress(ButtonId buttonId) { return GetPress(1ul << (int)buttonId); }
public bool GetPressDown(ButtonId buttonId) { return GetPressDown(1ul << (int)buttonId); }
public bool GetPressUp(ButtonId buttonId) { return GetPressUp(1ul << (int)buttonId); }
public bool GetTouch(ulong buttonMask) { return (State.ulButtonTouched & buttonMask) != 0; }
public bool GetTouchDown(ulong buttonMask) { return (State.ulButtonTouched & buttonMask) != 0 && (PreviousState.ulButtonTouched & buttonMask) == 0; }
public bool GetTouchUp(ulong buttonMask) { return (State.ulButtonTouched & buttonMask) == 0 && (PreviousState.ulButtonTouched & buttonMask) != 0; }
public bool GetTouch(ButtonId buttonId) { return GetTouch(1ul << (int)buttonId); }
public bool GetTouchDown(ButtonId buttonId) { return GetTouchDown(1ul << (int)buttonId); }
public bool GetTouchUp(ButtonId buttonId) { return GetTouchUp(1ul << (int)buttonId); }
public Vector2 GetAxis(ButtonId buttonId = ButtonId.ButtonSteamVrTouchpad)
{
var axisId = (uint)buttonId - (uint)EVRButtonId.k_EButton_Axis0;
switch (axisId)
{
case 0: return new Vector2(State.rAxis0.x, State.rAxis0.y);
case 1: return new Vector2(State.rAxis1.x, State.rAxis1.y);
case 2: return new Vector2(State.rAxis2.x, State.rAxis2.y);
case 3: return new Vector2(State.rAxis3.x, State.rAxis3.y);
case 4: return new Vector2(State.rAxis4.x, State.rAxis4.y);
}
return Vector2.Zero;
}
public void Update()
{
PreviousState = State;
Valve.VR.OpenVR.System.GetControllerState(ControllerIndex, ref State, (uint)Unsafe.SizeOf<VRControllerState_t>());
}
}
public class TrackedDevice
{
public TrackedDevice(int trackerIndex)
{
TrackerIndex = trackerIndex;
}
const int StringBuilderSize = 64;
StringBuilder serialNumberStringBuilder = new StringBuilder(StringBuilderSize);
internal string SerialNumber
{
get
{
var error = ETrackedPropertyError.TrackedProp_Success;
serialNumberStringBuilder.Clear();
Valve.VR.OpenVR.System.GetStringTrackedDeviceProperty((uint)TrackerIndex, ETrackedDeviceProperty.Prop_SerialNumber_String, serialNumberStringBuilder, StringBuilderSize, ref error);
if (error == ETrackedPropertyError.TrackedProp_Success)
return serialNumberStringBuilder.ToString();
else
return "";
}
}
internal float BatteryPercentage
{
get
{
var error = ETrackedPropertyError.TrackedProp_Success;
var value = Valve.VR.OpenVR.System.GetFloatTrackedDeviceProperty((uint)TrackerIndex, ETrackedDeviceProperty.Prop_DeviceBatteryPercentage_Float, ref error);
if (error == ETrackedPropertyError.TrackedProp_Success)
return value;
else
return 0;
}
}
internal int TrackerIndex;
internal ETrackedDeviceClass DeviceClass => Valve.VR.OpenVR.System.GetTrackedDeviceClass((uint)TrackerIndex);
}
private static readonly TrackedDevicePose_t[] DevicePoses = new TrackedDevicePose_t[Valve.VR.OpenVR.k_unMaxTrackedDeviceCount];
private static readonly TrackedDevicePose_t[] GamePoses = new TrackedDevicePose_t[Valve.VR.OpenVR.k_unMaxTrackedDeviceCount];
static OpenVR()
{
NativeLibraryHelper.PreloadLibrary("openvr_api", typeof(OpenVR));
}
public static bool InitDone = false;
public static bool Init()
{
var err = EVRInitError.None;
Valve.VR.OpenVR.Init(ref err);
if (err != EVRInitError.None)
{
return false;
}
InitDone = true;
//this makes the camera behave like oculus rift default!
Valve.VR.OpenVR.Compositor.SetTrackingSpace(ETrackingUniverseOrigin.TrackingUniverseSeated);
return true;
}
public static void Shutdown()
{
if (!InitDone) return;
Valve.VR.OpenVR.Shutdown();
InitDone = false;
}
public static bool Submit(int eyeIndex, Texture texture, ref RectangleF viewport)
{
var tex = new Texture_t
{
eType = ETextureType.DirectX,
eColorSpace = EColorSpace.Auto,
handle = texture.NativeResource.NativePointer,
};
var bounds = new VRTextureBounds_t
{
uMin = viewport.X,
uMax = viewport.Width,
vMin = viewport.Y,
vMax = viewport.Height,
};
return Valve.VR.OpenVR.Compositor.Submit(eyeIndex == 0 ? EVREye.Eye_Left : EVREye.Eye_Right, ref tex, ref bounds, EVRSubmitFlags.Submit_Default) == EVRCompositorError.None;
}
public static void GetEyeToHead(int eyeIndex, out Matrix pose)
{
GetEyeToHeadUnsafe(eyeIndex, out pose);
}
private static unsafe void GetEyeToHeadUnsafe(int eyeIndex, out Matrix pose)
{
Debug.Assert(Unsafe.SizeOf<Matrix>() > Unsafe.SizeOf<HmdMatrix34_t>());
pose = Matrix.Identity;
var eye = eyeIndex == 0 ? EVREye.Eye_Left : EVREye.Eye_Right;
var eyeToHead = Valve.VR.OpenVR.System.GetEyeToHeadTransform(eye);
Unsafe.As<Matrix, HmdMatrix34_t>(ref pose) = eyeToHead;
}
public static void UpdatePoses()
{
Valve.VR.OpenVR.Compositor.WaitGetPoses(DevicePoses, GamePoses);
}
public static void Recenter()
{
Valve.VR.OpenVR.Chaperone.ResetZeroPose(ETrackingUniverseOrigin.TrackingUniverseSeated);
}
public static void SetTrackingSpace(ETrackingUniverseOrigin space)
{
Valve.VR.OpenVR.Compositor.SetTrackingSpace(space);
}
public static DeviceState GetControllerPose(int controllerIndex, out Matrix pose, out Vector3 velocity, out Vector3 angVelocity)
{
return GetControllerPoseUnsafe(controllerIndex, out pose, out velocity, out angVelocity);
}
private static unsafe DeviceState GetControllerPoseUnsafe(int controllerIndex, out Matrix pose, out Vector3 velocity, out Vector3 angVelocity)
{
Debug.Assert(Unsafe.SizeOf<Vector3>() == Unsafe.SizeOf<HmdVector3_t>());
Debug.Assert(Unsafe.SizeOf<Matrix>() > Unsafe.SizeOf<HmdMatrix34_t>());
var currentIndex = 0;
pose = Matrix.Identity;
for (uint index = 0; index < DevicePoses.Length; index++)
{
if (Valve.VR.OpenVR.System.GetTrackedDeviceClass(index) == ETrackedDeviceClass.Controller)
{
if (currentIndex == controllerIndex)
{
ref var devicePose = ref DevicePoses[index];
Unsafe.As<Matrix, HmdMatrix34_t>(ref pose) = devicePose.mDeviceToAbsoluteTracking;
Unsafe.As<Vector3, HmdVector3_t>(ref SkipInit(out velocity)) = devicePose.vVelocity;
Unsafe.As<Vector3, HmdVector3_t>(ref SkipInit(out angVelocity)) = devicePose.vAngularVelocity;
var state = DeviceState.Invalid;
if (devicePose.bDeviceIsConnected && devicePose.bPoseIsValid)
{
state = DeviceState.Valid;
}
else if (devicePose.bDeviceIsConnected && !devicePose.bPoseIsValid && devicePose.eTrackingResult == ETrackingResult.Running_OutOfRange)
{
state = DeviceState.OutOfRange;
}
return state;
}
currentIndex++;
}
}
velocity = default;
angVelocity = default;
return DeviceState.Invalid;
}
public static DeviceState GetTrackerPose(int trackerIndex, out Matrix pose, out Vector3 velocity, out Vector3 angVelocity)
{
return GetTrackerPoseUnsafe(trackerIndex, out pose, out velocity, out angVelocity);
}
private static unsafe DeviceState GetTrackerPoseUnsafe(int trackerIndex, out Matrix pose, out Vector3 velocity, out Vector3 angVelocity)
{
Debug.Assert(Unsafe.SizeOf<Vector3>() == Unsafe.SizeOf<HmdVector3_t>());
Debug.Assert(Unsafe.SizeOf<Matrix>() > Unsafe.SizeOf<HmdMatrix34_t>());
pose = Matrix.Identity;
ref var devicePose = ref DevicePoses[trackerIndex];
Unsafe.As<Matrix, HmdMatrix34_t>(ref pose) = devicePose.mDeviceToAbsoluteTracking;
Unsafe.As<Vector3, HmdVector3_t>(ref SkipInit(out velocity)) = devicePose.vVelocity;
Unsafe.As<Vector3, HmdVector3_t>(ref SkipInit(out angVelocity)) = devicePose.vAngularVelocity;
var state = DeviceState.Invalid;
if (devicePose.bDeviceIsConnected && devicePose.bPoseIsValid)
{
state = DeviceState.Valid;
}
else if (devicePose.bDeviceIsConnected && !devicePose.bPoseIsValid && devicePose.eTrackingResult == ETrackingResult.Running_OutOfRange)
{
state = DeviceState.OutOfRange;
}
return state;
}
public static DeviceState GetHeadPose(out Matrix pose, out Vector3 linearVelocity, out Vector3 angularVelocity)
{
return GetHeadPoseUnsafe(out pose, out linearVelocity, out angularVelocity);
}
private static unsafe DeviceState GetHeadPoseUnsafe(out Matrix pose, out Vector3 linearVelocity, out Vector3 angularVelocity)
{
Debug.Assert(Unsafe.SizeOf<Vector3>() == Unsafe.SizeOf<HmdVector3_t>());
Debug.Assert(Unsafe.SizeOf<Matrix>() > Unsafe.SizeOf<HmdMatrix34_t>());
pose = Matrix.Identity;
for (uint index = 0; index < DevicePoses.Length; index++)
{
ref var devicePose = ref DevicePoses[index];
if (Valve.VR.OpenVR.System.GetTrackedDeviceClass(index) == ETrackedDeviceClass.HMD)
{
Unsafe.As<Matrix, HmdMatrix34_t>(ref pose) = devicePose.mDeviceToAbsoluteTracking;
Unsafe.As<Vector3, HmdVector3_t>(ref SkipInit(out linearVelocity)) = devicePose.vVelocity;
Unsafe.As<Vector3, HmdVector3_t>(ref SkipInit(out angularVelocity)) = devicePose.vAngularVelocity;
var state = DeviceState.Invalid;
if (DevicePoses[index].bDeviceIsConnected && DevicePoses[index].bPoseIsValid)
{
state = DeviceState.Valid;
}
else if (DevicePoses[index].bDeviceIsConnected && !DevicePoses[index].bPoseIsValid && DevicePoses[index].eTrackingResult == ETrackingResult.Running_OutOfRange)
{
state = DeviceState.OutOfRange;
}
return state;
}
}
linearVelocity = default;
angularVelocity = default;
return DeviceState.Invalid;
}
public static void GetProjection(int eyeIndex, float near, float far, out Matrix projection)
{
GetProjectionUnsafe(eyeIndex, near, far, out projection);
}
private static unsafe void GetProjectionUnsafe(int eyeIndex, float near, float far, out Matrix projection)
{
Debug.Assert(Unsafe.SizeOf<HmdMatrix44_t>() == Unsafe.SizeOf<Matrix>());
var eye = eyeIndex == 0 ? EVREye.Eye_Left : EVREye.Eye_Right;
var proj = Valve.VR.OpenVR.System.GetProjectionMatrix(eye, near, far);
projection = Unsafe.As<HmdMatrix44_t, Matrix>(ref proj);
}
public static void ShowMirror()
{
Valve.VR.OpenVR.Compositor.ShowMirrorWindow();
}
public static void HideMirror()
{
Valve.VR.OpenVR.Compositor.HideMirrorWindow();
}
public static Texture GetMirrorTexture(GraphicsDevice device, int eyeIndex)
{
var nativeDevice = device.NativeDevice.NativePointer;
var eyeTexSrv = IntPtr.Zero;
Valve.VR.OpenVR.Compositor.GetMirrorTextureD3D11(eyeIndex == 0 ? EVREye.Eye_Left : EVREye.Eye_Right, nativeDevice, ref eyeTexSrv);
var tex = new Texture(device);
var srv = new ShaderResourceView(eyeTexSrv);
tex.InitializeFromImpl(srv);
return tex;
}
public static void GetRecommendedRenderTargetSize(out (uint x, uint y) size)
{
size = default;
Valve.VR.OpenVR.System.GetRecommendedRenderTargetSize(ref size.x, ref size.y);
}
public static ulong CreateOverlay()
{
var layerKeyName = Guid.NewGuid().ToString();
ulong handle = 0;
return Valve.VR.OpenVR.Overlay.CreateOverlay(layerKeyName, layerKeyName, ref handle) == EVROverlayError.None ? handle : 0;
}
public static void InitOverlay(ulong overlayId)
{
Valve.VR.OpenVR.Overlay.SetOverlayInputMethod(overlayId, VROverlayInputMethod.None);
Valve.VR.OpenVR.Overlay.SetOverlayFlag(overlayId, VROverlayFlags.SortWithNonSceneOverlays, true);
}
public static bool SubmitOverlay(ulong overlayId, Texture texture)
{
var tex = new Texture_t
{
eType = ETextureType.DirectX,
eColorSpace = EColorSpace.Auto,
handle = texture.NativeResource.NativePointer,
};
return Valve.VR.OpenVR.Overlay.SetOverlayTexture(overlayId, ref tex) == EVROverlayError.None;
}
public static unsafe void SetOverlayParams(ulong overlayId, Matrix transform, bool followsHead, Vector2 surfaceSize)
{
Valve.VR.OpenVR.Overlay.SetOverlayWidthInMeters(overlayId, 1.0f);
transform = Matrix.Scaling(new Vector3(surfaceSize.X, surfaceSize.Y, 1.0f)) * transform;
if (followsHead)
{
var pose = Unsafe.As<Matrix, HmdMatrix34_t>(ref transform);
Valve.VR.OpenVR.Overlay.SetOverlayTransformTrackedDeviceRelative(overlayId, 0, ref pose);
}
else
{
var pose = Unsafe.As<Matrix, HmdMatrix34_t>(ref transform);
Valve.VR.OpenVR.Overlay.SetOverlayTransformAbsolute(overlayId, ETrackingUniverseOrigin.TrackingUniverseSeated, ref pose);
}
}
public static void SetOverlayEnabled(ulong overlayId, bool enabled)
{
if (enabled)
Valve.VR.OpenVR.Overlay.ShowOverlay(overlayId);
else
Valve.VR.OpenVR.Overlay.HideOverlay(overlayId);
}
}
}
#endif