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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

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

use crate::{
    MTL4BinaryFunction, MTL4BinaryFunctionDescriptor, MTL4ComputePipelineDescriptor, MTL4PipelineDescriptor,
    MTL4PipelineStageDynamicLinkingDescriptor, MTL4RenderPipelineDynamicLinkingDescriptor, MTLComputePipelineState,
    MTLRenderPipelineState,
};

extern_protocol!(
    /// A read-only container that stores pipeline states from a shader compiler.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4archive?language=objc)
    pub unsafe trait MTL4Archive: NSObjectProtocol + Send + Sync {}
);

pub trait MTL4ArchiveExt: MTL4Archive + Message {
    /// Creates a compute pipeline state from the archive with a descriptor.
    fn new_compute_pipeline_state_with_descriptor(
        &self,
        descriptor: &MTL4ComputePipelineDescriptor,
    ) -> Result<Retained<ProtocolObject<dyn MTLComputePipelineState>>, crate::MetalError>
    where
        Self: Sized,
    {
        unsafe { msg_send![self, newComputePipelineStateWithDescriptor: descriptor, error: _] }
            .map_err(crate::MetalError::from_nserror)
    }

    /// Creates a compute pipeline state with dynamic-linking configuration from the archive.
    fn new_compute_pipeline_state_with_descriptor_dynamic_linking_descriptor(
        &self,
        descriptor: &MTL4ComputePipelineDescriptor,
        dynamic_linking_descriptor: &MTL4PipelineStageDynamicLinkingDescriptor,
    ) -> Result<Retained<ProtocolObject<dyn MTLComputePipelineState>>, crate::MetalError>
    where
        Self: Sized,
    {
        unsafe {
            msg_send![
                self,
                newComputePipelineStateWithDescriptor: descriptor,
                dynamicLinkingDescriptor: dynamic_linking_descriptor,
                error: _
            ]
        }
        .map_err(crate::MetalError::from_nserror)
    }

    /// Creates a render pipeline state from the archive with a descriptor.
    fn new_render_pipeline_state_with_descriptor(
        &self,
        descriptor: &MTL4PipelineDescriptor,
    ) -> Result<Retained<ProtocolObject<dyn MTLRenderPipelineState>>, crate::MetalError>
    where
        Self: Sized,
    {
        unsafe { msg_send![self, newRenderPipelineStateWithDescriptor: descriptor, error: _] }
            .map_err(crate::MetalError::from_nserror)
    }

    /// Creates a render pipeline state with dynamic-linking configuration from the archive.
    fn new_render_pipeline_state_with_descriptor_dynamic_linking_descriptor(
        &self,
        descriptor: &MTL4PipelineDescriptor,
        dynamic_linking_descriptor: &MTL4RenderPipelineDynamicLinkingDescriptor,
    ) -> Result<Retained<ProtocolObject<dyn MTLRenderPipelineState>>, crate::MetalError>
    where
        Self: Sized,
    {
        unsafe {
            msg_send![
                self,
                newRenderPipelineStateWithDescriptor: descriptor,
                dynamicLinkingDescriptor: dynamic_linking_descriptor,
                error: _
            ]
        }
        .map_err(crate::MetalError::from_nserror)
    }

    /// Creates a binary function from the contents of the archive.
    fn new_binary_function_with_descriptor(
        &self,
        descriptor: &MTL4BinaryFunctionDescriptor,
    ) -> Result<Retained<ProtocolObject<dyn MTL4BinaryFunction>>, crate::MetalError>
    where
        Self: Sized,
    {
        unsafe { msg_send![self, newBinaryFunctionWithDescriptor: descriptor, error: _] }
            .map_err(crate::MetalError::from_nserror)
    }

    /// A label that you can associate with this archive.
    fn label(&self) -> Option<String> {
        let s: Option<Retained<NSString>> = unsafe { msg_send![self, label] };
        s.map(|v| v.to_string())
    }

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

impl<T: MTL4Archive + Message> MTL4ArchiveExt for T {}

#[cfg(test)]
mod tests {
    use objc2::{rc::Retained, runtime::ProtocolObject};

    use super::{MTL4Archive, MTL4ArchiveExt};
    use crate::{MTL4ComputePipelineDescriptor, MTLComputePipelineState, MetalError};

    #[test]
    fn fallible_methods_have_rust_native_signatures() {
        let _: fn(
            &ProtocolObject<dyn MTL4Archive>,
            &MTL4ComputePipelineDescriptor,
        ) -> Result<Retained<ProtocolObject<dyn MTLComputePipelineState>>, MetalError> =
            <ProtocolObject<dyn MTL4Archive> as MTL4ArchiveExt>::new_compute_pipeline_state_with_descriptor;
    }
}