Package org.lwjgl.openxr

Class FBFoveation

java.lang.Object

org.lwjgl.openxr.FBFoveation

public class FBFoveation
extends Object

The XR_FB_foveation extension.

Foveation in the context of XR is a rendering technique that allows the area of an image near the focal point or fovea of the eye to be displayed at higher resolution than areas in the periphery. This trades some visual fidelity in the periphery, where it is less noticeable for the user, for improved rendering performance, most notably regarding the fragment shader, as fewer pixels or subpixels in the periphery need to be shaded and processed. On platforms which support foveation patterns and features tailored towards the optical properties, performance profiles, and hardware support of specific HMDs, application developers may request and use available foveation profiles from the runtime. Foveation profiles refer to a set of properties describing how, when, and where foveation will be applied.

This extension allows:

• An application to create swapchains that can support foveation for its graphics API.
• An application to request foveation profiles supported by the runtime and apply them to foveation-supported swapchains.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_FB_FOVEATION_EXTENSION_NAME	The extension name.
static final int	XR_FB_foveation_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_FOVEATION_PROFILE_FB	Extends XrObjectType.
static final int	XR_SWAPCHAIN_CREATE_FOVEATION_FRAGMENT_DENSITY_MAP_BIT_FB	XrSwapchainCreateFoveationFlagBitsFB - XrSwapchainCreateFoveationFlagBitsFB
static final int	XR_SWAPCHAIN_CREATE_FOVEATION_SCALED_BIN_BIT_FB	XrSwapchainCreateFoveationFlagBitsFB - XrSwapchainCreateFoveationFlagBitsFB
static final int	XR_TYPE_FOVEATION_PROFILE_CREATE_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB	Extends XrStructureType.
static final int	XR_TYPE_SWAPCHAIN_STATE_FOVEATION_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateFoveationProfileFB(XrSession session, long createInfo, long profile)	Unsafe version of: CreateFoveationProfileFB
static int	xrCreateFoveationProfileFB(XrSession session, XrFoveationProfileCreateInfoFB createInfo, org.lwjgl.PointerBuffer profile)	Create a foveation profile.
static int	xrDestroyFoveationProfileFB(XrFoveationProfileFB profile)	Destroy a foveation profile.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_foveation_SPEC_VERSION

public static final int XR_FB_foveation_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_FOVEATION_EXTENSION_NAME

public static final String XR_FB_FOVEATION_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_OBJECT_TYPE_FOVEATION_PROFILE_FB

public static final int XR_OBJECT_TYPE_FOVEATION_PROFILE_FB

Extends XrObjectType.

See Also:

• Constant Field Values

XR_TYPE_FOVEATION_PROFILE_CREATE_INFO_FB

public static final int XR_TYPE_FOVEATION_PROFILE_CREATE_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_FOVEATION_PROFILE_CREATE_INFO_FB
• TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB
• TYPE_SWAPCHAIN_STATE_FOVEATION_FB

See Also:

• Constant Field Values

XR_TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB

public static final int XR_TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB

Extends XrStructureType.

Enum values:

• TYPE_FOVEATION_PROFILE_CREATE_INFO_FB
• TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB
• TYPE_SWAPCHAIN_STATE_FOVEATION_FB

See Also:

• Constant Field Values

XR_TYPE_SWAPCHAIN_STATE_FOVEATION_FB

public static final int XR_TYPE_SWAPCHAIN_STATE_FOVEATION_FB

Extends XrStructureType.

Enum values:

• TYPE_FOVEATION_PROFILE_CREATE_INFO_FB
• TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB
• TYPE_SWAPCHAIN_STATE_FOVEATION_FB

See Also:

• Constant Field Values

XR_SWAPCHAIN_CREATE_FOVEATION_SCALED_BIN_BIT_FB

public static final int XR_SWAPCHAIN_CREATE_FOVEATION_SCALED_BIN_BIT_FB

XrSwapchainCreateFoveationFlagBitsFB - XrSwapchainCreateFoveationFlagBitsFB

