mtl-rs 0.1.9

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

use core::{ffi::c_void, ops::Range, ptr::NonNull};

use objc2::{
    extern_class, extern_conformance, extern_methods, msg_send,
    rc::{Allocated, Retained},
    runtime::NSObject,
};
use objc2_foundation::{CopyingHelper, NSCopying, NSObjectProtocol, NSRange, NSString};

use crate::MTLDataType;

extern_class!(
    /// Values for Metal function constants (bridged from `MTLFunctionConstantValues`).
    ///
    /// Availability: macOS 10.12+, iOS 10.0+
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct MTLFunctionConstantValues;
);

extern_conformance!(
    unsafe impl NSCopying for MTLFunctionConstantValues {}
);

unsafe impl CopyingHelper for MTLFunctionConstantValues {
    type Result = Self;
}

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

impl MTLFunctionConstantValues {
    extern_methods!(
        /// Set a single constant value by index.
        ///
        /// Safety: `value` must be a valid pointer to a value of the specified `type`.
        #[unsafe(method(setConstantValue:type:atIndex:))]
        #[unsafe(method_family = none)]
        pub fn set_constant_value_type_at_index(
            &self,
            value: NonNull<c_void>,
            r#type: MTLDataType,
            index: usize,
        );

        /// Reset all function constant values.
        #[unsafe(method(reset))]
        #[unsafe(method_family = none)]
        pub fn reset(&self);
    );
}

/// Methods declared on superclass `NSObject`.
impl MTLFunctionConstantValues {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub fn new() -> Retained<Self>;
    );

    /// Set a range of constant values by index range.
    ///
    /// Safety: `values` must be a valid pointer to an array of values of the specified `type` large enough to cover `range`.
    pub fn set_constant_values_type_with_range(
        &self,
        values: NonNull<c_void>,
        r#type: MTLDataType,
        range: Range<usize>,
    ) {
        unsafe {
            msg_send![
                self,
                setConstantValues: values,
                type: r#type,
                withRange: NSRange::from(range),
            ]
        }
    }

    /// Set a single constant value by name.
    ///
    /// Safety: `value` must be a valid pointer to a value of the specified `type`.
    pub fn set_constant_value_type_with_name(
        &self,
        value: NonNull<c_void>,
        r#type: MTLDataType,
        name: &str,
    ) {
        unsafe {
            msg_send![
                self,
                setConstantValue: value,
                type: r#type,
                withName: &*NSString::from_str(name),
            ]
        }
    }
}