Package org.lwjgl.openxr

Class EXTPlaneDetection

java.lang.Object

org.lwjgl.openxr.EXTPlaneDetection

public class EXTPlaneDetection
extends Object

The XR_EXT_plane_detection extension.

This extension enables applications to detect planes in the scene.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_PLANE_DETECTION_PERMISSION_DENIED_EXT	Extends XrResult.
static final int	XR_ERROR_SPACE_NOT_LOCATABLE_EXT	Extends XrResult.
static final String	XR_EXT_PLANE_DETECTION_EXTENSION_NAME	The extension name.
static final int	XR_EXT_plane_detection_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_PLANE_DETECTOR_EXT	Extends XrObjectType.
static final int	XR_PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT	XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits
static final int	XR_PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT	XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits
static final int	XR_PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT	XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits
static final int	XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT	XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits
static final int	XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT	XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits
static final int	XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT	XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits
static final int	XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT	XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits
static final int	XR_PLANE_DETECTION_STATE_DONE_EXT	XrPlaneDetectionStateEXT - Plane Detection State
static final int	XR_PLANE_DETECTION_STATE_ERROR_EXT	XrPlaneDetectionStateEXT - Plane Detection State
static final int	XR_PLANE_DETECTION_STATE_FATAL_EXT	XrPlaneDetectionStateEXT - Plane Detection State
static final int	XR_PLANE_DETECTION_STATE_NONE_EXT	XrPlaneDetectionStateEXT - Plane Detection State
static final int	XR_PLANE_DETECTION_STATE_PENDING_EXT	XrPlaneDetectionStateEXT - Plane Detection State
static final int	XR_PLANE_DETECTOR_ENABLE_CONTOUR_BIT_EXT	XrPlaneDetectorFlagBitsEXT - Plane Detector flags
static final int	XR_PLANE_DETECTOR_ORIENTATION_ARBITRARY_EXT	XrPlaneDetectorOrientationEXT - Orientation of the detected plane (upward, downward…)
static final int	XR_PLANE_DETECTOR_ORIENTATION_HORIZONTAL_DOWNWARD_EXT	XrPlaneDetectorOrientationEXT - Orientation of the detected plane (upward, downward…)
static final int	XR_PLANE_DETECTOR_ORIENTATION_HORIZONTAL_UPWARD_EXT	XrPlaneDetectorOrientationEXT - Orientation of the detected plane (upward, downward…)
static final int	XR_PLANE_DETECTOR_ORIENTATION_VERTICAL_EXT	XrPlaneDetectorOrientationEXT - Orientation of the detected plane (upward, downward…)
static final int	XR_PLANE_DETECTOR_SEMANTIC_TYPE_CEILING_EXT	XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)
static final int	XR_PLANE_DETECTOR_SEMANTIC_TYPE_FLOOR_EXT	XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)
static final int	XR_PLANE_DETECTOR_SEMANTIC_TYPE_PLATFORM_EXT	XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)
static final int	XR_PLANE_DETECTOR_SEMANTIC_TYPE_UNDEFINED_EXT	XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)
static final int	XR_PLANE_DETECTOR_SEMANTIC_TYPE_WALL_EXT	XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)
static final int	XR_TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT	Extends XrStructureType.
static final int	XR_TYPE_PLANE_DETECTOR_CREATE_INFO_EXT	Extends XrStructureType.
static final int	XR_TYPE_PLANE_DETECTOR_GET_INFO_EXT	Extends XrStructureType.
static final int	XR_TYPE_PLANE_DETECTOR_LOCATION_EXT	Extends XrStructureType.
static final int	XR_TYPE_PLANE_DETECTOR_LOCATIONS_EXT	Extends XrStructureType.
static final int	XR_TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrBeginPlaneDetectionEXT(XrPlaneDetectorEXT planeDetector, long beginInfo)	Unsafe version of: BeginPlaneDetectionEXT
static int	nxrCreatePlaneDetectorEXT(XrSession session, long createInfo, long planeDetector)	Unsafe version of: CreatePlaneDetectorEXT
static int	nxrGetPlaneDetectionsEXT(XrPlaneDetectorEXT planeDetector, long info, long locations)	Unsafe version of: GetPlaneDetectionsEXT
static int	nxrGetPlaneDetectionStateEXT(XrPlaneDetectorEXT planeDetector, long state)	Unsafe version of: GetPlaneDetectionStateEXT
static int	nxrGetPlanePolygonBufferEXT(XrPlaneDetectorEXT planeDetector, long planeId, int polygonBufferIndex, long polygonBuffer)	Unsafe version of: GetPlanePolygonBufferEXT
static int	xrBeginPlaneDetectionEXT(XrPlaneDetectorEXT planeDetector, XrPlaneDetectorBeginInfoEXT beginInfo)	Detect planes.
static int	xrCreatePlaneDetectorEXT(XrSession session, XrPlaneDetectorCreateInfoEXT createInfo, org.lwjgl.PointerBuffer planeDetector)	Create a plane detection handle.
static int	xrDestroyPlaneDetectorEXT(XrPlaneDetectorEXT planeDetector)	Destroy a plane detection handle.
static int	xrGetPlaneDetectionsEXT(XrPlaneDetectorEXT planeDetector, XrPlaneDetectorGetInfoEXT info, XrPlaneDetectorLocationsEXT locations)	Get the detected planes.
static int	xrGetPlaneDetectionStateEXT(XrPlaneDetectorEXT planeDetector, IntBuffer state)	Get the state of the plane detection pass.
static int	xrGetPlanePolygonBufferEXT(XrPlaneDetectorEXT planeDetector, long planeId, int polygonBufferIndex, XrPlaneDetectorPolygonBufferEXT polygonBuffer)	Gets the plane.

