Browse Source

Add note about asynchronous headset rendering;

bjorn 6 years ago
parent
commit
45c410c093
2 changed files with 8 additions and 2 deletions
  1. 2 1
      api/init.lua
  2. 6 1
      api/lovr/headset/renderTo.lua

+ 2 - 1
api/init.lua

@@ -14291,7 +14291,8 @@ return {
               },
               returns = {}
             }
-          }
+          },
+          notes = "On the `web` and `android` platforms (see `lovr.getOS`), headset rendering is asynchronous and the callback passed to `lovr.headset.renderTo` will not be called immediately.  This is due to certain restrictions inherent to these platforms."
         },
         {
           name = "setClipDistance",

+ 6 - 1
api/lovr/headset/renderTo.lua

@@ -23,5 +23,10 @@ return {
       ]]
     }
   },
-  returns = {}
+  returns = {},
+  notes = [[
+    On the `web` and `android` platforms (see `lovr.getOS`), headset rendering is asynchronous and
+    the callback passed to `lovr.headset.renderTo` will not be called immediately.  This is due to
+    certain restrictions inherent to these platforms.
+  ]]
 }