Package org.lwjgl.openxr

Class HTCFoveation

java.lang.Object

org.lwjgl.openxr.HTCFoveation

public class HTCFoveation
extends Object

The XR_HTC_foveation extension.

This extension enables an application to gain rendering performance improvement by reducing the pixel density of areas in the peripheral vision. The areas near the focal point still sustains the original pixel density than periphery.

The application can use this extension in the following steps:

• Create an XrFoveationApplyInfoHTC structure with the desired foveation configurations.
• Apply the foveation configuration by calling ApplyFoveationHTC with desired XrFoveationApplyInfoHTC.

Note

This extension is recommended for XrSession whose XrViewConfigurationType is VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_FOVEATION_DYNAMIC_CLEAR_FOV_ENABLED_BIT_HTC	XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode
static final int	XR_FOVEATION_DYNAMIC_FOCAL_CENTER_OFFSET_ENABLED_BIT_HTC	XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode
static final int	XR_FOVEATION_DYNAMIC_LEVEL_ENABLED_BIT_HTC	XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode
static final int	XR_FOVEATION_LEVEL_HIGH_HTC	XrFoveationLevelHTC - The pixel density drop level of periphery area
static final int	XR_FOVEATION_LEVEL_LOW_HTC	XrFoveationLevelHTC - The pixel density drop level of periphery area
static final int	XR_FOVEATION_LEVEL_MEDIUM_HTC	XrFoveationLevelHTC - The pixel density drop level of periphery area
static final int	XR_FOVEATION_LEVEL_NONE_HTC	XrFoveationLevelHTC - The pixel density drop level of periphery area
static final int	XR_FOVEATION_MODE_CUSTOM_HTC	XrFoveationModeHTC - Foveation mode
static final int	XR_FOVEATION_MODE_DISABLE_HTC	XrFoveationModeHTC - Foveation mode
static final int	XR_FOVEATION_MODE_DYNAMIC_HTC	XrFoveationModeHTC - Foveation mode
static final int	XR_FOVEATION_MODE_FIXED_HTC	XrFoveationModeHTC - Foveation mode
static final String	XR_HTC_FOVEATION_EXTENSION_NAME	The extension name.
static final int	XR_HTC_foveation_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_FOVEATION_APPLY_INFO_HTC	Extends XrStructureType.
static final int	XR_TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC	Extends XrStructureType.
static final int	XR_TYPE_FOVEATION_DYNAMIC_MODE_INFO_HTC	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrApplyFoveationHTC(XrSession session, long applyInfo)	Unsafe version of: ApplyFoveationHTC
static int	xrApplyFoveationHTC(XrSession session, XrFoveationApplyInfoHTC applyInfo)	Apply foveation config to system.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_HTC_foveation_SPEC_VERSION

public static final int XR_HTC_foveation_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_HTC_FOVEATION_EXTENSION_NAME

public static final String XR_HTC_FOVEATION_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_FOVEATION_APPLY_INFO_HTC

public static final int XR_TYPE_FOVEATION_APPLY_INFO_HTC

Extends XrStructureType.

Enum values:

• TYPE_FOVEATION_APPLY_INFO_HTC
• TYPE_FOVEATION_DYNAMIC_MODE_INFO_HTC
• TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC

See Also:

• Constant Field Values

XR_TYPE_FOVEATION_DYNAMIC_MODE_INFO_HTC

public static final int XR_TYPE_FOVEATION_DYNAMIC_MODE_INFO_HTC

Extends XrStructureType.

Enum values:

• TYPE_FOVEATION_APPLY_INFO_HTC
• TYPE_FOVEATION_DYNAMIC_MODE_INFO_HTC
• TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC

See Also:

• Constant Field Values

XR_TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC

public static final int XR_TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC

Extends XrStructureType.

Enum values:

• TYPE_FOVEATION_APPLY_INFO_HTC
• TYPE_FOVEATION_DYNAMIC_MODE_INFO_HTC
• TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC

See Also:

• Constant Field Values

XR_FOVEATION_MODE_DISABLE_HTC

public static final int XR_FOVEATION_MODE_DISABLE_HTC

XrFoveationModeHTC - Foveation mode

Enumerant Descriptions

