Package org.lwjgl.openxr

Class METAEnvironmentDepth

java.lang.Object

org.lwjgl.openxr.METAEnvironmentDepth

public class METAEnvironmentDepth
extends Object

The XR_META_environment_depth extension.

This extension allows the application to request depth maps of the real-world environment around the headset. The depth maps are generated by the runtime and shared with the application using an XrEnvironmentDepthSwapchainMETA.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ENVIRONMENT_DEPTH_NOT_AVAILABLE_META	Extends XrResult.
static final String	XR_META_ENVIRONMENT_DEPTH_EXTENSION_NAME	The extension name.
static final int	XR_META_environment_depth_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_ENVIRONMENT_DEPTH_PROVIDER_META	Extends XrObjectType.
static final int	XR_OBJECT_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_META	Extends XrObjectType.
static final int	XR_TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META	Extends XrStructureType.
static final int	XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META	Extends XrStructureType.
static final int	XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_META	Extends XrStructureType.
static final int	XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META	Extends XrStructureType.
static final int	XR_TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META	Extends XrStructureType.
static final int	XR_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META	Extends XrStructureType.
static final int	XR_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrAcquireEnvironmentDepthImageMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider, long acquireInfo, long environmentDepthImage)	Unsafe version of: AcquireEnvironmentDepthImageMETA
static int	nxrCreateEnvironmentDepthProviderMETA(XrSession session, long createInfo, long environmentDepthProvider)	Unsafe version of: CreateEnvironmentDepthProviderMETA
static int	nxrCreateEnvironmentDepthSwapchainMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider, long createInfo, long swapchain)	Unsafe version of: CreateEnvironmentDepthSwapchainMETA
static int	nxrEnumerateEnvironmentDepthSwapchainImagesMETA(XrEnvironmentDepthSwapchainMETA swapchain, int imageCapacityInput, long imageCountOutput, long images)	Unsafe version of: EnumerateEnvironmentDepthSwapchainImagesMETA
static int	nxrGetEnvironmentDepthSwapchainStateMETA(XrEnvironmentDepthSwapchainMETA swapchain, long state)	Unsafe version of: GetEnvironmentDepthSwapchainStateMETA
static int	nxrSetEnvironmentDepthHandRemovalMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider, long setInfo)	Unsafe version of: SetEnvironmentDepthHandRemovalMETA
static int	xrAcquireEnvironmentDepthImageMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider, XrEnvironmentDepthImageAcquireInfoMETA acquireInfo, XrEnvironmentDepthImageMETA environmentDepthImage)	Returns an image index in a readable depth swapchain and associated metadata.
static int	xrCreateEnvironmentDepthProviderMETA(XrSession session, XrEnvironmentDepthProviderCreateInfoMETA createInfo, org.lwjgl.PointerBuffer environmentDepthProvider)	Creates and initializes a depth provider.
static int	xrCreateEnvironmentDepthSwapchainMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider, XrEnvironmentDepthSwapchainCreateInfoMETA createInfo, org.lwjgl.PointerBuffer swapchain)	Returns a readable depth swapchain.
static int	xrDestroyEnvironmentDepthProviderMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider)	Destroys the depth provider and frees all memory and resources.
static int	xrDestroyEnvironmentDepthSwapchainMETA(XrEnvironmentDepthSwapchainMETA swapchain)	Destroys a readable depth swapchain.
static int	xrEnumerateEnvironmentDepthSwapchainImagesMETA(XrEnvironmentDepthSwapchainMETA swapchain, IntBuffer imageCountOutput, @Nullable XrSwapchainImageBaseHeader.Buffer images)	Gets images from a readable depth swapchain.
static int	xrGetEnvironmentDepthSwapchainStateMETA(XrEnvironmentDepthSwapchainMETA swapchain, XrEnvironmentDepthSwapchainStateMETA state)	Returns the state of the readable depth swapchain.
static int	xrSetEnvironmentDepthHandRemovalMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider, XrEnvironmentDepthHandRemovalSetInfoMETA setInfo)	Enables/disables hand removal from the depth map.
static int	xrStartEnvironmentDepthProviderMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider)	Starts the generation of depth maps.
static int	xrStopEnvironmentDepthProviderMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider)	Stops the depth feature.

Methods inherited from class java.lang.Object

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

Field Details

