Browse Source

rm t.headset.offset;

bjorn 1 year ago
parent
commit
32a0654c79
2 changed files with 6 additions and 8 deletions
  1. 2 2
      api/init.lua
  2. 4 6
      api/lovr/callbacks/conf.lua

+ 2 - 2
api/init.lua

@@ -13,7 +13,7 @@ return {
           code = "function lovr.conf(t)\n\n  -- Set the project version and identity\n  t.version = '0.16.0'\n  t.identity = 'default'\n\n  -- Set save directory precedence\n  t.saveprecedence = true\n\n  -- Enable or disable different modules\n  t.modules.audio = true\n  t.modules.data = true\n  t.modules.event = true\n  t.modules.graphics = true\n  t.modules.headset = true\n  t.modules.math = true\n  t.modules.physics = true\n  t.modules.system = true\n  t.modules.thread = true\n  t.modules.timer = true\n\n  -- Audio\n  t.audio.spatializer = nil\n  t.audio.samplerate = 48000\n  t.audio.start = true\n\n  -- Graphics\n  t.graphics.debug = false\n  t.graphics.vsync = true\n  t.graphics.stencil = false\n  t.graphics.antialias = true\n  t.graphics.shadercache = true\n\n  -- Headset settings\n  t.headset.drivers = { 'openxr', 'desktop' }\n  t.headset.supersample = false\n  t.headset.seated = false\n  t.headset.antialias = true\n  t.headset.stencil = false\n  t.headset.submitdepth = true\n  t.headset.overlay = false\n\n  -- Math settings\n  t.math.globals = true\n\n  -- Configure the desktop window\n  t.window.width = 1080\n  t.window.height = 600\n  t.window.fullscreen = false\n  t.window.resizable = false\n  t.window.title = 'LÖVR'\n  t.window.icon = nil\nend"
         }
       },
-      notes = "Disabling unused modules can improve startup time.\n\n`t.window` can be set to nil to avoid creating the window.  The window can later be opened manually using `lovr.system.openWindow`.\n\nEnabling the `t.graphics.debug` flag will add additional error checks and will send messages from the GPU driver to the `lovr.log` callback.  This will decrease performance but can help provide information on performance problems or other bugs.  It will also cause `lovr.graphics.newShader` to embed debugging information in shaders which allows inspecting variables and stepping through shaders line-by-line in tools like RenderDoc.\n\n`t.graphics.debug` can also be enabled using the `--graphics-debug` command line option.\n\nThe `headset.offset` field is a vertical offset applied to the scene for headsets that do not center their tracking origin on the floor.  This can be thought of as a \"default user height\". Setting this offset makes it easier to design experiences that work in both seated and standing VR configurations.",
+      notes = "Disabling unused modules can improve startup time.\n\n`t.window` can be set to nil to avoid creating the window.  The window can later be opened manually using `lovr.system.openWindow`.\n\nEnabling the `t.graphics.debug` flag will add additional error checks and will send messages from the GPU driver to the `lovr.log` callback.  This will decrease performance but can help provide information on performance problems or other bugs.  It will also cause `lovr.graphics.newShader` to embed debugging information in shaders which allows inspecting variables and stepping through shaders line-by-line in tools like RenderDoc.\n\n`t.graphics.debug` can also be enabled using the `--graphics-debug` command line option.",
       related = {
         "lovr.load"
       },
@@ -169,7 +169,7 @@ return {
                     {
                       name = "seated",
                       type = "boolean",
-                      description = "Whether seated mode should be used instead of standing."
+                      description = "Whether <a data-key=\"lovr.headset.isSeated\">seated mode</a> should be used instead of standing, changing the headset coordinate space to place y=0 at eye level."
                     },
                     {
                       name = "antialias",

+ 4 - 6
api/lovr/callbacks/conf.lua

@@ -165,7 +165,10 @@ return {
             {
               name = 'seated',
               type = 'boolean',
-              description = 'Whether seated mode should be used instead of standing.'
+              description = [[
+                Whether <a data-key="lovr.headset.isSeated">seated mode</a> should be used instead
+                of standing, changing the headset coordinate space to place y=0 at eye level.
+              ]]
             },
             {
               name = 'antialias',
@@ -260,11 +263,6 @@ return {
     variables and stepping through shaders line-by-line in tools like RenderDoc.
 
     `t.graphics.debug` can also be enabled using the `--graphics-debug` command line option.
-
-    The `headset.offset` field is a vertical offset applied to the scene for headsets that do not
-    center their tracking origin on the floor.  This can be thought of as a "default user height".
-    Setting this offset makes it easier to design experiences that work in both seated and standing
-    VR configurations.
   ]],
   example = {
     description = 'A noop conf.lua that sets all configuration settings to their defaults:',