• FOVEATION_MODE_DISABLE_HTC — No foveation
• FOVEATION_MODE_FIXED_HTC — Apply system default setting with fixed clear FOV and periphery quality.
• FOVEATION_MODE_DYNAMIC_HTC — Allow system to set foveation dynamically according realtime system metric or other extensions.
• FOVEATION_MODE_CUSTOM_HTC — Allow application to set foveation with desired clear FOV, periphery quality, and focal center offset.

See Also

XrFoveationApplyInfoHTC

See Also:

• Constant Field Values

XR_FOVEATION_MODE_FIXED_HTC

public static final int XR_FOVEATION_MODE_FIXED_HTC

XrFoveationModeHTC - Foveation mode

Enumerant Descriptions

• FOVEATION_MODE_DISABLE_HTC — No foveation
• FOVEATION_MODE_FIXED_HTC — Apply system default setting with fixed clear FOV and periphery quality.
• FOVEATION_MODE_DYNAMIC_HTC — Allow system to set foveation dynamically according realtime system metric or other extensions.
• FOVEATION_MODE_CUSTOM_HTC — Allow application to set foveation with desired clear FOV, periphery quality, and focal center offset.

See Also

XrFoveationApplyInfoHTC

See Also:

• Constant Field Values

XR_FOVEATION_MODE_DYNAMIC_HTC

public static final int XR_FOVEATION_MODE_DYNAMIC_HTC

XrFoveationModeHTC - Foveation mode

Enumerant Descriptions

• FOVEATION_MODE_DISABLE_HTC — No foveation
• FOVEATION_MODE_FIXED_HTC — Apply system default setting with fixed clear FOV and periphery quality.
• FOVEATION_MODE_DYNAMIC_HTC — Allow system to set foveation dynamically according realtime system metric or other extensions.
• FOVEATION_MODE_CUSTOM_HTC — Allow application to set foveation with desired clear FOV, periphery quality, and focal center offset.

See Also

XrFoveationApplyInfoHTC

See Also:

• Constant Field Values

XR_FOVEATION_MODE_CUSTOM_HTC

public static final int XR_FOVEATION_MODE_CUSTOM_HTC

XrFoveationModeHTC - Foveation mode

Enumerant Descriptions

• FOVEATION_MODE_DISABLE_HTC — No foveation
• FOVEATION_MODE_FIXED_HTC — Apply system default setting with fixed clear FOV and periphery quality.
• FOVEATION_MODE_DYNAMIC_HTC — Allow system to set foveation dynamically according realtime system metric or other extensions.
• FOVEATION_MODE_CUSTOM_HTC — Allow application to set foveation with desired clear FOV, periphery quality, and focal center offset.

See Also

XrFoveationApplyInfoHTC

See Also:

• Constant Field Values

XR_FOVEATION_LEVEL_NONE_HTC

public static final int XR_FOVEATION_LEVEL_NONE_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area

Enumerant Descriptions

• FOVEATION_LEVEL_NONE_HTC — No foveation
• FOVEATION_LEVEL_LOW_HTC — Light periphery pixel density drop and lower performance gain.
• FOVEATION_LEVEL_MEDIUM_HTC — Medium periphery pixel density drop and medium performance gain
• FOVEATION_LEVEL_HIGH_HTC — Heavy periphery pixel density drop and higher performance gain

See Also

XrFoveationConfigurationHTC

See Also:

• Constant Field Values

XR_FOVEATION_LEVEL_LOW_HTC

public static final int XR_FOVEATION_LEVEL_LOW_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area

Enumerant Descriptions

• FOVEATION_LEVEL_NONE_HTC — No foveation
• FOVEATION_LEVEL_LOW_HTC — Light periphery pixel density drop and lower performance gain.
• FOVEATION_LEVEL_MEDIUM_HTC — Medium periphery pixel density drop and medium performance gain
• FOVEATION_LEVEL_HIGH_HTC — Heavy periphery pixel density drop and higher performance gain

See Also

XrFoveationConfigurationHTC

See Also:

• Constant Field Values

XR_FOVEATION_LEVEL_MEDIUM_HTC

public static final int XR_FOVEATION_LEVEL_MEDIUM_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area

Enumerant Descriptions

• FOVEATION_LEVEL_NONE_HTC — No foveation
• FOVEATION_LEVEL_LOW_HTC — Light periphery pixel density drop and lower performance gain.
• FOVEATION_LEVEL_MEDIUM_HTC — Medium periphery pixel density drop and medium performance gain
• FOVEATION_LEVEL_HIGH_HTC — Heavy periphery pixel density drop and higher performance gain