Methods inherited from class java.lang.Object

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

Field Details

XR_EXT_plane_detection_SPEC_VERSION

public static final int XR_EXT_plane_detection_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_EXT_PLANE_DETECTION_EXTENSION_NAME

public static final String XR_EXT_PLANE_DETECTION_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_ERROR_SPACE_NOT_LOCATABLE_EXT

public static final int XR_ERROR_SPACE_NOT_LOCATABLE_EXT

Extends XrResult.

Enum values:

• ERROR_SPACE_NOT_LOCATABLE_EXT
• ERROR_PLANE_DETECTION_PERMISSION_DENIED_EXT

See Also:

• Constant Field Values

XR_ERROR_PLANE_DETECTION_PERMISSION_DENIED_EXT

public static final int XR_ERROR_PLANE_DETECTION_PERMISSION_DENIED_EXT

Extends XrResult.

Enum values:

• ERROR_SPACE_NOT_LOCATABLE_EXT
• ERROR_PLANE_DETECTION_PERMISSION_DENIED_EXT

See Also:

• Constant Field Values

XR_OBJECT_TYPE_PLANE_DETECTOR_EXT

public static final int XR_OBJECT_TYPE_PLANE_DETECTOR_EXT

Extends XrObjectType.

See Also:

• Constant Field Values

XR_TYPE_PLANE_DETECTOR_CREATE_INFO_EXT

public static final int XR_TYPE_PLANE_DETECTOR_CREATE_INFO_EXT

Extends XrStructureType.

Enum values:

• TYPE_PLANE_DETECTOR_CREATE_INFO_EXT
• TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT
• TYPE_PLANE_DETECTOR_GET_INFO_EXT
• TYPE_PLANE_DETECTOR_LOCATIONS_EXT
• TYPE_PLANE_DETECTOR_LOCATION_EXT
• TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT
• TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT

See Also:

• Constant Field Values

XR_TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT

public static final int XR_TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT

Extends XrStructureType.

Enum values:

• TYPE_PLANE_DETECTOR_CREATE_INFO_EXT
• TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT
• TYPE_PLANE_DETECTOR_GET_INFO_EXT
• TYPE_PLANE_DETECTOR_LOCATIONS_EXT
• TYPE_PLANE_DETECTOR_LOCATION_EXT
• TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT
• TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT

See Also:

• Constant Field Values

XR_TYPE_PLANE_DETECTOR_GET_INFO_EXT

public static final int XR_TYPE_PLANE_DETECTOR_GET_INFO_EXT

Extends XrStructureType.

Enum values:

• TYPE_PLANE_DETECTOR_CREATE_INFO_EXT
• TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT
• TYPE_PLANE_DETECTOR_GET_INFO_EXT
• TYPE_PLANE_DETECTOR_LOCATIONS_EXT
• TYPE_PLANE_DETECTOR_LOCATION_EXT
• TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT
• TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT

See Also:

• Constant Field Values

XR_TYPE_PLANE_DETECTOR_LOCATIONS_EXT

public static final int XR_TYPE_PLANE_DETECTOR_LOCATIONS_EXT

Extends XrStructureType.

Enum values:

• TYPE_PLANE_DETECTOR_CREATE_INFO_EXT
• TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT
• TYPE_PLANE_DETECTOR_GET_INFO_EXT
• TYPE_PLANE_DETECTOR_LOCATIONS_EXT
• TYPE_PLANE_DETECTOR_LOCATION_EXT
• TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT
• TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT

See Also:

• Constant Field Values

XR_TYPE_PLANE_DETECTOR_LOCATION_EXT

public static final int XR_TYPE_PLANE_DETECTOR_LOCATION_EXT

Extends XrStructureType.

Enum values:

• TYPE_PLANE_DETECTOR_CREATE_INFO_EXT
• TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT
• TYPE_PLANE_DETECTOR_GET_INFO_EXT
• TYPE_PLANE_DETECTOR_LOCATIONS_EXT
• TYPE_PLANE_DETECTOR_LOCATION_EXT
• TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT
• TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT

See Also:

• Constant Field Values

XR_TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT

public static final int XR_TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT

Extends XrStructureType.

Enum values:

• TYPE_PLANE_DETECTOR_CREATE_INFO_EXT
• TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT
• TYPE_PLANE_DETECTOR_GET_INFO_EXT
• TYPE_PLANE_DETECTOR_LOCATIONS_EXT
• TYPE_PLANE_DETECTOR_LOCATION_EXT
• TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT
• TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT

public static final int XR_TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT

Extends XrStructureType.

