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

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

use crate::{MTLArgument, MTLBinding};

extern_class!(
    /// Reflection info for a render pipeline.
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct MTLRenderPipelineReflection;
);

unsafe impl Send for MTLRenderPipelineReflection {}
unsafe impl Sync for MTLRenderPipelineReflection {}

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

impl MTLRenderPipelineReflection {
    /// The vertex-stage resource bindings.
    pub fn vertex_bindings(&self) -> Box<[Retained<ProtocolObject<dyn MTLBinding>>]> {
        let bindings: Retained<NSArray<ProtocolObject<dyn MTLBinding>>> = unsafe { msg_send![self, vertexBindings] };
        bindings.to_vec().into_boxed_slice()
    }

    /// The fragment-stage resource bindings.
    pub fn fragment_bindings(&self) -> Box<[Retained<ProtocolObject<dyn MTLBinding>>]> {
        let bindings: Retained<NSArray<ProtocolObject<dyn MTLBinding>>> = unsafe { msg_send![self, fragmentBindings] };
        bindings.to_vec().into_boxed_slice()
    }

    /// The tile-stage resource bindings.
    pub fn tile_bindings(&self) -> Box<[Retained<ProtocolObject<dyn MTLBinding>>]> {
        let bindings: Retained<NSArray<ProtocolObject<dyn MTLBinding>>> = unsafe { msg_send![self, tileBindings] };
        bindings.to_vec().into_boxed_slice()
    }

    /// The object-stage resource bindings.
    pub fn object_bindings(&self) -> Box<[Retained<ProtocolObject<dyn MTLBinding>>]> {
        let bindings: Retained<NSArray<ProtocolObject<dyn MTLBinding>>> = unsafe { msg_send![self, objectBindings] };
        bindings.to_vec().into_boxed_slice()
    }

    /// The mesh-stage resource bindings.
    pub fn mesh_bindings(&self) -> Box<[Retained<ProtocolObject<dyn MTLBinding>>]> {
        let bindings: Retained<NSArray<ProtocolObject<dyn MTLBinding>>> = unsafe { msg_send![self, meshBindings] };
        bindings.to_vec().into_boxed_slice()
    }

    /// The deprecated vertex-stage argument reflection.
    #[deprecated(note = "use vertex_bindings")]
    pub fn vertex_arguments(&self) -> Option<Box<[Retained<MTLArgument>]>> {
        let arguments: Option<Retained<NSArray<MTLArgument>>> = unsafe { msg_send![self, vertexArguments] };
        arguments.map(|arguments| arguments.to_vec().into_boxed_slice())
    }

    /// The deprecated fragment-stage argument reflection.
    #[deprecated(note = "use fragment_bindings")]
    pub fn fragment_arguments(&self) -> Option<Box<[Retained<MTLArgument>]>> {
        let arguments: Option<Retained<NSArray<MTLArgument>>> = unsafe { msg_send![self, fragmentArguments] };
        arguments.map(|arguments| arguments.to_vec().into_boxed_slice())
    }

    /// The deprecated tile-stage argument reflection.
    #[deprecated(note = "use tile_bindings")]
    pub fn tile_arguments(&self) -> Option<Box<[Retained<MTLArgument>]>> {
        let arguments: Option<Retained<NSArray<MTLArgument>>> = unsafe { msg_send![self, tileArguments] };
        arguments.map(|arguments| arguments.to_vec().into_boxed_slice())
    }
}

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

    use super::MTLRenderPipelineReflection;
    use crate::{MTLArgument, MTLBinding};

    #[test]
    #[expect(deprecated, reason = "verifies the deprecated Rust-native compatibility API")]
    fn collection_methods_have_rust_native_signatures() {
        let _: fn(&MTLRenderPipelineReflection) -> Box<[Retained<ProtocolObject<dyn MTLBinding>>]> =
            MTLRenderPipelineReflection::vertex_bindings;
        let _: fn(&MTLRenderPipelineReflection) -> Option<Box<[Retained<MTLArgument>]>> =
            MTLRenderPipelineReflection::vertex_arguments;
    }
}