Package org.lwjgl.openxr

Class FBSceneCapture

java.lang.Object

org.lwjgl.openxr.FBSceneCapture

public class FBSceneCapture
extends Object

The XR_FB_scene_capture extension.

This extension allows an application to request that the system begin capturing information about what is in the environment around the user.

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_SCENE_CAPTURE_EXTENSION_NAME	The extension name.
static final int	XR_FB_scene_capture_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB	Extends XrStructureType.
static final int	XR_TYPE_SCENE_CAPTURE_REQUEST_INFO_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrRequestSceneCaptureFB(XrSession session, long info, long requestId)	Unsafe version of: RequestSceneCaptureFB
static int	xrRequestSceneCaptureFB(XrSession session, XrSceneCaptureRequestInfoFB info, LongBuffer requestId)	Begins a scene capture using the specified parameters.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_scene_capture_SPEC_VERSION

public static final int XR_FB_scene_capture_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_SCENE_CAPTURE_EXTENSION_NAME

public static final String XR_FB_SCENE_CAPTURE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB

public static final int XR_TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB

Extends XrStructureType.

Enum values:

• TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB
• TYPE_SCENE_CAPTURE_REQUEST_INFO_FB

See Also:

• Constant Field Values

XR_TYPE_SCENE_CAPTURE_REQUEST_INFO_FB

public static final int XR_TYPE_SCENE_CAPTURE_REQUEST_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB
• TYPE_SCENE_CAPTURE_REQUEST_INFO_FB

See Also:

• Constant Field Values

Method Details

nxrRequestSceneCaptureFB

public static int nxrRequestSceneCaptureFB(XrSession session,
 long info,
 long requestId)

Unsafe version of: RequestSceneCaptureFB

xrRequestSceneCaptureFB

public static int xrRequestSceneCaptureFB(XrSession session,
 XrSceneCaptureRequestInfoFB info,
 LongBuffer requestId)

Begins a scene capture using the specified parameters.

C Specification

The RequestSceneCaptureFB function is defined as:

 XrResult xrRequestSceneCaptureFB(
     XrSession                                   session,
     const XrSceneCaptureRequestInfoFB*          info,
     XrAsyncRequestIdFB*                         requestId);

Description

The RequestSceneCaptureFB function is used by an application to begin capturing the scene around the user. This is an asynchronous operation.

Valid Usage (Implicit)

• The XR_FB_scene_capture extension must be enabled prior to calling RequestSceneCaptureFB
• session must be a valid XrSession handle
• info must be a pointer to a valid XrSceneCaptureRequestInfoFB structure
• requestId must be a pointer to an XrAsyncRequestIdFB value

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

XrSceneCaptureRequestInfoFB

Parameters:

session - a handle to an XrSession.

info - an XrSceneCaptureRequestInfoFB which specifies how the scene capture should occur.

requestId - the output parameter that points to the ID of this asynchronous request.