Enum values:

• TYPE_PLANE_DETECTOR_CREATE_INFO_EXT
• TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT
• TYPE_PLANE_DETECTOR_GET_INFO_EXT
• TYPE_PLANE_DETECTOR_LOCATIONS_EXT
• TYPE_PLANE_DETECTOR_LOCATION_EXT
• TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT
• TYPE_SYSTEM_PLANE_DETECTION_PROPERTIES_EXT

See Also:

• Constant Field Values

XR_PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT

public static final int XR_PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT

XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits

Description

The flag bits have the following meanings:

Flag Descriptions

• PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT — plane detection is supported
• PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT — polygon buffers for holes in planes can be generated
• PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT — plane detection supports ceiling semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT — plane detection supports floor semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT — plane detection supports wall semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT — plane detection supports platform semantic classification (for example table tops)
• PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT — plane detection supports plane orientation classification. If not supported planes are always classified as ARBITRARY.

See Also:

• Constant Field Values

XR_PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT

public static final int XR_PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT

XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits

Description

The flag bits have the following meanings:

Flag Descriptions

• PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT — plane detection is supported
• PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT — polygon buffers for holes in planes can be generated
• PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT — plane detection supports ceiling semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT — plane detection supports floor semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT — plane detection supports wall semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT — plane detection supports platform semantic classification (for example table tops)
• PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT — plane detection supports plane orientation classification. If not supported planes are always classified as ARBITRARY.

See Also:

• Constant Field Values

XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT

public static final int XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT

XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits

Description

The flag bits have the following meanings:

Flag Descriptions

• PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT — plane detection is supported
• PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT — polygon buffers for holes in planes can be generated
• PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT — plane detection supports ceiling semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT — plane detection supports floor semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT — plane detection supports wall semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT — plane detection supports platform semantic classification (for example table tops)
• PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT — plane detection supports plane orientation classification. If not supported planes are always classified as ARBITRARY.

See Also:

• Constant Field Values

XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT

public static final int XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT

XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits

Description

The flag bits have the following meanings:

Flag Descriptions

• PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT — plane detection is supported
• PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT — polygon buffers for holes in planes can be generated
• PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT — plane detection supports ceiling semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT — plane detection supports floor semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT — plane detection supports wall semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT — plane detection supports platform semantic classification (for example table tops)
• PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT — plane detection supports plane orientation classification. If not supported planes are always classified as ARBITRARY.

See Also:

• Constant Field Values

XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT

public static final int XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT

XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits

Description

The flag bits have the following meanings:

Flag Descriptions

• PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT — plane detection is supported
• PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT — polygon buffers for holes in planes can be generated
• PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT — plane detection supports ceiling semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT — plane detection supports floor semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT — plane detection supports wall semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT — plane detection supports platform semantic classification (for example table tops)
• PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT — plane detection supports plane orientation classification. If not supported planes are always classified as ARBITRARY.

See Also:

• Constant Field Values

XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT

public static final int XR_PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT

XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits

Description

The flag bits have the following meanings:

Flag Descriptions

• PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT — plane detection is supported
• PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT — polygon buffers for holes in planes can be generated
• PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT — plane detection supports ceiling semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT — plane detection supports floor semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT — plane detection supports wall semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT — plane detection supports platform semantic classification (for example table tops)
• PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT — plane detection supports plane orientation classification. If not supported planes are always classified as ARBITRARY.

See Also:

• Constant Field Values

XR_PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT

public static final int XR_PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT

XrPlaneDetectionCapabilityFlagBitsEXT - Feature Flag Bits

Description

The flag bits have the following meanings:

Flag Descriptions

• PLANE_DETECTION_CAPABILITY_PLANE_DETECTION_BIT_EXT — plane detection is supported
• PLANE_DETECTION_CAPABILITY_PLANE_HOLES_BIT_EXT — polygon buffers for holes in planes can be generated
• PLANE_DETECTION_CAPABILITY_SEMANTIC_CEILING_BIT_EXT — plane detection supports ceiling semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_FLOOR_BIT_EXT — plane detection supports floor semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_WALL_BIT_EXT — plane detection supports wall semantic classification
• PLANE_DETECTION_CAPABILITY_SEMANTIC_PLATFORM_BIT_EXT — plane detection supports platform semantic classification (for example table tops)
• PLANE_DETECTION_CAPABILITY_ORIENTATION_BIT_EXT — plane detection supports plane orientation classification. If not supported planes are always classified as ARBITRARY.

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_ENABLE_CONTOUR_BIT_EXT

public static final int XR_PLANE_DETECTOR_ENABLE_CONTOUR_BIT_EXT

XrPlaneDetectorFlagBitsEXT - Plane Detector flags

Description

The flag bits have the following meanings:

Flag Descriptions

• PLANE_DETECTOR_ENABLE_CONTOUR_BIT_EXT — populate the plane contour information

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_ORIENTATION_HORIZONTAL_UPWARD_EXT

public static final int XR_PLANE_DETECTOR_ORIENTATION_HORIZONTAL_UPWARD_EXT

