objc2-quartz-core 0.3.2

Bindings to the QuartzCore/CoreAnimation framework
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
#[cfg(feature = "objc2-core-foundation")]
use objc2_core_foundation::*;
#[cfg(feature = "objc2-core-video")]
use objc2_core_video::*;
use objc2_foundation::*;
#[cfg(feature = "objc2-metal")]
use objc2_metal::*;

use crate::*;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/quartzcore/carenderer?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct CARenderer;
);

extern_conformance!(
    unsafe impl NSObjectProtocol for CARenderer {}
);

impl CARenderer {
    extern_methods!(
        /// # Safety
        ///
        /// - `ctx` must be a valid pointer.
        /// - `dict` generic should be of the correct type.
        #[deprecated = "OpenGL is deprecated. (Define GL_SILENCE_DEPRECATION to silence these warnings)"]
        #[unsafe(method(rendererWithCGLContext:options:))]
        #[unsafe(method_family = none)]
        pub unsafe fn rendererWithCGLContext_options(
            ctx: NonNull<c_void>,
            dict: Option<&NSDictionary>,
        ) -> Retained<CARenderer>;

        #[cfg(feature = "objc2-metal")]
        /// # Safety
        ///
        /// - `tex` may need to be synchronized.
        /// - `tex` may be unretained, you must ensure it is kept alive while in use.
        /// - `dict` generic should be of the correct type.
        #[unsafe(method(rendererWithMTLTexture:options:))]
        #[unsafe(method_family = none)]
        pub unsafe fn rendererWithMTLTexture_options(
            tex: &ProtocolObject<dyn MTLTexture>,
            dict: Option<&NSDictionary>,
        ) -> Retained<CARenderer>;

        #[cfg(feature = "CALayer")]
        #[unsafe(method(layer))]
        #[unsafe(method_family = none)]
        pub fn layer(&self) -> Option<Retained<CALayer>>;

        #[cfg(feature = "CALayer")]
        /// Setter for [`layer`][Self::layer].
        #[unsafe(method(setLayer:))]
        #[unsafe(method_family = none)]
        pub fn setLayer(&self, layer: Option<&CALayer>);

        #[cfg(feature = "objc2-core-foundation")]
        #[unsafe(method(bounds))]
        #[unsafe(method_family = none)]
        pub fn bounds(&self) -> CGRect;

        #[cfg(feature = "objc2-core-foundation")]
        /// Setter for [`bounds`][Self::bounds].
        #[unsafe(method(setBounds:))]
        #[unsafe(method_family = none)]
        pub fn setBounds(&self, bounds: CGRect);

        #[cfg(all(feature = "objc2-core-foundation", feature = "objc2-core-video"))]
        /// # Safety
        ///
        /// `ts` must be a valid pointer or null.
        #[unsafe(method(beginFrameAtTime:timeStamp:))]
        #[unsafe(method_family = none)]
        pub unsafe fn beginFrameAtTime_timeStamp(&self, t: CFTimeInterval, ts: *mut CVTimeStamp);

        #[cfg(feature = "objc2-core-foundation")]
        #[unsafe(method(updateBounds))]
        #[unsafe(method_family = none)]
        pub fn updateBounds(&self) -> CGRect;

        #[cfg(feature = "objc2-core-foundation")]
        #[unsafe(method(addUpdateRect:))]
        #[unsafe(method_family = none)]
        pub fn addUpdateRect(&self, r: CGRect);

        #[unsafe(method(render))]
        #[unsafe(method_family = none)]
        pub fn render(&self);

        #[cfg(feature = "objc2-core-foundation")]
        #[unsafe(method(nextFrameTime))]
        #[unsafe(method_family = none)]
        pub fn nextFrameTime(&self) -> CFTimeInterval;

        #[unsafe(method(endFrame))]
        #[unsafe(method_family = none)]
        pub fn endFrame(&self);

        #[cfg(feature = "objc2-metal")]
        /// # Safety
        ///
        /// - `tex` may need to be synchronized.
        /// - `tex` may be unretained, you must ensure it is kept alive while in use.
        #[unsafe(method(setDestination:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setDestination(&self, tex: &ProtocolObject<dyn MTLTexture>);
    );
}

/// Methods declared on superclass `NSObject`.
impl CARenderer {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub fn new() -> Retained<Self>;
    );
}

impl DefaultRetained for CARenderer {
    #[inline]
    fn default_retained() -> Retained<Self> {
        Self::new()
    }
}

extern "C" {
    /// Options for the renderer options dictionary. *
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/quartzcore/kcarenderercolorspace?language=objc)
    pub static kCARendererColorSpace: &'static NSString;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/quartzcore/kcarenderermetalcommandqueue?language=objc)
    pub static kCARendererMetalCommandQueue: &'static NSString;
}