mtl-rs 0.2.1

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
121
122
123
124
125
126

use objc2_foundation::NSString;

/// A common counter name that has similar meaning across Metal implementations.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum MTLCommonCounter {
    Timestamp,
    TessellationInputPatches,
    VertexInvocations,
    PostTessellationVertexInvocations,
    ClipperInvocations,
    ClipperPrimitivesOut,
    FragmentInvocations,
    FragmentsPassed,
    ComputeKernelInvocations,
    TotalCycles,
    VertexCycles,
    TessellationCycles,
    PostTessellationVertexCycles,
    FragmentCycles,
    RenderTargetWriteCycles,
}

impl MTLCommonCounter {
    /// Returns Metal's platform-defined string for this counter.
    pub fn name(self) -> String {
        let name = unsafe {
            match self {
                Self::Timestamp => MTL_COMMON_COUNTER_TIMESTAMP,
                Self::TessellationInputPatches => MTL_COMMON_COUNTER_TESSELLATION_INPUT_PATCHES,
                Self::VertexInvocations => MTL_COMMON_COUNTER_VERTEX_INVOCATIONS,
                Self::PostTessellationVertexInvocations => MTL_COMMON_COUNTER_POST_TESSELLATION_VERTEX_INVOCATIONS,
                Self::ClipperInvocations => MTL_COMMON_COUNTER_CLIPPER_INVOCATIONS,
                Self::ClipperPrimitivesOut => MTL_COMMON_COUNTER_CLIPPER_PRIMITIVES_OUT,
                Self::FragmentInvocations => MTL_COMMON_COUNTER_FRAGMENT_INVOCATIONS,
                Self::FragmentsPassed => MTL_COMMON_COUNTER_FRAGMENTS_PASSED,
                Self::ComputeKernelInvocations => MTL_COMMON_COUNTER_COMPUTE_KERNEL_INVOCATIONS,
                Self::TotalCycles => MTL_COMMON_COUNTER_TOTAL_CYCLES,
                Self::VertexCycles => MTL_COMMON_COUNTER_VERTEX_CYCLES,
                Self::TessellationCycles => MTL_COMMON_COUNTER_TESSELLATION_CYCLES,
                Self::PostTessellationVertexCycles => MTL_COMMON_COUNTER_POST_TESSELLATION_VERTEX_CYCLES,
                Self::FragmentCycles => MTL_COMMON_COUNTER_FRAGMENT_CYCLES,
                Self::RenderTargetWriteCycles => MTL_COMMON_COUNTER_RENDER_TARGET_WRITE_CYCLES,
            }
        };
        name.to_string()
    }
}

/// A common counter-set name.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum MTLCommonCounterSet {
    Timestamp,
    StageUtilization,
    Statistic,
}

impl MTLCommonCounterSet {
    /// Returns Metal's platform-defined string for this counter set.
    pub fn name(self) -> String {
        let name = unsafe {
            match self {
                Self::Timestamp => MTL_COMMON_COUNTER_SET_TIMESTAMP,
                Self::StageUtilization => MTL_COMMON_COUNTER_SET_STAGE_UTILIZATION,
                Self::Statistic => MTL_COMMON_COUNTER_SET_STATISTIC,
            }
        };
        name.to_string()
    }
}

unsafe extern "C" {
    #[link_name = "MTLCommonCounterTimestamp"]
    static MTL_COMMON_COUNTER_TIMESTAMP: &'static NSString;
    #[link_name = "MTLCommonCounterTessellationInputPatches"]
    static MTL_COMMON_COUNTER_TESSELLATION_INPUT_PATCHES: &'static NSString;
    #[link_name = "MTLCommonCounterVertexInvocations"]
    static MTL_COMMON_COUNTER_VERTEX_INVOCATIONS: &'static NSString;
    #[link_name = "MTLCommonCounterPostTessellationVertexInvocations"]
    static MTL_COMMON_COUNTER_POST_TESSELLATION_VERTEX_INVOCATIONS: &'static NSString;
    #[link_name = "MTLCommonCounterClipperInvocations"]
    static MTL_COMMON_COUNTER_CLIPPER_INVOCATIONS: &'static NSString;
    #[link_name = "MTLCommonCounterClipperPrimitivesOut"]
    static MTL_COMMON_COUNTER_CLIPPER_PRIMITIVES_OUT: &'static NSString;
    #[link_name = "MTLCommonCounterFragmentInvocations"]
    static MTL_COMMON_COUNTER_FRAGMENT_INVOCATIONS: &'static NSString;
    #[link_name = "MTLCommonCounterFragmentsPassed"]
    static MTL_COMMON_COUNTER_FRAGMENTS_PASSED: &'static NSString;
    #[link_name = "MTLCommonCounterComputeKernelInvocations"]
    static MTL_COMMON_COUNTER_COMPUTE_KERNEL_INVOCATIONS: &'static NSString;
    #[link_name = "MTLCommonCounterTotalCycles"]
    static MTL_COMMON_COUNTER_TOTAL_CYCLES: &'static NSString;
    #[link_name = "MTLCommonCounterVertexCycles"]
    static MTL_COMMON_COUNTER_VERTEX_CYCLES: &'static NSString;
    #[link_name = "MTLCommonCounterTessellationCycles"]
    static MTL_COMMON_COUNTER_TESSELLATION_CYCLES: &'static NSString;
    #[link_name = "MTLCommonCounterPostTessellationVertexCycles"]
    static MTL_COMMON_COUNTER_POST_TESSELLATION_VERTEX_CYCLES: &'static NSString;
    #[link_name = "MTLCommonCounterFragmentCycles"]
    static MTL_COMMON_COUNTER_FRAGMENT_CYCLES: &'static NSString;
    #[link_name = "MTLCommonCounterRenderTargetWriteCycles"]
    static MTL_COMMON_COUNTER_RENDER_TARGET_WRITE_CYCLES: &'static NSString;

    #[link_name = "MTLCommonCounterSetTimestamp"]
    static MTL_COMMON_COUNTER_SET_TIMESTAMP: &'static NSString;
    #[link_name = "MTLCommonCounterSetStageUtilization"]
    static MTL_COMMON_COUNTER_SET_STAGE_UTILIZATION: &'static NSString;
    #[link_name = "MTLCommonCounterSetStatistic"]
    static MTL_COMMON_COUNTER_SET_STATISTIC: &'static NSString;
}

#[cfg(test)]
mod tests {
    use super::{MTLCommonCounter, MTLCommonCounterSet};

    #[test]
    fn counter_names_have_rust_string_signatures() {
        let _: fn(MTLCommonCounter) -> String = MTLCommonCounter::name;
    }

    #[test]
    fn counter_set_names_have_rust_string_signatures() {
        let _: fn(MTLCommonCounterSet) -> String = MTLCommonCounterSet::name;
    }
}