XRRecommendedSettingsFeature

This XRRecommendedSettingsFeature provides a function to query the recommended settings information at runtime.

Summary

Inheritance

Inherits from: OpenXRFeature, Google.XR.Extensions.IXRSpatialSdk

Public attributes
ExtensionString = "XR_ANDROID_recommended_settings"
const string
The OpenXR Extension string.
FeatureId = "com.google.xr.extensions.recommended_settings"
const string
The feature ID string.
UiName = "Android XR: Recommended Settings"
const string
The UI name shows on the XR Plug-in Management panel, to help users understand validation errors and expected fixes.

Public static attributes
IsExtensionEnabled => _extensionEnabled
bool
Gets if the required OpenXR extension is enabled.

Public static functions
TryGetRecommendedSettings(out XrRecommendedSettings recommendedSettings)
bool
Gets the current recommended settings.

Public functions
GetTargetVersion()
Gets the target version of the given feature if applicable.

Public attributes

ExtensionString

const string ExtensionString = "XR_ANDROID_recommended_settings"

The OpenXR Extension string.

Used to check if this extension is available or enabled.

FeatureId

const string FeatureId = "com.google.xr.extensions.recommended_settings"

The feature ID string.

UiName

const string UiName = "Android XR: Recommended Settings"

The UI name shows on the XR Plug-in Management panel, to help users understand validation errors and expected fixes.

Public static attributes

IsExtensionEnabled

bool IsExtensionEnabled => _extensionEnabled

Gets if the required OpenXR extension is enabled.

When OpenXR runtime is waiting, it returns null. Otherwise, it indicates whether the XR_ANDROID_recommended_settings extension is available on the current device.

Public static functions

TryGetRecommendedSettings

bool TryGetRecommendedSettings(
  out XrRecommendedSettings recommendedSettings
)

Gets the current recommended settings.

Details
Parameters
recommendedSettings
Recommended settings info obtained from the system.

Public functions

GetTargetVersion

XRSpatialSdkVersions GetTargetVersion()

Gets the target version of the given feature if applicable.