XR_META_environment_depth_SPEC_VERSION

public static final int XR_META_environment_depth_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_META_ENVIRONMENT_DEPTH_EXTENSION_NAME

public static final String XR_META_ENVIRONMENT_DEPTH_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_OBJECT_TYPE_ENVIRONMENT_DEPTH_PROVIDER_META

public static final int XR_OBJECT_TYPE_ENVIRONMENT_DEPTH_PROVIDER_META

Extends XrObjectType.

Enum values:

• OBJECT_TYPE_ENVIRONMENT_DEPTH_PROVIDER_META
• OBJECT_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_META

See Also:

• Constant Field Values

XR_OBJECT_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_META

public static final int XR_OBJECT_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_META

Extends XrObjectType.

Enum values:

• OBJECT_TYPE_ENVIRONMENT_DEPTH_PROVIDER_META
• OBJECT_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_META

See Also:

• Constant Field Values

XR_TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META

public static final int XR_TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META

Extends XrStructureType.

Enum values:

• TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_META
• TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META
• TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

See Also:

• Constant Field Values

XR_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META

public static final int XR_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META

Extends XrStructureType.

Enum values:

• TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_META
• TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META
• TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

See Also:

• Constant Field Values

XR_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META

public static final int XR_TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META

Extends XrStructureType.

Enum values:

• TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_META
• TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META
• TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

See Also:

• Constant Field Values

XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META

public static final int XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META

Extends XrStructureType.

Enum values:

• TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_META
• TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META
• TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

See Also:

• Constant Field Values

XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META

public static final int XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META

Extends XrStructureType.

Enum values:

• TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_META
• TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META
• TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

See Also:

• Constant Field Values

XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_META

public static final int XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_META

Extends XrStructureType.

Enum values:

• TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_META
• TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META
• TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

See Also:

• Constant Field Values

XR_TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META

public static final int XR_TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META

Extends XrStructureType.

Enum values:

• TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_META
• TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META
• TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

public static final int XR_TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

Extends XrStructureType.

Enum values:

• TYPE_ENVIRONMENT_DEPTH_PROVIDER_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_CREATE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_SWAPCHAIN_STATE_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_ACQUIRE_INFO_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META
• TYPE_ENVIRONMENT_DEPTH_IMAGE_META
• TYPE_ENVIRONMENT_DEPTH_HAND_REMOVAL_SET_INFO_META
• TYPE_SYSTEM_ENVIRONMENT_DEPTH_PROPERTIES_META

See Also:

• Constant Field Values

XR_ENVIRONMENT_DEPTH_NOT_AVAILABLE_META

public static final int XR_ENVIRONMENT_DEPTH_NOT_AVAILABLE_META

Extends XrResult.

See Also:

• Constant Field Values

Method Details

nxrCreateEnvironmentDepthProviderMETA

public static int nxrCreateEnvironmentDepthProviderMETA(XrSession session,
 long createInfo,
 long environmentDepthProvider)

Unsafe version of: CreateEnvironmentDepthProviderMETA

xrCreateEnvironmentDepthProviderMETA

public static int xrCreateEnvironmentDepthProviderMETA(XrSession session,
 XrEnvironmentDepthProviderCreateInfoMETA createInfo,
 org.lwjgl.PointerBuffer environmentDepthProvider)

Creates and initializes a depth provider.

C Specification

The CreateEnvironmentDepthProviderMETA function is defined as:

 XrResult xrCreateEnvironmentDepthProviderMETA(
     XrSession                                   session,
     const XrEnvironmentDepthProviderCreateInfoMETA* createInfo,
     XrEnvironmentDepthProviderMETA*             environmentDepthProvider);

Description

The CreateEnvironmentDepthProviderMETA function creates a depth provider instance.

Creating the depth provider may allocate resources, but should not incur any per-frame compute costs until the provider has been started.

• Runtimes must create the provider in a stopped state.
• Runtimes may limit the number of depth providers per XrInstance. If CreateEnvironmentDepthProviderMETA fails due to reaching this limit, the runtime must return ERROR_LIMIT_REACHED.
• Runtimes must support at least 1 provider per XrInstance.
• Runtimes may return ERROR_NOT_PERMITTED_PASSTHROUGH_FB if the app permissions have not been granted to the calling app.
• Applications can call StartEnvironmentDepthProviderMETA to start the generation of depth maps.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling CreateEnvironmentDepthProviderMETA
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrEnvironmentDepthProviderCreateInfoMETA structure
• environmentDepthProvider must be a pointer to an XrEnvironmentDepthProviderMETA 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
• ERROR_NOT_PERMITTED_PASSTHROUGH_FB

