The open source OpenXR runtime
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

xrt: Fix plane doc errors and use xrt_result_t typedef [NFC]

Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2612>

authored by

Jakob Bornecrantz and committed by
Korcan Hussein
a516ee1b 0e5a7ed7

+19 -19
+19 -19
src/xrt/include/xrt/xrt_device.h
··· 489 489 * @param[out] out_plane_detection_id The id of the new plane detection request generated by the xdev. 490 490 * @return generally XRT_SUCCESS, except for internal runtime failures. 491 491 */ 492 - enum xrt_result (*begin_plane_detection_ext)(struct xrt_device *xdev, 493 - const struct xrt_plane_detector_begin_info_ext *begin_info, 494 - uint64_t plane_detection_id, 495 - uint64_t *out_plane_detection_id); 492 + xrt_result_t (*begin_plane_detection_ext)(struct xrt_device *xdev, 493 + const struct xrt_plane_detector_begin_info_ext *begin_info, 494 + uint64_t plane_detection_id, 495 + uint64_t *out_plane_detection_id); 496 496 497 497 /*! 498 498 * Destroy internal resources associated with plane_detector_id. ··· 501 501 * @param[in] plane_detection_id An id generated by the xdev. 502 502 * @return generally XRT_SUCCESS, except for internal runtime failures. 503 503 */ 504 - enum xrt_result (*destroy_plane_detection_ext)(struct xrt_device *xdev, uint64_t plane_detection_id); 504 + xrt_result_t (*destroy_plane_detection_ext)(struct xrt_device *xdev, uint64_t plane_detection_id); 505 505 506 506 /*! 507 507 * Get the state of a plane detection request. ··· 511 511 * @param[out] out_state The state of the plane detection. 512 512 * @return generally XRT_SUCCESS, except for internal runtime failures. 513 513 */ 514 - enum xrt_result (*get_plane_detection_state_ext)(struct xrt_device *xdev, 515 - uint64_t plane_detection_id, 516 - enum xrt_plane_detector_state_ext *out_state); 514 + xrt_result_t (*get_plane_detection_state_ext)(struct xrt_device *xdev, 515 + uint64_t plane_detection_id, 516 + enum xrt_plane_detector_state_ext *out_state); 517 517 518 518 /*! 519 519 * Get results of a plane detection request. ··· 523 523 * @param[out] detections The detected planes, if any. 524 524 * @return generally XRT_SUCCESS, except for internal runtime failures. 525 525 */ 526 - enum xrt_result (*get_plane_detections_ext)(struct xrt_device *xdev, 527 - uint64_t plane_detection_id, 528 - struct xrt_plane_detections_ext *out_detections); 526 + xrt_result_t (*get_plane_detections_ext)(struct xrt_device *xdev, 527 + uint64_t plane_detection_id, 528 + struct xrt_plane_detections_ext *out_detections); 529 529 530 530 /*! 531 531 * @brief Get the per-view pose in relation to the view space. ··· 860 860 } 861 861 862 862 /*! 863 - * Helper function for @ref xrt_device::begin_plane_detection. 863 + * Helper function for @ref xrt_device::begin_plane_detection_ext. 864 864 * 865 865 * @public @memberof xrt_device 866 866 */ 867 - static inline enum xrt_result 867 + static inline xrt_result_t 868 868 xrt_device_begin_plane_detection_ext(struct xrt_device *xdev, 869 869 const struct xrt_plane_detector_begin_info_ext *begin_info, 870 870 uint64_t plane_detection_id, ··· 874 874 } 875 875 876 876 /*! 877 - * Helper function for @ref xrt_device::destroy_plane_detection. 877 + * Helper function for @ref xrt_device::destroy_plane_detection_ext. 878 878 * 879 879 * @public @memberof xrt_device 880 880 */ 881 - static inline enum xrt_result 881 + static inline xrt_result_t 882 882 xrt_device_destroy_plane_detection_ext(struct xrt_device *xdev, uint64_t plane_detection_id) 883 883 { 884 884 return xdev->destroy_plane_detection_ext(xdev, plane_detection_id); 885 885 } 886 886 887 887 /*! 888 - * Helper function for @ref xrt_device::get_plane_detections. 888 + * Helper function for @ref xrt_device::get_plane_detections_ext. 889 889 * 890 890 * @public @memberof xrt_device 891 891 */ 892 - static inline enum xrt_result 892 + static inline xrt_result_t 893 893 xrt_device_get_plane_detection_state_ext(struct xrt_device *xdev, 894 894 uint64_t plane_detection_id, 895 895 enum xrt_plane_detector_state_ext *out_state) ··· 898 898 } 899 899 900 900 /*! 901 - * Helper function for @ref xrt_device::get_plane_detections. 901 + * Helper function for @ref xrt_device::get_plane_detections_ext. 902 902 * 903 903 * @public @memberof xrt_device 904 904 */ 905 - static inline enum xrt_result 905 + static inline xrt_result_t 906 906 xrt_device_get_plane_detections_ext(struct xrt_device *xdev, 907 907 uint64_t plane_detection_id, 908 908 struct xrt_plane_detections_ext *out_detections)