lovr-indeck/lovr-api/headset/init.lua

return {
  tag = 'modules',
  summary = 'Connects to VR hardware.',
  description = [[
    The `lovr.headset` module is where all the magical VR functionality is.  With it, you can access
    connected VR hardware and get information about the available space the player has.  Note that
    all units are reported in meters.  Position `(0, 0, 0)` is on the floor in the center of the play
    area.
  ]],
  sections = {
    {
      name = 'Input',
      tag = 'input',
      description = [[
        Functions for accessing input devices, like controllers, hands, trackers, or gamepads.
      ]]
    },
    {
      name = 'Controller Models',
      tag = 'controller-models'
    },
    {
      name = 'Display',
      tag = 'headset',
      description = 'Functions that return information about the active head mounted display (HMD).'
    },
    {
      name = 'Play area',
      tag = 'playArea',
      description = [[
        Retrieve information about the size and shape of the room the player is in, and provides
        information about the "chaperone", a visual indicator that appears whenever a player is
        about to run into a wall.
      ]]
    },
    {
      name = 'Layers',
      tag = 'layers',
      description = 'TODO'
    },
    {
      name = 'Miscellaneous',
      tag = 'headset-misc',
      description = 'Functions that are internal or return information about the VR session.'
    }
  }
}