XrPlaneDetectorOrientationEXT - Orientation of the detected plane (upward, downward…)

Description

The enums have the following meanings:

Enum	Description
PLANE_DETECTOR_ORIENTATION_HORIZONTAL_UPWARD_EXT	The detected plane is horizontal and faces upward (e.g. floor).
PLANE_DETECTOR_ORIENTATION_HORIZONTAL_DOWNWARD_EXT	The detected plane is horizontal and faces downward (e.g. ceiling).
PLANE_DETECTOR_ORIENTATION_VERTICAL_EXT	The detected plane is vertical (e.g. wall).
PLANE_DETECTOR_ORIENTATION_ARBITRARY_EXT	The detected plane has an arbitrary, non-vertical and non-horizontal orientation.

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_ORIENTATION_HORIZONTAL_DOWNWARD_EXT

public static final int XR_PLANE_DETECTOR_ORIENTATION_HORIZONTAL_DOWNWARD_EXT

XrPlaneDetectorOrientationEXT - Orientation of the detected plane (upward, downward…)

Description

The enums have the following meanings:

Enum	Description
PLANE_DETECTOR_ORIENTATION_HORIZONTAL_UPWARD_EXT	The detected plane is horizontal and faces upward (e.g. floor).
PLANE_DETECTOR_ORIENTATION_HORIZONTAL_DOWNWARD_EXT	The detected plane is horizontal and faces downward (e.g. ceiling).
PLANE_DETECTOR_ORIENTATION_VERTICAL_EXT	The detected plane is vertical (e.g. wall).
PLANE_DETECTOR_ORIENTATION_ARBITRARY_EXT	The detected plane has an arbitrary, non-vertical and non-horizontal orientation.

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_ORIENTATION_VERTICAL_EXT

public static final int XR_PLANE_DETECTOR_ORIENTATION_VERTICAL_EXT

XrPlaneDetectorOrientationEXT - Orientation of the detected plane (upward, downward…)

Description

The enums have the following meanings:

Enum	Description
PLANE_DETECTOR_ORIENTATION_HORIZONTAL_UPWARD_EXT	The detected plane is horizontal and faces upward (e.g. floor).
PLANE_DETECTOR_ORIENTATION_HORIZONTAL_DOWNWARD_EXT	The detected plane is horizontal and faces downward (e.g. ceiling).
PLANE_DETECTOR_ORIENTATION_VERTICAL_EXT	The detected plane is vertical (e.g. wall).
PLANE_DETECTOR_ORIENTATION_ARBITRARY_EXT	The detected plane has an arbitrary, non-vertical and non-horizontal orientation.

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_ORIENTATION_ARBITRARY_EXT

public static final int XR_PLANE_DETECTOR_ORIENTATION_ARBITRARY_EXT

XrPlaneDetectorOrientationEXT - Orientation of the detected plane (upward, downward…)

Description

The enums have the following meanings:

Enum	Description
PLANE_DETECTOR_ORIENTATION_HORIZONTAL_UPWARD_EXT	The detected plane is horizontal and faces upward (e.g. floor).
PLANE_DETECTOR_ORIENTATION_HORIZONTAL_DOWNWARD_EXT	The detected plane is horizontal and faces downward (e.g. ceiling).
PLANE_DETECTOR_ORIENTATION_VERTICAL_EXT	The detected plane is vertical (e.g. wall).
PLANE_DETECTOR_ORIENTATION_ARBITRARY_EXT	The detected plane has an arbitrary, non-vertical and non-horizontal orientation.

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_SEMANTIC_TYPE_UNDEFINED_EXT

public static final int XR_PLANE_DETECTOR_SEMANTIC_TYPE_UNDEFINED_EXT

XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)

Description

The enums have the following meanings:

Enum	Description
PLANE_DETECTOR_SEMANTIC_TYPE_UNDEFINED_EXT	The runtime was unable to classify this plane.
PLANE_DETECTOR_SEMANTIC_TYPE_CEILING_EXT	The detected plane is a ceiling.
PLANE_DETECTOR_SEMANTIC_TYPE_FLOOR_EXT	The detected plane is a floor.
PLANE_DETECTOR_SEMANTIC_TYPE_WALL_EXT	The detected plane is a wall.
PLANE_DETECTOR_SEMANTIC_TYPE_PLATFORM_EXT	The detected plane is a platform, like a table.

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_SEMANTIC_TYPE_CEILING_EXT

public static final int XR_PLANE_DETECTOR_SEMANTIC_TYPE_CEILING_EXT

XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)

Description

The enums have the following meanings:

Enum	Description
PLANE_DETECTOR_SEMANTIC_TYPE_UNDEFINED_EXT	The runtime was unable to classify this plane.
PLANE_DETECTOR_SEMANTIC_TYPE_CEILING_EXT	The detected plane is a ceiling.
PLANE_DETECTOR_SEMANTIC_TYPE_FLOOR_EXT	The detected plane is a floor.
PLANE_DETECTOR_SEMANTIC_TYPE_WALL_EXT	The detected plane is a wall.
PLANE_DETECTOR_SEMANTIC_TYPE_PLATFORM_EXT	The detected plane is a platform, like a table.

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_SEMANTIC_TYPE_FLOOR_EXT

