objc2_vision/generated/
VNTrackHomographicImageRegistrationRequest.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ptr::NonNull;
4use objc2::__framework_prelude::*;
5#[cfg(feature = "objc2-core-media")]
6use objc2_core_media::*;
7use objc2_foundation::*;
8
9use crate::*;
10
11extern_class!(
12    /// An image registration request that will produce a homographic transformation that can morph one image to another.
13    ///
14    /// Because this is a stateful request, it must be performed on at least two images in order to produce an observation.
15    ///
16    /// See also [Apple's documentation](https://developer.apple.com/documentation/vision/vntrackhomographicimageregistrationrequest?language=objc)
17    #[unsafe(super(VNStatefulRequest, VNImageBasedRequest, VNRequest, NSObject))]
18    #[derive(Debug, PartialEq, Eq, Hash)]
19    #[cfg(all(feature = "VNRequest", feature = "VNStatefulRequest"))]
20    pub struct VNTrackHomographicImageRegistrationRequest;
21);
22
23#[cfg(all(feature = "VNRequest", feature = "VNStatefulRequest"))]
24extern_conformance!(
25    unsafe impl NSCopying for VNTrackHomographicImageRegistrationRequest {}
26);
27
28#[cfg(all(feature = "VNRequest", feature = "VNStatefulRequest"))]
29unsafe impl CopyingHelper for VNTrackHomographicImageRegistrationRequest {
30    type Result = Self;
31}
32
33#[cfg(all(feature = "VNRequest", feature = "VNStatefulRequest"))]
34extern_conformance!(
35    unsafe impl NSObjectProtocol for VNTrackHomographicImageRegistrationRequest {}
36);
37
38#[cfg(all(feature = "VNRequest", feature = "VNStatefulRequest"))]
39impl VNTrackHomographicImageRegistrationRequest {
40    extern_methods!(
41        /// Create a new request that can statefully track the homographic registration of two images.
42        ///
43        /// This is a convenience initializer for a frame analysis spacing of kCMTimeZero and a nil completion handler.
44        #[unsafe(method(init))]
45        #[unsafe(method_family = init)]
46        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
47
48        #[cfg(feature = "block2")]
49        /// Create a new request that can statefully track the homographic registration of two images.
50        ///
51        /// This is a convenience initializer for a frame analysis spacing of kCMTimeZero.
52        ///
53        /// # Safety
54        ///
55        /// `completion_handler` must be a valid pointer or null.
56        #[unsafe(method(initWithCompletionHandler:))]
57        #[unsafe(method_family = init)]
58        pub unsafe fn initWithCompletionHandler(
59            this: Allocated<Self>,
60            completion_handler: VNRequestCompletionHandler,
61        ) -> Retained<Self>;
62
63        #[cfg(feature = "VNObservation")]
64        /// VNImageHomographicAlignmentObservation results.
65        #[unsafe(method(results))]
66        #[unsafe(method_family = none)]
67        pub unsafe fn results(
68            &self,
69        ) -> Option<Retained<NSArray<VNImageHomographicAlignmentObservation>>>;
70    );
71}
72
73/// Methods declared on superclass `VNStatefulRequest`.
74#[cfg(all(feature = "VNRequest", feature = "VNStatefulRequest"))]
75impl VNTrackHomographicImageRegistrationRequest {
76    extern_methods!(
77        #[unsafe(method(new))]
78        #[unsafe(method_family = new)]
79        pub unsafe fn new() -> Retained<Self>;
80
81        #[cfg(all(feature = "block2", feature = "objc2-core-media"))]
82        /// Create a new video-based stateful request.
83        ///
84        ///
85        /// Parameter `frameAnalysisSpacing`: The reciprocal of maximum rate at which buffers will be processed. The request will not process buffers that fall within the frameAnalysisSpacing after it has performed the analysis. The analysis is not done by wall time but by analysis of of the time stamps of the samplebuffers being processed.
86        ///
87        /// Parameter `completionHandler`: The block to be invoked after the request has completed its processing. The completion handler gets executed on the same dispatch queue as the request being executed.
88        ///
89        /// # Safety
90        ///
91        /// `completion_handler` must be a valid pointer or null.
92        #[unsafe(method(initWithFrameAnalysisSpacing:completionHandler:))]
93        #[unsafe(method_family = init)]
94        pub unsafe fn initWithFrameAnalysisSpacing_completionHandler(
95            this: Allocated<Self>,
96            frame_analysis_spacing: CMTime,
97            completion_handler: VNRequestCompletionHandler,
98        ) -> Retained<Self>;
99    );
100}
101
102/// [Apple's documentation](https://developer.apple.com/documentation/vision/vntrackhomographicimageregistrationrequestrevision1?language=objc)
103pub static VNTrackHomographicImageRegistrationRequestRevision1: NSUInteger = 1;
objc2_vision/generated/VNTrackHomographicImageRegistrationRequest.rs

objc2_vision/generated/
VNTrackHomographicImageRegistrationRequest.rs
