Class VivePassthrough

Inheritance

object

Object

ScriptableObject

OpenXRFeature

VivePassthrough

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VIVE.OpenXR.Passthrough

Assembly: VIVE.OpenXR.dll

Syntax

public class VivePassthrough : OpenXRFeature

Fields

featureId

The feature id string. This is used to give the feature a well known id for reference.

Declaration

public const string featureId = "vive.openxr.feature.passthrough"

Field Value

Type	Description
string

kOpenxrExtensionStrings

The extension string.

Declaration

public const string kOpenxrExtensionStrings = "XR_HTC_passthrough XR_HTC_passthrough_configuration"

Field Value

Type	Description
string

Properties

PassthroughList

Declaration

public List<XrPassthroughHTC> PassthroughList { get; }

Property Value

Type	Description
List<XrPassthroughHTC>

XrInstanceCreated

The XR instance is created or not.

Declaration

public bool XrInstanceCreated { get; }

Property Value

Type	Description
bool

XrSessionCreated

The XR session is created or not.

Declaration

public bool XrSessionCreated { get; }

Property Value

Type	Description
bool

XrSessionCurrentState

The current XR session state.

Declaration

public XrSessionState XrSessionCurrentState { get; }

Property Value

Type	Description
XrSessionState

XrSessionEnding

The XR session is ending or not.

Declaration

public bool XrSessionEnding { get; }

Property Value

Type	Description
bool

Methods

CreatePassthroughHTC(XrPassthroughCreateInfoHTC, out XrPassthroughHTC, LayerType)

Declaration

public XrResult CreatePassthroughHTC(XrPassthroughCreateInfoHTC createInfo, out XrPassthroughHTC passthrough, LayerType layerType = LayerType.Overlay)

Parameters

Type	Name	Description
XrPassthroughCreateInfoHTC	createInfo
XrPassthroughHTC	passthrough
LayerType	layerType

Returns

Type	Description
XrResult

CreatePassthroughHTC(XrPassthroughCreateInfoHTC, out XrPassthroughHTC, LayerType, uint, OnPassthroughSessionDestroyDelegate)

Declaration

public XrResult CreatePassthroughHTC(XrPassthroughCreateInfoHTC createInfo, out XrPassthroughHTC passthrough, LayerType layerType, uint compositionDepth, VivePassthrough.OnPassthroughSessionDestroyDelegate onDestroy)

Parameters

Type	Name	Description
XrPassthroughCreateInfoHTC	createInfo
XrPassthroughHTC	passthrough
LayerType	layerType
uint	compositionDepth
VivePassthrough.OnPassthroughSessionDestroyDelegate	onDestroy

Returns

Type	Description
XrResult

CreatePassthroughHTC(XrPassthroughCreateInfoHTC, out XrPassthroughHTC, LayerType, OnPassthroughSessionDestroyDelegate)

Declaration

public XrResult CreatePassthroughHTC(XrPassthroughCreateInfoHTC createInfo, out XrPassthroughHTC passthrough, LayerType layerType, VivePassthrough.OnPassthroughSessionDestroyDelegate onDestroy = null)

Parameters

Type	Name	Description
XrPassthroughCreateInfoHTC	createInfo
XrPassthroughHTC	passthrough
LayerType	layerType
VivePassthrough.OnPassthroughSessionDestroyDelegate	onDestroy

Returns

Type	Description
XrResult

DestroyPassthroughHTC(XrPassthroughHTC)

Declaration

public XrResult DestroyPassthroughHTC(XrPassthroughHTC passthrough)

Parameters

Type	Name	Description
XrPassthroughHTC	passthrough

Returns

Type	Description
XrResult

EnumeratePassthroughImageRatesHTC(uint, ref uint, XrPassthroughConfigurationImageRateHTC[])

Declaration

public XrResult EnumeratePassthroughImageRatesHTC(uint imageRateCapacityInput, ref uint imageRateCountOutput, XrPassthroughConfigurationImageRateHTC[] imageRates)

Parameters

Type	Name	Description
uint	imageRateCapacityInput
uint	imageRateCountOutput
XrPassthroughConfigurationImageRateHTC[]	imageRates

Returns

Type	Description
XrResult

GetPassthroughConfigurationHTC(IntPtr)

Declaration

public XrResult GetPassthroughConfigurationHTC(IntPtr config)

Parameters

Type	Name	Description
IntPtr	config

Returns

Type	Description
XrResult

GetSystemProperties(ref XrSystemProperties)

Helper function to get this feature' properties. See xrGetSystemProperties

Declaration

public XrResult GetSystemProperties(ref XrSystemProperties properties)

Parameters

Type	Name	Description
XrSystemProperties	properties

Returns

Type	Description
XrResult

GetTrackingSpace()

According to XRInputSubsystem's tracking origin mode, return the corresponding XrSpace.

Declaration

public XrSpace GetTrackingSpace()

Returns

Type	Description
XrSpace	XrSpace for tracking origin.

GetXrSpaceFromSpaceType(ProjectedPassthroughSpaceType)

Helper function to get XrSpace from space type.

Declaration

public XrSpace GetXrSpaceFromSpaceType(ProjectedPassthroughSpaceType spaceType)

Parameters

Type	Name	Description
ProjectedPassthroughSpaceType	spaceType

Returns

Type	Description
XrSpace

OnInstanceCreate(ulong)

Declaration

protected override bool OnInstanceCreate(ulong xrInstance)

Parameters

Type	Name	Description
ulong	xrInstance

Returns

Type	Description
bool

Overrides

OpenXRFeature.OnInstanceCreate(ulong)

OnInstanceDestroy(ulong)

Declaration

protected override void OnInstanceDestroy(ulong xrInstance)

Parameters

Type	Name	Description
ulong	xrInstance

Overrides

OpenXRFeature.OnInstanceDestroy(ulong)

OnSessionBegin(ulong)

Declaration

protected override void OnSessionBegin(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession

Overrides

OpenXRFeature.OnSessionBegin(ulong)

OnSessionCreate(ulong)

Declaration

protected override void OnSessionCreate(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession

Overrides

OpenXRFeature.OnSessionCreate(ulong)

OnSessionDestroy(ulong)

Declaration

protected override void OnSessionDestroy(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession

Overrides

OpenXRFeature.OnSessionDestroy(ulong)

OnSessionEnd(ulong)

Declaration

protected override void OnSessionEnd(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession

Overrides

OpenXRFeature.OnSessionEnd(ulong)

OnSessionStateChange(int, int)

Declaration

protected override void OnSessionStateChange(int oldState, int newState)

Parameters

Type	Name	Description
int	oldState
int	newState

Overrides

OpenXRFeature.OnSessionStateChange(int, int)

OnSystemChange(ulong)

Declaration

protected override void OnSystemChange(ulong xrSystem)

Parameters

Type	Name	Description
ulong	xrSystem

Overrides

OpenXRFeature.OnSystemChange(ulong)

SetPassthroughConfigurationHTC(IntPtr)

Declaration

public XrResult SetPassthroughConfigurationHTC(IntPtr config)

Parameters

Type	Name	Description
IntPtr	config

Returns

Type	Description
XrResult

SupportsImageQuality()

Declaration

public bool SupportsImageQuality()

Returns

Type	Description
bool

SupportsImageRate()

Declaration

public bool SupportsImageRate()

Returns

Type	Description
bool