lovr.headset
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 the center of the play area.
Headset
Functions that return information about the head mounted display (HMD) currently strapped to the player's face.
| lovr.headset.getVelocity | Get the linear velocity of the headset. |
| lovr.headset.getMirrorTexture | Get the Texture containing a view of what's in the headset. |
| lovr.headset.getDisplayDimensions | Get the dimensions of the headset display. |
| lovr.headset.getDisplayHeight | Get the height of the headset display. |
| lovr.headset.getDisplayWidth | Get the width of the headset display. |
| lovr.headset.getClipDistance | Get the near and far clipping planes of the headset. |
| lovr.headset.setClipDistance | Set the near and far clipping planes of the headset. |
| lovr.headset.getAngularVelocity | Get the angular velocity of the headset. |
| lovr.headset.getPose | Get the pose of the headset. |
| lovr.headset.getPosition | Get the position of the headset. |
| lovr.headset.isMounted | Get whether or not the headset is mounted. |
| lovr.headset.renderTo | Render to the headset using a function. |
| lovr.headset.getOrientation | Get the orientation of the headset. |
| lovr.headset.getOriginType | Get the type of tracking origin of the headset. |
| lovr.headset.getDriver | Get the VR API currently in use. |
| lovr.headset.getType | Get the type of connected headset. |
Play area
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.
| lovr.headset.getBoundsDepth | Get the depth of the play area. |
| lovr.headset.getBoundsDimensions | Get the size of the play area. |
| lovr.headset.getBoundsGeometry | Get a list of points that make up the play area boundary. |
| lovr.headset.getBoundsWidth | Get the width of the play area. |
Controllers
Get a list of connected Controllers. Also see lovr.controlleradded and lovr.controllerremoved.
| lovr.headset.getControllerCount | Get the number of currently connected controller objects. |
| lovr.headset.getControllers | Get a list of currently connected controller objects. |