LWJGL 3.3.3 · org.lwjgl.openxr.FBFoveation

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 extensions section.

Field Summary

Modifier and Type	Field and Description
public static final String	XR_FB_FOVEATION_EXTENSION_NAME The extension name.
public static final int	XR_FB_foveation_SPEC_VERSION The extension specification version.
public static final int	XR_OBJECT_TYPE_FOVEATION_PROFILE_FB Extends `XrObjectType`.
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.
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.
public static final int	XR_TYPE_FOVEATION_PROFILE_CREATE_INFO_FB Extends `XrStructureType`.
public static final int	XR_TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB Extends `XrStructureType`.
public static final int	XR_TYPE_SWAPCHAIN_STATE_FOVEATION_FB Extends `XrStructureType`.

Access	Constructor and Description
protected	FBFoveation()

Method Summary

Modifier and Type	Method and Description
public static int	nxrCreateFoveationProfileFB(XrSession session, long createInfo, long profile) Unsafe version of: `CreateFoveationProfileFB`
public static int	xrCreateFoveationProfileFB(XrSession the `XrSession` that created the swapchains to which this foveation profile will be applied. session, XrFoveationProfileCreateInfoFB a pointer to an `XrFoveationProfileCreateInfoFB` structure containing parameters to be used to create the foveation profile. createInfo, PointerBuffer a pointer to a handle in which the created `XrFoveationProfileFB` is returned. profile) Create a foveation profile.
public static int	xrDestroyFoveationProfileFB(XrFoveationProfileFB the `XrFoveationProfileFB` to destroy. profile) Destroy a foveation profile.

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

Field Detail

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

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

XR_OBJECT_TYPE_FOVEATION_PROFILE_FB	back to summary
public static final int XR_OBJECT_TYPE_FOVEATION_PROFILE_FB Extends `XrObjectType`.

XR_SWAPCHAIN_CREATE_FOVEATION_FRAGMENT_DENSITY_MAP_BIT_FB back to summary

XR_SWAPCHAIN_CREATE_FOVEATION_FRAGMENT_DENSITY_MAP_BIT_FB	back to summary
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.

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.

XR_SWAPCHAIN_CREATE_FOVEATION_SCALED_BIN_BIT_FB back to summary

XR_SWAPCHAIN_CREATE_FOVEATION_SCALED_BIN_BIT_FB	back to summary
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.

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.

XR_TYPE_FOVEATION_PROFILE_CREATE_INFO_FB back to summary

XR_TYPE_FOVEATION_PROFILE_CREATE_INFO_FB	back to summary
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`

public static final int XR_TYPE_FOVEATION_PROFILE_CREATE_INFO_FB

Extends XrStructureType.

Enum values:

XR_TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB back to summary

XR_TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB	back to summary
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`

public static final int XR_TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB

Extends XrStructureType.

Enum values:

XR_TYPE_SWAPCHAIN_STATE_FOVEATION_FB back to summary

XR_TYPE_SWAPCHAIN_STATE_FOVEATION_FB	back to summary
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`

public static final int XR_TYPE_SWAPCHAIN_STATE_FOVEATION_FB

Extends XrStructureType.

Enum values:

Constructor Detail

FBFoveation	back to summary
protected FBFoveation()

Method Detail

nxrCreateFoveationProfileFB	back to summary
public static int nxrCreateFoveationProfileFB(XrSession session, long createInfo, long profile) Unsafe version of: `CreateFoveationProfileFB`

xrCreateFoveationProfileFB back to summary

xrCreateFoveationProfileFB	back to summary
public static int xrCreateFoveationProfileFB(XrSession session, XrFoveationProfileCreateInfoFB createInfo, 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:XrSession the `XrSession` that created the swapchains to which this foveation profile will be applied. createInfo:XrFoveationProfileCreateInfoFB a pointer to an `XrFoveationProfileCreateInfoFB` structure containing parameters to be used to create the foveation profile. profile:PointerBuffer a pointer to a handle in which the created `XrFoveationProfileFB` is returned. Annotations @NativeType:XrResult

public static int xrCreateFoveationProfileFB(XrSession session, XrFoveationProfileCreateInfoFB createInfo, 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

On failure, this command returns

xrDestroyFoveationProfileFB	back to summary
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:XrFoveationProfileFB the `XrFoveationProfileFB` to destroy. Annotations @NativeType:XrResult

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

Parameters

profile:XrFoveationProfileFB: the XrFoveationProfileFB to destroy.

Annotations

@NativeType:XrResult

public Class FBFoveation

Field Summary

Constructor Summary

Method Summary

Field Detail

Flag Descriptions

Flag Descriptions

Enum values:

Enum values:

Enum values:

Constructor Detail

Method Detail

C Specification

Description

Valid Usage (Implicit)

Return Codes

See Also

C Specification

Description

Valid Usage (Implicit)

Thread Safety

Return Codes