Flag Descriptions

• SWAPCHAIN_CREATE_FOVEATION_SCALED_BIN_BIT_FB — Explicitly create the swapchain with scaled bin foveation support. The application must ensure that the swapchain is using the OpenGL graphics API and that the QCOM_texture_foveated extension is supported and enabled.
• SWAPCHAIN_CREATE_FOVEATION_FRAGMENT_DENSITY_MAP_BIT_FB — Explicitly create the swapchain with fragment density map foveation support. The application must ensure that the swapchain is using the Vulkan graphics API and that the VK_EXT_fragment_density_map extension is supported and enabled.

See Also:

• Constant Field Values

XR_SWAPCHAIN_CREATE_FOVEATION_FRAGMENT_DENSITY_MAP_BIT_FB

public static final int XR_SWAPCHAIN_CREATE_FOVEATION_FRAGMENT_DENSITY_MAP_BIT_FB

XrSwapchainCreateFoveationFlagBitsFB - XrSwapchainCreateFoveationFlagBitsFB

Flag Descriptions

• SWAPCHAIN_CREATE_FOVEATION_SCALED_BIN_BIT_FB — Explicitly create the swapchain with scaled bin foveation support. The application must ensure that the swapchain is using the OpenGL graphics API and that the QCOM_texture_foveated extension is supported and enabled.
• SWAPCHAIN_CREATE_FOVEATION_FRAGMENT_DENSITY_MAP_BIT_FB — Explicitly create the swapchain with fragment density map foveation support. The application must ensure that the swapchain is using the Vulkan graphics API and that the VK_EXT_fragment_density_map extension is supported and enabled.

See Also:

• Constant Field Values

Method Details

nxrCreateFoveationProfileFB

public static int nxrCreateFoveationProfileFB(XrSession session,
 long createInfo,
 long profile)

Unsafe version of: CreateFoveationProfileFB

xrCreateFoveationProfileFB

public static int xrCreateFoveationProfileFB(XrSession session,
 XrFoveationProfileCreateInfoFB createInfo,
 org.lwjgl.PointerBuffer profile)

Create a foveation profile.

C Specification

The CreateFoveationProfileFB function is defined as:

 XrResult xrCreateFoveationProfileFB(
     XrSession                                   session,
     const XrFoveationProfileCreateInfoFB*       createInfo,
     XrFoveationProfileFB*                       profile);

Description

Creates an XrFoveationProfileFB handle. The returned foveation profile handle may be subsequently used in API calls.

Valid Usage (Implicit)

• The XR_FB_foveation extension must be enabled prior to calling CreateFoveationProfileFB
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrFoveationProfileCreateInfoFB structure
• profile must be a pointer to an XrFoveationProfileFB handle

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_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED

See Also

XrFoveationProfileCreateInfoFB

Parameters:

session - the XrSession that created the swapchains to which this foveation profile will be applied.

createInfo - a pointer to an XrFoveationProfileCreateInfoFB structure containing parameters to be used to create the foveation profile.

profile - a pointer to a handle in which the created XrFoveationProfileFB is returned.

xrDestroyFoveationProfileFB

public static int xrDestroyFoveationProfileFB(XrFoveationProfileFB profile)

Destroy a foveation profile.

C Specification

The DestroyFoveationProfileFB function is defined as:

 XrResult xrDestroyFoveationProfileFB(
     XrFoveationProfileFB                        profile);

Description

XrFoveationProfileFB handles are destroyed using DestroyFoveationProfileFB. A XrFoveationProfileFB may be safely destroyed after being applied to a swapchain state using UpdateSwapchainFB without affecting the foveation parameters of the swapchain. The application is responsible for ensuring that it has no calls using profile in progress when the foveation profile is destroyed.

Valid Usage (Implicit)

• The XR_FB_foveation extension must be enabled prior to calling DestroyFoveationProfileFB
• profile must be a valid XrFoveationProfileFB handle

Thread Safety

• Access to profile, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID

Parameters:

profile - the XrFoveationProfileFB to destroy.