cidre 0.16.0

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
104
105
106
107
108

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

#[cfg(feature = "dispatch")]
use crate::dispatch;

define_obj_type!(
    #[doc(alias = "MTLEvent")]
    pub Event(ns::Id)
);

impl Event {
    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<&ns::String>;
}

define_obj_type!(
    /// This class provides a simple interface for handling the dispatching of mtl::SharedEvent notifications from Metal.
    #[doc(alias = "MTLSharedEventListener")]
    pub SharedEventListener(ns::Id)
);

impl arc::A<SharedEventListener> {
    #[cfg(feature = "dispatch")]
    #[objc::msg_send(initWithDispatchQueue:)]
    pub fn init_with_dispatch_queue(self, queue: &dispatch::Queue) -> arc::R<SharedEventListener>;
}

/// A block of code invoked after a shareable event’s signal value equals or exceeds a given value.
pub type SharedEventNotificationBlock =
    blocks::EscBlock<fn(event: &mut mtl::SharedEvent, value: u64)>;

impl SharedEventListener {
    define_cls!(MTL_SHARED_EVENT_LISTENER);

    /// Creates a new shareable event listener with a specific dispatch queue.
    #[inline]
    #[cfg(feature = "dispatch")]
    pub fn with_dispatch_queue(queue: &dispatch::Queue) -> arc::R<Self> {
        Self::alloc().init_with_dispatch_queue(queue)
    }

    #[cfg(feature = "dispatch")]
    #[objc::msg_send(dispatchQueue)]
    pub fn dispatch_queue(&self) -> arc::R<dispatch::Queue>;
}

define_obj_type!(
    /// mtl::SharedEventHandle objects may be passed between processes via XPC connections and then used to recreate
    /// a mtl::SharedEvent via an existing mtl::Device.
    #[doc(alias = "MTLSharedEventHandle")]
    pub SharedEventHandle(ns::Id)
);

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

define_obj_type!(
    /// An object you use to synchronize access to Metal resources across multiple CPUs, GPUs, and processes.
    #[doc(alias = "MTLSharedEvent")]
    pub SharedEvent(Event)
);

impl SharedEvent {
    /// When the event's signaled value reaches value or higher, invoke the block on the dispatch queue owned by the listener.
    #[objc::msg_send(notifyListener:atValue:block:)]
    pub fn notify_listener_at_block(
        &self,
        listener: &mtl::SharedEventListener,
        at_value: u64,
        block: &mut SharedEventNotificationBlock,
    );

    pub fn notify_listener_at(
        &self,
        listener: &mtl::SharedEventListener,
        at_value: u64,
        block: impl FnMut(&mut mtl::SharedEvent, u64) + Send + 'static,
    ) {
        let mut block = SharedEventNotificationBlock::new2(block);
        self.notify_listener_at_block(listener, at_value, &mut block);
    }

    /// Convenience method for creating a shared event handle that may be passed to other processes via XPC.
    #[objc::msg_send(newSharedEventHandle)]
    pub fn new_shared_event_handle(&self) -> arc::R<mtl::SharedEventHandle>;

    /// Synchronously wait for the signaledValue to be greater than or equal to 'value', with a timeout
    /// specified in milliseconds. Returns true if the value was signaled before the timeout, otherwise NO.
    #[objc::msg_send(waitUntilSignaledValue:timeoutMS:)]
    pub fn wait_until_signaled_value(&self, value: u64, timeout_ms: u64) -> bool;

    #[objc::msg_send(signaledValue)]
    pub fn signaled_value(&self) -> u64;

    #[objc::msg_send(setSignaledValue:)]
    pub fn set_signaled_value(&self, val: u64);
}

unsafe extern "C" {
    static MTL_SHARED_EVENT_LISTENER: &'static objc::Class<SharedEventListener>;
}