Top Description Fields Constructors Methods

org.lwjgl.openxr

public Class OCULUSExternalCamera

Class Inheritance

extends Object

java.lang.Object
org.lwjgl.openxr.OCULUSExternalCamera

Imports

javax.annotation.*, java.nio.*, org.lwjgl.system.*

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

Modifier and Type Field and Description

public static final int

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUS

XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS Description

EnumDescription EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUSExternal camera is at a fixed point in LOCAL space EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUSExternal camera is attached to the HMD EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUSExternal camera is attached to a left Touch controller EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUSExternal camera is attached to a right Touch controller

public static final int

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUS

XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS Description

EnumDescription EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUSExternal camera is at a fixed point in LOCAL space EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUSExternal camera is attached to the HMD EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUSExternal camera is attached to a left Touch controller EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUSExternal camera is attached to a right Touch controller

public static final int

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUS

XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS Description

EnumDescription EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUSExternal camera is at a fixed point in LOCAL space EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUSExternal camera is attached to the HMD EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUSExternal camera is attached to a left Touch controller EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUSExternal camera is attached to a right Touch controller

public static final int

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUS

XrExternalCameraAttachedToDeviceOCULUS - XrExternalCameraAttachedToDeviceOCULUS Description

EnumDescription EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUSExternal camera is at a fixed point in LOCAL space EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUSExternal camera is attached to the HMD EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUSExternal camera is attached to a left Touch controller EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUSExternal camera is attached to a right Touch controller

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

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

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

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

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

public static final int

XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS

XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS

public static final String

XR_OCULUS_EXTERNAL_CAMERA_EXTENSION_NAME

The extension name.

public static final int

XR_OCULUS_external_camera_SPEC_VERSION

The extension specification version.

public static final int

XR_TYPE_EXTERNAL_CAMERA_OCULUS

Extends XrStructureType.

Constructor Summary

Access	Constructor and Description
protected	OCULUSExternalCamera()

Method Summary

Modifier and Type Method and Description

public static int

nxrEnumerateExternalCamerasOCULUS(XrSession session, int

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

cameraCapacityInput, long cameraCountOutput, long cameras)

Unsafe version of: EnumerateExternalCamerasOCULUS

public static int

xrEnumerateExternalCamerasOCULUS(XrSession

the XrSession to query the external cameras in

session, IntBuffer

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

cameraCountOutput, XrExternalCameraOCULUS.Buffer

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

cameras)

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

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

Field Detail

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_HMD_OCULUS back to summary

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

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_LTOUCH_OCULUS back to summary

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

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_NONE_OCULUS back to summary

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

XR_EXTERNAL_CAMERA_ATTACHED_TO_DEVICE_RTOUCH_OCULUS back to summary

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

XR_EXTERNAL_CAMERA_STATUS_CALIBRATED_BIT_OCULUS back to summary

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

XR_EXTERNAL_CAMERA_STATUS_CALIBRATING_BIT_OCULUS back to summary

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

XR_EXTERNAL_CAMERA_STATUS_CALIBRATION_FAILED_BIT_OCULUS back to summary

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

XR_EXTERNAL_CAMERA_STATUS_CAPTURING_BIT_OCULUS back to summary

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

XR_EXTERNAL_CAMERA_STATUS_CONNECTED_BIT_OCULUS back to summary

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

XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS	back to summary
public static final int XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS XR_MAX_EXTERNAL_CAMERA_NAME_SIZE_OCULUS

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

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

XR_TYPE_EXTERNAL_CAMERA_OCULUS	back to summary
public static final int XR_TYPE_EXTERNAL_CAMERA_OCULUS Extends `XrStructureType`.

Constructor Detail

OCULUSExternalCamera	back to summary
protected OCULUSExternalCamera()

Method Detail

nxrEnumerateExternalCamerasOCULUS back to summary

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

Unsafe version of: EnumerateExternalCamerasOCULUS

Parameters

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

xrEnumerateExternalCamerasOCULUS back to summary

public static int xrEnumerateExternalCamerasOCULUS(XrSession session, IntBuffer cameraCountOutput, 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

On failure, this command returns

See Also

XrExternalCameraOCULUS

Parameters

session:XrSession: the XrSession to query the external cameras in
cameraCountOutput:IntBuffer: filled in by the runtime with the count of cameras written or the required capacity in the case that cameraCapacityInput is insufficient.
cameras:XrExternalCameraOCULUS.Buffer: an array of XrExternalCameraOCULUS filled in by the runtime which contains all the available external cameras, but can be NULL if cameraCapacityInput is 0.

Annotations

@NativeType:XrResult