Layer

Edit

A Layer is a textured plane placed in 3D space. Layers are sent directly to the VR runtime and composited along with the rest of the 3D content. This has several advantages compared to rendering the texture into the 3D scene with Pass:draw:

• Better tracking. The VR runtime composites the texture later in the rendering process, using a more accurate head pose.
• Better resolution, less shimmery. Regular 3D content must have lens distortion correction applied to it, whereas layers are composited after distortion correction, meaning they have a higher pixel density. The layer can also use a higher resolution than the main headset texture, allowing for extra resolution on the 2D content without having to supersample all of the 3D rendering.
• Supersampling and sharpening effects. Some headset runtimes (currently just Quest) can also supersample and sharpen layers.

Combined, all of this makes a massive difference in quality when rendering 2D content on a Layer, especially improving text readability.

Note that currently the VR simulator does not support layers.

Constructor

lovr.headset.newLayer

Create a new Layer.

Methods

Layer:getColor	Get the color of the layer.
Layer:getCurve	Get the curve of the layer.
Layer:getDimensions	Get the size of the layer.
Layer:getOrientation	Get the orientation of the layer.
Layer:getOrigin	Get the Device the layer is attached to.
Layer:getPass	Get the render pass for the layer.
Layer:getPose	Get the pose of the layer.
Layer:getPosition	Get the position of the layer.
Layer:getTexture	Get the texture for the layer.
Layer:getViewport	Get the viewport of the layer.
Layer:setColor	Set the color of the layer.
Layer:setCurve	Set the curve of the layer.
Layer:setDimensions	Set the size of the layer.
Layer:setOrientation	Set the orientation of the layer.
Layer:setOrigin	Attach the layer to a Device.
Layer:setPose	Set the pose of the layer.
Layer:setPosition	Set the position of the layer.
Layer:setViewport	Set the viewport of the layer.
Object:release	Immediately release the Lua reference to an object.
Object:type	Get the type name of the object.

See also

• Object
• lovr.headset