See Also

XrEnvironmentDepthProviderCreateInfoMETA

Parameters:

session - the XrSession.

createInfo - a pointer to an XrEnvironmentDepthProviderCreateInfoMETA containing creation options for the depth provider.

environmentDepthProvider - the returned XrEnvironmentDepthProviderMETA handle for the created depth provider.

xrDestroyEnvironmentDepthProviderMETA

public static int xrDestroyEnvironmentDepthProviderMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider)

Destroys the depth provider and frees all memory and resources.

C Specification

The DestroyEnvironmentDepthProviderMETA function is defined as:

 XrResult xrDestroyEnvironmentDepthProviderMETA(
     XrEnvironmentDepthProviderMETA              environmentDepthProvider);

Description

The DestroyEnvironmentDepthProviderMETA function destroys the depth provider. After this call the runtime may free all related memory and resources.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling DestroyEnvironmentDepthProviderMETA
• environmentDepthProvider must be a valid XrEnvironmentDepthProviderMETA handle

Thread Safety

• Access to environmentDepthProvider, 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:

environmentDepthProvider - an XrEnvironmentDepthProviderMETA handle for the depth provider.

xrStartEnvironmentDepthProviderMETA

public static int xrStartEnvironmentDepthProviderMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider)

Starts the generation of depth maps.

C Specification

The StartEnvironmentDepthProviderMETA function is defined as:

 XrResult xrStartEnvironmentDepthProviderMETA(
     XrEnvironmentDepthProviderMETA              environmentDepthProvider);

Description

The StartEnvironmentDepthProviderMETA function starts the asynchronous generation of depth maps.

Starting the depth provider may use CPU and GPU resources.

Runtimes must return ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB if StartEnvironmentDepthProviderMETA is called on an already started XrEnvironmentDepthProviderMETA.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling StartEnvironmentDepthProviderMETA
• environmentDepthProvider must be a valid XrEnvironmentDepthProviderMETA handle

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB

Parameters:

environmentDepthProvider - an XrEnvironmentDepthProviderMETA handle for the depth provider.

xrStopEnvironmentDepthProviderMETA

public static int xrStopEnvironmentDepthProviderMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider)

Stops the depth feature.

C Specification

The StopEnvironmentDepthProviderMETA function is defined as:

 XrResult xrStopEnvironmentDepthProviderMETA(
     XrEnvironmentDepthProviderMETA              environmentDepthProvider);

Description

The StopEnvironmentDepthProviderMETA function stops the generation of depth maps. This stops all per frame computation of environment depth for the application.

Runtimes must return ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB if StopEnvironmentDepthProviderMETA is called on an already stopped XrEnvironmentDepthProviderMETA.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling StopEnvironmentDepthProviderMETA
• environmentDepthProvider must be a valid XrEnvironmentDepthProviderMETA handle

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB

Parameters:

environmentDepthProvider - an XrEnvironmentDepthProviderMETA handle for the depth provider.

nxrCreateEnvironmentDepthSwapchainMETA

public static int nxrCreateEnvironmentDepthSwapchainMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider,
 long createInfo,
 long swapchain)

Unsafe version of: CreateEnvironmentDepthSwapchainMETA

xrCreateEnvironmentDepthSwapchainMETA

public static int xrCreateEnvironmentDepthSwapchainMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider,
 XrEnvironmentDepthSwapchainCreateInfoMETA createInfo,
 org.lwjgl.PointerBuffer swapchain)

Returns a readable depth swapchain.

C Specification

The CreateEnvironmentDepthSwapchainMETA function is defined as:

 XrResult xrCreateEnvironmentDepthSwapchainMETA(
     XrEnvironmentDepthProviderMETA              environmentDepthProvider,
     const XrEnvironmentDepthSwapchainCreateInfoMETA* createInfo,
     XrEnvironmentDepthSwapchainMETA*            swapchain);

Description

The CreateEnvironmentDepthSwapchainMETA function creates a readable swapchain, which is used for accessing the depth data.

