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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

use objc2::{Encode, Encoding, RefEncode};
use objc2_foundation::{NSErrorDomain, NSErrorUserInfoKey};

unsafe extern "C" {
    /// Error domain for NSError objects produced by MTLCommandBuffer.
    static MTLCommandBufferErrorDomain: &'static NSErrorDomain;

    /// Key whose value contains encoder execution details in a command-buffer error.
    static MTLCommandBufferEncoderInfoErrorKey: &'static NSErrorUserInfoKey;
}

#[inline]
pub fn command_buffer_error_domain() -> String {
    unsafe { MTLCommandBufferErrorDomain }.to_string()
}

/// Returns the user-info key for command-buffer encoder execution details.
#[inline]
pub fn command_buffer_encoder_info_error_key() -> String {
    unsafe { MTLCommandBufferEncoderInfoErrorKey }.to_string()
}

/// Error codes that can be found in MTLCommandBuffer.error.
///
/// Availability: macOS 10.11+, iOS 8.0+
#[repr(u64)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[allow(unused)]
pub enum MTLCommandBufferError {
    None = 0,
    Internal = 1,
    Timeout = 2,
    PageFault = 3,
    AccessRevoked = 4,
    NotPermitted = 7,
    OutOfMemory = 8,
    InvalidResource = 9,
    Memoryless = 10,
    #[deprecated(note = "this error cannot occur on Apple Silicon")]
    DeviceRemoved = 11,
    StackOverflow = 12,
}

impl MTLCommandBufferError {
    /// Deprecated name for [`Self::AccessRevoked`].
    #[allow(non_upper_case_globals)]
    #[deprecated(note = "use AccessRevoked")]
    pub const Blacklisted: Self = Self::AccessRevoked;
}

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

bitflags::bitflags! {
    #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
    pub struct MTLCommandBufferErrorOption: u64 { const None = 0; const EncoderExecutionStatus = 1<<0; }
}
unsafe impl Encode for MTLCommandBufferErrorOption {
    const ENCODING: Encoding = u64::ENCODING;
}
unsafe impl RefEncode for MTLCommandBufferErrorOption {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

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

    #[test]
    #[allow(deprecated)]
    fn deprecated_blacklisted_error_matches_access_revoked() {
        assert_eq!(MTLCommandBufferError::Blacklisted, MTLCommandBufferError::AccessRevoked);
    }

    #[test]
    fn error_option_bits_match_metal_header_values() {
        assert_eq!(MTLCommandBufferErrorOption::None.bits(), 0);
        assert_eq!(MTLCommandBufferErrorOption::EncoderExecutionStatus.bits(), 1);
    }
}