mtl-rs 0.2.2

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

use objc2::{Encode, Encoding, RefEncode};

/// Describes how a resource will be used by a shader through an argument buffer (from `MTLResourceUsage`).
///
/// Availability: macOS 10.13+, iOS 11.0+
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct MTLResourceUsage(pub usize);
bitflags::bitflags! {
    impl MTLResourceUsage: usize {
        const Read = 1<<0;
        const Write = 1<<1;
        #[deprecated(note = "use MTLResourceUsage::Read")]
        const Sample = 1<<2;
    }
}

unsafe impl Encode for MTLResourceUsage {
    const ENCODING: Encoding = usize::ENCODING;
}

unsafe impl RefEncode for MTLResourceUsage {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

/// Describes the types of resources that a barrier operates on (from `MTLBarrierScope`).
///
/// Availability: macOS 10.14+, iOS 12.0+
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct MTLBarrierScope(pub usize);
bitflags::bitflags! {
    impl MTLBarrierScope: usize {
        const Buffers = 1<<0;
        const Textures = 1<<1;
        /// Available on macOS and Mac Catalyst; unavailable on iOS.
        const RenderTargets = 1<<2;
    }
}

unsafe impl Encode for MTLBarrierScope {
    const ENCODING: Encoding = usize::ENCODING;
}

unsafe impl RefEncode for MTLBarrierScope {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

/// Describes stages of GPU work (from `MTLStages`).
///
/// Availability: macOS 26.0+, iOS 26.0+
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct MTLStages(pub usize);
bitflags::bitflags! {
    impl MTLStages: usize {
        const Vertex = 1<<0;
        const Fragment = 1<<1;
        const Tile = 1<<2;
        const Object = 1<<3;
        const Mesh = 1<<4;
        const ResourceState = 1<<26;
        const Dispatch = 1<<27;
        const Blit = 1<<28;
        const AccelerationStructure = 1<<29;
        const MachineLearning = 1<<30;
        const All = isize::MAX as usize;
    }
}

unsafe impl Encode for MTLStages {
    const ENCODING: Encoding = usize::ENCODING;
}

unsafe impl RefEncode for MTLStages {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

#[cfg(test)]
mod tests {
    use core::mem::{align_of, size_of};

    use super::*;

    #[test]
    fn option_sets_match_platform_nsuinteger_abi() {
        assert_eq!(size_of::<MTLResourceUsage>(), size_of::<usize>());
        assert_eq!(align_of::<MTLResourceUsage>(), align_of::<usize>());
        assert_eq!(size_of::<MTLBarrierScope>(), size_of::<usize>());
        assert_eq!(align_of::<MTLBarrierScope>(), align_of::<usize>());
        assert_eq!(size_of::<MTLStages>(), size_of::<usize>());
        assert_eq!(align_of::<MTLStages>(), align_of::<usize>());
    }

    #[test]
    #[allow(deprecated)]
    fn resource_usage_and_barrier_scope_bits_match_metal_values() {
        assert_eq!(MTLResourceUsage::Read.bits(), 1 << 0);
        assert_eq!(MTLResourceUsage::Write.bits(), 1 << 1);
        assert_eq!(MTLResourceUsage::Sample.bits(), 1 << 2);
        assert_eq!(MTLBarrierScope::Buffers.bits(), 1 << 0);
        assert_eq!(MTLBarrierScope::Textures.bits(), 1 << 1);
        assert_eq!(MTLBarrierScope::RenderTargets.bits(), 1 << 2);
    }

    #[test]
    fn stage_masks_match_metal_values() {
        assert_eq!(MTLStages::Vertex.bits(), 1 << 0);
        assert_eq!(MTLStages::Fragment.bits(), 1 << 1);
        assert_eq!(MTLStages::Tile.bits(), 1 << 2);
        assert_eq!(MTLStages::Object.bits(), 1 << 3);
        assert_eq!(MTLStages::Mesh.bits(), 1 << 4);
        assert_eq!(MTLStages::ResourceState.bits(), 1 << 26);
        assert_eq!(MTLStages::Dispatch.bits(), 1 << 27);
        assert_eq!(MTLStages::Blit.bits(), 1 << 28);
        assert_eq!(MTLStages::AccelerationStructure.bits(), 1 << 29);
        assert_eq!(MTLStages::MachineLearning.bits(), 1 << 30);
        assert_eq!(MTLStages::All.bits(), isize::MAX as usize);
    }
}