Class XRPassthroughLayer

This class represents the XR Passthrough Layer.

Inheritance

object

DisposableObject

XRPassthroughLayer

Implements

IDisposable

Inherited Members

DisposableObject.Disposed

DisposableObject.Dispose()

DisposableObject.Dispose(bool)

DisposableObject.Destroy()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Evergine.Framework.XR.Passthrough

Assembly: Evergine.Framework.dll

Syntax

public abstract class XRPassthroughLayer : DisposableObject, IDisposable

Properties

Brightness

Gets or sets the brightness adjustment value in the range [-100, 100]. The neutral element is 0.

Declaration

public abstract float Brightness { get; set; }

Property Value

Type	Description
float

ColorControl

Gets or sets the flags indicating how to control the color of the layer.

Declaration

public abstract XRPassthroughColorControlType ColorControl { get; set; }

Property Value

Type	Description
XRPassthroughColorControlType

ColorMapMonoToMono

Gets or sets the color curve to which the passthrough imagery luminance values are mapped.

Declaration

public abstract FloatCurve ColorMapMonoToMono { get; set; }

Property Value

Type	Description
FloatCurve

ColorMapMonoToRGBA

Gets or sets the color curve to which the passthrough imagery luminance values are mapped.

Declaration

public abstract ColorCurve ColorMapMonoToRGBA { get; set; }

Property Value

Type	Description
ColorCurve

CompositionOrder

Gets or sets the composition order. It defines the order of the layers in composition. The layer with larger CompositionOrder would be composited in the front of the layer with smaller CompositionOrder.

Declaration

public abstract int CompositionOrder { get; set; }

Property Value

Type	Description
int

Contrast

Gets or sets the contrast adjustment value in the range [0, Infinity]. The neutral element is 1.

Declaration

public abstract float Contrast { get; set; }

Property Value

Type	Description
float

EdgeColor

Gets or sets the passthorugh edge color.

Declaration

public abstract Color EdgeColor { get; set; }

Property Value

Type	Description
Color

EdgeRendering

Gets or sets a value indicating whether enabling or not the Passthroigh edge enhancement.

Declaration

public abstract bool EdgeRendering { get; set; }

Property Value

Type	Description
bool

IsRunning

Gets a value indicating whether the passthrough is running.

Declaration

public abstract bool IsRunning { get; }

Property Value

Type	Description
bool

Opacity

Gets or sets passthrough texture opacity.

Declaration

public abstract float Opacity { get; set; }

Property Value

Type	Description
float

Placement

Gets or sets whether this overlay should layer behind the scene or in front of it.

Declaration

public abstract XROverlayType Placement { get; set; }

Property Value

Type	Description
XROverlayType

ProjectionSurface

Gets or sets the type of projection surface for this Passthrough layer.

Declaration

public abstract XRProjectionSurfaceType ProjectionSurface { get; set; }

Property Value

Type	Description
XRProjectionSurfaceType

Saturation

Gets or sets the saturation adjustment value in the range [0, Infinity]. The neutral element is 1.

Declaration

public abstract float Saturation { get; set; }

Property Value

Type	Description
float

SurfaceMeshes

Gets a collection of registered surface meshes.

Declaration

public abstract IEnumerable<XRPassthroughSurfaceMesh> SurfaceMeshes { get; }

Property Value

Type	Description
IEnumerable<XRPassthroughSurfaceMesh>

Methods

AddSurfaceMesh(XRPassthroughSurfaceMesh)

Add a surface mesh to be used by this layer.

Declaration

public abstract bool AddSurfaceMesh(XRPassthroughSurfaceMesh surfaceMesh)

Parameters

Type	Name	Description
XRPassthroughSurfaceMesh	surfaceMesh	The surface mesh.

Returns

Type	Description
bool	True if the mesh has been suscessfully added.

PausePassthrough()

Pause the passthrough layer update.

Declaration

public abstract void PausePassthrough()

RefreshLayerStyle()

Force to refresh the layer style.

Declaration

public abstract void RefreshLayerStyle()

RemoveSurfaceMesh(XRPassthroughSurfaceMesh)

Remove the surface mesh.

Declaration

public abstract bool RemoveSurfaceMesh(XRPassthroughSurfaceMesh surfaceMesh)

Parameters

Type	Name	Description
XRPassthroughSurfaceMesh	surfaceMesh	The surface mesh to be removed.

Returns

Type	Description
bool	True if the mesh has been removed.

StartPassthrough()

Resume the passthrough layer update.

Declaration

public abstract void StartPassthrough()

Implements

IDisposable

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)