The runtime decides on the resolution and length of the swapchain. Additional information about the swapchain can be accessed by calling GetEnvironmentDepthSwapchainStateMETA.

Runtimes must create a swapchain with array textures of length 2, which map to a left-eye and right-eye view. View index 0 must represent the left eye and view index 1 must represent the right eye. This is the same convention as for VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO in XrViewConfigurationType. Runtimes must create the swapchain with the following image formats depending on the graphics API associated with the session:

• OpenGL: GL_DEPTH_COMPONENT16
• Vulkan: VK_FORMAT_D16_UNORM
• Direct3D: DXGI_FORMAT_D16_UNORM

Runtimes must only allow maximum one swapchain to exist per depth provider at any given time, and must return ERROR_LIMIT_REACHED if CreateEnvironmentDepthSwapchainMETA is called to create more. Applications should destroy the swapchain when no longer needed. Applications must be able to handle different swapchain lengths and resolutions.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling CreateEnvironmentDepthSwapchainMETA
• environmentDepthProvider must be a valid XrEnvironmentDepthProviderMETA handle
• createInfo must be a pointer to a valid XrEnvironmentDepthSwapchainCreateInfoMETA structure
• swapchain must be a pointer to an XrEnvironmentDepthSwapchainMETA 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

XrEnvironmentDepthSwapchainCreateInfoMETA

Parameters:

environmentDepthProvider - an XrEnvironmentDepthProviderMETA handle for the depth provider.

createInfo - a pointer to an XrEnvironmentDepthSwapchainCreateInfoMETA containing creation options for the swapchain.

swapchain - the returned XrEnvironmentDepthSwapchainMETA handle for the created swapchain.

xrDestroyEnvironmentDepthSwapchainMETA

public static int xrDestroyEnvironmentDepthSwapchainMETA(XrEnvironmentDepthSwapchainMETA swapchain)

Destroys a readable depth swapchain.

C Specification

The DestroyEnvironmentDepthSwapchainMETA function is defined as:

 XrResult xrDestroyEnvironmentDepthSwapchainMETA(
     XrEnvironmentDepthSwapchainMETA             swapchain);

Description

The DestroyEnvironmentDepthSwapchainMETA function destroys a readable environment depth swapchain.

All submitted graphics API commands that refer to swapchain must have completed execution. Runtimes may continue to utilize swapchain images after DestroyEnvironmentDepthSwapchainMETA is called.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling DestroyEnvironmentDepthSwapchainMETA
• swapchain must be a valid XrEnvironmentDepthSwapchainMETA handle

Thread Safety

• Access to swapchain, 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_HANDLE_INVALID

Parameters:

swapchain - the XrEnvironmentDepthSwapchainMETA to be destroyed.

nxrEnumerateEnvironmentDepthSwapchainImagesMETA

public static int nxrEnumerateEnvironmentDepthSwapchainImagesMETA(XrEnvironmentDepthSwapchainMETA swapchain,
 int imageCapacityInput,
 long imageCountOutput,
 long images)

Unsafe version of: EnumerateEnvironmentDepthSwapchainImagesMETA

Parameters:

imageCapacityInput - the capacity of the images array, or 0 to indicate a request to retrieve the required capacity.

xrEnumerateEnvironmentDepthSwapchainImagesMETA

public static int xrEnumerateEnvironmentDepthSwapchainImagesMETA(XrEnvironmentDepthSwapchainMETA swapchain,
 IntBuffer imageCountOutput,
 @Nullable XrSwapchainImageBaseHeader.Buffer images)

Gets images from a readable depth swapchain.

C Specification

The EnumerateEnvironmentDepthSwapchainImagesMETA function is defined as:

 XrResult xrEnumerateEnvironmentDepthSwapchainImagesMETA(
     XrEnvironmentDepthSwapchainMETA             swapchain,
     uint32_t                                    imageCapacityInput,
     uint32_t*                                   imageCountOutput,
     XrSwapchainImageBaseHeader*                 images);

Description

EnumerateEnvironmentDepthSwapchainImagesMETA fills an array of graphics API-specific stext:XrSwapchainImage* structures derived from XrSwapchainImageBaseHeader. The resources must be constant and valid for the lifetime of the XrEnvironmentDepthSwapchainMETA. This function behaves analogously to EnumerateSwapchainImages.

