mtl-rs 0.1.11

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

use objc2::{Message, extern_protocol, msg_send, rc::Retained, runtime::ProtocolObject};
use objc2_foundation::{NSObjectProtocol, NSString};

use super::MTLIOCommandBuffer;

extern_protocol!(
    /// Represents a queue that schedules IO command buffers.
    ///
    /// Availability: macOS 13.0+, iOS 16.0+
    pub unsafe trait MTLIOCommandQueue: NSObjectProtocol + Send + Sync {
        /// Insert a barrier to order prior and subsequent command buffers.
        #[unsafe(method(enqueueBarrier))]
        #[unsafe(method_family = none)]
        fn enqueue_barrier(&self);

        /// Vend an autoreleased command buffer for encoding IO commands.
        #[unsafe(method(commandBuffer))]
        #[unsafe(method_family = none)]
        fn command_buffer(&self) -> Retained<ProtocolObject<dyn MTLIOCommandBuffer>>;

        /// Vend an autoreleased command buffer that does not retain referenced objects.
        ///
        /// For correct execution, the application must retain objects referenced by commands.
        #[unsafe(method(commandBufferWithUnretainedReferences))]
        #[unsafe(method_family = none)]
        fn command_buffer_with_unretained_references(&self) -> Retained<ProtocolObject<dyn MTLIOCommandBuffer>>;
    }
);

#[allow(unused)]
pub trait MTLIOCommandQueueExt: MTLIOCommandQueue + Message {
    fn label(&self) -> Option<String>;
    fn set_label(
        &self,
        label: Option<&str>,
    );
}

impl MTLIOCommandQueueExt for ProtocolObject<dyn MTLIOCommandQueue> {
    fn label(&self) -> Option<String> {
        let s: Option<Retained<NSString>> = unsafe { msg_send![self, label] };
        s.map(|s| s.to_string())
    }

    fn set_label(
        &self,
        label: Option<&str>,
    ) {
        unsafe {
            let _: () = msg_send![self, setLabel: label.map(NSString::from_str).as_deref()];
        }
    }
}