xrt_settings.h

Go to the documentation of this file.

// Copyright 2020, Collabora, Ltd.
// SPDX-License-Identifier: BSL-1.0
/*!
 * @file
 * @brief  Common settings structs to be transferred between different parts of
 *         Monado, mainly for tracking and camera usage.
 * @author Jakob Bornecrantz <jakob@collabora.com>
 * @ingroup xrt_iface
 */
 
#pragma once
 
#include "xrt/xrt_compiler.h"
 
// XRT_DEVICE_NAME_LEN
#include "xrt/xrt_device.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/*!
 * @addtogroup xrt_iface
 * @{
 */
 
/*!
 * Camera type.
 */
enum xrt_settings_camera_type
{
        XRT_SETTINGS_CAMERA_TYPE_REGULAR_MONO = 0,
        XRT_SETTINGS_CAMERA_TYPE_REGULAR_SBS = 1, // side-by-side
        XRT_SETTINGS_CAMERA_TYPE_SLAM = 2,
        XRT_SETTINGS_CAMERA_TYPE_PS4 = 3,
        XRT_SETTINGS_CAMERA_TYPE_LEAP_MOTION = 4,
};
 
#define XRT_SETTINGS_CAMERA_NAME_LENGTH 256
#define XRT_SETTINGS_PATH_LENGTH 1024
 
#define XRT_MAX_TRACKING_OVERRIDES 16
 
/*!
 * Tracking override type.
 */
enum xrt_tracking_override_type
{
        XRT_TRACKING_OVERRIDE_DIRECT = 0,
        XRT_TRACKING_OVERRIDE_ATTACHED,
};
 
struct xrt_tracking_override
{
        char target_device_serial[XRT_DEVICE_NAME_LEN];
        char tracker_device_serial[XRT_DEVICE_NAME_LEN];
        enum xrt_input_name input_name;
        struct xrt_pose offset;
        enum xrt_tracking_override_type override_type;
};
 
/*!
 * Holding enough information to recreate a tracking pipeline.
 */
struct xrt_settings_tracking
{
        char camera_name[XRT_SETTINGS_CAMERA_NAME_LENGTH];
        int camera_mode;
        enum xrt_settings_camera_type camera_type;
        char calibration_path[XRT_SETTINGS_PATH_LENGTH];
};
 
/*!
 * @}
 */
 
 
#ifdef __cplusplus
}
#endif