Class VivePathEnumeration

Inheritance

object

Object

ScriptableObject

OpenXRFeature

VivePathEnumeration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VIVE.OpenXR

Assembly: VIVE.OpenXR.dll

Syntax

public class VivePathEnumeration : 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.wave.openxr.feature.pathenumeration"

Field Value

Type	Description
string

kOpenxrExtensionString

OpenXR specification 12.1. XR_HTC_path_enumeration.

Declaration

public const string kOpenxrExtensionString = "XR_HTC_path_enumeration"

Field Value

Type	Description
string

Methods

EnumeratePathsForInteractionProfileHTC(ref XrPathsForInteractionProfileEnumerateInfoHTC, uint, ref uint, XrPath[])

Declaration

public XrResult EnumeratePathsForInteractionProfileHTC(ref XrPathsForInteractionProfileEnumerateInfoHTC createInfo, uint pathCapacityInput, ref uint pathCountOutput, XrPath[] paths)

Parameters

Type	Name	Description
XrPathsForInteractionProfileEnumerateInfoHTC	createInfo
uint	pathCapacityInput
uint	pathCountOutput
XrPath[]	paths

Returns

Type	Description
XrResult

GetInputPathsWithUserPath(string, XrPath, out XrPath[])

Declaration

public bool GetInputPathsWithUserPath(string interactionProfileString, XrPath userPath, out XrPath[] inputPaths)

Parameters

Type	Name	Description
string	interactionProfileString
XrPath	userPath
XrPath[]	inputPaths

Returns

Type	Description
bool

GetUserPaths(string, out XrPath[])

Declaration

public bool GetUserPaths(string interactionProfileString, out XrPath[] userPaths)

Parameters

Type	Name	Description
string	interactionProfileString
XrPath[]	userPaths

Returns

Type	Description
bool

OnInstanceCreate(ulong)

Called when xrCreateInstance is done.

Declaration

protected override bool OnInstanceCreate(ulong xrInstance)

Parameters

Type	Name	Description
ulong	xrInstance	The created instance.

Returns

Type	Description
bool	True for valid XrInstance

Overrides

OpenXRFeature.OnInstanceCreate(ulong)

OnInstanceDestroy(ulong)

Called when xrDestroyInstance is done.

Declaration

protected override void OnInstanceDestroy(ulong xrInstance)

Parameters

Type	Name	Description
ulong	xrInstance	The instance to destroy.

Overrides

OpenXRFeature.OnInstanceDestroy(ulong)

OnSessionCreate(ulong)

Called when xrCreateSession is done.

Declaration

protected override void OnSessionCreate(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession	The created session ID.

Overrides

OpenXRFeature.OnSessionCreate(ulong)

OnSessionDestroy(ulong)

Called when xrDestroySession is done.

Declaration

protected override void OnSessionDestroy(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession	The session ID to destroy.

Overrides

OpenXRFeature.OnSessionDestroy(ulong)

OnSystemChange(ulong)

Called when the XrSystemId retrieved by xrGetSystem is changed.

Declaration

protected override void OnSystemChange(ulong xrSystem)

Parameters

Type	Name	Description
ulong	xrSystem	The system id.

Overrides

OpenXRFeature.OnSystemChange(ulong)

xrPathToString(ulong)

Declaration

public string xrPathToString(ulong path)

Parameters

Type	Name	Description
ulong	path

Returns

Type	Description
string

xrStringToPath(string)

Declaration

public ulong xrStringToPath(string str)

Parameters

Type	Name	Description
string	str

Returns

Type	Description
ulong