public static final int XR_PLANE_DETECTOR_SEMANTIC_TYPE_FLOOR_EXT

XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)

Description

The enums have the following meanings:

Enum	Description
PLANE_DETECTOR_SEMANTIC_TYPE_UNDEFINED_EXT	The runtime was unable to classify this plane.
PLANE_DETECTOR_SEMANTIC_TYPE_CEILING_EXT	The detected plane is a ceiling.
PLANE_DETECTOR_SEMANTIC_TYPE_FLOOR_EXT	The detected plane is a floor.
PLANE_DETECTOR_SEMANTIC_TYPE_WALL_EXT	The detected plane is a wall.
PLANE_DETECTOR_SEMANTIC_TYPE_PLATFORM_EXT	The detected plane is a platform, like a table.

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_SEMANTIC_TYPE_WALL_EXT

public static final int XR_PLANE_DETECTOR_SEMANTIC_TYPE_WALL_EXT

XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)

Description

The enums have the following meanings:

Enum	Description
PLANE_DETECTOR_SEMANTIC_TYPE_UNDEFINED_EXT	The runtime was unable to classify this plane.
PLANE_DETECTOR_SEMANTIC_TYPE_CEILING_EXT	The detected plane is a ceiling.
PLANE_DETECTOR_SEMANTIC_TYPE_FLOOR_EXT	The detected plane is a floor.
PLANE_DETECTOR_SEMANTIC_TYPE_WALL_EXT	The detected plane is a wall.
PLANE_DETECTOR_SEMANTIC_TYPE_PLATFORM_EXT	The detected plane is a platform, like a table.

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTOR_SEMANTIC_TYPE_PLATFORM_EXT

public static final int XR_PLANE_DETECTOR_SEMANTIC_TYPE_PLATFORM_EXT

XrPlaneDetectorSemanticTypeEXT - Type of the detected plane (upward, downward…)

Description

The enums have the following meanings:

Enum	Description
PLANE_DETECTOR_SEMANTIC_TYPE_UNDEFINED_EXT	The runtime was unable to classify this plane.
PLANE_DETECTOR_SEMANTIC_TYPE_CEILING_EXT	The detected plane is a ceiling.
PLANE_DETECTOR_SEMANTIC_TYPE_FLOOR_EXT	The detected plane is a floor.
PLANE_DETECTOR_SEMANTIC_TYPE_WALL_EXT	The detected plane is a wall.
PLANE_DETECTOR_SEMANTIC_TYPE_PLATFORM_EXT	The detected plane is a platform, like a table.

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTION_STATE_NONE_EXT

public static final int XR_PLANE_DETECTION_STATE_NONE_EXT

XrPlaneDetectionStateEXT - Plane Detection State

Enumerant Descriptions

• PLANE_DETECTION_STATE_NONE_EXT - The plane detector is not actively looking for planes; call BeginPlaneDetectionEXT to start detection.
• PLANE_DETECTION_STATE_PENDING_EXT - This plane detector is currently looking for planes but not yet ready with results; call GetPlaneDetectionsEXT again, or call BeginPlaneDetectionEXT to restart with new filter parameters.
• PLANE_DETECTION_STATE_DONE_EXT - This plane detector has finished and results may now be retrieved. The results are valid until BeginPlaneDetectionEXT or DestroyPlaneDetectorEXT are called.
• PLANE_DETECTION_STATE_ERROR_EXT - An error occurred. The query may be tried again.
• PLANE_DETECTION_STATE_FATAL_EXT - An error occurred. The query must not be tried again.

See Also

GetPlaneDetectionStateEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTION_STATE_PENDING_EXT

public static final int XR_PLANE_DETECTION_STATE_PENDING_EXT

XrPlaneDetectionStateEXT - Plane Detection State

Enumerant Descriptions

• PLANE_DETECTION_STATE_NONE_EXT - The plane detector is not actively looking for planes; call BeginPlaneDetectionEXT to start detection.
• PLANE_DETECTION_STATE_PENDING_EXT - This plane detector is currently looking for planes but not yet ready with results; call GetPlaneDetectionsEXT again, or call BeginPlaneDetectionEXT to restart with new filter parameters.
• PLANE_DETECTION_STATE_DONE_EXT - This plane detector has finished and results may now be retrieved. The results are valid until BeginPlaneDetectionEXT or DestroyPlaneDetectorEXT are called.
• PLANE_DETECTION_STATE_ERROR_EXT - An error occurred. The query may be tried again.
• PLANE_DETECTION_STATE_FATAL_EXT - An error occurred. The query must not be tried again.

See Also

GetPlaneDetectionStateEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTION_STATE_DONE_EXT

public static final int XR_PLANE_DETECTION_STATE_DONE_EXT

XrPlaneDetectionStateEXT - Plane Detection State

Enumerant Descriptions

