apple-mps 0.2.4

Safe Rust bindings for Apple's MetalPerformanceShaders framework on macOS, backed by a Swift bridge
Documentation 
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

use crate::ffi;
use core::ffi::c_void;
use core::ptr;

macro_rules! opaque_generated_handle {
    ($name:ident) => {
        pub struct $name {
            ptr: *mut c_void,
        }

        unsafe impl Send for $name {}
        unsafe impl Sync for $name {}

        impl Drop for $name {
            fn drop(&mut self) {
                if !self.ptr.is_null() {
                    unsafe { ffi::mps_object_release(self.ptr) };
                    self.ptr = ptr::null_mut();
                }
            }
        }

        impl $name {
            #[must_use]
            pub const fn as_ptr(&self) -> *mut c_void {
                self.ptr
            }

            /// # Safety
            ///
            /// `ptr` must be a valid Objective-C object of the matching MPS type or protocol.
            #[must_use]
            pub unsafe fn retained_from_raw(ptr: *mut c_void) -> Option<Self> {
                let retained = unsafe { ffi::mps_object_retain(ptr) };
                if retained.is_null() {
                    None
                } else {
                    Some(Self { ptr: retained })
                }
            }
        }
    };
}

macro_rules! raw_value_type {
    ($name:ident, $raw:ty) => {
        #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
        #[repr(transparent)]
        pub struct $name(pub $raw);

        impl $name {
            #[must_use]
            pub const fn from_raw(raw: $raw) -> Self {
                Self(raw)
            }

            #[must_use]
            pub const fn as_raw(self) -> $raw {
                self.0
            }
        }

        impl From<$raw> for $name {
            fn from(value: $raw) -> Self {
                Self(value)
            }
        }

        impl From<$name> for $raw {
            fn from(value: $name) -> Self {
                value.0
            }
        }
    };
}

raw_value_type!(MatrixRandomDistribution, usize);
raw_value_type!(MatrixDecompositionStatus, i32);
opaque_generated_handle!(MatrixBatchNormalization);
opaque_generated_handle!(MatrixBatchNormalizationGradient);
opaque_generated_handle!(MatrixBinaryKernel);
opaque_generated_handle!(MatrixCopy);
opaque_generated_handle!(MatrixCopyDescriptor);
opaque_generated_handle!(MatrixCopyToImage);
opaque_generated_handle!(MatrixDecompositionCholesky);
opaque_generated_handle!(MatrixDecompositionLU);
opaque_generated_handle!(MatrixFindTopK);
opaque_generated_handle!(MatrixFullyConnected);
opaque_generated_handle!(MatrixFullyConnectedGradient);
opaque_generated_handle!(MatrixLogSoftMax);
opaque_generated_handle!(MatrixLogSoftMaxGradient);
opaque_generated_handle!(MatrixNeuron);
opaque_generated_handle!(MatrixNeuronGradient);
opaque_generated_handle!(MatrixRandom);
opaque_generated_handle!(MatrixRandomDistributionDescriptor);
opaque_generated_handle!(MatrixRandomMTGP32);
opaque_generated_handle!(MatrixRandomPhilox);
opaque_generated_handle!(MatrixSoftMax);
opaque_generated_handle!(MatrixSoftMaxGradient);
opaque_generated_handle!(MatrixSolveCholesky);
opaque_generated_handle!(MatrixSolveLU);
opaque_generated_handle!(MatrixSolveTriangular);
opaque_generated_handle!(MatrixSum);
opaque_generated_handle!(MatrixUnaryKernel);
opaque_generated_handle!(MatrixVectorMultiplication);
opaque_generated_handle!(TemporaryMatrix);
opaque_generated_handle!(TemporaryVector);