lovr.headset.setPassthrough
EditSets a new passthrough mode. Not all headsets support all passthrough modes. Use lovr.headset.getPassthroughModes to see which modes are supported.
Arguments
| Name | Type | Description |
| mode | PassthroughMode | The passthrough mode to request. |
Returns
| Name | Type | Description |
| success | boolean | Whether the passthrough mode was supported and successfully enabled. |
Arguments
| Name | Type | Description |
| transparent | boolean |
Whether the headset should use a transparent passthrough mode. When false, this will request the opaque mode. When true, either blend or add will be requested, based on what the VR runtime supports.
|
Returns
| Name | Type | Description |
| success | boolean | Whether the passthrough mode was supported and successfully enabled. |
Switch to the headset's default passthrough mode.
Arguments
None
Returns
| Name | Type | Description |
| success | boolean | Whether the passthrough mode was supported and successfully enabled. |
Notes
When using one of the transparent passthrough modes, be sure to set the alpha of the background color to zero using lovr.graphics.setBackgroundColor, so the background shows through.
Quest Link currently requires some extra steps to enable passthrough, see this article for details.