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::{NSObjectProtocol, NSRange, NSString};

use crate::{MTLDevice, MTLResourceID};

extern_protocol!(
    /// Contains views over resources of a specific type, and allows you to manage those views.
    pub unsafe trait MTLResourceViewPool: NSObjectProtocol {
        /// Obtains the resource ID corresponding to the resource view at index 0 in this resource view pool.
        #[unsafe(method(baseResourceID))]
        #[unsafe(method_family = none)]
        fn base_resource_id(&self) -> MTLResourceID;

        /// Queries the number of resource views that this pool contains.
        #[unsafe(method(resourceViewCount))]
        #[unsafe(method_family = none)]
        fn resource_view_count(&self) -> usize;

        /// Obtains a reference to the GPU device this pool belongs to.
        #[unsafe(method(device))]
        #[unsafe(method_family = none)]
        fn device(&self) -> Retained<ProtocolObject<dyn MTLDevice>>;
    }
);

#[allow(unused)]
pub trait MTLResourceViewPoolExt: MTLResourceViewPool + Message {
    /// Queries the optional debug label of this resource-view pool.
    fn label(&self) -> Option<String>
    where
        Self: Sized,
    {
        let label: Option<Retained<NSString>> = unsafe { msg_send![self, label] };
        label.map(|label| label.to_string())
    }

    /// Copies a range of resource views from a source view pool to a destination location in this view pool.
    ///
    /// `source_range` needs to be within `source_pool`, and the destination
    /// range beginning at `destination_index` needs to be within `self`.
    fn copy_resource_views_from_pool(
        &self,
        source_pool: &ProtocolObject<dyn MTLResourceViewPool>,
        source_range: Range<usize>,
        destination_index: usize,
    ) -> MTLResourceID
    where
        Self: Sized,
    {
        let source_range = NSRange::from(source_range);
        unsafe {
            msg_send![
                self,
                copyResourceViewsFromPool: source_pool,
                sourceRange: source_range,
                destinationIndex: destination_index
            ]
        }
    }
}

impl<T: MTLResourceViewPool + Message> MTLResourceViewPoolExt for T {}