Package org.lwjgl.openxr

Class FBSwapchainUpdateState

java.lang.Object

org.lwjgl.openxr.FBSwapchainUpdateState

public class FBSwapchainUpdateState
extends Object

The XR_FB_swapchain_update_state extension.

This extension enables the application to modify and query specific mutable state associated with a swapchain.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_FB_SWAPCHAIN_UPDATE_STATE_EXTENSION_NAME	The extension name.
static final int	XR_FB_swapchain_update_state_SPEC_VERSION	The extension specification version.

Method Summary

Modifier and Type	Method	Description
static int	nxrGetSwapchainStateFB(XrSwapchain swapchain, long state)	Unsafe version of: GetSwapchainStateFB
static int	nxrUpdateSwapchainFB(XrSwapchain swapchain, long state)	Unsafe version of: UpdateSwapchainFB
static int	xrGetSwapchainStateFB(XrSwapchain swapchain, XrSwapchainStateBaseHeaderFB state)	Query state for the corresponding swapchain.
static int	xrUpdateSwapchainFB(XrSwapchain swapchain, XrSwapchainStateBaseHeaderFB state)	Updates state for the corresponding swapchain.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_swapchain_update_state_SPEC_VERSION

public static final int XR_FB_swapchain_update_state_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_SWAPCHAIN_UPDATE_STATE_EXTENSION_NAME

public static final String XR_FB_SWAPCHAIN_UPDATE_STATE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

Method Details

nxrUpdateSwapchainFB

public static int nxrUpdateSwapchainFB(XrSwapchain swapchain,
 long state)

Unsafe version of: UpdateSwapchainFB

xrUpdateSwapchainFB

public static int xrUpdateSwapchainFB(XrSwapchain swapchain,
 XrSwapchainStateBaseHeaderFB state)

Updates state for the corresponding swapchain.

C Specification

The UpdateSwapchainFB function is defined as:

 XrResult xrUpdateSwapchainFB(
     XrSwapchain                                 swapchain,
     const XrSwapchainStateBaseHeaderFB*         state);

Description

UpdateSwapchainFB provides support for an application to update specific mutable state associated with an XrSwapchain.

Valid Usage (Implicit)

• The XR_FB_swapchain_update_state extension must be enabled prior to calling UpdateSwapchainFB
• swapchain must be a valid XrSwapchain handle
• state must be a pointer to a valid XrSwapchainStateBaseHeaderFB-based structure. See also: XrSwapchainStateFoveationFB, XrSwapchainStateSamplerOpenGLESFB, XrSwapchainStateSamplerVulkanFB

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

See Also

XrSwapchainStateBaseHeaderFB, CreateSwapchain

Parameters:

swapchain - the XrSwapchain to update state for.

state - a pointer to a XrSwapchainState structure based off of XrSwapchainStateBaseHeaderFB.

nxrGetSwapchainStateFB

public static int nxrGetSwapchainStateFB(XrSwapchain swapchain,
 long state)

Unsafe version of: GetSwapchainStateFB

xrGetSwapchainStateFB

public static int xrGetSwapchainStateFB(XrSwapchain swapchain,
 XrSwapchainStateBaseHeaderFB state)

Query state for the corresponding swapchain.

C Specification

The GetSwapchainStateFB function is defined as:

 XrResult xrGetSwapchainStateFB(
     XrSwapchain                                 swapchain,
     XrSwapchainStateBaseHeaderFB*               state);

Description

GetSwapchainStateFB provides support for an application to query specific mutable state associated with an XrSwapchain.

Valid Usage (Implicit)

• The XR_FB_swapchain_update_state extension must be enabled prior to calling GetSwapchainStateFB
• swapchain must be a valid XrSwapchain handle
• state must be a pointer to an XrSwapchainStateBaseHeaderFB-based structure. See also: XrSwapchainStateFoveationFB, XrSwapchainStateSamplerOpenGLESFB, XrSwapchainStateSamplerVulkanFB

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

See Also

XrSwapchainStateBaseHeaderFB, CreateSwapchain, UpdateSwapchainFB

Parameters:

swapchain - the XrSwapchain to update state for.

state - a pointer to a XrSwapchainState structure based off of XrSwapchainStateBaseHeaderFB.