Package org.lwjgl.openxr

Class OCULUSExternalCamera

java.lang.Object

org.lwjgl.openxr.OCULUSExternalCamera

public class OCULUSExternalCamera
extends Object

The XR_OCULUS_external_camera extension.

This extension enables the querying of external camera information for a session. This extension is intended to enable mixed reality capture support for applications.

This extension does not provide a mechanism for supplying external camera information to the runtime. If external camera information is not supplied to the runtime before using this extension, no camera information will be returned.

This API supports returning camera intrinsics and extrinsics:

• Camera intrinsics are the attributes of the camera: resolution, field of view, etc.
• Camera extrinsics are everything external to the camera: relative pose, attached to, etc.
• We do not expect the camera intrinsics to change frequently. We expect the camera extrinsics to change frequently.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUS	XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS
static final int	XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUS	XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS
static final int	XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUS	XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS
static final int	XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUS	XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS
static final int	XR_EXTERNAL_CAMERA_STATUS_CALIBRATED_BIT_OCULUS	XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS
static final int	XR_EXTERNAL_CAMERA_STATUS_CALIBRATING_BIT_OCULUS	XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS
static final int	XR_EXTERNAL_CAMERA_STATUS_CALIBRATION_FAILED_BIT_OCULUS	XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS
static final int	XR_EXTERNAL_CAMERA_STATUS_CAPTURING_BIT_OCULUS	XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS
static final int	XR_EXTERNAL_CAMERA_STATUS_CONNECTED_BIT_OCULUS	XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS
static final int	XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS	XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS
static final String	XR_OCULUS_EXTERNAL_CAMERA_EXTENSION_NAME	The extension name.
static final int	XR_OCULUS_external_camera_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_EXTERNAL_CAMERA_OCULUS	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrEnumerateExternalCamerasOCULUS(XrSession session, int cameraCapacityInput, long cameraCountOutput, long cameras)	Unsafe version of: EnumerateExternalCamerasOCULUS
static int	xrEnumerateExternalCamerasOCULUS(XrSession session, IntBuffer cameraCountOutput, @Nullable XrExternalCameraOCULUS.Buffer cameras)	Enumerates all the external cameras that are supported by the runtime.

Methods inherited from class java.lang.Object

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

Field Details

XR_OCULUS_external_camera_SPEC_VERSION

public static final int XR_OCULUS_external_camera_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_OCULUS_EXTERNAL_CAMERA_EXTENSION_NAME

public static final String XR_OCULUS_EXTERNAL_CAMERA_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_EXTERNAL_CAMERA_OCULUS

public static final int XR_TYPE_EXTERNAL_CAMERA_OCULUS

Extends XrStructureType.

See Also:

• Constant Field Values

XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS

public static final int XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS

XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS

See Also:

• Constant Field Values

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUS

public static final int XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUS

XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS

Description

Enum	Description
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUS	External camera is at a fixed point in LOCAL space
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUS	External camera is attached to the HMD
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUS	External camera is attached to a left Touch controller
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUS	External camera is attached to a right Touch controller

See Also

XrExternalCameraExtrinsicsOCULUS

See Also:

• Constant Field Values

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUS

public static final int XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUS

XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS

Description

Enum	Description
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUS	External camera is at a fixed point in LOCAL space
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUS	External camera is attached to the HMD
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUS	External camera is attached to a left Touch controller
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUS	External camera is attached to a right Touch controller

See Also

XrExternalCameraExtrinsicsOCULUS

See Also:

• Constant Field Values

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUS

public static final int XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUS

XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS

Description

Enum	Description
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUS	External camera is at a fixed point in LOCAL space
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUS	External camera is attached to the HMD
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUS	External camera is attached to a left Touch controller
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUS	External camera is attached to a right Touch controller

See Also

XrExternalCameraExtrinsicsOCULUS

See Also:

• Constant Field Values

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUS

public static final int XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUS

XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS

Description

Enum	Description
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUS	External camera is at a fixed point in LOCAL space
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUS	External camera is attached to the HMD
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUS	External camera is attached to a left Touch controller
EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUS	External camera is attached to a right Touch controller

See Also

XrExternalCameraExtrinsicsOCULUS

See Also:

• Constant Field Values

XR_EXTERNAL_CAMERA_STATUS_CONNECTED_BIT_OCULUS

public static final int XR_EXTERNAL_CAMERA_STATUS_CONNECTED_BIT_OCULUS

XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS

Flag Descriptions

• EXTERNAL_CAMERA_STATUS_CONNECTED_BIT_OCULUS — External camera is connected
• EXTERNAL_CAMERA_STATUS_CALIBRATING_BIT_OCULUS — External camera is undergoing calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATION_FAILED_BIT_OCULUS — External camera has tried and failed calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATED_BIT_OCULUS — External camera has tried and passed calibration
• EXTERNAL_CAMERA_STATUS_CAPTURING_BIT_OCULUS — External camera is capturing

See Also:

• Constant Field Values

XR_EXTERNAL_CAMERA_STATUS_CALIBRATING_BIT_OCULUS