Runtimes must always return identical buffer contents from this enumeration for the lifetime of the swapchain.

Note: images is a pointer to an array of structures of graphics API-specific type, not an array of structure pointers.

The pointer submitted as images will be treated as an array of the expected graphics API-specific type based on the graphics API used at session creation time. If the type member of any array element accessed in this way does not match the expected value, the runtime must return ERROR_VALIDATION_FAILURE.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling EnumerateEnvironmentDepthSwapchainImagesMETA
• swapchain must be a valid XrEnvironmentDepthSwapchainMETA handle
• imageCountOutput must be a pointer to a uint32_t value
• If imageCapacityInput is not 0, images must be a pointer to an array of imageCapacityInput XrSwapchainImageBaseHeader-based structures. See also: XrSwapchainImageOpenGLKHR, XrSwapchainImageVulkanKHR

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_SIZE_INSUFFICIENT

See Also

XrSwapchainImageBaseHeader

Parameters:

swapchain - the XrEnvironmentDepthSwapchainMETA to get images from.

imageCountOutput - a pointer to the count of images written, or a pointer to the required capacity in the case that imageCapacityInput is insufficient.

images - a pointer to an array of graphics API-specific XrSwapchainImage structures, all of the same type, based on XrSwapchainImageBaseHeader. It can be NULL if imageCapacityInput is 0.

nxrGetEnvironmentDepthSwapchainStateMETA

public static int nxrGetEnvironmentDepthSwapchainStateMETA(XrEnvironmentDepthSwapchainMETA swapchain,
 long state)

Unsafe version of: GetEnvironmentDepthSwapchainStateMETA

xrGetEnvironmentDepthSwapchainStateMETA

public static int xrGetEnvironmentDepthSwapchainStateMETA(XrEnvironmentDepthSwapchainMETA swapchain,
 XrEnvironmentDepthSwapchainStateMETA state)

Returns the state of the readable depth swapchain.

C Specification

The GetEnvironmentDepthSwapchainStateMETA function is defined as:

 XrResult xrGetEnvironmentDepthSwapchainStateMETA(
     XrEnvironmentDepthSwapchainMETA             swapchain,
     XrEnvironmentDepthSwapchainStateMETA*       state);

Description

GetEnvironmentDepthSwapchainStateMETA retrieves information about the XrEnvironmentDepthSwapchainMETA. This information is constant throughout the lifetime of the XrEnvironmentDepthSwapchainMETA.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling GetEnvironmentDepthSwapchainStateMETA
• swapchain must be a valid XrEnvironmentDepthSwapchainMETA handle
• state must be a pointer to an XrEnvironmentDepthSwapchainStateMETA 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

See Also

XrEnvironmentDepthSwapchainStateMETA

Parameters:

swapchain - an XrEnvironmentDepthSwapchainMETA handle.

state - a pointer to an XrEnvironmentDepthSwapchainStateMETA.

nxrAcquireEnvironmentDepthImageMETA

public static int nxrAcquireEnvironmentDepthImageMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider,
 long acquireInfo,
 long environmentDepthImage)

Unsafe version of: AcquireEnvironmentDepthImageMETA

xrAcquireEnvironmentDepthImageMETA

public static int xrAcquireEnvironmentDepthImageMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider,
 XrEnvironmentDepthImageAcquireInfoMETA acquireInfo,
 XrEnvironmentDepthImageMETA environmentDepthImage)

Returns an image index in a readable depth swapchain and associated metadata.

C Specification

The AcquireEnvironmentDepthImageMETA function is defined as:

 XrResult xrAcquireEnvironmentDepthImageMETA(
     XrEnvironmentDepthProviderMETA              environmentDepthProvider,
     const XrEnvironmentDepthImageAcquireInfoMETA* acquireInfo,
     XrEnvironmentDepthImageMETA*                environmentDepthImage);

Description

Acquires the latest available swapchain image that has been generated by the depth provider and ensures it is ready to be accessed by the application. The application may access and queue GPU operations using the acquired image until the next EndFrame call, when the image is released and the depth provider may write new depth data into it after completion of all work queued before the EndFrame call.

The returned XrEnvironmentDepthImageMETA contains the swapchain index into the array enumerated by EnumerateEnvironmentDepthSwapchainImagesMETA. It also contains other information such as the field of view and pose that are necessary to interpret the depth data.

