mtl-rs 0.2.1

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

use objc2::{
    extern_class, extern_conformance, extern_methods, msg_send,
    rc::{Allocated, Retained},
    runtime::{NSObject, ProtocolObject},
};
use objc2_foundation::{CopyingHelper, NSArray, NSCopying, NSObjectProtocol};

use crate::MTLFunction;

extern_class!(
    /// Additional binary functions for incrementally creating a render pipeline state.
    ///
    /// Availability: macOS 12.0+, iOS 15.0+
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct MTLRenderPipelineFunctionsDescriptor;
);

extern_conformance!(
    unsafe impl NSCopying for MTLRenderPipelineFunctionsDescriptor {}
);

unsafe impl CopyingHelper for MTLRenderPipelineFunctionsDescriptor {
    type Result = Self;
}

extern_conformance!(
    unsafe impl NSObjectProtocol for MTLRenderPipelineFunctionsDescriptor {}
);

impl MTLRenderPipelineFunctionsDescriptor {
    /// Additional binary functions available to the vertex function.
    pub fn vertex_additional_binary_functions(&self) -> Option<Box<[Retained<ProtocolObject<dyn MTLFunction>>]>> {
        let functions: Option<Retained<NSArray<ProtocolObject<dyn MTLFunction>>>> =
            unsafe { msg_send![self, vertexAdditionalBinaryFunctions] };
        functions.map(|functions| functions.to_vec().into_boxed_slice())
    }

    /// Setter for [`vertex_additional_binary_functions`][Self::vertex_additional_binary_functions].
    pub fn set_vertex_additional_binary_functions(
        &self,
        functions: Option<&[&ProtocolObject<dyn MTLFunction>]>,
    ) {
        let functions = functions.map(NSArray::from_slice);
        unsafe {
            let _: () = msg_send![self, setVertexAdditionalBinaryFunctions: functions.as_deref()];
        }
    }

    /// Additional binary functions available to the fragment function.
    pub fn fragment_additional_binary_functions(&self) -> Option<Box<[Retained<ProtocolObject<dyn MTLFunction>>]>> {
        let functions: Option<Retained<NSArray<ProtocolObject<dyn MTLFunction>>>> =
            unsafe { msg_send![self, fragmentAdditionalBinaryFunctions] };
        functions.map(|functions| functions.to_vec().into_boxed_slice())
    }

    /// Setter for [`fragment_additional_binary_functions`][Self::fragment_additional_binary_functions].
    pub fn set_fragment_additional_binary_functions(
        &self,
        functions: Option<&[&ProtocolObject<dyn MTLFunction>]>,
    ) {
        let functions = functions.map(NSArray::from_slice);
        unsafe {
            let _: () = msg_send![self, setFragmentAdditionalBinaryFunctions: functions.as_deref()];
        }
    }

    /// Additional binary functions available to the tile function.
    pub fn tile_additional_binary_functions(&self) -> Option<Box<[Retained<ProtocolObject<dyn MTLFunction>>]>> {
        let functions: Option<Retained<NSArray<ProtocolObject<dyn MTLFunction>>>> =
            unsafe { msg_send![self, tileAdditionalBinaryFunctions] };
        functions.map(|functions| functions.to_vec().into_boxed_slice())
    }

    /// Setter for [`tile_additional_binary_functions`][Self::tile_additional_binary_functions].
    pub fn set_tile_additional_binary_functions(
        &self,
        functions: Option<&[&ProtocolObject<dyn MTLFunction>]>,
    ) {
        let functions = functions.map(NSArray::from_slice);
        unsafe {
            let _: () = msg_send![self, setTileAdditionalBinaryFunctions: functions.as_deref()];
        }
    }
}

impl MTLRenderPipelineFunctionsDescriptor {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub fn new() -> Retained<Self>;
    );
}

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

    use super::MTLRenderPipelineFunctionsDescriptor;
    use crate::MTLFunction;

    #[test]
    fn collection_methods_have_rust_native_signatures() {
        let _: fn(&MTLRenderPipelineFunctionsDescriptor) -> Option<Box<[Retained<ProtocolObject<dyn MTLFunction>>]>> =
            MTLRenderPipelineFunctionsDescriptor::vertex_additional_binary_functions;
        let _: fn(&MTLRenderPipelineFunctionsDescriptor) -> Option<Box<[Retained<ProtocolObject<dyn MTLFunction>>]>> =
            MTLRenderPipelineFunctionsDescriptor::fragment_additional_binary_functions;
        let _: fn(&MTLRenderPipelineFunctionsDescriptor) -> Option<Box<[Retained<ProtocolObject<dyn MTLFunction>>]>> =
            MTLRenderPipelineFunctionsDescriptor::tile_additional_binary_functions;
        let _: fn(&MTLRenderPipelineFunctionsDescriptor, Option<&[&ProtocolObject<dyn MTLFunction>]>) =
            MTLRenderPipelineFunctionsDescriptor::set_vertex_additional_binary_functions;
    }
}