mtl-rs 0.1.8

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

use objc2::{
    encode::{Encode, Encoding, RefEncode},
    extern_class, extern_conformance, extern_methods, msg_send,
    rc::{Allocated, Retained},
};
use objc2_foundation::{CopyingHelper, NSCopying, NSObject, NSObjectProtocol, NSString};

use crate::*;

/// Options for configuring the creation of binary functions.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4binaryfunctionoptions?language=objc)
// NS_OPTIONS
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct MTL4BinaryFunctionOptions(pub usize);
bitflags::bitflags! {
    impl MTL4BinaryFunctionOptions: usize {
        /// Represents the default value: no options.
        #[doc(alias = "MTL4BinaryFunctionOptionNone")]
        const None = 0;
        /// Compiles the function to have its function handles return a constant MTLResourceID across
        /// all pipeline states. The function needs to be linked to the pipeline that will use this function.
        #[doc(alias = "MTL4BinaryFunctionOptionPipelineIndependent")]
        const PipelineIndependent = 1<<1;
    }
}

unsafe impl Encode for MTL4BinaryFunctionOptions {
    const ENCODING: Encoding = usize::ENCODING;
}

unsafe impl RefEncode for MTL4BinaryFunctionOptions {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

extern_class!(
    /// Base interface for other function-derived interfaces.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4binaryfunctiondescriptor?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct MTL4BinaryFunctionDescriptor;
);

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

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

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

impl MTL4BinaryFunctionDescriptor {
    extern_methods!(
        /// Provides the function descriptor corresponding to the function to compile into a binary function.
        #[unsafe(method(functionDescriptor))]
        #[unsafe(method_family = none)]
        pub fn function_descriptor(&self) -> Retained<MTL4FunctionDescriptor>;

        /// Setter for [`functionDescriptor`][Self::functionDescriptor].
        ///
        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
        #[unsafe(method(setFunctionDescriptor:))]
        #[unsafe(method_family = none)]
        pub fn set_function_descriptor(
            &self,
            function_descriptor: &MTL4FunctionDescriptor,
        );

        /// Configure the options to use at binary function creation time.
        #[unsafe(method(options))]
        #[unsafe(method_family = none)]
        pub fn options(&self) -> MTL4BinaryFunctionOptions;

        /// Setter for [`options`][Self::options].
        #[unsafe(method(setOptions:))]
        #[unsafe(method_family = none)]
        pub fn set_options(
            &self,
            options: MTL4BinaryFunctionOptions,
        );
    );
}

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

impl MTL4BinaryFunctionDescriptor {
    /// Associates a string that uniquely identifies a binary function.
    pub fn name(&self) -> String {
        let s: Retained<NSString> = unsafe { msg_send![self, name] };
        s.to_string()
    }

    /// Setter for name.
    pub fn set_name(
        &self,
        name: &str,
    ) {
        unsafe {
            let _: () = msg_send![self, setName: &*NSString::from_str(name)];
        }
    }
}