There must be no more than one call to AcquireEnvironmentDepthImageMETA between any pair of corresponding BeginFrame and EndFrame calls in a session.

• The runtime may block if previously acquired swapchain images are still being used by the graphics API.
• The runtime must return ERROR_CALL_ORDER_INVALID if AcquireEnvironmentDepthImageMETA is called before BeginFrame or after EndFrame.
• The runtime must return ERROR_CALL_ORDER_INVALID if AcquireEnvironmentDepthImageMETA is called on a stopped XrEnvironmentDepthProviderMETA.
• The runtime must return ERROR_LIMIT_REACHED if AcquireEnvironmentDepthImageMETA is called more than once per frame - i.e. in a running session, after a call to BeginFrame that has not had an associated EndFrame.
• Runtimes must return ENVIRONMENT_DEPTH_NOT_AVAILABLE_META if no depth frame is available yet (i.e. the provider was recently started and did not yet have time to compute depth). Note that this is a success code. In this case the output parameters must be unchanged.
• The application must not utilize the swapchain image in calls to the graphics API after EndFrame has been called.
• A runtime may use the graphics API specific contexts provided to OpenXR. In particular:
  • For OpenGL, a runtime may use the OpenGL context specified in the call to CreateSession, which needs external synchronization.
  • For Vulkan, a runtime may use the VkQueue specified in the XrGraphicsBindingVulkan2KHR, which needs external synchronization.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling AcquireEnvironmentDepthImageMETA
• environmentDepthProvider must be a valid XrEnvironmentDepthProviderMETA handle
• acquireInfo must be a pointer to a valid XrEnvironmentDepthImageAcquireInfoMETA structure
• environmentDepthImage must be a pointer to an XrEnvironmentDepthImageMETA structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING
• ENVIRONMENT_DEPTH_NOT_AVAILABLE_META

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_TIME_INVALID
• ERROR_CALL_ORDER_INVALID

See Also

XrEnvironmentDepthImageAcquireInfoMETA, XrEnvironmentDepthImageMETA

Parameters:

environmentDepthProvider - an XrEnvironmentDepthProviderMETA handle for the depth provider.

acquireInfo - an XrEnvironmentDepthImageAcquireInfoMETA containing parameters for populating a depth swapchain image.

environmentDepthImage - the returned XrEnvironmentDepthImageMETA containing information about the acquired depth image.

nxrSetEnvironmentDepthHandRemovalMETA

public static int nxrSetEnvironmentDepthHandRemovalMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider,
 long setInfo)

Unsafe version of: SetEnvironmentDepthHandRemovalMETA

xrSetEnvironmentDepthHandRemovalMETA

public static int xrSetEnvironmentDepthHandRemovalMETA(XrEnvironmentDepthProviderMETA environmentDepthProvider,
 XrEnvironmentDepthHandRemovalSetInfoMETA setInfo)

Enables/disables hand removal from the depth map.

C Specification

The SetEnvironmentDepthHandRemovalMETA function is defined as:

 XrResult xrSetEnvironmentDepthHandRemovalMETA(
     XrEnvironmentDepthProviderMETA              environmentDepthProvider,
     const XrEnvironmentDepthHandRemovalSetInfoMETA* setInfo);

Description

The SetEnvironmentDepthHandRemovalMETA function sets hand removal options.

Runtimes should enable or disable the removal of the hand depths from the depth map. If enabled, the corresponding depth pixels should be replaced with the estimated background depth behind the hands. Runtimes must return ERROR_FEATURE_UNSUPPORTED if and only if XrSystemEnvironmentDepthPropertiesMETA::supportsHandRemoval is FALSE.

Valid Usage (Implicit)

• The XR_META_environment_depth extension must be enabled prior to calling SetEnvironmentDepthHandRemovalMETA
• environmentDepthProvider must be a valid XrEnvironmentDepthProviderMETA handle
• setInfo must be a pointer to a valid XrEnvironmentDepthHandRemovalSetInfoMETA 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_FEATURE_UNSUPPORTED

See Also

XrEnvironmentDepthHandRemovalSetInfoMETA

Parameters:

environmentDepthProvider - an XrEnvironmentDepthProviderMETA handle for the depth provider.

setInfo - a pointer to an XrEnvironmentDepthHandRemovalSetInfoMETA containing options for the hand removal.