cidre 0.11.4

Apple frameworks bindings for rust
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

use crate::{api, arc, define_mtl, define_obj_type, mtl, ns, objc};

define_obj_type!(
    /// A serial queue of command buffers to be executed by the device.
    #[doc(alias = "MTLCommandQueue")]
    pub CmdQueue(ns::Id)
);

impl CmdQueue {
    define_mtl!(set_label);

    #[objc::msg_send(device)]
    pub fn device(&self) -> arc::R<mtl::Device>;

    #[objc::msg_send(label)]
    pub fn label(&self) -> Option<arc::R<ns::String>>;

    #[objc::msg_send(commandBuffer)]
    pub fn new_cmd_buf(&self) -> Option<arc::R<mtl::CmdBuf>>;

    #[objc::msg_send(commandBufferWithUnretainedReferences)]
    pub fn new_cmd_buf_unretained_refs(&self) -> Option<arc::R<mtl::CmdBuf>>;

    /// Marks the residency set as part of the command queue execution.
    ///
    /// This ensures that the residency set is resident during execution of all
    /// the command buffers within the queue.
    #[objc::msg_send(addResidencySet:)]
    #[api::available(
        macos = 15.0,
        ios = 18.0,
        maccatalyst = 18.0,
        tvos = 18.0,
        visionos = 2.0
    )]
    pub fn add_residency_set(&self, set: &mtl::ResidencySet);

    #[objc::msg_send(addResidencySets:count:)]
    #[api::available(
        macos = 15.0,
        ios = 18.0,
        maccatalyst = 18.0,
        tvos = 18.0,
        visionos = 2.0
    )]
    pub unsafe fn add_residency_sets_count(&self, sets: *const &mtl::ResidencySet, count: usize);

    /// Marks the residency sets as part of the command queue execution.
    ///
    /// This ensures that the residency sets are resident during execution of all
    /// the command buffers within the queue.
    #[inline]
    #[api::available(
        macos = 15.0,
        ios = 18.0,
        maccatalyst = 18.0,
        tvos = 18.0,
        visionos = 2.0
    )]
    pub fn add_residency_sets(&self, sets: &[&mtl::ResidencySet]) {
        unsafe { self.add_residency_sets_count(sets.as_ptr(), sets.len()) }
    }

    /// Removes the residency set from the command queue execution.
    ///
    /// This ensures that only the remaining residency sets are resident during execution
    /// of all the command buffers within the queue.
    #[objc::msg_send(removeResidencySet:)]
    #[api::available(
        macos = 15.0,
        ios = 18.0,
        maccatalyst = 18.0,
        tvos = 18.0,
        visionos = 2.0
    )]
    pub fn remove_residency_set(&self, set: &mtl::ResidencySet);

    #[objc::msg_send(removeResidencySets:count:)]
    #[api::available(
        macos = 15.0,
        ios = 18.0,
        maccatalyst = 18.0,
        tvos = 18.0,
        visionos = 2.0
    )]
    pub unsafe fn remove_residency_sets_count(&self, sets: *const &mtl::ResidencySet, count: usize);

    /// Removes the residency sets from the command queue execution.
    ///
    /// This ensures that only the remaining residency sets are resident during execution
    /// of all the command buffers within the queue.
    #[inline]
    #[api::available(
        macos = 15.0,
        ios = 18.0,
        maccatalyst = 18.0,
        tvos = 18.0,
        visionos = 2.0
    )]
    pub fn remove_residency_sets(&self, sets: &[&mtl::ResidencySet]) {
        unsafe { self.remove_residency_sets_count(sets.as_ptr(), sets.len()) }
    }
}