public static final int XR_EXTERNAL_CAMERA_STATUS_CALIBRATING_BIT_OCULUS

XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS

Flag Descriptions

• EXTERNAL_CAMERA_STATUS_CONNECTED_BIT_OCULUS — External camera is connected
• EXTERNAL_CAMERA_STATUS_CALIBRATING_BIT_OCULUS — External camera is undergoing calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATION_FAILED_BIT_OCULUS — External camera has tried and failed calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATED_BIT_OCULUS — External camera has tried and passed calibration
• EXTERNAL_CAMERA_STATUS_CAPTURING_BIT_OCULUS — External camera is capturing

See Also:

• Constant Field Values

XR_EXTERNAL_CAMERA_STATUS_CALIBRATION_FAILED_BIT_OCULUS

public static final int XR_EXTERNAL_CAMERA_STATUS_CALIBRATION_FAILED_BIT_OCULUS

XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS

Flag Descriptions

• EXTERNAL_CAMERA_STATUS_CONNECTED_BIT_OCULUS — External camera is connected
• EXTERNAL_CAMERA_STATUS_CALIBRATING_BIT_OCULUS — External camera is undergoing calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATION_FAILED_BIT_OCULUS — External camera has tried and failed calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATED_BIT_OCULUS — External camera has tried and passed calibration
• EXTERNAL_CAMERA_STATUS_CAPTURING_BIT_OCULUS — External camera is capturing

See Also:

• Constant Field Values

XR_EXTERNAL_CAMERA_STATUS_CALIBRATED_BIT_OCULUS

public static final int XR_EXTERNAL_CAMERA_STATUS_CALIBRATED_BIT_OCULUS

XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS

Flag Descriptions

• EXTERNAL_CAMERA_STATUS_CONNECTED_BIT_OCULUS — External camera is connected
• EXTERNAL_CAMERA_STATUS_CALIBRATING_BIT_OCULUS — External camera is undergoing calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATION_FAILED_BIT_OCULUS — External camera has tried and failed calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATED_BIT_OCULUS — External camera has tried and passed calibration
• EXTERNAL_CAMERA_STATUS_CAPTURING_BIT_OCULUS — External camera is capturing

See Also:

• Constant Field Values

XR_EXTERNAL_CAMERA_STATUS_CAPTURING_BIT_OCULUS

public static final int XR_EXTERNAL_CAMERA_STATUS_CAPTURING_BIT_OCULUS

XrExternalCameraStatusFlagBitsOCULUS - XrExternalCameraStatusFlagBitsOCULUS

Flag Descriptions

• EXTERNAL_CAMERA_STATUS_CONNECTED_BIT_OCULUS — External camera is connected
• EXTERNAL_CAMERA_STATUS_CALIBRATING_BIT_OCULUS — External camera is undergoing calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATION_FAILED_BIT_OCULUS — External camera has tried and failed calibration
• EXTERNAL_CAMERA_STATUS_CALIBRATED_BIT_OCULUS — External camera has tried and passed calibration
• EXTERNAL_CAMERA_STATUS_CAPTURING_BIT_OCULUS — External camera is capturing

See Also:

• Constant Field Values

Method Details

nxrEnumerateExternalCamerasOCULUS

public static int nxrEnumerateExternalCamerasOCULUS(XrSession session,
 int cameraCapacityInput,
 long cameraCountOutput,
 long cameras)

Unsafe version of: EnumerateExternalCamerasOCULUS

Parameters:

cameraCapacityInput - the capacity of the cameras array, or 0 to indicate a request to retrieve the required capacity.

xrEnumerateExternalCamerasOCULUS

public static int xrEnumerateExternalCamerasOCULUS(XrSession session,
 IntBuffer cameraCountOutput,
 @Nullable XrExternalCameraOCULUS.Buffer cameras)

Enumerates all the external cameras that are supported by the runtime.

C Specification

The EnumerateExternalCamerasOCULUS function enumerates all the external cameras that are supported by the runtime, it is defined as:

 XrResult xrEnumerateExternalCamerasOCULUS(
     XrSession                                   session,
     uint32_t                                    cameraCapacityInput,
     uint32_t*                                   cameraCountOutput,
     XrExternalCameraOCULUS*                     cameras);

Valid Usage (Implicit)

• The XR_OCULUS_external_camera extension must be enabled prior to calling EnumerateExternalCamerasOCULUS
• session must be a valid XrSession handle
• cameraCountOutput must be a pointer to a uint32_t value
• If cameraCapacityInput is not 0, cameras must be a pointer to an array of cameraCapacityInput XrExternalCameraOCULUS structures

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_SIZE_INSUFFICIENT

See Also

XrExternalCameraOCULUS

Parameters:

session - the XrSession to query the external cameras in

cameraCountOutput - filled in by the runtime with the count of cameras written or the required capacity in the case that cameraCapacityInput is insufficient.

cameras - an array of XrExternalCameraOCULUS filled in by the runtime which contains all the available external cameras, but can be NULL if cameraCapacityInput is 0.