Browse Source

Document how to change spatializers;

bjorn 4 years ago
parent
commit
43d25fb0c3
2 changed files with 8 additions and 2 deletions
  1. 1 1
      api/init.lua
  2. 7 1
      api/lovr/audio/getSpatializer.lua

+ 1 - 1
api/init.lua

@@ -1125,7 +1125,7 @@ return {
           name = "getSpatializer",
           tag = "listener",
           summary = "Get the name of the active spatializer",
-          description = "Returns the name of the active spatializer (`simple`, `oculus`, or `phonon`).",
+          description = "Returns the name of the active spatializer (`simple`, `oculus`, or `phonon`).\n\nThe `t.audio.spatializer` setting in `lovr.conf` can be used to express a preference for a particular spatializer.  If it's `nil`, all spatializers will be tried in the following order: `phonon`, `oculus`, `simple`.",
           key = "lovr.audio.getSpatializer",
           module = "lovr.audio",
           related = {

+ 7 - 1
api/lovr/audio/getSpatializer.lua

@@ -1,7 +1,13 @@
 return {
   tag = 'listener',
   summary = 'Get the name of the active spatializer',
-  description = 'Returns the name of the active spatializer (`simple`, `oculus`, or `phonon`).',
+  description = [[
+    Returns the name of the active spatializer (`simple`, `oculus`, or `phonon`).
+
+    The `t.audio.spatializer` setting in `lovr.conf` can be used to express a preference for a
+    particular spatializer.  If it's `nil`, all spatializers will be tried in the following order:
+    `phonon`, `oculus`, `simple`.
+  ]],
   arguments = {},
   returns = {
     {