• PLANE_DETECTION_STATE_NONE_EXT - The plane detector is not actively looking for planes; call BeginPlaneDetectionEXT to start detection.
• PLANE_DETECTION_STATE_PENDING_EXT - This plane detector is currently looking for planes but not yet ready with results; call GetPlaneDetectionsEXT again, or call BeginPlaneDetectionEXT to restart with new filter parameters.
• PLANE_DETECTION_STATE_DONE_EXT - This plane detector has finished and results may now be retrieved. The results are valid until BeginPlaneDetectionEXT or DestroyPlaneDetectorEXT are called.
• PLANE_DETECTION_STATE_ERROR_EXT - An error occurred. The query may be tried again.
• PLANE_DETECTION_STATE_FATAL_EXT - An error occurred. The query must not be tried again.

See Also

GetPlaneDetectionStateEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTION_STATE_ERROR_EXT

public static final int XR_PLANE_DETECTION_STATE_ERROR_EXT

XrPlaneDetectionStateEXT - Plane Detection State

Enumerant Descriptions

• PLANE_DETECTION_STATE_NONE_EXT - The plane detector is not actively looking for planes; call BeginPlaneDetectionEXT to start detection.
• PLANE_DETECTION_STATE_PENDING_EXT - This plane detector is currently looking for planes but not yet ready with results; call GetPlaneDetectionsEXT again, or call BeginPlaneDetectionEXT to restart with new filter parameters.
• PLANE_DETECTION_STATE_DONE_EXT - This plane detector has finished and results may now be retrieved. The results are valid until BeginPlaneDetectionEXT or DestroyPlaneDetectorEXT are called.
• PLANE_DETECTION_STATE_ERROR_EXT - An error occurred. The query may be tried again.
• PLANE_DETECTION_STATE_FATAL_EXT - An error occurred. The query must not be tried again.

See Also

GetPlaneDetectionStateEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

XR_PLANE_DETECTION_STATE_FATAL_EXT

public static final int XR_PLANE_DETECTION_STATE_FATAL_EXT

XrPlaneDetectionStateEXT - Plane Detection State

Enumerant Descriptions

• PLANE_DETECTION_STATE_NONE_EXT - The plane detector is not actively looking for planes; call BeginPlaneDetectionEXT to start detection.
• PLANE_DETECTION_STATE_PENDING_EXT - This plane detector is currently looking for planes but not yet ready with results; call GetPlaneDetectionsEXT again, or call BeginPlaneDetectionEXT to restart with new filter parameters.
• PLANE_DETECTION_STATE_DONE_EXT - This plane detector has finished and results may now be retrieved. The results are valid until BeginPlaneDetectionEXT or DestroyPlaneDetectorEXT are called.
• PLANE_DETECTION_STATE_ERROR_EXT - An error occurred. The query may be tried again.
• PLANE_DETECTION_STATE_FATAL_EXT - An error occurred. The query must not be tried again.

See Also

GetPlaneDetectionStateEXT, GetPlaneDetectionsEXT

See Also:

• Constant Field Values

Method Details

nxrCreatePlaneDetectorEXT

public static int nxrCreatePlaneDetectorEXT(XrSession session,
 long createInfo,
 long planeDetector)

Unsafe version of: CreatePlaneDetectorEXT

xrCreatePlaneDetectorEXT

public static int xrCreatePlaneDetectorEXT(XrSession session,
 XrPlaneDetectorCreateInfoEXT createInfo,
 org.lwjgl.PointerBuffer planeDetector)

Create a plane detection handle.

C Specification

The CreatePlaneDetectorEXT function is defined as:

 XrResult xrCreatePlaneDetectorEXT(
     XrSession                                   session,
     const XrPlaneDetectorCreateInfoEXT*         createInfo,
     XrPlaneDetectorEXT*                         planeDetector);

Description

An application creates an XrPlaneDetectorEXT handle using CreatePlaneDetectorEXT function.

If the system does not support plane detection, the runtime must return ERROR_FEATURE_UNSUPPORTED from CreatePlaneDetectorEXT.

Valid Usage (Implicit)

• The XR_EXT_plane_detection extension must be enabled prior to calling CreatePlaneDetectorEXT
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrPlaneDetectorCreateInfoEXT structure
• planeDetector must be a pointer to an XrPlaneDetectorEXT 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_PLANE_DETECTION_PERMISSION_DENIED_EXT
• ERROR_FEATURE_UNSUPPORTED

See Also

XrPlaneDetectorCreateInfoEXT, BeginPlaneDetectionEXT, DestroyPlaneDetectorEXT

Parameters:

session - an XrSession in which the plane detection will be active.

createInfo - the XrPlaneDetectorCreateInfoEXT used to specify the plane detection.

planeDetector - the returned XrPlaneDetectorEXT handle.

xrDestroyPlaneDetectorEXT

public static int xrDestroyPlaneDetectorEXT(XrPlaneDetectorEXT planeDetector)

Destroy a plane detection handle.

C Specification

The DestroyPlaneDetectorEXT function is defined as:

 XrResult xrDestroyPlaneDetectorEXT(
     XrPlaneDetectorEXT                          planeDetector);

Description

DestroyPlaneDetectorEXT function releases the planeDetector and the underlying resources when finished with plane detection experiences.

Valid Usage (Implicit)

• The XR_EXT_plane_detection extension must be enabled prior to calling DestroyPlaneDetectorEXT
• planeDetector must be a valid XrPlaneDetectorEXT handle

