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

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

use super::visibility_options::MTL4VisibilityOptions;
use crate::*;

extern_protocol!(
    /// An encoder that writes GPU commands into a command buffer.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4commandencoder?language=objc)
    pub unsafe trait MTL4CommandEncoder: NSObjectProtocol {
        /// Returns the command buffer that is currently encoding commands.
        ///
        /// This property may return undefined results if you call it after calling ``endEncoding``.
        #[unsafe(method(commandBuffer))]
        #[unsafe(method_family = none)]
        fn command_buffer(&self) -> Option<Retained<ProtocolObject<dyn MTL4CommandBuffer>>>;

        /// Encodes a consumer barrier on work you commit to the same command queue.
        #[unsafe(method(barrierAfterQueueStages:beforeStages:visibilityOptions:))]
        #[unsafe(method_family = none)]
        fn barrier_after_queue_stages_before_stages_visibility_options(
            &self,
            after_queue_stages: MTLRenderStages,
            before_stages: MTLRenderStages,
            visibility_options: MTL4VisibilityOptions,
        );

        /// Encodes a producer barrier on work committed to the same command queue.
        #[unsafe(method(barrierAfterStages:beforeQueueStages:visibilityOptions:))]
        #[unsafe(method_family = none)]
        fn barrier_after_stages_before_queue_stages_visibility_options(
            &self,
            after_stages: MTLRenderStages,
            before_queue_stages: MTLRenderStages,
            visibility_options: MTL4VisibilityOptions,
        );

        /// Encodes an intra-pass barrier.
        #[unsafe(method(barrierAfterEncoderStages:beforeEncoderStages:visibilityOptions:))]
        #[unsafe(method_family = none)]
        fn barrier_after_encoder_stages_before_encoder_stages_visibility_options(
            &self,
            after_encoder_stages: MTLRenderStages,
            before_encoder_stages: MTLRenderStages,
            visibility_options: MTL4VisibilityOptions,
        );

        /// Encodes a command to update a GPU fence.
        #[unsafe(method(updateFence:afterEncoderStages:))]
        #[unsafe(method_family = none)]
        fn update_fence_after_encoder_stages(
            &self,
            fence: &ProtocolObject<dyn MTLFence>,
            after_encoder_stages: MTLRenderStages,
        );

        /// Encodes a command to wait on a GPU fence.
        #[unsafe(method(waitForFence:beforeEncoderStages:))]
        #[unsafe(method_family = none)]
        fn wait_for_fence_before_encoder_stages(
            &self,
            fence: &ProtocolObject<dyn MTLFence>,
            before_encoder_stages: MTLRenderStages,
        );

        /// Pops the latest debug group string from this encoder's stack of debug groups.
        #[unsafe(method(popDebugGroup))]
        #[unsafe(method_family = none)]
        fn pop_debug_group(&self);

        /// Declares that all command generation from this encoder is complete.
        #[unsafe(method(endEncoding))]
        #[unsafe(method_family = none)]
        fn end_encoding(&self);
    }
);

#[allow(unused)]
pub trait MTL4CommandEncoderExt: MTL4CommandEncoder + Message {
    /// Provides an optional label to assign to the command encoder for debug purposes.
    fn label(&self) -> Option<String>;
    /// Setter for label.
    fn set_label(
        &self,
        label: Option<&str>,
    );
    /// Inserts a debug signpost.
    fn insert_debug_signpost(
        &self,
        signpost: &str,
    );
    /// Pushes a debug group.
    fn push_debug_group(
        &self,
        label: &str,
    );
}

impl MTL4CommandEncoderExt for ProtocolObject<dyn MTL4CommandEncoder> {
    fn label(&self) -> Option<String> {
        let s: Option<Retained<NSString>> = unsafe { msg_send![self, label] };
        s.map(|v| v.to_string())
    }

    fn set_label(
        &self,
        label: Option<&str>,
    ) {
        unsafe {
            let _: () = msg_send![self, setLabel: label.map(NSString::from_str).as_deref()];
        }
    }

    fn insert_debug_signpost(
        &self,
        signpost: &str,
    ) {
        unsafe {
            let _: () = msg_send![self, insertDebugSignpost: &*NSString::from_str(signpost)];
        }
    }

    fn push_debug_group(
        &self,
        label: &str,
    ) {
        unsafe {
            let _: () = msg_send![self, pushDebugGroup: &*NSString::from_str(label)];
        }
    }
}