Meta Developers

The Passthrough API enables you to show the user's real environment in your mixed reality experiences. It offers several options to customize the appearance of passthrough, such as adjusting opacity, highlight salient edges in the image, or control the color reproduction. For passthrough to be visible, it must be enabled in OVRManager via the OVRManager.isInsightPassthroughEnabled field.

Find out more about passthrough and its features or follow along with these tutorials.

Member Enumerations

Enumeration ProjectionSurfaceType

The passthrough projection surface type: reconstructed | user defined.

Reconstructed	Reconstructed surface type will render passthrough using automatic environment depth reconstruction.
UserDefined	UserDefined allows you to define the projection surface manually, see Surface Projected Passthrough.

Enumeration ColorMapEditorType

Unity editor enumerator to provide a dropdown in the inspector.

None	= 0
GrayscaleToColor	= 1
Controls	= GrayscaleToColor
Custom	= 2
Grayscale	= 3
ColorAdjustment	= 4
ColorLut	= 5
InterpolatedColorLut	= 6

Fields

ProjectionSurfaceType projectionSurfaceType[Get]

The type of the surface which passthrough textures are projected on: Automatic reconstruction or user-defined geometry.

This field can only be modified immediately after the component is instantiated (e.g. using AddComponent). Once the backing layer has been created, changes won't be reflected unless the layer is disabled and enabled again. Default is automatic reconstruction.

OVROverlay.OverlayType overlayType[Get]

Specify whether passthrough should appear on top of (OverlayType.Overlay) or beneath (OverlayType.Underlay) the virtual content.

The default is Overlay.

int compositionDepth[Get]

Defines the order of the layers among all passthrough layers and OVROverlay instances.

The layer with smaller compositionDepth is composited in the front of the layer with larger compositionDepth. The default value is zero.

bool hidden[Get]

Hides the passthrough layer from view when true and pauses the system's passthrough system if there are no other visible passthrough layers.

bool overridePerLayerColorScaleAndOffset[Get]

Specify whether colorScale and colorOffset field values should be applied to this layer.

By default, the color scale and offset are not applied to the layer.

Vector4 colorScale[Get]

Color scale is a factor applied to the pixel color values during compositing.

The four components of the vector correspond to the R, G, B, and A values, default set to {1,1,1,1}. This field is only applicable if overridePerLayerColorScaleAndOffset is set to 'true'.

Vector4 colorOffset[Get]

Color offset is a value which gets added to the pixel color values during compositing.

The four components of the vector correspond to the R, G, B, and A values, default set to {0,0,0,0}. This field is only applicable if overridePerLayerColorScaleAndOffset is set to 'true'.

UnityEvent< OVRPassthroughLayer > passthroughLayerResumed[Get]

Occurs when a passthrough layer has been rendered and presented on the HMD screen for the first time after being restarted.

This event passes the reference to the current OVRPassthroughLayer passthrough layer to subscribers.

Gradient colorMapEditorGradient[Get]