Class OpenXRFBPassthroughLayer

OpenXR implementation of the passthrough layer.

Inheritance

object

DisposableObject

XRPassthroughLayer

OpenXRPassthroughLayer

OpenXRFBPassthroughLayer

Inherited Members

DisposableObject.Disposed

DisposableObject.Dispose()

DisposableObject.Dispose(bool)

Namespace: Evergine.OpenXR.Passthrough.FB

Assembly: Evergine.OpenXR.dll

Syntax

public class OpenXRFBPassthroughLayer : OpenXRPassthroughLayer

Constructors

OpenXRFBPassthroughLayer(OpenXRFBPassthrough)

Initializes a new instance of the OpenXRFBPassthroughLayer class.

Declaration

public OpenXRFBPassthroughLayer(OpenXRFBPassthrough fbPassthrough)

Parameters

Type	Name	Description
OpenXRFBPassthrough	fbPassthrough	The FB Passthrough class.

Properties

Brightness

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

Declaration

public override float Brightness { get; set; }

Property Value

Type	Description
float

Overrides

XRPassthroughLayer.Brightness

ColorControl

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

Declaration

public override XRPassthroughColorControlType ColorControl { get; set; }

Property Value

Type	Description
XRPassthroughColorControlType

Overrides

XRPassthroughLayer.ColorControl

ColorMapMonoToMono

Gets or sets the color curve to which the pass-through imagery luminance values are mapped.

Declaration

public override FloatCurve ColorMapMonoToMono { get; set; }

Property Value

Type	Description
FloatCurve

Overrides

XRPassthroughLayer.ColorMapMonoToMono

ColorMapMonoToRGBA

Gets or sets the color curve that maps the passthrough imagery luminance values.

Declaration

public override ColorCurve ColorMapMonoToRGBA { get; set; }

Property Value

Type	Description
ColorCurve

Overrides

XRPassthroughLayer.ColorMapMonoToRGBA

CompositionOrder

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

Declaration

public override int CompositionOrder { get; set; }

Property Value

Type	Description
int

Overrides

XRPassthroughLayer.CompositionOrder

Contrast

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

Declaration

public override float Contrast { get; set; }

Property Value

Type	Description
float

Overrides

XRPassthroughLayer.Contrast

EdgeColor

Gets or sets the passthrough edge color.

Declaration

public override Color EdgeColor { get; set; }

Property Value

Type	Description
Color

Overrides

XRPassthroughLayer.EdgeColor

EdgeRendering

Gets or sets a value indicating whether to enable the Passthrough edge enhancement.

Declaration

public override bool EdgeRendering { get; set; }

Property Value

Type	Description
bool

Overrides

XRPassthroughLayer.EdgeRendering

IsRunning

Gets a value indicating whether the passthrough is running.

Declaration

public override bool IsRunning { get; }

Property Value

Type	Description
bool

Overrides

XRPassthroughLayer.IsRunning

Opacity

Gets or sets the passthrough texture opacity.

Declaration

public override float Opacity { get; set; }

Property Value

Type	Description
float

Overrides

XRPassthroughLayer.Opacity

Placement

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

Declaration

public override XROverlayType Placement { get; set; }

Property Value

Type	Description
XROverlayType

Overrides

XRPassthroughLayer.Placement

ProjectionSurface

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

Declaration

public override XRProjectionSurfaceType ProjectionSurface { get; set; }

Property Value

Type	Description
XRProjectionSurfaceType

Overrides

XRPassthroughLayer.ProjectionSurface

Saturation

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

Declaration

public override float Saturation { get; set; }

Property Value

Type	Description
float

Overrides

XRPassthroughLayer.Saturation

SurfaceMeshes

Gets a collection of registered surface meshes.

Declaration

public override IEnumerable<XRPassthroughSurfaceMesh> SurfaceMeshes { get; }

Property Value

Type	Description
IEnumerable<XRPassthroughSurfaceMesh>

Overrides

XRPassthroughLayer.SurfaceMeshes

Methods

AddSurfaceMesh(XRPassthroughSurfaceMesh)

Add a surface mesh to be used by this layer.

Declaration

public override bool AddSurfaceMesh(XRPassthroughSurfaceMesh surfaceMesh)

Parameters

Type	Name	Description
XRPassthroughSurfaceMesh	surfaceMesh	The surface mesh.

Returns

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

Overrides

XRPassthroughLayer.AddSurfaceMesh(XRPassthroughSurfaceMesh)

Destroy()

Destroys all resources of this instance.

Declaration

protected override void Destroy()

Overrides

DisposableObject.Destroy()

PausePassthrough()

Pauses the passthrough layer update.

Declaration

public override void PausePassthrough()

Overrides

XRPassthroughLayer.PausePassthrough()

RefreshLayerStyle()

Forces a refresh of the layer style.

Declaration

public override void RefreshLayerStyle()

Overrides

XRPassthroughLayer.RefreshLayerStyle()

RemoveSurfaceMesh(XRPassthroughSurfaceMesh)

Removes the surface mesh.

Declaration

public override 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.

Overrides

XRPassthroughLayer.RemoveSurfaceMesh(XRPassthroughSurfaceMesh)

StartPassthrough()

Resumes the passthrough layer update.

Declaration

public override void StartPassthrough()

Overrides

XRPassthroughLayer.StartPassthrough()

Update(long)

Updates the passthrough layer.

Declaration

public void Update(long predictedDisplayTime)

Parameters

Type	Name	Description
long	predictedDisplayTime	The predicted display time.

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)