Class FoveatedRenderingFeature

This OpenXRFeature enables the use of foveated rendering in OpenXR.

Inheritance
object
Object
ScriptableObject
OpenXRFeature
FoveatedRenderingFeature
Inherited Members
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, InstantiateParameters)
Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.XR.OpenXR.Features
Assembly: Unity.XR.OpenXR.dll
Syntax
public class FoveatedRenderingFeature : 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 = "com.unity.openxr.feature.foveatedrendering"
Field Value
Type Description
string

Properties

isSubsampledLayoutEnabled

Get whether Vulkan subsampled layout is currently enabled.

Declaration
public static bool isSubsampledLayoutEnabled { get; }
Property Value
Type Description
bool

Methods

GetValidationChecks(List<ValidationRule>, BuildTargetGroup)

Allows a feature to add to a list of validation rules which your feature will evaluate at build time. Details of the validation results can be found in OpenXRProjectValidation.

Declaration
protected override void GetValidationChecks(List<OpenXRFeature.ValidationRule> rules, BuildTargetGroup targetGroup)
Parameters
Type Name Description
List<OpenXRFeature.ValidationRule> rules

Your feature will check the rules in this list at build time. Add rules that you want your feature to check, and remove rules that you want your feature to ignore.
BuildTargetGroup targetGroup

Build target group these validation rules will be evaluated for.
Overrides

HookGetInstanceProcAddr(IntPtr)

Called to hook xrGetInstanceProcAddr. Returning a different function pointer allows intercepting any OpenXR method.

Declaration
protected override IntPtr HookGetInstanceProcAddr(IntPtr func)
Parameters
Type Name Description
IntPtr func

xrGetInstanceProcAddr native function pointer
Returns
Type Description
IntPtr

Function pointer that Unity will use to look up OpenXR native functions.
Overrides

OnInstanceCreate(ulong)

Called after xrCreateInstance. Override this method to validate that any necessary OpenXR extensions were successfully enabled (OpenXRRuntime.IsExtensionEnabled) and that any required system properties are supported. If this method returns false, the feature's enabled property is set to false.

Declaration
protected override bool OnInstanceCreate(ulong instance)
Parameters
Type Name Description
ulong instance
Returns
Type Description
bool

true if this feature successfully initialized. Otherwise, false.
Overrides
Remarks

If this feature is a required feature of an enabled feature set, returning false here causes the OpenXRLoader to fail, and XR Plug-in Management will fall back to another loader if enabled.

See Also

TrySetSubsampledLayoutEnabled(bool)

Attempts to set whether subsampled layout is enabled.

Declaration
public static bool TrySetSubsampledLayoutEnabled(bool enableSubsampling)
Parameters
Type Name Description
bool enableSubsampling

Indicates whether to enable subsampling.
Returns
Type Description
bool

Returns true if subsampling state was updated and returns false otherwise.