mtl-rs 0.2.0

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

use core::ops::Range;

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

use crate::{MTLIndirectComputeCommand, MTLIndirectRenderCommand, MTLResource, types::MTLResourceID};

extern_protocol!(
    /// Bridged protocol for `MTLIndirectCommandBuffer`.
    ///
    /// Availability: macOS 10.14+, iOS 12.0+
    pub unsafe trait MTLIndirectCommandBuffer: MTLResource {
        #[unsafe(method(size))]
        #[unsafe(method_family = none)]
        fn size(&self) -> usize;

        /// Handle of the GPU resource suitable for storing in an Argument Buffer.
        ///
        /// Availability: macOS 13.0+, iOS 16.0+
        #[unsafe(method(gpuResourceID))]
        #[unsafe(method_family = none)]
        fn gpu_resource_id(&self) -> MTLResourceID;

        /// Returns the render command at `command_index`.
        ///
        /// `command_index` needs to be less than [`size`](Self::size).
        #[unsafe(method(indirectRenderCommandAtIndex:))]
        #[unsafe(method_family = none)]
        fn indirect_render_command_at_index(
            &self,
            command_index: usize,
        ) -> Retained<ProtocolObject<dyn MTLIndirectRenderCommand>>;

        /// Returns the compute command at `command_index`.
        ///
        /// `command_index` needs to be less than [`size`](Self::size).
        #[unsafe(method(indirectComputeCommandAtIndex:))]
        #[unsafe(method_family = none)]
        fn indirect_compute_command_at_index(
            &self,
            command_index: usize,
        ) -> Retained<ProtocolObject<dyn MTLIndirectComputeCommand>>;
    }
);

pub trait MTLIndirectCommandBufferExt: MTLIndirectCommandBuffer + Message {
    /// Resets commands in `range`.
    ///
    /// `range` needs to lie within the command buffer's
    /// [`size`](MTLIndirectCommandBuffer::size).
    fn reset_with_range(
        &self,
        range: Range<usize>,
    ) where
        Self: Sized,
    {
        let range = NSRange::from(range);
        unsafe {
            let _: () = msg_send![self, resetWithRange: range];
        }
    }
}

impl<T: MTLIndirectCommandBuffer + Message> MTLIndirectCommandBufferExt for T {}