lovr

lovr is the single global table that is exposed to every LÖVR app. It contains a set of modules and a set of callbacks.

Modules

Modules are the what of your app; you can use the functions in modules to tell LÖVR to do things. For example, you can draw things on the screen, figure out what buttons on a controller are pressed, or load a 3D model from a file. Each module does what it says on the tin, so the lovr.graphics module deals with rendering graphics and lovr.headset allows you to interact with VR hardware.

lovr.audio	Plays sound.
lovr.data	Exposes low level functions for working with data.
lovr.event	Handles events from the operating system.
lovr.filesystem	Provides access to the filesystem.
lovr.graphics	Renders graphics.
lovr.headset	Connects to VR hardware.
lovr.math	Contains useful math helpers.
lovr.physics	Simulates 3D physics.
lovr.thread	Allows you to work with background threads.
lovr.timer	Exposes a high resolution timer.

Callbacks

Callbacks are the when of the application; you write code inside callbacks which LÖVR then calls at certain points in time. For example, the lovr.load callback is called once at startup, and lovr.focus is called when the VR application gains or loses input focus.

lovr.conf	Called to read configuration settings at startup.
lovr.draw	Called continuously to render frames to the display.
lovr.errhand	Called when an error occurs.
lovr.focus	Called when the application gets or loses focus.
lovr.keypressed	Called when a key is pressed.
lovr.keyreleased	Called when a key is released.
lovr.load	Called once at startup.
lovr.log	Called when a message is logged.
lovr.mirror	Called to render content to the desktop window.
lovr.quit	Called before quitting.
lovr.resize	Called when the window is resized.
lovr.restart	Called when restarting.
lovr.run	The main entry point.
lovr.textinput	Called when text has been entered.
lovr.threaderror	Called when an error occurs in a thread.
lovr.update	Called every frame to update the application logic.

System

The lovr module also exposes some functions for retrieving information about the system.

lovr.getVersion	Get the current version.
lovr.getOS	Get the current operating system.

Libraries

A few helpful third-party libraries are included with LÖVR for convenience.

enet	Multiplayer utilities.
json	Encodes and decodes JSON.