Thread Safety

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

See Also

CreatePlaneDetectorEXT

Parameters:

planeDetector - an XrPlaneDetectorEXT previously created by CreatePlaneDetectorEXT.

nxrBeginPlaneDetectionEXT

public static int nxrBeginPlaneDetectionEXT(XrPlaneDetectorEXT planeDetector,
 long beginInfo)

Unsafe version of: BeginPlaneDetectionEXT

xrBeginPlaneDetectionEXT

public static int xrBeginPlaneDetectionEXT(XrPlaneDetectorEXT planeDetector,
 XrPlaneDetectorBeginInfoEXT beginInfo)

Detect planes.

C Specification

The BeginPlaneDetectionEXT function is defined as:

 XrResult xrBeginPlaneDetectionEXT(
     XrPlaneDetectorEXT                          planeDetector,
     const XrPlaneDetectorBeginInfoEXT*          beginInfo);

Description

The BeginPlaneDetectionEXT function begins the detection of planes in the scene. Detecting planes in a scene is an asynchronous operation. GetPlaneDetectionStateEXT can be used to determine if the query has finished. Once it has finished the results may be retrieved via GetPlaneDetectionsEXT. If a detection has already been started on a plane detector handle, calling BeginPlaneDetectionEXT again on the same handle will cancel the operation in progress and start a new detection with the new filter parameters.

The bounding volume is resolved and fixed relative to LOCAL space at the time of the call to BeginPlaneDetectionEXT using XrPlaneDetectorBeginInfoEXT::baseSpace, XrPlaneDetectorBeginInfoEXT::time, XrPlaneDetectorBeginInfoEXT::boundingBoxPose and XrPlaneDetectorBeginInfoEXT::boundingBoxExtent. The runtime must resolve the location defined by XrPlaneDetectorBeginInfoEXT::baseSpace at the time of the call. The XrPlaneDetectorBeginInfoEXT::boundingBoxPose is the pose of the center of the box defined by XrPlaneDetectorBeginInfoEXT::boundingBoxExtent.

The runtime must return ERROR_SPACE_NOT_LOCATABLE_EXT if the XrPlaneDetectorBeginInfoEXT::baseSpace is not locatable at the time of the call.

Valid Usage (Implicit)

• The XR_EXT_plane_detection extension must be enabled prior to calling BeginPlaneDetectionEXT
• planeDetector must be a valid XrPlaneDetectorEXT handle
• beginInfo must be a pointer to a valid XrPlaneDetectorBeginInfoEXT 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_TIME_INVALID
• ERROR_SPACE_NOT_LOCATABLE_EXT
• ERROR_POSE_INVALID

See Also

XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorGetInfoEXT, GetPlaneDetectionsEXT

Parameters:

planeDetector - an XrPlaneDetectorEXT previously created by CreatePlaneDetectorEXT.

beginInfo - a pointer to XrPlaneDetectorBeginInfoEXT containing plane detection parameters.

nxrGetPlaneDetectionStateEXT

public static int nxrGetPlaneDetectionStateEXT(XrPlaneDetectorEXT planeDetector,
 long state)

Unsafe version of: GetPlaneDetectionStateEXT

xrGetPlaneDetectionStateEXT

public static int xrGetPlaneDetectionStateEXT(XrPlaneDetectorEXT planeDetector,
 IntBuffer state)

Get the state of the plane detection pass.

C Specification

The GetPlaneDetectionStateEXT function is defined as:

 XrResult xrGetPlaneDetectionStateEXT(
     XrPlaneDetectorEXT                          planeDetector,
     XrPlaneDetectionStateEXT*                   state);

Description

The GetPlaneDetectionStateEXT function retrieves the state of the plane query and must be called before calling GetPlaneDetectionsEXT.

If the plane detection has not yet finished state must be PLANE_DETECTION_STATE_PENDING_EXT. If the plane detection has finished state must be PLANE_DETECTION_STATE_DONE_EXT. If no plane detection was previously started PLANE_DETECTION_STATE_NONE_EXT must be returned. For all three states the function must return SUCCESS.

When a query error occurs the function must return SUCCESS and the appropriate error state value must be set.

Valid Usage (Implicit)

• The XR_EXT_plane_detection extension must be enabled prior to calling GetPlaneDetectionStateEXT
• planeDetector must be a valid XrPlaneDetectorEXT handle
• state must be a pointer to an XrPlaneDetectionStateEXT 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

See Also

BeginPlaneDetectionEXT

Parameters:

planeDetector - an XrPlaneDetectorEXT previously created by CreatePlaneDetectorEXT.

state - a pointer to XrPlaneDetectionStateEXT.

nxrGetPlaneDetectionsEXT

public static int nxrGetPlaneDetectionsEXT(XrPlaneDetectorEXT planeDetector,
 long info,
 long locations)

Unsafe version of: GetPlaneDetectionsEXT

xrGetPlaneDetectionsEXT

public static int xrGetPlaneDetectionsEXT(XrPlaneDetectorEXT planeDetector,
 XrPlaneDetectorGetInfoEXT info,
 XrPlaneDetectorLocationsEXT locations)

