Top Description Fields Constructors Methods
org.lwjgl.openxr

public Class HTCFoveation

extends Object
Class Inheritance
Imports
org.lwjgl.system.*

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:

Note

This extension is recommended for XrSession whose XrViewConfigurationType is VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO.

Field Summary

Modifier and TypeField and Description
public static final int
XR_FOVEATION_DYNAMIC_CLEAR_FOV_ENABLED_BIT_HTC

XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode Flag Descriptions

public static final int
XR_FOVEATION_DYNAMIC_FOCAL_CENTER_OFFSET_ENABLED_BIT_HTC

XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode Flag Descriptions

public static final int
XR_FOVEATION_DYNAMIC_LEVEL_ENABLED_BIT_HTC

XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode Flag Descriptions

public static final int
XR_FOVEATION_LEVEL_HIGH_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area Enumerant Descriptions

public static final int
XR_FOVEATION_LEVEL_LOW_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area Enumerant Descriptions

public static final int
XR_FOVEATION_LEVEL_MEDIUM_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area Enumerant Descriptions

public static final int
XR_FOVEATION_LEVEL_NONE_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area Enumerant Descriptions

public static final int
XR_FOVEATION_MODE_CUSTOM_HTC

XrFoveationModeHTC - Foveation mode Enumerant Descriptions

public static final int
XR_FOVEATION_MODE_DISABLE_HTC

XrFoveationModeHTC - Foveation mode Enumerant Descriptions

public static final int
XR_FOVEATION_MODE_DYNAMIC_HTC

XrFoveationModeHTC - Foveation mode Enumerant Descriptions

public static final int
XR_FOVEATION_MODE_FIXED_HTC

XrFoveationModeHTC - Foveation mode Enumerant Descriptions

public static final String
public static final int
XR_HTC_foveation_SPEC_VERSION

The extension specification version.

public static final int
XR_TYPE_FOVEATION_APPLY_INFO_HTC

Extends XrStructureType.

public static final int
public static final int

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static int
nxrApplyFoveationHTC(XrSession session, long applyInfo)

Unsafe version of: ApplyFoveationHTC

public static int
xrApplyFoveationHTC(XrSession
a handle to an XrSession in which the foveation will apply to.
session
,
XrFoveationApplyInfoHTC
a pointer to an XrFoveationApplyInfoHTC structure containing information about the foveation configuration and applied XrSwapchainSubImage.
applyInfo
)

Apply foveation config to system.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

XR_FOVEATION_DYNAMIC_CLEAR_FOV_ENABLED_BIT_HTCback to summary
public static final int XR_FOVEATION_DYNAMIC_CLEAR_FOV_ENABLED_BIT_HTC

XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode

Flag Descriptions
XR_FOVEATION_DYNAMIC_FOCAL_CENTER_OFFSET_ENABLED_BIT_HTCback to summary
public static final int XR_FOVEATION_DYNAMIC_FOCAL_CENTER_OFFSET_ENABLED_BIT_HTC

XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode

Flag Descriptions
XR_FOVEATION_DYNAMIC_LEVEL_ENABLED_BIT_HTCback to summary
public static final int XR_FOVEATION_DYNAMIC_LEVEL_ENABLED_BIT_HTC

XrFoveationDynamicFlagBitsHTC - Features allow to change in dynamic mode

Flag Descriptions
XR_FOVEATION_LEVEL_HIGH_HTCback to summary
public static final int XR_FOVEATION_LEVEL_HIGH_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area

Enumerant Descriptions
See Also

XrFoveationConfigurationHTC

XR_FOVEATION_LEVEL_LOW_HTCback to summary
public static final int XR_FOVEATION_LEVEL_LOW_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area

Enumerant Descriptions
See Also

XrFoveationConfigurationHTC

XR_FOVEATION_LEVEL_MEDIUM_HTCback to summary
public static final int XR_FOVEATION_LEVEL_MEDIUM_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area

Enumerant Descriptions
See Also

XrFoveationConfigurationHTC

XR_FOVEATION_LEVEL_NONE_HTCback to summary
public static final int XR_FOVEATION_LEVEL_NONE_HTC

XrFoveationLevelHTC - The pixel density drop level of periphery area

Enumerant Descriptions
See Also

XrFoveationConfigurationHTC

XR_FOVEATION_MODE_CUSTOM_HTCback to summary
public static final int XR_FOVEATION_MODE_CUSTOM_HTC

XrFoveationModeHTC - Foveation mode

Enumerant Descriptions
See Also

XrFoveationApplyInfoHTC

XR_FOVEATION_MODE_DISABLE_HTCback to summary
public static final int XR_FOVEATION_MODE_DISABLE_HTC

XrFoveationModeHTC - Foveation mode

Enumerant Descriptions
See Also

XrFoveationApplyInfoHTC

XR_FOVEATION_MODE_DYNAMIC_HTCback to summary
public static final int XR_FOVEATION_MODE_DYNAMIC_HTC

XrFoveationModeHTC - Foveation mode

Enumerant Descriptions
See Also

XrFoveationApplyInfoHTC

XR_FOVEATION_MODE_FIXED_HTCback to summary
public static final int XR_FOVEATION_MODE_FIXED_HTC

XrFoveationModeHTC - Foveation mode

Enumerant Descriptions
See Also

XrFoveationApplyInfoHTC

XR_HTC_FOVEATION_EXTENSION_NAMEback to summary
public static final String XR_HTC_FOVEATION_EXTENSION_NAME

The extension name.

XR_HTC_foveation_SPEC_VERSIONback to summary
public static final int XR_HTC_foveation_SPEC_VERSION

The extension specification version.

XR_TYPE_FOVEATION_APPLY_INFO_HTCback to summary
public static final int XR_TYPE_FOVEATION_APPLY_INFO_HTC

Extends XrStructureType.

Enum values:
XR_TYPE_FOVEATION_CUSTOM_MODE_INFO_HTCback to summary
public static final int XR_TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC

Extends XrStructureType.

Enum values:
XR_TYPE_FOVEATION_DYNAMIC_MODE_INFO_HTCback to summary
public static final int XR_TYPE_FOVEATION_DYNAMIC_MODE_INFO_HTC

Extends XrStructureType.

Enum values:

Constructor Detail

HTCFoveationback to summary
protected HTCFoveation()

Method Detail

nxrApplyFoveationHTCback to summary
public static int nxrApplyFoveationHTC(XrSession session, long applyInfo)

Unsafe version of: ApplyFoveationHTC

xrApplyFoveationHTCback to summary
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)
Return Codes
On success, this command returns
On failure, this command returns
See Also

XrFoveationApplyInfoHTC

Parameters
session:XrSession

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

applyInfo:XrFoveationApplyInfoHTC

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

Annotations
@NativeType:XrResult