mtl-rs 0.2.0

Rust bindings for Apple's Metal API
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

use objc2::{Message, extern_protocol, msg_send};
use objc2_foundation::NSObjectProtocol;

use crate::MTLDrawablePresentedHandler;

extern_protocol!(
    /// All "drawable" objects (such as those coming from CAMetalLayer) are expected to conform to this protocol.
    ///
    /// Availability: macOS 10.11+, iOS 8.0+
    ///
    /// # Safety
    ///
    /// Implementors must be valid Objective-C objects that conform to the
    /// `MTLDrawable` protocol.
    #[expect(
        clippy::missing_safety_doc,
        reason = "extern_protocol does not attach this safety section to its generated unsafe trait"
    )]
    pub unsafe trait MTLDrawable: NSObjectProtocol {
        /// Present this drawable immediately.
        #[unsafe(method(present))]
        #[unsafe(method_family = none)]
        fn present(&self);

        /// Present this drawable at a specific host time.
        #[unsafe(method(presentAtTime:))]
        #[unsafe(method_family = none)]
        fn present_at_time(
            &self,
            presentation_time: f64,
        );

        /// Present this drawable while setting a minimum duration in seconds
        /// before allowing this drawable to appear on the display.
        ///
        /// Availability: macOS 10.15.4+, iOS 10.3+, Mac Catalyst 13.4+
        #[unsafe(method(presentAfterMinimumDuration:))]
        #[unsafe(method_family = none)]
        fn present_after_minimum_duration(
            &self,
            duration: f64,
        );

        /// The host time that this drawable was presented on screen.
        /// Returns 0 if a frame has not been presented or has been skipped.
        ///
        /// Availability: macOS 10.15.4+, iOS 10.3+, Mac Catalyst 13.4+
        #[unsafe(method(presentedTime))]
        #[unsafe(method_family = none)]
        fn presented_time(&self) -> f64;

        /// The monotonically incremented ID for all drawable objects created
        /// from the same CAMetalLayer object. The value starts from 0.
        ///
        /// Availability: macOS 10.15.4+, iOS 10.3+, Mac Catalyst 13.4+
        #[unsafe(method(drawableID))]
        #[unsafe(method_family = none)]
        fn drawable_id(&self) -> usize;
    }
);

/// Safe convenience methods for [`MTLDrawable`].
pub trait MTLDrawableExt: MTLDrawable + Message {
    /// Registers a sendable block that Metal invokes after presenting this
    /// drawable on screen.
    ///
    /// Availability: macOS 10.15.4+, iOS 10.3+, Mac Catalyst 13.4+
    fn add_presented_handler(
        &self,
        handler: &MTLDrawablePresentedHandler,
    );
}

impl<T> MTLDrawableExt for T
where
    T: MTLDrawable + Message,
{
    fn add_presented_handler(
        &self,
        handler: &MTLDrawablePresentedHandler,
    ) {
        unsafe {
            let _: () = msg_send![self, addPresentedHandler: handler.as_block()];
        }
    }
}