Get the detected planes.

C Specification

The GetPlaneDetectionsEXT function is defined as:

 XrResult xrGetPlaneDetectionsEXT(
     XrPlaneDetectorEXT                          planeDetector,
     const XrPlaneDetectorGetInfoEXT*            info,
     XrPlaneDetectorLocationsEXT*                locations);

Description

GetPlaneDetectionsEXT must return ERROR_CALL_ORDER_INVALID if the detector state reported by GetPlaneDetectionStateEXT is not PLANE_DETECTION_STATE_DONE_EXT for the current query started by BeginPlaneDetectionEXT.

If the XrPlaneDetectorGetInfoEXT::baseSpace is not locatable ERROR_SPACE_NOT_LOCATABLE_EXT must be returned.

Once BeginPlaneDetectionEXT is called again, the previous results for that handle are no longer available. The application should cache them before calling BeginPlaneDetectionEXT again if it needs access to that data while waiting for updated detection results.

Upon the completion of a detection cycle (BeginPlaneDetectionEXT, GetPlaneDetectionStateEXT to GetPlaneDetectionsEXT) the runtime must keep a snapshot of the plane data and no data may be modified. Calling GetPlaneDetectionsEXT multiple times with the same baseSpace and time must return the same plane pose data.

The current snapshot, if any, must be discarded upon calling BeginPlaneDetectionEXT.

If the XrEventDataReferenceSpaceChangePending is queued and the changeTime elapsed while the application is holding cached data the application may use the event data to adjusted poses accordingly.

Valid Usage (Implicit)

• The XR_EXT_plane_detection extension must be enabled prior to calling GetPlaneDetectionsEXT
• planeDetector must be a valid XrPlaneDetectorEXT handle
• info must be a pointer to a valid XrPlaneDetectorGetInfoEXT structure
• locations must be a pointer to an XrPlaneDetectorLocationsEXT 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_TIME_INVALID
• ERROR_SPACE_NOT_LOCATABLE_EXT
• ERROR_CALL_ORDER_INVALID

See Also

XrPlaneDetectorGetInfoEXT, XrPlaneDetectorLocationsEXT, BeginPlaneDetectionEXT

Parameters:

planeDetector - an XrPlaneDetectorEXT previously created by CreatePlaneDetectorEXT.

info - a pointer to XrPlaneDetectorGetInfoEXT.

locations - a pointer to XrPlaneDetectorLocationsEXT receiving the returned plane locations.

nxrGetPlanePolygonBufferEXT

public static int nxrGetPlanePolygonBufferEXT(XrPlaneDetectorEXT planeDetector,
 long planeId,
 int polygonBufferIndex,
 long polygonBuffer)

Unsafe version of: GetPlanePolygonBufferEXT

xrGetPlanePolygonBufferEXT

public static int xrGetPlanePolygonBufferEXT(XrPlaneDetectorEXT planeDetector,
 long planeId,
 int polygonBufferIndex,
 XrPlaneDetectorPolygonBufferEXT polygonBuffer)

Gets the plane.

C Specification

The GetPlanePolygonBufferEXT function is defined as:

 XrResult xrGetPlanePolygonBufferEXT(
     XrPlaneDetectorEXT                          planeDetector,
     uint64_t                                    planeId,
     uint32_t                                    polygonBufferIndex,
     XrPlaneDetectorPolygonBufferEXT*            polygonBuffer);

Description

The GetPlanePolygonBufferEXT function retrieves the plane’s polygon buffer for the given planeId and polygonBufferIndex. Calling GetPlanePolygonBufferEXT with polygonBufferIndex equal to 0 must return the outside contour, if available. Calls with non-zero indices less than XrPlaneDetectorLocationEXT::polygonBufferCount must return polygons corresponding to holes in the plane. This feature may not be supported by all runtimes, check the XrSystemPlaneDetectionPropertiesEXT::supportedFeatures for support.

Outside contour polygon vertices must be ordered in counter clockwise order. Vertices of holes must be ordered in clockwise order. The right-hand rule is used to determine the direction of the normal of this plane. The polygon contour data is relative to the pose of the plane and coplanar with it.

This function only retrieves polygons, which means that it needs to be converted to a regular mesh to be rendered.

Valid Usage (Implicit)

• The XR_EXT_plane_detection extension must be enabled prior to calling GetPlanePolygonBufferEXT
• planeDetector must be a valid XrPlaneDetectorEXT handle
• polygonBuffer must be a pointer to an XrPlaneDetectorPolygonBufferEXT 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

XrPlaneDetectorPolygonBufferEXT, GetPlaneDetectionsEXT

Parameters:

planeDetector - an XrPlaneDetectorEXT previously created by CreatePlaneDetectorEXT.

planeId - the XrPlaneDetectorLocationEXT::planeId.

polygonBufferIndex - the index of the polygon contour buffer to retrieve. This must be a number from 0 to XrPlaneDetectorLocationEXT:polygonBufferCount -1. Index 0 retrieves the outside contour, larger indexes retrieve holes in the plane.

polygonBuffer - a pointer to XrPlaneDetectorPolygonBufferEXT receiving the returned plane polygon buffer.