API reference
API reference
Select your platform
No SDKs available
No versions available

UOculusXRStereoLayerShapeUserDefined Class

Extends UOculusXRPassthroughLayerBase
Represents a passthrough layer which relies on the geometry and the depth provided by the client to render itself.
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 the Meta XR Plugin via the UOculusXRHMDRuntimeSettings::bInsightPassthroughEnabled property.

Member Functions

AddGeometry ( MeshName , PassthroughMesh , Transform , bUpdateTransform )
Adds a geometry onto which the passthrough images will be projected.
Signature 
void UOculusXRStereoLayerShapeUserDefined::AddGeometry(const FString &MeshName, OculusXRHMD::FOculusPassthroughMeshRef PassthroughMesh, FTransform Transform, bool bUpdateTransform)
Parameters
MeshName: const FString &  Name for the geometry to be added. It is used if later you decide to remove the geometry from the layer.
PassthroughMesh: OculusXRHMD::FOculusPassthroughMeshRef  Reference to the mesh to be added.
Transform: FTransform  Transform of the mesh to be added.
bUpdateTransform: bool  When the value is true, current layer will update the transform of the surface mesh every frame. Otherwise only the initial transform is recorded.
Returns
void
ApplyShape ( LayerDesc )
Signature 
virtual void UOculusXRStereoLayerShapeUserDefined::ApplyShape(IStereoLayers::FLayerDesc &LayerDesc) override
Parameters
LayerDesc: IStereoLayers::FLayerDesc &
Returns
void
GetUserGeometryList ()
Returns a list of geometries previously added to this surface projected passthrough layer.
Signature 
TArray< FUserDefinedGeometryDesc > & UOculusXRStereoLayerShapeUserDefined::GetUserGeometryList()
Returns
TArray< FUserDefinedGeometryDesc > &
RemoveGeometry ( MeshName )
Removes the geometry that has previously been added using AddGeometry() from the projection surface
Signature 
void UOculusXRStereoLayerShapeUserDefined::RemoveGeometry(const FString &MeshName)
Parameters
MeshName: const FString &  Name for the geometry to be removed.
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta