LWJGL 3.3.3 · org.lwjgl.openxr.METAFoveationEyeTracked

The XR_META_foveation_eye_tracked extension.

Eye tracked foveated rendering renders lower pixel density in the periphery of the user’s gaze, taking advantage of low peripheral acuity.

This extension allows:

An application to query eye tracked foveation availability.
An application to request eye tracked foveation profile supported by the runtime and apply them to foveation-supported swapchains.
An application to query foveation center position every frame.
An application to request a foveation pattern update from the runtime. As a consequence, runtime knows how to adjust the eye tracking camera exposure start time in order to optimize the total pipeline latency.

In order to enable the functionality of this extension, the application must pass the name of the extension into CreateInstance via the XrInstanceCreateInfo::enabledExtensionNames parameter as indicated in the extensions section.

Field Summary

Modifier and Type	Field and Description
public static final int	XR_FOVEATION_CENTER_SIZE_META XR_FOVEATION_CENTER_SIZE_META
public static final int	XR_FOVEATION_EYE_TRACKED_STATE_VALID_BIT_META XrFoveationEyeTrackedStateFlagBitsMETA - XrFoveationEyeTrackedStateFlagBitsMETA Flag Descriptions `FOVEATION_EYE_TRACKED_STATE_VALID_BIT_META` — Indicates whether or not foveation data is valid. This can happen if the eye tracker is obscured, the camera has dirt, or eye lid is closed, etc.
public static final String	XR_META_FOVEATION_EYE_TRACKED_EXTENSION_NAME The extension name.
public static final int	XR_META_foveation_eye_tracked_SPEC_VERSION The extension specification version.
public static final int	XR_TYPE_FOVEATION_EYE_TRACKED_PROFILE_CREATE_INFO_META Extends `XrStructureType`.
public static final int	XR_TYPE_FOVEATION_EYE_TRACKED_STATE_META Extends `XrStructureType`.
public static final int	XR_TYPE_SYSTEM_FOVEATION_EYE_TRACKED_PROPERTIES_META Extends `XrStructureType`.

Access	Constructor and Description
protected	METAFoveationEyeTracked()

Method Summary

Modifier and Type	Method and Description
public static int	nxrGetFoveationEyeTrackedStateMETA(XrSession session, long foveationState) Unsafe version of: `GetFoveationEyeTrackedStateMETA`
public static int	xrGetFoveationEyeTrackedStateMETA(XrSession the `XrSession` in which the eye tracked foveation profile is applied. session, XrFoveationEyeTrackedStateMETA a pointer to an `XrFoveationEyeTrackedStateMETA` structure returning the current eye tracked foveation state. foveationState) Get the current eye tracked foveation state.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

XR_FOVEATION_CENTER_SIZE_META	back to summary
public static final int XR_FOVEATION_CENTER_SIZE_META XR_FOVEATION_CENTER_SIZE_META

XR_FOVEATION_EYE_TRACKED_STATE_VALID_BIT_META back to summary

XR_FOVEATION_EYE_TRACKED_STATE_VALID_BIT_META	back to summary
public static final int XR_FOVEATION_EYE_TRACKED_STATE_VALID_BIT_META XrFoveationEyeTrackedStateFlagBitsMETA - XrFoveationEyeTrackedStateFlagBitsMETA Flag Descriptions `FOVEATION_EYE_TRACKED_STATE_VALID_BIT_META` — Indicates whether or not foveation data is valid. This can happen if the eye tracker is obscured, the camera has dirt, or eye lid is closed, etc.

public static final int XR_FOVEATION_EYE_TRACKED_STATE_VALID_BIT_META

XrFoveationEyeTrackedStateFlagBitsMETA - XrFoveationEyeTrackedStateFlagBitsMETA

Flag Descriptions

FOVEATION_EYE_TRACKED_STATE_VALID_BIT_META — Indicates whether or not foveation data is valid. This can happen if the eye tracker is obscured, the camera has dirt, or eye lid is closed, etc.

XR_META_FOVEATION_EYE_TRACKED_EXTENSION_NAME	back to summary
public static final String XR_META_FOVEATION_EYE_TRACKED_EXTENSION_NAME The extension name.

XR_META_foveation_eye_tracked_SPEC_VERSION	back to summary
public static final int XR_META_foveation_eye_tracked_SPEC_VERSION The extension specification version.

XR_TYPE_FOVEATION_EYE_TRACKED_PROFILE_CREATE_INFO_META back to summary

XR_TYPE_FOVEATION_EYE_TRACKED_PROFILE_CREATE_INFO_META	back to summary
public static final int XR_TYPE_FOVEATION_EYE_TRACKED_PROFILE_CREATE_INFO_META Extends `XrStructureType`. Enum values: `TYPE_FOVEATION_EYE_TRACKED_PROFILE_CREATE_INFO_META` `TYPE_FOVEATION_EYE_TRACKED_STATE_META` `TYPE_SYSTEM_FOVEATION_EYE_TRACKED_PROPERTIES_META`

public static final int XR_TYPE_FOVEATION_EYE_TRACKED_PROFILE_CREATE_INFO_META

Extends XrStructureType.

Enum values:

XR_TYPE_FOVEATION_EYE_TRACKED_STATE_META back to summary

