org.lwjgl.openxr.VARJOMarkerTracking Maven / Gradle / Ivy
Show all versions of lwjgl-openxr Show documentation
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.openxr;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.JNI.*;
import static org.lwjgl.system.MemoryUtil.*;
/**
* The XR_VARJO_marker_tracking extension.
*
* Varjo Markers are physical markers tracked by the video cameras of the HMD. Different types of markers can be used for different purposes. As an example, Varjo Markers can be used as cheap replacements for electronic trackers. The cost per printed tracker is significantly lower and the markers require no power to function.
*
* This extension provides the tracking interface to a set of marker types and sizes. Markers can be printed out from the PDF documents and instructions freely available at https://developer.varjo.com/docs/get-started/varjo-markers#printing-varjo-markers. Note that the printed marker must have the exact physical size for its ID.
*
* Object markers are used to track static or dynamic objects in the user environment. You may use object markers in both XR and VR applications. Each marker has a unique ID, and you must not use the same physical marker more than once in any given environment. For added precision, an application may use multiple markers to track a single object. For example, you could track a monitor by placing a marker in each corner.
*
* There is a set of marker IDs recognized by runtime and if the application uses ID which is not in the set then runtime must return {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO}.
*/
public class VARJOMarkerTracking {
/** The extension specification version. */
public static final int XR_VARJO_marker_tracking_SPEC_VERSION = 1;
/** The extension name. */
public static final String XR_VARJO_MARKER_TRACKING_EXTENSION_NAME = "XR_VARJO_marker_tracking";
/**
* Extends {@code XrStructureType}.
*
* Enum values:
*
*
* - {@link #XR_TYPE_SYSTEM_MARKER_TRACKING_PROPERTIES_VARJO TYPE_SYSTEM_MARKER_TRACKING_PROPERTIES_VARJO}
* - {@link #XR_TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO}
* - {@link #XR_TYPE_MARKER_SPACE_CREATE_INFO_VARJO TYPE_MARKER_SPACE_CREATE_INFO_VARJO}
*
*/
public static final int
XR_TYPE_SYSTEM_MARKER_TRACKING_PROPERTIES_VARJO = 1000124000,
XR_TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO = 1000124001,
XR_TYPE_MARKER_SPACE_CREATE_INFO_VARJO = 1000124002;
/**
* Extends {@code XrResult}.
*
* Enum values:
*
*
* - {@link #XR_ERROR_MARKER_NOT_TRACKED_VARJO ERROR_MARKER_NOT_TRACKED_VARJO}
* - {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO}
*
*/
public static final int
XR_ERROR_MARKER_NOT_TRACKED_VARJO = -1000124000,
XR_ERROR_MARKER_ID_INVALID_VARJO = -1000124001;
protected VARJOMarkerTracking() {
throw new UnsupportedOperationException();
}
// --- [ xrSetMarkerTrackingVARJO ] ---
/**
* Enables marker tracking.
*
* C Specification
*
* The {@link #xrSetMarkerTrackingVARJO SetMarkerTrackingVARJO} function is defined as:
*
*
* XrResult xrSetMarkerTrackingVARJO(
* XrSession session,
* XrBool32 enabled);
*
* Description
*
* The {@link #xrSetMarkerTrackingVARJO SetMarkerTrackingVARJO} function enables or disables marker tracking functionality. As soon as feature is become disabled all trackable markers become inactive and corresponding events will be generated. An application may call any of the functions in this extension regardless if the marker tracking functionality is enabled or disabled.
*
* Valid Usage (Implicit)
*
*
* - The {@link VARJOMarkerTracking XR_VARJO_marker_tracking} extension must be enabled prior to calling {@link #xrSetMarkerTrackingVARJO SetMarkerTrackingVARJO}
* - {@code session} must be a valid {@code XrSession} handle
*
*
* Return Codes
*
*
* - On success, this command returns
*
* - {@link XR10#XR_SUCCESS SUCCESS}
* - {@link XR10#XR_SESSION_LOSS_PENDING SESSION_LOSS_PENDING}
*
- On failure, this command returns
*
* - {@link XR10#XR_ERROR_FUNCTION_UNSUPPORTED ERROR_FUNCTION_UNSUPPORTED}
* - {@link XR10#XR_ERROR_RUNTIME_FAILURE ERROR_RUNTIME_FAILURE}
* - {@link XR10#XR_ERROR_HANDLE_INVALID ERROR_HANDLE_INVALID}
* - {@link XR10#XR_ERROR_INSTANCE_LOST ERROR_INSTANCE_LOST}
* - {@link XR10#XR_ERROR_SESSION_LOST ERROR_SESSION_LOST}
* - {@link XR10#XR_ERROR_FEATURE_UNSUPPORTED ERROR_FEATURE_UNSUPPORTED}
*
*
* @param session an {@code XrSession} handle previously created with {@link XR10#xrCreateSession CreateSession}.
* @param enabled the flag to enable or disable marker tracking.
*/
@NativeType("XrResult")
public static int xrSetMarkerTrackingVARJO(XrSession session, @NativeType("XrBool32") boolean enabled) {
long __functionAddress = session.getCapabilities().xrSetMarkerTrackingVARJO;
if (CHECKS) {
check(__functionAddress);
}
return callPI(session.address(), enabled ? 1 : 0, __functionAddress);
}
// --- [ xrSetMarkerTrackingTimeoutVARJO ] ---
/**
* Sets marker lifetime duration.
*
* C Specification
*
* The {@link #xrSetMarkerTrackingTimeoutVARJO SetMarkerTrackingTimeoutVARJO} function is defined as:
*
*
* XrResult xrSetMarkerTrackingTimeoutVARJO(
* XrSession session,
* uint64_t markerId,
* XrDuration timeout);
*
* Description
*
* The {@link #xrSetMarkerTrackingTimeoutVARJO SetMarkerTrackingTimeoutVARJO} function sets a desired lifetime duration for a specified marker. The default value is {@link XR10#XR_NO_DURATION NO_DURATION}. Negative value will be clamped to {@link XR10#XR_NO_DURATION NO_DURATION}. It defines the time period during which the runtime must keep returning poses of previously tracked markers. The tracking may be lost if the marker went outside of the trackable field of view. In this case the runtime still will try to predict marker’s pose for the timeout period. The runtime must return {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO} if the supplied {@code markerId} is invalid.
*
* Valid Usage (Implicit)
*
*
* - The {@link VARJOMarkerTracking XR_VARJO_marker_tracking} extension must be enabled prior to calling {@link #xrSetMarkerTrackingTimeoutVARJO SetMarkerTrackingTimeoutVARJO}
* - {@code session} must be a valid {@code XrSession} handle
*
*
* Return Codes
*
*
* - On success, this command returns
*
* - {@link XR10#XR_SUCCESS SUCCESS}
* - {@link XR10#XR_SESSION_LOSS_PENDING SESSION_LOSS_PENDING}
*
- On failure, this command returns
*
* - {@link XR10#XR_ERROR_FUNCTION_UNSUPPORTED ERROR_FUNCTION_UNSUPPORTED}
* - {@link XR10#XR_ERROR_RUNTIME_FAILURE ERROR_RUNTIME_FAILURE}
* - {@link XR10#XR_ERROR_HANDLE_INVALID ERROR_HANDLE_INVALID}
* - {@link XR10#XR_ERROR_INSTANCE_LOST ERROR_INSTANCE_LOST}
* - {@link XR10#XR_ERROR_SESSION_LOST ERROR_SESSION_LOST}
* - {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO}
* - {@link XR10#XR_ERROR_FEATURE_UNSUPPORTED ERROR_FEATURE_UNSUPPORTED}
*
*
* @param session an {@code XrSession} handle previously created with {@link XR10#xrCreateSession CreateSession}.
* @param markerId the unique identifier of the marker for which the timeout will be updated.
* @param timeout the desired lifetime duration for a specified marker.
*/
@NativeType("XrResult")
public static int xrSetMarkerTrackingTimeoutVARJO(XrSession session, @NativeType("uint64_t") long markerId, @NativeType("XrDuration") long timeout) {
long __functionAddress = session.getCapabilities().xrSetMarkerTrackingTimeoutVARJO;
if (CHECKS) {
check(__functionAddress);
}
return callPJJI(session.address(), markerId, timeout, __functionAddress);
}
// --- [ xrSetMarkerTrackingPredictionVARJO ] ---
/**
* Sets marker tracking with prediction.
*
* C Specification
*
* The {@link #xrSetMarkerTrackingPredictionVARJO SetMarkerTrackingPredictionVARJO} function is defined as:
*
*
* XrResult xrSetMarkerTrackingPredictionVARJO(
* XrSession session,
* uint64_t markerId,
* XrBool32 enable);
*
* Description
*
* The {@link #xrSetMarkerTrackingPredictionVARJO SetMarkerTrackingPredictionVARJO} function enables or disables the prediction feature for a specified marker. By default, markers are created with disabled prediction. This works well for markers that are supposed to be stationary. The prediction can be used to improve tracking of movable markers. The runtime must return {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO} if the supplied {@code markerId} is invalid.
*
* Valid Usage (Implicit)
*
*
* - The {@link VARJOMarkerTracking XR_VARJO_marker_tracking} extension must be enabled prior to calling {@link #xrSetMarkerTrackingPredictionVARJO SetMarkerTrackingPredictionVARJO}
* - {@code session} must be a valid {@code XrSession} handle
*
*
* Return Codes
*
*
* - On success, this command returns
*
* - {@link XR10#XR_SUCCESS SUCCESS}
* - {@link XR10#XR_SESSION_LOSS_PENDING SESSION_LOSS_PENDING}
*
- On failure, this command returns
*
* - {@link XR10#XR_ERROR_FUNCTION_UNSUPPORTED ERROR_FUNCTION_UNSUPPORTED}
* - {@link XR10#XR_ERROR_RUNTIME_FAILURE ERROR_RUNTIME_FAILURE}
* - {@link XR10#XR_ERROR_HANDLE_INVALID ERROR_HANDLE_INVALID}
* - {@link XR10#XR_ERROR_INSTANCE_LOST ERROR_INSTANCE_LOST}
* - {@link XR10#XR_ERROR_SESSION_LOST ERROR_SESSION_LOST}
* - {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO}
* - {@link XR10#XR_ERROR_FEATURE_UNSUPPORTED ERROR_FEATURE_UNSUPPORTED}
*
*
* @param session an {@code XrSession} handle previously created with {@link XR10#xrCreateSession CreateSession}.
* @param markerId the unique identifier of the marker which should be tracked with prediction.
* @param enable whether to enable the prediction feature.
*/
@NativeType("XrResult")
public static int xrSetMarkerTrackingPredictionVARJO(XrSession session, @NativeType("uint64_t") long markerId, @NativeType("XrBool32") boolean enable) {
long __functionAddress = session.getCapabilities().xrSetMarkerTrackingPredictionVARJO;
if (CHECKS) {
check(__functionAddress);
}
return callPJI(session.address(), markerId, enable ? 1 : 0, __functionAddress);
}
// --- [ xrGetMarkerSizeVARJO ] ---
/** Unsafe version of: {@link #xrGetMarkerSizeVARJO GetMarkerSizeVARJO} */
public static int nxrGetMarkerSizeVARJO(XrSession session, long markerId, long size) {
long __functionAddress = session.getCapabilities().xrGetMarkerSizeVARJO;
if (CHECKS) {
check(__functionAddress);
}
return callPJPI(session.address(), markerId, size, __functionAddress);
}
/**
* Gets physical size of marker.
*
* C Specification
*
* The {@link #xrGetMarkerSizeVARJO GetMarkerSizeVARJO} function is defined as:
*
*
* XrResult xrGetMarkerSizeVARJO(
* XrSession session,
* uint64_t markerId,
* XrExtent2Df* size);
*
* Description
*
* The {@link #xrGetMarkerSizeVARJO GetMarkerSizeVARJO} function retrieves the height and width of an active marker. The runtime must return {@link #XR_ERROR_MARKER_NOT_TRACKED_VARJO ERROR_MARKER_NOT_TRACKED_VARJO} if marker tracking functionality is disabled or the marker with given {@code markerId} is inactive. The runtime must return {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO} if the supplied {@code markerId} is invalid.
*
* Valid Usage (Implicit)
*
*
* - The {@link VARJOMarkerTracking XR_VARJO_marker_tracking} extension must be enabled prior to calling {@link #xrGetMarkerSizeVARJO GetMarkerSizeVARJO}
* - {@code session} must be a valid {@code XrSession} handle
* - {@code size} must be a pointer to an {@link XrExtent2Df} structure
*
*
* Return Codes
*
*
* - On success, this command returns
*
* - {@link XR10#XR_SUCCESS SUCCESS}
* - {@link XR10#XR_SESSION_LOSS_PENDING SESSION_LOSS_PENDING}
*
- On failure, this command returns
*
* - {@link XR10#XR_ERROR_FUNCTION_UNSUPPORTED ERROR_FUNCTION_UNSUPPORTED}
* - {@link XR10#XR_ERROR_RUNTIME_FAILURE ERROR_RUNTIME_FAILURE}
* - {@link XR10#XR_ERROR_HANDLE_INVALID ERROR_HANDLE_INVALID}
* - {@link XR10#XR_ERROR_INSTANCE_LOST ERROR_INSTANCE_LOST}
* - {@link XR10#XR_ERROR_SESSION_LOST ERROR_SESSION_LOST}
* - {@link #XR_ERROR_MARKER_NOT_TRACKED_VARJO ERROR_MARKER_NOT_TRACKED_VARJO}
* - {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO}
* - {@link XR10#XR_ERROR_FEATURE_UNSUPPORTED ERROR_FEATURE_UNSUPPORTED}
*
*
* See Also
*
* {@link XrExtent2Df}
*
* @param session an {@code XrSession} handle previously created with {@link XR10#xrCreateSession CreateSession}.
* @param markerId the unique identifier of the marker for which size is requested.
* @param size pointer to the size to populate by the runtime with the physical size of plane marker in meters.
*/
@NativeType("XrResult")
public static int xrGetMarkerSizeVARJO(XrSession session, @NativeType("uint64_t") long markerId, @NativeType("XrExtent2Df *") XrExtent2Df size) {
return nxrGetMarkerSizeVARJO(session, markerId, size.address());
}
// --- [ xrCreateMarkerSpaceVARJO ] ---
/** Unsafe version of: {@link #xrCreateMarkerSpaceVARJO CreateMarkerSpaceVARJO} */
public static int nxrCreateMarkerSpaceVARJO(XrSession session, long createInfo, long space) {
long __functionAddress = session.getCapabilities().xrCreateMarkerSpaceVARJO;
if (CHECKS) {
check(__functionAddress);
}
return callPPPI(session.address(), createInfo, space, __functionAddress);
}
/**
* Creates marker space.
*
* C Specification
*
* The {@link #xrCreateMarkerSpaceVARJO CreateMarkerSpaceVARJO} function is defined as:
*
*
* XrResult xrCreateMarkerSpaceVARJO(
* XrSession session,
* const XrMarkerSpaceCreateInfoVARJO* createInfo,
* XrSpace* space);
*
* Description
*
* The {@link #xrCreateMarkerSpaceVARJO CreateMarkerSpaceVARJO} function creates marker {@code XrSpace} for pose relative to the marker specified in {@link XrMarkerSpaceCreateInfoVARJO}. The runtime must return {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO} if the supplied {@link XrMarkerSpaceCreateInfoVARJO}{@code ::markerId} is invalid.
*
* Valid Usage (Implicit)
*
*
* - The {@link VARJOMarkerTracking XR_VARJO_marker_tracking} extension must be enabled prior to calling {@link #xrCreateMarkerSpaceVARJO CreateMarkerSpaceVARJO}
* - {@code session} must be a valid {@code XrSession} handle
* - {@code createInfo} must be a pointer to a valid {@link XrMarkerSpaceCreateInfoVARJO} structure
* - {@code space} must be a pointer to an {@code XrSpace} handle
*
*
* Return Codes
*
*
* - On success, this command returns
*
* - {@link XR10#XR_SUCCESS SUCCESS}
* - {@link XR10#XR_SESSION_LOSS_PENDING SESSION_LOSS_PENDING}
*
- On failure, this command returns
*
* - {@link XR10#XR_ERROR_FUNCTION_UNSUPPORTED ERROR_FUNCTION_UNSUPPORTED}
* - {@link XR10#XR_ERROR_VALIDATION_FAILURE ERROR_VALIDATION_FAILURE}
* - {@link XR10#XR_ERROR_HANDLE_INVALID ERROR_HANDLE_INVALID}
* - {@link XR10#XR_ERROR_INSTANCE_LOST ERROR_INSTANCE_LOST}
* - {@link XR10#XR_ERROR_SESSION_LOST ERROR_SESSION_LOST}
* - {@link XR10#XR_ERROR_OUT_OF_MEMORY ERROR_OUT_OF_MEMORY}
* - {@link XR10#XR_ERROR_LIMIT_REACHED ERROR_LIMIT_REACHED}
* - {@link XR10#XR_ERROR_POSE_INVALID ERROR_POSE_INVALID}
* - {@link #XR_ERROR_MARKER_ID_INVALID_VARJO ERROR_MARKER_ID_INVALID_VARJO}
* - {@link XR10#XR_ERROR_FEATURE_UNSUPPORTED ERROR_FEATURE_UNSUPPORTED}
*
*
* See Also
*
* {@link XrMarkerSpaceCreateInfoVARJO}
*
* @param session an {@code XrSession} handle previously created with {@link XR10#xrCreateSession CreateSession}.
* @param createInfo the structure containing information about how to create the space based on marker.
* @param space a pointer to a handle in which the created {@code XrSpace} is returned.
*/
@NativeType("XrResult")
public static int xrCreateMarkerSpaceVARJO(XrSession session, @NativeType("XrMarkerSpaceCreateInfoVARJO const *") XrMarkerSpaceCreateInfoVARJO createInfo, @NativeType("XrSpace *") PointerBuffer space) {
if (CHECKS) {
check(space, 1);
}
return nxrCreateMarkerSpaceVARJO(session, createInfo.address(), memAddress(space));
}
}