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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
use objc2::{
extern_class, extern_conformance, extern_methods,
rc::{Allocated, Retained},
};
use objc2_foundation::{CopyingHelper, NSCopying, NSObject, NSObjectProtocol, NSUInteger};
use crate::*;
extern_class!(
/// Descriptor for an "indirect" instance acceleration structure that allows providing the instance count and
/// motion transform count indirectly, through buffer references.
///
/// An instance acceleration structure references other acceleration structures, and provides the ability to
/// "instantiate" them multiple times, each one with potentially a different transformation matrix.
///
/// You specify the properties of the instances in the acceleration structure this descriptor builds by providing a
/// buffer of `structs` via its ``instanceDescriptorBuffer`` property.
///
/// Compared to ``MTL4InstanceAccelerationStructureDescriptor``, this descriptor allows you to provide the number
/// of instances it references indirectly through a buffer reference, as well as the number of motion transforms.
///
/// This enables you to determine these counts indirectly in the GPU timeline via a compute pipeline.
/// Metal needs only to know the maximum possible number of instances and motion transforms to support,
/// which you specify via the ``maxInstanceCount`` and ``maxMotionTransformCount`` properties.
///
/// Use a ``MTLResidencySet`` to mark residency of all buffers and acceleration structures this descriptor references
/// when you build this acceleration structure.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4indirectinstanceaccelerationstructuredescriptor?language=objc)
#[unsafe(super(MTL4AccelerationStructureDescriptor, MTLAccelerationStructureDescriptor, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTL4IndirectInstanceAccelerationStructureDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTL4IndirectInstanceAccelerationStructureDescriptor {}
);
unsafe impl CopyingHelper for MTL4IndirectInstanceAccelerationStructureDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4IndirectInstanceAccelerationStructureDescriptor {}
);
impl MTL4IndirectInstanceAccelerationStructureDescriptor {
extern_methods!(
/// Assigns a reference to a buffer containing instance descriptors for acceleration structures to reference.
///
/// This buffer conceptually represents an array of instance data. The specific format for the structs that comprise
/// each entry depends on the value of the ``instanceDescriptorType`` property.
///
/// You are responsible for ensuring the buffer address the range contains is not zero.
#[unsafe(method(instanceDescriptorBuffer))]
#[unsafe(method_family = none)]
pub fn instance_descriptor_buffer(&self) -> MTL4BufferRange;
/// Setter for [`instanceDescriptorBuffer`][Self::instanceDescriptorBuffer].
#[unsafe(method(setInstanceDescriptorBuffer:))]
#[unsafe(method_family = none)]
pub fn set_instance_descriptor_buffer(
&self,
instance_descriptor_buffer: MTL4BufferRange,
);
/// Sets the stride, in bytes, between instance descriptors in the instance descriptor buffer.
///
/// You are responsible for ensuring this stride is at least the size of the structure type corresponding to the instance
/// descriptor type and a multiple of 4 bytes.
///
/// Defaults to `0`, indicating the instance descriptors are tightly packed.
#[unsafe(method(instanceDescriptorStride))]
#[unsafe(method_family = none)]
pub fn instance_descriptor_stride(&self) -> NSUInteger;
/// Setter for [`instanceDescriptorStride`][Self::instanceDescriptorStride].
#[unsafe(method(setInstanceDescriptorStride:))]
#[unsafe(method_family = none)]
pub fn set_instance_descriptor_stride(
&self,
instance_descriptor_stride: NSUInteger,
);
/// Controls the maximum number of instance descriptors the instance descriptor buffer can reference.
///
/// You are responsible for ensuring that the final number of instances at build time, which you provide indirectly
/// via a buffer reference in ``instanceCountBuffer``, is less than or equal to this number.
#[unsafe(method(maxInstanceCount))]
#[unsafe(method_family = none)]
pub fn max_instance_count(&self) -> NSUInteger;
/// Setter for [`maxInstanceCount`][Self::maxInstanceCount].
#[unsafe(method(setMaxInstanceCount:))]
#[unsafe(method_family = none)]
pub fn set_max_instance_count(
&self,
max_instance_count: NSUInteger,
);
/// Provides a reference to a buffer containing the number of instances in the instance descriptor buffer, formatted as a
/// 32-bit unsigned integer.
///
/// You are responsible for ensuring that the final number of instances at build time, which you provide indirectly
/// via this buffer reference , is less than or equal to the value of property ``maxInstanceCount``.
#[unsafe(method(instanceCountBuffer))]
#[unsafe(method_family = none)]
pub fn instance_count_buffer(&self) -> MTL4BufferRange;
/// Setter for [`instanceCountBuffer`][Self::instanceCountBuffer].
#[unsafe(method(setInstanceCountBuffer:))]
#[unsafe(method_family = none)]
pub fn set_instance_count_buffer(
&self,
instance_count_buffer: MTL4BufferRange,
);
/// Controls the type of instance descriptor that the instance descriptor buffer references.
///
/// This value determines the layout Metal expects for the structs the instance descriptor buffer contains.
///
/// Defaults to `MTLAccelerationStructureInstanceDescriptorTypeIndirect`. Valid values for this property are
/// `MTLAccelerationStructureInstanceDescriptorTypeIndirect` or `MTLAccelerationStructureInstanceDescriptorTypeIndirectMotion`.
#[unsafe(method(instanceDescriptorType))]
#[unsafe(method_family = none)]
pub fn instance_descriptor_type(&self) -> MTLAccelerationStructureInstanceDescriptorType;
/// Setter for [`instanceDescriptorType`][Self::instanceDescriptorType].
#[unsafe(method(setInstanceDescriptorType:))]
#[unsafe(method_family = none)]
pub fn set_instance_descriptor_type(
&self,
instance_descriptor_type: MTLAccelerationStructureInstanceDescriptorType,
);
/// A buffer containing transformation information for instance motion keyframes, formatted according
/// to the motion transform type.
///
/// Each instance can have a different number of keyframes that you configure via individual instance
/// descriptors.
///
/// You are responsible for ensuring the buffer address the range references is not zero when using motion instance descriptors.
#[unsafe(method(motionTransformBuffer))]
#[unsafe(method_family = none)]
pub fn motion_transform_buffer(&self) -> MTL4BufferRange;
/// Setter for [`motionTransformBuffer`][Self::motionTransformBuffer].
#[unsafe(method(setMotionTransformBuffer:))]
#[unsafe(method_family = none)]
pub fn set_motion_transform_buffer(
&self,
motion_transform_buffer: MTL4BufferRange,
);
/// Controls the maximum number of motion transforms in the motion transform buffer.
///
/// You are responsible for ensuring that final number of motion transforms at build time that the buffer
/// ``motionTransformCountBuffer`` references is less than or equal to this number.
#[unsafe(method(maxMotionTransformCount))]
#[unsafe(method_family = none)]
pub fn max_motion_transform_count(&self) -> NSUInteger;
/// Setter for [`maxMotionTransformCount`][Self::maxMotionTransformCount].
#[unsafe(method(setMaxMotionTransformCount:))]
#[unsafe(method_family = none)]
pub fn set_max_motion_transform_count(
&self,
max_motion_transform_count: NSUInteger,
);
/// Associates a buffer reference containing the number of motion transforms in the motion transform buffer, formatted as a
/// 32-bit unsigned integer.
///
/// You are responsible for ensuring that the final number of motion transforms at build time in the buffer this property
/// references is less than or equal to the value of property ``maxMotionTransformCount``.
#[unsafe(method(motionTransformCountBuffer))]
#[unsafe(method_family = none)]
pub fn motion_transform_count_buffer(&self) -> MTL4BufferRange;
/// Setter for [`motionTransformCountBuffer`][Self::motionTransformCountBuffer].
#[unsafe(method(setMotionTransformCountBuffer:))]
#[unsafe(method_family = none)]
pub fn set_motion_transform_count_buffer(
&self,
motion_transform_count_buffer: MTL4BufferRange,
);
/// Specifies the layout for the transformation matrices in the instance descriptor buffer and the motion transformation matrix buffer.
///
/// Metal interprets the value of this property as the layout for the buffers that both ``instanceDescriptorBuffer`` and
/// ``motionTransformBuffer`` reference.
///
/// Defaults to `MTLMatrixLayoutColumnMajor`.
#[unsafe(method(instanceTransformationMatrixLayout))]
#[unsafe(method_family = none)]
pub fn instance_transformation_matrix_layout(&self) -> MTLMatrixLayout;
/// Setter for [`instanceTransformationMatrixLayout`][Self::instanceTransformationMatrixLayout].
#[unsafe(method(setInstanceTransformationMatrixLayout:))]
#[unsafe(method_family = none)]
pub fn set_instance_transformation_matrix_layout(
&self,
instance_transformation_matrix_layout: MTLMatrixLayout,
);
/// Sets the type of motion transforms, either as a matrix or individual components.
///
/// Defaults to `MTLTransformTypePackedFloat4x3`. Using a `MTLTransformTypeComponent` allows you to represent the
/// rotation by a quaternion (instead as of part of the matrix), allowing for correct motion interpolation.
#[unsafe(method(motionTransformType))]
#[unsafe(method_family = none)]
pub fn motion_transform_type(&self) -> MTLTransformType;
/// Setter for [`motionTransformType`][Self::motionTransformType].
#[unsafe(method(setMotionTransformType:))]
#[unsafe(method_family = none)]
pub fn set_motion_transform_type(
&self,
motion_transform_type: MTLTransformType,
);
/// Sets the stride for motion transform.
///
/// Defaults to `0`, indicating that transforms are tightly packed according to the motion transform type.
#[unsafe(method(motionTransformStride))]
#[unsafe(method_family = none)]
pub fn motion_transform_stride(&self) -> NSUInteger;
/// Setter for [`motionTransformStride`][Self::motionTransformStride].
#[unsafe(method(setMotionTransformStride:))]
#[unsafe(method_family = none)]
pub fn set_motion_transform_stride(
&self,
motion_transform_stride: NSUInteger,
);
);
}
/// Methods declared on superclass `NSObject`.
impl MTL4IndirectInstanceAccelerationStructureDescriptor {
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>;
);
}