XR_TYPE_FOVEATION_EYE_TRACKED_STATE_META	back to summary
public static final int XR_TYPE_FOVEATION_EYE_TRACKED_STATE_META Extends `XrStructureType`. Enum values: `TYPE_FOVEATION_EYE_TRACKED_PROFILE_CREATE_INFO_META` `TYPE_FOVEATION_EYE_TRACKED_STATE_META` `TYPE_SYSTEM_FOVEATION_EYE_TRACKED_PROPERTIES_META`

public static final int XR_TYPE_FOVEATION_EYE_TRACKED_STATE_META

Extends XrStructureType.

Enum values:

XR_TYPE_SYSTEM_FOVEATION_EYE_TRACKED_PROPERTIES_META back to summary

XR_TYPE_SYSTEM_FOVEATION_EYE_TRACKED_PROPERTIES_META	back to summary
public static final int XR_TYPE_SYSTEM_FOVEATION_EYE_TRACKED_PROPERTIES_META Extends `XrStructureType`. Enum values: `TYPE_FOVEATION_EYE_TRACKED_PROFILE_CREATE_INFO_META` `TYPE_FOVEATION_EYE_TRACKED_STATE_META` `TYPE_SYSTEM_FOVEATION_EYE_TRACKED_PROPERTIES_META`

public static final int XR_TYPE_SYSTEM_FOVEATION_EYE_TRACKED_PROPERTIES_META

Extends XrStructureType.

Enum values:

Constructor Detail

METAFoveationEyeTracked	back to summary
protected METAFoveationEyeTracked()

Method Detail

nxrGetFoveationEyeTrackedStateMETA	back to summary
public static int nxrGetFoveationEyeTrackedStateMETA(XrSession session, long foveationState) Unsafe version of: `GetFoveationEyeTrackedStateMETA`

xrGetFoveationEyeTrackedStateMETA back to summary

xrGetFoveationEyeTrackedStateMETA	back to summary
public static int xrGetFoveationEyeTrackedStateMETA(XrSession session, XrFoveationEyeTrackedStateMETA foveationState) Get the current eye tracked foveation state. C Specification The `GetFoveationEyeTrackedStateMETA` function is defined as: `XrResult xrGetFoveationEyeTrackedStateMETA( XrSession session, XrFoveationEyeTrackedStateMETA* foveationState);` Description The `GetFoveationEyeTrackedStateMETA` function returns the current eye tracked foveation state including the center of the foveal region, validity of the foveation data, etc. Note that `UpdateSwapchainFB` should be called right before the `GetFoveationEyeTrackedStateMETA` function in order to (1) request a foveation pattern update by the runtime (2) optionally instruct the runtime to adjust the eye tracking camera capture start time in order to optimize for pipeline latency. Valid Usage (Implicit) The `XR_META_foveation_eye_tracked` extension must be enabled prior to calling `GetFoveationEyeTrackedStateMETA` `session` must be a valid `XrSession` handle `foveationState` must be a pointer to an `XrFoveationEyeTrackedStateMETA` structure Return Codes On success, this command returns `SUCCESS` `SESSION_LOSS_PENDING` On failure, this command returns `ERROR_FUNCTION_UNSUPPORTED` `ERROR_VALIDATION_FAILURE` `ERROR_RUNTIME_FAILURE` `ERROR_HANDLE_INVALID` `ERROR_INSTANCE_LOST` `ERROR_SESSION_LOST` `ERROR_FEATURE_UNSUPPORTED` See Also `XrFoveationEyeTrackedStateMETA` Parameters session:XrSession the `XrSession` in which the eye tracked foveation profile is applied. foveationState:XrFoveationEyeTrackedStateMETA a pointer to an `XrFoveationEyeTrackedStateMETA` structure returning the current eye tracked foveation state. Annotations @NativeType:XrResult

public static int xrGetFoveationEyeTrackedStateMETA(XrSession session, XrFoveationEyeTrackedStateMETA foveationState)

Get the current eye tracked foveation state.

C Specification

The GetFoveationEyeTrackedStateMETA function is defined as:


XrResult xrGetFoveationEyeTrackedStateMETA(
    XrSession                                   session,
    XrFoveationEyeTrackedStateMETA*             foveationState);

Description

The GetFoveationEyeTrackedStateMETA function returns the current eye tracked foveation state including the center of the foveal region, validity of the foveation data, etc.

Note that UpdateSwapchainFB should be called right before the GetFoveationEyeTrackedStateMETA function in order to (1) request a foveation pattern update by the runtime (2) optionally instruct the runtime to adjust the eye tracking camera capture start time in order to optimize for pipeline latency.

Valid Usage (Implicit)

The XR_META_foveation_eye_tracked extension must be enabled prior to calling GetFoveationEyeTrackedStateMETA
session must be a valid XrSession handle
foveationState must be a pointer to an XrFoveationEyeTrackedStateMETA structure

Return Codes

On success, this command returns

On failure, this command returns

public Class METAFoveationEyeTracked

Field Summary

Constructor Summary

Method Summary

Field Detail

Flag Descriptions

Enum values:

Enum values:

Enum values:

Constructor Detail

Method Detail

C Specification

Description

Valid Usage (Implicit)

Return Codes

See Also