Class XRPassthrough

This class represents the passthrough functionality in the XR platform.

Inheritance
object
DisposableObject
XRPassthrough
OpenXRPassthrough
Inherited Members
Namespace: Evergine.Framework.XR.Passthrough
Assembly: Evergine.Framework.dll
Syntax
public abstract class XRPassthrough : DisposableObject

Properties

IsColorSupported

Gets a value indicating whether the passthrough supports color.

Declaration
public abstract bool IsColorSupported { get; }
Property Value
Type Description
bool

IsSurfaceMeshSupported

Gets a value indicating whether the device supports passthrough projected meshes.

Declaration
public abstract bool IsSurfaceMeshSupported { get; }
Property Value
Type Description
bool

Methods

CreatePassthroughLayer()

Creates a new passthrough layer.

Declaration
public abstract XRPassthroughLayer CreatePassthroughLayer()
Returns
Type Description
XRPassthroughLayer

The passthrough layer instance.

CreateSurfaceMesh(Mesh, Matrix4x4)

Creates a Mesh for the Insight Passthrough projection surface.

Declaration
public abstract XRPassthroughSurfaceMesh CreateSurfaceMesh(Mesh surfaceMesh, Matrix4x4 worldToTrackingSpace)
Parameters
Type Name Description
Mesh surfaceMesh

The mesh.
Matrix4x4 worldToTrackingSpace

Transform of the mesh with respect to the tracking space.
Returns
Type Description
XRPassthroughSurfaceMesh

True if the mesh has been successfully added.

PausePassthrough()

Pauses the passthrough of all layers.

Declaration
public abstract void PausePassthrough()

StartPassthrough()

Resumes the passthrough of all layers.

Declaration
public abstract void StartPassthrough()

Extension Methods