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
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

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

use crate::{MTLDataType, MTLTensorDataType, MTLTensorExtents, MTLTextureType};

extern_protocol!(
    /// Describes a resource binding.
    ///
    /// Availability: macOS 13.0+, iOS 16.0+
    pub unsafe trait MTLBinding: NSObjectProtocol {
        /// Type of the binding.
        #[unsafe(method(type))]
        #[unsafe(method_family = none)]
        fn binding_type(&self) -> crate::argument::MTLBindingType;

        /// Access flags of the binding.
        #[unsafe(method(access))]
        #[unsafe(method_family = none)]
        fn access(&self) -> crate::argument::MTLBindingAccess;

        /// Bind point index of the binding.
        #[unsafe(method(index))]
        #[unsafe(method_family = none)]
        fn index(&self) -> usize;

        /// Whether the binding is used.
        #[unsafe(method(isUsed))]
        #[unsafe(method_family = none)]
        fn is_used(&self) -> bool;

        /// Whether this reflection entry is an argument as opposed to a function constant.
        #[unsafe(method(isArgument))]
        #[unsafe(method_family = none)]
        fn is_argument(&self) -> bool;
    }
);

#[allow(unused)]
pub trait MTLBindingExt: MTLBinding + Message {
    fn name(&self) -> String;
}

impl MTLBindingExt for ProtocolObject<dyn MTLBinding> {
    fn name(&self) -> String {
        let ns: Retained<NSString> = unsafe { msg_send![self, name] };
        ns.to_string()
    }
}

extern_protocol!(
    /// Binding for buffers.
    ///
    /// Availability: macOS 13.0+, iOS 16.0+
    pub unsafe trait MTLBufferBinding: MTLBinding {
        #[unsafe(method(bufferAlignment))]
        #[unsafe(method_family = none)]
        fn buffer_alignment(&self) -> usize;

        #[unsafe(method(bufferDataSize))]
        #[unsafe(method_family = none)]
        fn buffer_data_size(&self) -> usize;

        #[unsafe(method(bufferDataType))]
        #[unsafe(method_family = none)]
        fn buffer_data_type(&self) -> MTLDataType;

        #[unsafe(method(bufferStructType))]
        #[unsafe(method_family = none)]
        fn buffer_struct_type(&self) -> Option<Retained<crate::argument::MTLStructType>>;

        #[unsafe(method(bufferPointerType))]
        #[unsafe(method_family = none)]
        fn buffer_pointer_type(&self) -> Option<Retained<crate::argument::MTLPointerType>>;
    }
);

extern_protocol!(
    /// Binding for threadgroup memory.
    ///
    /// Availability: macOS 13.0+, iOS 16.0+
    pub unsafe trait MTLThreadgroupBinding: MTLBinding {
        #[unsafe(method(threadgroupMemoryAlignment))]
        #[unsafe(method_family = none)]
        fn threadgroup_memory_alignment(&self) -> usize;

        #[unsafe(method(threadgroupMemoryDataSize))]
        #[unsafe(method_family = none)]
        fn threadgroup_memory_data_size(&self) -> usize;
    }
);

extern_protocol!(
    /// Binding for textures.
    ///
    /// Availability: macOS 13.0+, iOS 16.0+
    pub unsafe trait MTLTextureBinding: MTLBinding {
        #[unsafe(method(textureType))]
        #[unsafe(method_family = none)]
        fn texture_type(&self) -> MTLTextureType;

        #[unsafe(method(textureDataType))]
        #[unsafe(method_family = none)]
        fn texture_data_type(&self) -> MTLDataType;

        #[unsafe(method(isDepthTexture))]
        #[unsafe(method_family = none)]
        fn is_depth_texture(&self) -> bool;

        #[unsafe(method(arrayLength))]
        #[unsafe(method_family = none)]
        fn array_length(&self) -> usize;
    }
);

extern_protocol!(
    /// Binding for object payloads.
    ///
    /// Availability: macOS 13.0+, iOS 16.0+
    pub unsafe trait MTLObjectPayloadBinding: MTLBinding {
        #[unsafe(method(objectPayloadAlignment))]
        #[unsafe(method_family = none)]
        fn object_payload_alignment(&self) -> usize;

        #[unsafe(method(objectPayloadDataSize))]
        #[unsafe(method_family = none)]
        fn object_payload_data_size(&self) -> usize;
    }
);

extern_protocol!(
    /// Binding for a tensor resource bound to a graphics, compute, or ML function.
    ///
    /// Availability: macOS 26.0+, iOS 26.0+
    pub unsafe trait MTLTensorBinding: MTLBinding {
        /// The underlying data format of this tensor.
        #[unsafe(method(tensorDataType))]
        #[unsafe(method_family = none)]
        fn tensor_data_type(&self) -> MTLTensorDataType;

        /// The data format used for indexing into the tensor.
        #[unsafe(method(indexType))]
        #[unsafe(method_family = none)]
        fn index_type(&self) -> MTLDataType;

        /// The array of sizes, in elements, one for each dimension of this tensor.
        ///
        /// For shader-bound tensors with dynamic extents, the rank corresponds to
        /// the shader-specified rank and each extent value is -1.
        #[unsafe(method(dimensions))]
        #[unsafe(method_family = none)]
        fn dimensions(&self) -> Option<Retained<MTLTensorExtents>>;
    }
);