mtl-rs 0.1.7

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

use objc2::{
    extern_class, extern_conformance, extern_methods,
    rc::Retained,
    runtime::{NSObject, ProtocolObject},
};
use objc2_foundation::{CopyingHelper, NSCopying, NSObjectProtocol};

use super::{MTLLoadAction, MTLStoreAction, MTLStoreActionOptions};
use crate::MTLTexture;

extern_class!(
    /// Common attachment descriptor fields.
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct MTLRenderPassAttachmentDescriptor;
);

extern_conformance!(
    unsafe impl NSCopying for MTLRenderPassAttachmentDescriptor {}
);

unsafe impl CopyingHelper for MTLRenderPassAttachmentDescriptor {
    type Result = Self;
}

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

impl MTLRenderPassAttachmentDescriptor {
    extern_methods!(
        /// The texture object for this attachment.
        #[unsafe(method(texture))]
        #[unsafe(method_family = none)]
        pub fn texture(&self) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>;

        /// Setter for [`texture`][Self::texture].
        #[unsafe(method(setTexture:))]
        #[unsafe(method_family = none)]
        pub fn set_texture(
            &self,
            texture: Option<&ProtocolObject<dyn MTLTexture>>,
        );

        /// The mipmap level of the texture to be used for rendering. Default is zero.
        #[unsafe(method(level))]
        #[unsafe(method_family = none)]
        pub fn level(&self) -> usize;

        /// Setter for [`level`][Self::level].
        #[unsafe(method(setLevel:))]
        #[unsafe(method_family = none)]
        pub fn set_level(
            &self,
            level: usize,
        );

        /// The slice of the texture to be used for rendering. Default is zero.
        #[unsafe(method(slice))]
        #[unsafe(method_family = none)]
        pub fn slice(&self) -> usize;

        /// Setter for [`slice`][Self::slice].
        #[unsafe(method(setSlice:))]
        #[unsafe(method_family = none)]
        pub fn set_slice(
            &self,
            slice: usize,
        );

        /// The depth plane of the texture to be used for rendering. Default is zero.
        #[unsafe(method(depthPlane))]
        #[unsafe(method_family = none)]
        pub fn depth_plane(&self) -> usize;

        /// Setter for [`depth_plane`][Self::depth_plane].
        #[unsafe(method(setDepthPlane:))]
        #[unsafe(method_family = none)]
        pub fn set_depth_plane(
            &self,
            depth_plane: usize,
        );

        /// The action to be performed at the beginning of a render pass.
        #[unsafe(method(loadAction))]
        #[unsafe(method_family = none)]
        pub fn load_action(&self) -> MTLLoadAction;

        /// Setter for [`load_action`][Self::load_action].
        #[unsafe(method(setLoadAction:))]
        #[unsafe(method_family = none)]
        pub fn set_load_action(
            &self,
            load_action: MTLLoadAction,
        );

        /// The action to be performed at the end of a render pass.
        #[unsafe(method(storeAction))]
        #[unsafe(method_family = none)]
        pub fn store_action(&self) -> MTLStoreAction;

        /// Setter for [`store_action`][Self::store_action].
        #[unsafe(method(setStoreAction:))]
        #[unsafe(method_family = none)]
        pub fn set_store_action(
            &self,
            store_action: MTLStoreAction,
        );

        /// Optional configuration for the store action performed at the end of a render pass.
        #[unsafe(method(storeActionOptions))]
        #[unsafe(method_family = none)]
        pub fn store_action_options(&self) -> MTLStoreActionOptions;

        /// Setter for [`store_action_options`][Self::store_action_options].
        #[unsafe(method(setStoreActionOptions:))]
        #[unsafe(method_family = none)]
        pub fn set_store_action_options(
            &self,
            options: MTLStoreActionOptions,
        );
    );
}