XrResultExtensions

Extension class for XrResult, including helpers of OpenXRResultStatus and XRResultStatus.

Summary

Public static functions
GetDisplayName(this XrResult result)
string
Gets display name of a given result.
IsCloudAuthError(this OpenXRResultStatus status)
bool
Determines if the OpenXRResultStatus represents an XrResultAndroid.GeospatialCloudAuthFailed error.
IsKeylessError(this OpenXRResultStatus status)
bool
Determines if setting authentication failed with keyless errors.
IsUnsupported(this OpenXRResultStatus status)
bool
Determines if the OpenXRResultStatus represents unsupported cases.
ToExt(this XrResultAndroid android)
XrResult
Converts vendor error codes to XrResult type.
ToOpenXRStatus(this XRResultStatus xrStatus)
OpenXRResultStatus
Converts AR Foundation status type to OpenXR status to better analyze native error code XrResult.
ToStatus(this XrResult result)
OpenXRResultStatus
Converts XrResult to OpenXRResultStatus.
ToXRResultStatus(this OpenXRResultStatus openXRResult)
XRResultStatus
Converts OpenXR status type into AR Foundation status type, for the compatibility with Result.

Public static functions

GetDisplayName

string GetDisplayName(
  this XrResult result
)

Gets display name of a given result.

It converts to XrResultAndroid when possible.

Details
Parameters
result
A XrResult returned by OpenXR APIs.
Returns
The display name of the given result.

IsCloudAuthError

bool IsCloudAuthError(
  this OpenXRResultStatus status
)

Determines if the OpenXRResultStatus represents an XrResultAndroid.GeospatialCloudAuthFailed error.

Details
Parameters
status
The OpenXRResultStatus returned from OpenXR APIs.
Returns

IsKeylessError

bool IsKeylessError(
  this OpenXRResultStatus status
)

Determines if setting authentication failed with keyless errors.

Details
Parameters
status
Returns
True if it's failed with keyless authentication.

IsUnsupported

bool IsUnsupported(
  this OpenXRResultStatus status
)

Determines if the OpenXRResultStatus represents unsupported cases.

Details
Parameters
status
The OpenXRResultStatus returned from OpenXR APIs.
Returns
True if it's an unsupported status.

ToExt

XrResult ToExt(
  this XrResultAndroid android
)

Converts vendor error codes to XrResult type.

Details
Parameters
android
The vendor error code.
Returns
The XrResult error.

ToOpenXRStatus

OpenXRResultStatus ToOpenXRStatus(
  this XRResultStatus xrStatus
)

Converts AR Foundation status type to OpenXR status to better analyze native error code XrResult.

Details
Parameters
xrStatus
The XRResultStatus returned from OpenXR wrappers.
Returns
The OpenXRResultStatus equivalence.

ToStatus

OpenXRResultStatus ToStatus(
  this XrResult result
)

Converts XrResult to OpenXRResultStatus.

Details
Parameters
result
The XrResult returned from OpenXR APIs.
Returns
The OpenXRResultStatus equivalence.

ToXRResultStatus

XRResultStatus ToXRResultStatus(
  this OpenXRResultStatus openXRResult
)

Converts OpenXR status type into AR Foundation status type, for the compatibility with Result.

Details
Parameters
openXRResult
The OpenXRResultStatus returned from OpenXR APIs.
Returns
The XRResultStatus equivalence.