Browse Source

Try documenting lovr.headset.getName;

bjorn 4 years ago
parent
commit
91da71513f
2 changed files with 238 additions and 720 deletions
  1. 196 720
      api/init.lua
  2. 42 0
      api/lovr/headset/getName.lua

File diff suppressed because it is too large
+ 196 - 720
api/init.lua


+ 42 - 0
api/lovr/headset/getName.lua

@@ -14,6 +14,48 @@ return {
     }
     }
   },
   },
   notes = [[
   notes = [[
+    <table>
+      <thead>
+        <tr>
+          <td>driver</td>
+          <td>name</td>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td>desktop</td>
+          <td><code>Simulator</code></td>
+        </tr>
+        <tr>
+          <td>openvr</td>
+          <td>varies</td>
+        </tr>
+        <tr>
+          <td>openxr</td>
+          <td>varies</td>
+        </tr>
+        <tr>
+          <td>vrapi</td>
+          <td><code>Oculus Quest</code> or <code>Oculus Quest 2</code></td>
+        </tr>
+        <tr>
+          <td>webxr</td>
+          <td>always nil</td>
+        </tr>
+        <tr>
+          <td>oculus</td>
+          <td>varies</td>
+        </tr>
+        <tr>
+          <td>pico</td>
+          <td><code>Pico</code></td>
+        </tr>
+      </tbody>
+    </table>
+
+    - `Simulator` when using `desktop` driver.
+    - `Pico` when using `pico` driver.
+    - When using the `openvr`
     - The keyboard and mouse VR simulator is named `VR Simulator`.
     - The keyboard and mouse VR simulator is named `VR Simulator`.
     - Oculus headsets will usually contain the string `Oculus`.
     - Oculus headsets will usually contain the string `Oculus`.
   ]]
   ]]

Some files were not shown because too many files changed in this diff