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

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

use crate::{MTL4FunctionDescriptor, MTLFunctionStitchingGraph};

extern_class!(
    /// Groups together properties that describe a shader function suitable for stitching.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4stitchedfunctiondescriptor?language=objc)
    #[unsafe(super(MTL4FunctionDescriptor, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct MTL4StitchedFunctionDescriptor;
);

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

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

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

impl MTL4StitchedFunctionDescriptor {
    extern_methods!(
        /// Sets the graph representing how to stitch functions together.
        #[unsafe(method(functionGraph))]
        #[unsafe(method_family = none)]
        pub fn function_graph(&self) -> Option<Retained<MTLFunctionStitchingGraph>>;

        /// Setter for [`functionGraph`][Self::functionGraph].
        ///
        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
        #[unsafe(method(setFunctionGraph:))]
        #[unsafe(method_family = none)]
        pub fn set_function_graph(
            &self,
            function_graph: Option<&MTLFunctionStitchingGraph>,
        );
    );

    /// Function descriptors that contribute to the stitching process.
    pub fn function_descriptors(&self) -> Option<Box<[Retained<MTL4FunctionDescriptor>]>> {
        let descriptors: Option<Retained<NSArray<MTL4FunctionDescriptor>>> =
            unsafe { msg_send![self, functionDescriptors] };
        descriptors.map(|descriptors| descriptors.to_vec().into_boxed_slice())
    }

    /// Sets the function descriptors with copy semantics.
    pub fn set_function_descriptors(
        &self,
        function_descriptors: Option<&[&MTL4FunctionDescriptor]>,
    ) {
        let function_descriptors = function_descriptors.map(NSArray::from_slice);
        unsafe {
            let _: () = msg_send![self, setFunctionDescriptors: function_descriptors.as_deref()];
        }
    }
}

/// Methods declared on superclass `NSObject`.
impl MTL4StitchedFunctionDescriptor {
    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;

    use super::{MTL4FunctionDescriptor, MTL4StitchedFunctionDescriptor};

    #[test]
    fn collection_method_has_rust_native_signature() {
        let _: fn(&MTL4StitchedFunctionDescriptor) -> Option<Box<[Retained<MTL4FunctionDescriptor>]>> =
            MTL4StitchedFunctionDescriptor::function_descriptors;
        let _: fn(&MTL4StitchedFunctionDescriptor, Option<&[&MTL4FunctionDescriptor]>) =
            MTL4StitchedFunctionDescriptor::set_function_descriptors;
    }
}