See Also

XrFoveationConfigurationHTC

See Also:

• Constant Field Values

XR_FOVEATION_LEVEL_HIGH_HTC

public static final int XR_FOVEATION_LEVEL_HIGH_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area

Enumerant Descriptions

• FOVEATION_LEVEL_NONE_HTC — No foveation
• FOVEATION_LEVEL_LOW_HTC — Light periphery pixel density drop and lower performance gain.
• FOVEATION_LEVEL_MEDIUM_HTC — Medium periphery pixel density drop and medium performance gain
• FOVEATION_LEVEL_HIGH_HTC — Heavy periphery pixel density drop and higher performance gain

See Also

XrFoveationConfigurationHTC

See Also:

• Constant Field Values

XR_FOVEATION_DYNAMIC_LEVEL_ENABLED_BIT_HTC

public static final int XR_FOVEATION_DYNAMIC_LEVEL_ENABLED_BIT_HTC

XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode

Flag Descriptions

• FOVEATION_DYNAMIC_LEVEL_ENABLED_BIT_HTC — Allow system to set periphery pixel density dynamically.
• FOVEATION_DYNAMIC_CLEAR_FOV_ENABLED_BIT_HTC — Allow system to set clear FOV degree dynamically.
• FOVEATION_DYNAMIC_FOCAL_CENTER_OFFSET_ENABLED_BIT_HTC — Allow system to set focal center offset dynamically.

See Also:

• Constant Field Values

XR_FOVEATION_DYNAMIC_CLEAR_FOV_ENABLED_BIT_HTC

public static final int XR_FOVEATION_DYNAMIC_CLEAR_FOV_ENABLED_BIT_HTC

XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode

Flag Descriptions

• FOVEATION_DYNAMIC_LEVEL_ENABLED_BIT_HTC — Allow system to set periphery pixel density dynamically.
• FOVEATION_DYNAMIC_CLEAR_FOV_ENABLED_BIT_HTC — Allow system to set clear FOV degree dynamically.
• FOVEATION_DYNAMIC_FOCAL_CENTER_OFFSET_ENABLED_BIT_HTC — Allow system to set focal center offset dynamically.

See Also:

• Constant Field Values

XR_FOVEATION_DYNAMIC_FOCAL_CENTER_OFFSET_ENABLED_BIT_HTC

public static final int XR_FOVEATION_DYNAMIC_FOCAL_CENTER_OFFSET_ENABLED_BIT_HTC

XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode

Flag Descriptions

• FOVEATION_DYNAMIC_LEVEL_ENABLED_BIT_HTC — Allow system to set periphery pixel density dynamically.
• FOVEATION_DYNAMIC_CLEAR_FOV_ENABLED_BIT_HTC — Allow system to set clear FOV degree dynamically.
• FOVEATION_DYNAMIC_FOCAL_CENTER_OFFSET_ENABLED_BIT_HTC — Allow system to set focal center offset dynamically.

See Also:

• Constant Field Values

Method Details

nxrApplyFoveationHTC

public static int nxrApplyFoveationHTC(XrSession session,
 long applyInfo)

Unsafe version of: ApplyFoveationHTC

xrApplyFoveationHTC

public static int xrApplyFoveationHTC(XrSession session,
 XrFoveationApplyInfoHTC applyInfo)

Apply foveation config to system.

C Specification

The ApplyFoveationHTC function is defined as:

 XrResult xrApplyFoveationHTC(
     XrSession                                   session,
     const XrFoveationApplyInfoHTC*              applyInfo);

Description

The foveation configuration will be applied after this call, and the state will persist until the next call to ApplyFoveationHTC or the end of this XrSession, whichever comes first. You should not call ApplyFoveationHTC during rendering to target image layer XrSwapchainSubImage in render loop.

Valid Usage (Implicit)

• The XR_HTC_foveation extension must be enabled prior to calling ApplyFoveationHTC
• session must be a valid XrSession handle
• applyInfo must be a pointer to a valid XrFoveationApplyInfoHTC 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_LIMIT_REACHED

See Also

XrFoveationApplyInfoHTC

Parameters:

session - a handle to an XrSession in which the foveation will apply to.

applyInfo - a pointer to an XrFoveationApplyInfoHTC structure containing information about the foveation configuration and applied XrSwapchainSubImage.