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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
//! 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::*;
use objc2_foundation::*;
use crate::*;
extern_class!(
/// Base class for Metal 4 acceleration structure descriptors.
///
/// Don't use this class directly. Use one of its subclasses instead.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4accelerationstructuredescriptor?language=objc)
#[unsafe(super(MTLAccelerationStructureDescriptor, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(feature = "MTLAccelerationStructure")]
pub struct MTL4AccelerationStructureDescriptor;
);
#[cfg(feature = "MTLAccelerationStructure")]
extern_conformance!(
unsafe impl NSCopying for MTL4AccelerationStructureDescriptor {}
);
#[cfg(feature = "MTLAccelerationStructure")]
unsafe impl CopyingHelper for MTL4AccelerationStructureDescriptor {
type Result = Self;
}
#[cfg(feature = "MTLAccelerationStructure")]
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4AccelerationStructureDescriptor {}
);
#[cfg(feature = "MTLAccelerationStructure")]
impl MTL4AccelerationStructureDescriptor {
extern_methods!();
}
/// Methods declared on superclass `NSObject`.
#[cfg(feature = "MTLAccelerationStructure")]
impl MTL4AccelerationStructureDescriptor {
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>;
);
}
#[cfg(feature = "MTLAccelerationStructure")]
impl DefaultRetained for MTL4AccelerationStructureDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
/// Base class for all Metal 4 acceleration structure geometry descriptors.
///
/// Don't use this class directly. Use one of the derived classes instead.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4accelerationstructuregeometrydescriptor?language=objc)
#[unsafe(super(NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTL4AccelerationStructureGeometryDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTL4AccelerationStructureGeometryDescriptor {}
);
unsafe impl CopyingHelper for MTL4AccelerationStructureGeometryDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4AccelerationStructureGeometryDescriptor {}
);
impl MTL4AccelerationStructureGeometryDescriptor {
extern_methods!(
/// Sets the offset that this geometry contributes to determining the intersection function to invoke when a ray intersects it.
///
/// When you perform a ray tracing operation in the Metal Shading Language, and provide the ray intersector object
/// with an instance of ``MTLIntersectionFunctionTable``, Metal adds this offset to the instance offset from structs such
/// as:
///
/// - ``MTLAccelerationStructureInstanceDescriptor``
/// - ``MTLAccelerationStructureUserIDInstanceDescriptor``
/// - ``MTLAccelerationStructureMotionInstanceDescriptor``
/// - ``MTLIndirectAccelerationStructureInstanceDescriptor``
/// - ``MTLIndirectAccelerationStructureMotionInstanceDescriptor``
///
/// The sum of these offsets provides an index into the intersection function table that the ray tracing system uses
/// to retrieve and invoke the function at this index, allowing you to customize the intersection evaluation process.
#[unsafe(method(intersectionFunctionTableOffset))]
#[unsafe(method_family = none)]
pub fn intersectionFunctionTableOffset(&self) -> NSUInteger;
/// Setter for [`intersectionFunctionTableOffset`][Self::intersectionFunctionTableOffset].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setIntersectionFunctionTableOffset:))]
#[unsafe(method_family = none)]
pub unsafe fn setIntersectionFunctionTableOffset(
&self,
intersection_function_table_offset: NSUInteger,
);
/// Provides a hint to Metal that this geometry is opaque, potentially accelerating the ray/primitive intersection process.
#[unsafe(method(opaque))]
#[unsafe(method_family = none)]
pub fn opaque(&self) -> bool;
/// Setter for [`opaque`][Self::opaque].
#[unsafe(method(setOpaque:))]
#[unsafe(method_family = none)]
pub fn setOpaque(&self, opaque: bool);
/// A boolean value that indicates whether the ray-tracing system in Metal allows the invocation of intersection functions
/// more than once per ray-primitive intersection.
///
/// The property's default value is
/// <doc
/// ://com.apple.documentation/documentation/swift/true>.
#[unsafe(method(allowDuplicateIntersectionFunctionInvocation))]
#[unsafe(method_family = none)]
pub fn allowDuplicateIntersectionFunctionInvocation(&self) -> bool;
/// Setter for [`allowDuplicateIntersectionFunctionInvocation`][Self::allowDuplicateIntersectionFunctionInvocation].
#[unsafe(method(setAllowDuplicateIntersectionFunctionInvocation:))]
#[unsafe(method_family = none)]
pub fn setAllowDuplicateIntersectionFunctionInvocation(
&self,
allow_duplicate_intersection_function_invocation: bool,
);
/// Assigns an optional label you can assign to this geometry for debugging purposes.
#[unsafe(method(label))]
#[unsafe(method_family = none)]
pub fn label(&self) -> Option<Retained<NSString>>;
/// Setter for [`label`][Self::label].
///
/// This is [copied][objc2_foundation::NSCopying::copy] when set.
#[unsafe(method(setLabel:))]
#[unsafe(method_family = none)]
pub fn setLabel(&self, label: Option<&NSString>);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assigns optional buffer containing data to associate with each primitive in this geometry.
///
/// You can use zero as the buffer address in this buffer range.
#[unsafe(method(primitiveDataBuffer))]
#[unsafe(method_family = none)]
pub fn primitiveDataBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`primitiveDataBuffer`][Self::primitiveDataBuffer].
#[unsafe(method(setPrimitiveDataBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setPrimitiveDataBuffer(&self, primitive_data_buffer: MTL4BufferRange);
/// Defines the stride, in bytes, between each primitive's data in the primitive data buffer ``primitiveDataBuffer`` references.
///
/// You are responsible for ensuring the stride is at least ``primitiveDataElementSize`` in size and a multiple of 4 bytes.
///
/// This property defaults to `0` bytes, which indicates the stride is equal to ``primitiveDataElementSize``.
#[unsafe(method(primitiveDataStride))]
#[unsafe(method_family = none)]
pub fn primitiveDataStride(&self) -> NSUInteger;
/// Setter for [`primitiveDataStride`][Self::primitiveDataStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setPrimitiveDataStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setPrimitiveDataStride(&self, primitive_data_stride: NSUInteger);
/// Sets the size, in bytes, of the data for each primitive in the primitive data buffer ``primitiveDataBuffer`` references.
///
/// This size needs to be at most ``primitiveDataStride`` in size and a multiple of 4 bytes.
///
/// This property defaults to 0 bytes.
#[unsafe(method(primitiveDataElementSize))]
#[unsafe(method_family = none)]
pub fn primitiveDataElementSize(&self) -> NSUInteger;
/// Setter for [`primitiveDataElementSize`][Self::primitiveDataElementSize].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setPrimitiveDataElementSize:))]
#[unsafe(method_family = none)]
pub unsafe fn setPrimitiveDataElementSize(&self, primitive_data_element_size: NSUInteger);
);
}
/// Methods declared on superclass `NSObject`.
impl MTL4AccelerationStructureGeometryDescriptor {
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 MTL4AccelerationStructureGeometryDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
/// Descriptor for a primitive acceleration structure that directly references geometric shapes, such as triangles and
/// bounding boxes.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4primitiveaccelerationstructuredescriptor?language=objc)
#[unsafe(super(
MTL4AccelerationStructureDescriptor,
MTLAccelerationStructureDescriptor,
NSObject
))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(feature = "MTLAccelerationStructure")]
pub struct MTL4PrimitiveAccelerationStructureDescriptor;
);
#[cfg(feature = "MTLAccelerationStructure")]
extern_conformance!(
unsafe impl NSCopying for MTL4PrimitiveAccelerationStructureDescriptor {}
);
#[cfg(feature = "MTLAccelerationStructure")]
unsafe impl CopyingHelper for MTL4PrimitiveAccelerationStructureDescriptor {
type Result = Self;
}
#[cfg(feature = "MTLAccelerationStructure")]
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4PrimitiveAccelerationStructureDescriptor {}
);
#[cfg(feature = "MTLAccelerationStructure")]
impl MTL4PrimitiveAccelerationStructureDescriptor {
extern_methods!(
/// Associates the array of geometry descriptors that comprise this primitive acceleration structure.
///
/// If you enable keyframe motion by setting property ``motionKeyframeCount`` to a value greater than `1`, then
/// all geometry descriptors this array references need to be motion geometry descriptors and have a number of
/// primitive buffers equals to ``motionKeyframeCount``.
///
/// Example of motion geometry descriptors include: ``MTL4AccelerationStructureMotionTriangleGeometryDescriptor``,
/// ``MTL4AccelerationStructureMotionBoundingBoxGeometryDescriptor``, ``MTL4AccelerationStructureMotionCurveGeometryDescriptor``.
#[unsafe(method(geometryDescriptors))]
#[unsafe(method_family = none)]
pub fn geometryDescriptors(
&self,
) -> Option<Retained<NSArray<MTL4AccelerationStructureGeometryDescriptor>>>;
/// Setter for [`geometryDescriptors`][Self::geometryDescriptors].
#[unsafe(method(setGeometryDescriptors:))]
#[unsafe(method_family = none)]
pub fn setGeometryDescriptors(
&self,
geometry_descriptors: Option<&NSArray<MTL4AccelerationStructureGeometryDescriptor>>,
);
/// Configures the behavior when the ray-tracing system samples the acceleration structure before the motion start time.
///
/// Use this property to control the behavior when the ray-tracing system samples the acceleration structure
/// at a time prior to the one you set for ``motionStartTime``.
///
/// The default value of this property is `MTLMotionBorderModeClamp`.
#[unsafe(method(motionStartBorderMode))]
#[unsafe(method_family = none)]
pub fn motionStartBorderMode(&self) -> MTLMotionBorderMode;
/// Setter for [`motionStartBorderMode`][Self::motionStartBorderMode].
#[unsafe(method(setMotionStartBorderMode:))]
#[unsafe(method_family = none)]
pub fn setMotionStartBorderMode(&self, motion_start_border_mode: MTLMotionBorderMode);
/// Configures the motion border mode.
///
/// This property controls what happens if Metal samples the acceleration structure after ``motionEndTime``.
///
/// Its default value is `MTLMotionBorderModeClamp`.
#[unsafe(method(motionEndBorderMode))]
#[unsafe(method_family = none)]
pub fn motionEndBorderMode(&self) -> MTLMotionBorderMode;
/// Setter for [`motionEndBorderMode`][Self::motionEndBorderMode].
#[unsafe(method(setMotionEndBorderMode:))]
#[unsafe(method_family = none)]
pub fn setMotionEndBorderMode(&self, motion_end_border_mode: MTLMotionBorderMode);
/// Configures the motion start time for this geometry.
///
/// The default value of this property is `0.0f`.
#[unsafe(method(motionStartTime))]
#[unsafe(method_family = none)]
pub fn motionStartTime(&self) -> c_float;
/// Setter for [`motionStartTime`][Self::motionStartTime].
#[unsafe(method(setMotionStartTime:))]
#[unsafe(method_family = none)]
pub fn setMotionStartTime(&self, motion_start_time: c_float);
/// Configures the motion end time for this geometry.
///
/// The default value of this property is `1.0f`.
#[unsafe(method(motionEndTime))]
#[unsafe(method_family = none)]
pub fn motionEndTime(&self) -> c_float;
/// Setter for [`motionEndTime`][Self::motionEndTime].
#[unsafe(method(setMotionEndTime:))]
#[unsafe(method_family = none)]
pub fn setMotionEndTime(&self, motion_end_time: c_float);
/// Sets the motion keyframe count.
///
/// This property's default is `1`, indicating no motion.
#[unsafe(method(motionKeyframeCount))]
#[unsafe(method_family = none)]
pub fn motionKeyframeCount(&self) -> NSUInteger;
/// Setter for [`motionKeyframeCount`][Self::motionKeyframeCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setMotionKeyframeCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setMotionKeyframeCount(&self, motion_keyframe_count: NSUInteger);
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(feature = "MTLAccelerationStructure")]
impl MTL4PrimitiveAccelerationStructureDescriptor {
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>;
);
}
#[cfg(feature = "MTLAccelerationStructure")]
impl DefaultRetained for MTL4PrimitiveAccelerationStructureDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
/// Describes triangle geometry suitable for ray tracing.
///
/// Use a ``MTLResidencySet`` to mark residency of all buffers this descriptor references when you build this
/// acceleration structure.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4accelerationstructuretrianglegeometrydescriptor?language=objc)
#[unsafe(super(MTL4AccelerationStructureGeometryDescriptor, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTL4AccelerationStructureTriangleGeometryDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTL4AccelerationStructureTriangleGeometryDescriptor {}
);
unsafe impl CopyingHelper for MTL4AccelerationStructureTriangleGeometryDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4AccelerationStructureTriangleGeometryDescriptor {}
);
impl MTL4AccelerationStructureTriangleGeometryDescriptor {
extern_methods!(
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Associates a vertex buffer containing triangle vertices.
///
/// You are responsible for ensuring that the format of all vertex positions match the ``vertexFormat`` property, and
/// that the buffer address for the buffer range is not zero.
#[unsafe(method(vertexBuffer))]
#[unsafe(method_family = none)]
pub fn vertexBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`vertexBuffer`][Self::vertexBuffer].
#[unsafe(method(setVertexBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setVertexBuffer(&self, vertex_buffer: MTL4BufferRange);
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Describes the format of the vertices in the vertex buffer.
///
/// This property controls the format of the position attribute of the vertices the ``vertexBuffer`` references.
///
/// The format defaults to `MTLAttributeFormatFloat3`, corresponding to three packed floating point numbers.
#[unsafe(method(vertexFormat))]
#[unsafe(method_family = none)]
pub fn vertexFormat(&self) -> MTLAttributeFormat;
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Setter for [`vertexFormat`][Self::vertexFormat].
#[unsafe(method(setVertexFormat:))]
#[unsafe(method_family = none)]
pub fn setVertexFormat(&self, vertex_format: MTLAttributeFormat);
/// Sets the stride, in bytes, between vertices in the vertex buffer.
///
/// The stride you specify needs to be a multiple of the size of the vertex format you provide in the ``vertexFormat``
/// property. Similarly, you are responsible for ensuring this stride matches the vertex format data type's alignment.
///
/// Defaults to `0`, which signals the stride matches the size of the ``vertexFormat`` data.
#[unsafe(method(vertexStride))]
#[unsafe(method_family = none)]
pub fn vertexStride(&self) -> NSUInteger;
/// Setter for [`vertexStride`][Self::vertexStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setVertexStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setVertexStride(&self, vertex_stride: NSUInteger);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Sets an optional index buffer containing references to vertices in the `vertexBuffer`.
///
/// You can set this property to `0`, the default, to avoid specifying an index buffer.
#[unsafe(method(indexBuffer))]
#[unsafe(method_family = none)]
pub fn indexBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`indexBuffer`][Self::indexBuffer].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setIndexBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setIndexBuffer(&self, index_buffer: MTL4BufferRange);
#[cfg(feature = "MTLArgument")]
/// Configures the size of the indices the `indexBuffer` contains, which is typically either 16 or 32-bits for each index.
#[unsafe(method(indexType))]
#[unsafe(method_family = none)]
pub fn indexType(&self) -> MTLIndexType;
#[cfg(feature = "MTLArgument")]
/// Setter for [`indexType`][Self::indexType].
#[unsafe(method(setIndexType:))]
#[unsafe(method_family = none)]
pub fn setIndexType(&self, index_type: MTLIndexType);
/// Declares the number of triangles in this geometry descriptor.
#[unsafe(method(triangleCount))]
#[unsafe(method_family = none)]
pub fn triangleCount(&self) -> NSUInteger;
/// Setter for [`triangleCount`][Self::triangleCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setTriangleCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setTriangleCount(&self, triangle_count: NSUInteger);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assigns an optional reference to a buffer containing a `float4x3` transformation matrix.
///
/// When the buffer address is non-zero, Metal applies this transform to the vertex data positions when building
/// the acceleration structure.
///
/// Building an acceleration structure with a descriptor that specifies this property doesn't modify the contents of
/// the input `vertexBuffer`.
#[unsafe(method(transformationMatrixBuffer))]
#[unsafe(method_family = none)]
pub fn transformationMatrixBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`transformationMatrixBuffer`][Self::transformationMatrixBuffer].
#[unsafe(method(setTransformationMatrixBuffer:))]
#[unsafe(method_family = none)]
pub fn setTransformationMatrixBuffer(&self, transformation_matrix_buffer: MTL4BufferRange);
#[cfg(feature = "MTLAccelerationStructure")]
/// Configures the layout for the transformation matrix in the transformation matrix buffer.
///
/// You can provide matrices in column-major or row-major form, and this property allows you to control
/// how Metal interprets them.
///
/// Defaults to `MTLMatrixLayoutColumnMajor`.
#[unsafe(method(transformationMatrixLayout))]
#[unsafe(method_family = none)]
pub fn transformationMatrixLayout(&self) -> MTLMatrixLayout;
#[cfg(feature = "MTLAccelerationStructure")]
/// Setter for [`transformationMatrixLayout`][Self::transformationMatrixLayout].
#[unsafe(method(setTransformationMatrixLayout:))]
#[unsafe(method_family = none)]
pub fn setTransformationMatrixLayout(&self, transformation_matrix_layout: MTLMatrixLayout);
);
}
/// Methods declared on superclass `NSObject`.
impl MTL4AccelerationStructureTriangleGeometryDescriptor {
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 MTL4AccelerationStructureTriangleGeometryDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
/// Describes bounding-box geometry suitable for ray tracing.
///
/// You use bounding boxes to implement procedural geometry for ray tracing, such as spheres or any other shape
/// you define by using intersection functions.
///
/// Use a ``MTLResidencySet`` to mark residency of all buffers this descriptor references when you build this
/// acceleration structure.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4accelerationstructureboundingboxgeometrydescriptor?language=objc)
#[unsafe(super(MTL4AccelerationStructureGeometryDescriptor, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTL4AccelerationStructureBoundingBoxGeometryDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTL4AccelerationStructureBoundingBoxGeometryDescriptor {}
);
unsafe impl CopyingHelper for MTL4AccelerationStructureBoundingBoxGeometryDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4AccelerationStructureBoundingBoxGeometryDescriptor {}
);
impl MTL4AccelerationStructureBoundingBoxGeometryDescriptor {
extern_methods!(
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// References a buffer containing bounding box data in `MTLAxisAlignedBoundingBoxes` format.
///
/// You are responsible for ensuring the buffer address of the range is not zero.
#[unsafe(method(boundingBoxBuffer))]
#[unsafe(method_family = none)]
pub fn boundingBoxBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`boundingBoxBuffer`][Self::boundingBoxBuffer].
#[unsafe(method(setBoundingBoxBuffer:))]
#[unsafe(method_family = none)]
pub fn setBoundingBoxBuffer(&self, bounding_box_buffer: MTL4BufferRange);
/// Assigns the stride, in bytes, between bounding boxes in the bounding box buffer `boundingBoxBuffer` references.
///
/// You are responsible for ensuring this stride is at least 24 bytes and a multiple of 4 bytes.
///
/// This property defaults to `24` bytes.
#[unsafe(method(boundingBoxStride))]
#[unsafe(method_family = none)]
pub fn boundingBoxStride(&self) -> NSUInteger;
/// Setter for [`boundingBoxStride`][Self::boundingBoxStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setBoundingBoxStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setBoundingBoxStride(&self, bounding_box_stride: NSUInteger);
/// Describes the number of bounding boxes the `boundingBoxBuffer` contains.
#[unsafe(method(boundingBoxCount))]
#[unsafe(method_family = none)]
pub fn boundingBoxCount(&self) -> NSUInteger;
/// Setter for [`boundingBoxCount`][Self::boundingBoxCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setBoundingBoxCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setBoundingBoxCount(&self, bounding_box_count: NSUInteger);
);
}
/// Methods declared on superclass `NSObject`.
impl MTL4AccelerationStructureBoundingBoxGeometryDescriptor {
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 MTL4AccelerationStructureBoundingBoxGeometryDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
/// Describes motion triangle geometry, suitable for motion ray tracing.
///
/// Use a ``MTLResidencySet`` to mark residency of all buffers this descriptor references when you build this
/// acceleration structure.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4accelerationstructuremotiontrianglegeometrydescriptor?language=objc)
#[unsafe(super(MTL4AccelerationStructureGeometryDescriptor, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTL4AccelerationStructureMotionTriangleGeometryDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTL4AccelerationStructureMotionTriangleGeometryDescriptor {}
);
unsafe impl CopyingHelper for MTL4AccelerationStructureMotionTriangleGeometryDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4AccelerationStructureMotionTriangleGeometryDescriptor {}
);
impl MTL4AccelerationStructureMotionTriangleGeometryDescriptor {
extern_methods!(
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assigns a buffer where each entry contains a reference to a vertex buffer.
///
/// This property references a buffer that conceptually represents an array with one entry for each keyframe in the
/// motion animation. Each one of these entries consists of a ``MTL4BufferRange`` that, in turn, references a
/// vertex buffer containing the vertex data for the keyframe.
///
/// You are responsible for ensuring the buffer address is not zero for the top-level buffer, as well as for all
/// the vertex buffers it references.
#[unsafe(method(vertexBuffers))]
#[unsafe(method_family = none)]
pub fn vertexBuffers(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`vertexBuffers`][Self::vertexBuffers].
#[unsafe(method(setVertexBuffers:))]
#[unsafe(method_family = none)]
pub fn setVertexBuffers(&self, vertex_buffers: MTL4BufferRange);
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Defines the format of the vertices in the vertex buffers.
///
/// All keyframes share the same vertex format. Defaults to `MTLAttributeFormatFloat3`, corresponding to three packed
/// floating point numbers.
#[unsafe(method(vertexFormat))]
#[unsafe(method_family = none)]
pub fn vertexFormat(&self) -> MTLAttributeFormat;
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Setter for [`vertexFormat`][Self::vertexFormat].
#[unsafe(method(setVertexFormat:))]
#[unsafe(method_family = none)]
pub fn setVertexFormat(&self, vertex_format: MTLAttributeFormat);
/// Sets the stride, in bytes, between vertices in all the vertex buffer.
///
/// All keyframes share the same vertex stride. This stride needs to be a multiple of the size of the vertex format you
/// provide in the ``vertexFormat`` property.
///
/// Similarly, you are responsible for ensuring this stride matches the vertex format data type's alignment.
///
/// Defaults to `0`, which signals the stride matches the size of the ``vertexFormat`` data.
#[unsafe(method(vertexStride))]
#[unsafe(method_family = none)]
pub fn vertexStride(&self) -> NSUInteger;
/// Setter for [`vertexStride`][Self::vertexStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setVertexStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setVertexStride(&self, vertex_stride: NSUInteger);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assigns an optional index buffer containing references to vertices in the vertex buffers you reference through the
/// vertex buffers property.
///
/// You can set this property to `0`, the default, to avoid specifying an index buffer. All keyframes share the same
/// index buffer.
#[unsafe(method(indexBuffer))]
#[unsafe(method_family = none)]
pub fn indexBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`indexBuffer`][Self::indexBuffer].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setIndexBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setIndexBuffer(&self, index_buffer: MTL4BufferRange);
#[cfg(feature = "MTLArgument")]
/// Specifies the size of the indices the `indexBuffer` contains, which is typically either 16 or 32-bits for each index.
#[unsafe(method(indexType))]
#[unsafe(method_family = none)]
pub fn indexType(&self) -> MTLIndexType;
#[cfg(feature = "MTLArgument")]
/// Setter for [`indexType`][Self::indexType].
#[unsafe(method(setIndexType:))]
#[unsafe(method_family = none)]
pub fn setIndexType(&self, index_type: MTLIndexType);
/// Declares the number of triangles in the vertex buffers that the buffer in the vertex buffers property references.
///
/// All keyframes share the same triangle count.
#[unsafe(method(triangleCount))]
#[unsafe(method_family = none)]
pub fn triangleCount(&self) -> NSUInteger;
/// Setter for [`triangleCount`][Self::triangleCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setTriangleCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setTriangleCount(&self, triangle_count: NSUInteger);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assings an optional reference to a buffer containing a `float4x3` transformation matrix.
///
/// When the buffer address is non-zero, Metal applies this transform to the vertex data positions when building
/// the acceleration structure. All keyframes share the same transformation matrix.
///
/// Building an acceleration structure with a descriptor that specifies this property doesn't modify the contents of
/// the input `vertexBuffer`.
#[unsafe(method(transformationMatrixBuffer))]
#[unsafe(method_family = none)]
pub fn transformationMatrixBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`transformationMatrixBuffer`][Self::transformationMatrixBuffer].
#[unsafe(method(setTransformationMatrixBuffer:))]
#[unsafe(method_family = none)]
pub fn setTransformationMatrixBuffer(&self, transformation_matrix_buffer: MTL4BufferRange);
#[cfg(feature = "MTLAccelerationStructure")]
/// Configures the layout for the transformation matrix in the transformation matrix buffer.
///
/// You can provide matrices in column-major or row-major form, and this property allows you to control
/// how Metal interprets them.
///
/// Defaults to `MTLMatrixLayoutColumnMajor`.
#[unsafe(method(transformationMatrixLayout))]
#[unsafe(method_family = none)]
pub fn transformationMatrixLayout(&self) -> MTLMatrixLayout;
#[cfg(feature = "MTLAccelerationStructure")]
/// Setter for [`transformationMatrixLayout`][Self::transformationMatrixLayout].
#[unsafe(method(setTransformationMatrixLayout:))]
#[unsafe(method_family = none)]
pub fn setTransformationMatrixLayout(&self, transformation_matrix_layout: MTLMatrixLayout);
);
}
/// Methods declared on superclass `NSObject`.
impl MTL4AccelerationStructureMotionTriangleGeometryDescriptor {
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 MTL4AccelerationStructureMotionTriangleGeometryDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
/// Describes motion bounding box geometry, suitable for motion ray tracing.
///
/// You use bounding boxes to implement procedural geometry for ray tracing, such as spheres or any other shape
/// you define by using intersection functions.
///
/// Use a ``MTLResidencySet`` to mark residency of all buffers this descriptor references when you build this
/// acceleration structure.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4accelerationstructuremotionboundingboxgeometrydescriptor?language=objc)
#[unsafe(super(MTL4AccelerationStructureGeometryDescriptor, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTL4AccelerationStructureMotionBoundingBoxGeometryDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTL4AccelerationStructureMotionBoundingBoxGeometryDescriptor {}
);
unsafe impl CopyingHelper for MTL4AccelerationStructureMotionBoundingBoxGeometryDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4AccelerationStructureMotionBoundingBoxGeometryDescriptor {}
);
impl MTL4AccelerationStructureMotionBoundingBoxGeometryDescriptor {
extern_methods!(
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Configures a reference to a buffer where each entry contains a reference to a buffer of bounding boxes.
///
/// This property references a buffer that conceptually represents an array with one entry for each keyframe in the
/// motion animation. Each one of these entries consists of a ``MTL4BufferRange`` that, in turn, references a
/// vertex buffer containing the bounding box data for the keyframe.
///
/// You are responsible for ensuring the buffer address is not zero for the top-level buffer, as well as for all
/// the vertex buffers it references.
#[unsafe(method(boundingBoxBuffers))]
#[unsafe(method_family = none)]
pub fn boundingBoxBuffers(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`boundingBoxBuffers`][Self::boundingBoxBuffers].
#[unsafe(method(setBoundingBoxBuffers:))]
#[unsafe(method_family = none)]
pub fn setBoundingBoxBuffers(&self, bounding_box_buffers: MTL4BufferRange);
/// Declares the stride, in bytes, between bounding boxes in the bounding box buffers each entry in `boundingBoxBuffer`
/// references.
///
/// All keyframes share the same bounding box stride. You are responsible for ensuring this stride is at least 24 bytes
/// and a multiple of 4 bytes.
///
/// This property defaults to `24` bytes.
#[unsafe(method(boundingBoxStride))]
#[unsafe(method_family = none)]
pub fn boundingBoxStride(&self) -> NSUInteger;
/// Setter for [`boundingBoxStride`][Self::boundingBoxStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setBoundingBoxStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setBoundingBoxStride(&self, bounding_box_stride: NSUInteger);
/// Declares the number of bounding boxes in each buffer that `boundingBoxBuffer` references.
///
/// All keyframes share the same bounding box count.
#[unsafe(method(boundingBoxCount))]
#[unsafe(method_family = none)]
pub fn boundingBoxCount(&self) -> NSUInteger;
/// Setter for [`boundingBoxCount`][Self::boundingBoxCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setBoundingBoxCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setBoundingBoxCount(&self, bounding_box_count: NSUInteger);
);
}
/// Methods declared on superclass `NSObject`.
impl MTL4AccelerationStructureMotionBoundingBoxGeometryDescriptor {
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 MTL4AccelerationStructureMotionBoundingBoxGeometryDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
/// Describes curve geometry suitable for ray tracing.
///
/// Use a ``MTLResidencySet`` to mark residency of all buffers this descriptor references when you build this
/// acceleration structure.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4accelerationstructurecurvegeometrydescriptor?language=objc)
#[unsafe(super(MTL4AccelerationStructureGeometryDescriptor, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTL4AccelerationStructureCurveGeometryDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTL4AccelerationStructureCurveGeometryDescriptor {}
);
unsafe impl CopyingHelper for MTL4AccelerationStructureCurveGeometryDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4AccelerationStructureCurveGeometryDescriptor {}
);
impl MTL4AccelerationStructureCurveGeometryDescriptor {
extern_methods!(
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// References a buffer containing curve control points.
///
/// Control points are interpolated according to the basis function you specify in ``curveBasis``.
///
/// You are responsible for ensuring each control is in a format matching the control point format ``controlPointFormat``
/// specifies, as well as ensuring that the buffer address of the range is not zero.
#[unsafe(method(controlPointBuffer))]
#[unsafe(method_family = none)]
pub fn controlPointBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`controlPointBuffer`][Self::controlPointBuffer].
#[unsafe(method(setControlPointBuffer:))]
#[unsafe(method_family = none)]
pub fn setControlPointBuffer(&self, control_point_buffer: MTL4BufferRange);
/// Declares the number of control points in the control point buffer.
#[unsafe(method(controlPointCount))]
#[unsafe(method_family = none)]
pub fn controlPointCount(&self) -> NSUInteger;
/// Setter for [`controlPointCount`][Self::controlPointCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setControlPointCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setControlPointCount(&self, control_point_count: NSUInteger);
/// Sets the stride, in bytes, between control points in the control point buffer the control point buffer references.
///
/// You are responsible for ensuring this stride is a multiple of the control point format's element size, and
/// at a minimum exactly the control point format's size.
///
/// This property defaults to `0`, indicating that the control points are tightly-packed.
#[unsafe(method(controlPointStride))]
#[unsafe(method_family = none)]
pub fn controlPointStride(&self) -> NSUInteger;
/// Setter for [`controlPointStride`][Self::controlPointStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setControlPointStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setControlPointStride(&self, control_point_stride: NSUInteger);
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Declares the format of the control points the control point buffer references.
///
/// Defaults to `MTLAttributeFormatFloat3`, representing 3 floating point values tightly packed.
#[unsafe(method(controlPointFormat))]
#[unsafe(method_family = none)]
pub fn controlPointFormat(&self) -> MTLAttributeFormat;
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Setter for [`controlPointFormat`][Self::controlPointFormat].
#[unsafe(method(setControlPointFormat:))]
#[unsafe(method_family = none)]
pub fn setControlPointFormat(&self, control_point_format: MTLAttributeFormat);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assigns a reference to a buffer containing the curve radius for each control point.
///
/// Metal interpolates curve radii according to the basis function you specify via ``curveBasis``.
///
/// You are responsible for ensuring the type of each radius matches the type property ``radiusFormat`` specifies,
/// that each radius is at least zero, and that the buffer address of the range is not zero.
#[unsafe(method(radiusBuffer))]
#[unsafe(method_family = none)]
pub fn radiusBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`radiusBuffer`][Self::radiusBuffer].
#[unsafe(method(setRadiusBuffer:))]
#[unsafe(method_family = none)]
pub fn setRadiusBuffer(&self, radius_buffer: MTL4BufferRange);
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Declares the format of the radii in the radius buffer.
///
/// Defaults to `MTLAttributeFormatFloat`.
#[unsafe(method(radiusFormat))]
#[unsafe(method_family = none)]
pub fn radiusFormat(&self) -> MTLAttributeFormat;
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Setter for [`radiusFormat`][Self::radiusFormat].
#[unsafe(method(setRadiusFormat:))]
#[unsafe(method_family = none)]
pub fn setRadiusFormat(&self, radius_format: MTLAttributeFormat);
/// Configures the stride, in bytes, between radii in the radius buffer.
///
/// You are responsible for ensuring this property is set to a multiple of the size corresponding to the ``radiusFormat``.
///
/// This property defaults to `0` bytes, indicating that the radii are tightly packed.
#[unsafe(method(radiusStride))]
#[unsafe(method_family = none)]
pub fn radiusStride(&self) -> NSUInteger;
/// Setter for [`radiusStride`][Self::radiusStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setRadiusStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setRadiusStride(&self, radius_stride: NSUInteger);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assigns an optional index buffer containing references to control points in the control point buffer.
///
/// Each index represents the first control point of a curve segment. You are responsible for ensuring the buffer
/// address of the range is not zero.
#[unsafe(method(indexBuffer))]
#[unsafe(method_family = none)]
pub fn indexBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`indexBuffer`][Self::indexBuffer].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setIndexBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setIndexBuffer(&self, index_buffer: MTL4BufferRange);
#[cfg(feature = "MTLArgument")]
/// Specifies the size of the indices the `indexBuffer` contains, which is typically either 16 or 32-bits for each index.
#[unsafe(method(indexType))]
#[unsafe(method_family = none)]
pub fn indexType(&self) -> MTLIndexType;
#[cfg(feature = "MTLArgument")]
/// Setter for [`indexType`][Self::indexType].
#[unsafe(method(setIndexType:))]
#[unsafe(method_family = none)]
pub fn setIndexType(&self, index_type: MTLIndexType);
/// Declares the number of curve segments.
#[unsafe(method(segmentCount))]
#[unsafe(method_family = none)]
pub fn segmentCount(&self) -> NSUInteger;
/// Setter for [`segmentCount`][Self::segmentCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setSegmentCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setSegmentCount(&self, segment_count: NSUInteger);
/// Declares the number of control points per curve segment.
///
/// Valid values for this property are `2`, `3`, or `4`.
#[unsafe(method(segmentControlPointCount))]
#[unsafe(method_family = none)]
pub fn segmentControlPointCount(&self) -> NSUInteger;
/// Setter for [`segmentControlPointCount`][Self::segmentControlPointCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setSegmentControlPointCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setSegmentControlPointCount(&self, segment_control_point_count: NSUInteger);
#[cfg(feature = "MTLAccelerationStructure")]
/// Controls the curve type.
///
/// Defaults to `MTLCurveTypeRound`.
#[unsafe(method(curveType))]
#[unsafe(method_family = none)]
pub fn curveType(&self) -> MTLCurveType;
#[cfg(feature = "MTLAccelerationStructure")]
/// Setter for [`curveType`][Self::curveType].
#[unsafe(method(setCurveType:))]
#[unsafe(method_family = none)]
pub fn setCurveType(&self, curve_type: MTLCurveType);
#[cfg(feature = "MTLAccelerationStructure")]
/// Controls the curve basis function, determining how Metal interpolates the control points.
///
/// Defaults to `MTLCurveBasisBSpline`.
#[unsafe(method(curveBasis))]
#[unsafe(method_family = none)]
pub fn curveBasis(&self) -> MTLCurveBasis;
#[cfg(feature = "MTLAccelerationStructure")]
/// Setter for [`curveBasis`][Self::curveBasis].
#[unsafe(method(setCurveBasis:))]
#[unsafe(method_family = none)]
pub fn setCurveBasis(&self, curve_basis: MTLCurveBasis);
#[cfg(feature = "MTLAccelerationStructure")]
/// Sets the type of curve end caps.
///
/// Defaults to `MTLCurveEndCapsNone`.
#[unsafe(method(curveEndCaps))]
#[unsafe(method_family = none)]
pub fn curveEndCaps(&self) -> MTLCurveEndCaps;
#[cfg(feature = "MTLAccelerationStructure")]
/// Setter for [`curveEndCaps`][Self::curveEndCaps].
#[unsafe(method(setCurveEndCaps:))]
#[unsafe(method_family = none)]
pub fn setCurveEndCaps(&self, curve_end_caps: MTLCurveEndCaps);
);
}
/// Methods declared on superclass `NSObject`.
impl MTL4AccelerationStructureCurveGeometryDescriptor {
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 MTL4AccelerationStructureCurveGeometryDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
/// Describes motion curve geometry, suitable for motion ray tracing.
///
/// Use a ``MTLResidencySet`` to mark residency of all buffers this descriptor references when you build this
/// acceleration structure.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtl4accelerationstructuremotioncurvegeometrydescriptor?language=objc)
#[unsafe(super(MTL4AccelerationStructureGeometryDescriptor, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTL4AccelerationStructureMotionCurveGeometryDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTL4AccelerationStructureMotionCurveGeometryDescriptor {}
);
unsafe impl CopyingHelper for MTL4AccelerationStructureMotionCurveGeometryDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4AccelerationStructureMotionCurveGeometryDescriptor {}
);
impl MTL4AccelerationStructureMotionCurveGeometryDescriptor {
extern_methods!(
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assigns a reference to a buffer where each entry contains a reference to a buffer of control points.
///
/// This property references a buffer that conceptually represents an array with one entry for each keyframe in the
/// motion animation. Each one of these entries consists of a ``MTL4BufferRange`` that, in turn, references a
/// buffer containing the control points corresponding to the keyframe.
///
/// You are responsible for ensuring the buffer address is not zero for the top-level buffer, as well as for all
/// the vertex buffers it references.
#[unsafe(method(controlPointBuffers))]
#[unsafe(method_family = none)]
pub fn controlPointBuffers(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`controlPointBuffers`][Self::controlPointBuffers].
#[unsafe(method(setControlPointBuffers:))]
#[unsafe(method_family = none)]
pub fn setControlPointBuffers(&self, control_point_buffers: MTL4BufferRange);
/// Specifies the number of control points in the buffers the control point buffers reference.
///
/// All keyframes have the same number of control points.
#[unsafe(method(controlPointCount))]
#[unsafe(method_family = none)]
pub fn controlPointCount(&self) -> NSUInteger;
/// Setter for [`controlPointCount`][Self::controlPointCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setControlPointCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setControlPointCount(&self, control_point_count: NSUInteger);
/// Sets the stride, in bytes, between control points in the control point buffer.
///
/// All keyframes share the same control point stride.
///
/// You are responsible for ensuring this stride is a multiple of the control point format's element size, and
/// at a minimum exactly the control point format's size.
///
/// This property defaults to `0`, indicating that the control points are tightly-packed.
#[unsafe(method(controlPointStride))]
#[unsafe(method_family = none)]
pub fn controlPointStride(&self) -> NSUInteger;
/// Setter for [`controlPointStride`][Self::controlPointStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setControlPointStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setControlPointStride(&self, control_point_stride: NSUInteger);
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Declares the format of the control points in the buffers that the control point buffers reference.
///
/// All keyframes share the same control point format. Defaults to `MTLAttributeFormatFloat3`, representing 3 floating
/// point values tightly packed.
#[unsafe(method(controlPointFormat))]
#[unsafe(method_family = none)]
pub fn controlPointFormat(&self) -> MTLAttributeFormat;
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Setter for [`controlPointFormat`][Self::controlPointFormat].
#[unsafe(method(setControlPointFormat:))]
#[unsafe(method_family = none)]
pub fn setControlPointFormat(&self, control_point_format: MTLAttributeFormat);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assigns a reference to a buffer containing, in turn, references to curve radii buffers.
///
/// This property references a buffer that conceptually represents an array with one entry for each keyframe in the
/// motion animation. Each one of these entries consists of a ``MTL4BufferRange`` that, in turn, references a
/// buffer containing the radii corresponding to the keyframe.
///
/// Metal interpolates curve radii according to the basis function you specify via ``curveBasis``.
///
/// You are responsible for ensuring the type of each radius matches the type property ``radiusFormat`` specifies,
/// that each radius is at least zero, and that the buffer address of the top-level buffer, as well as of buffer
/// it references, is not zero.
#[unsafe(method(radiusBuffers))]
#[unsafe(method_family = none)]
pub fn radiusBuffers(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`radiusBuffers`][Self::radiusBuffers].
#[unsafe(method(setRadiusBuffers:))]
#[unsafe(method_family = none)]
pub fn setRadiusBuffers(&self, radius_buffers: MTL4BufferRange);
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Sets the format of the radii in the radius buffer.
///
/// Defaults to `MTLAttributeFormatFloat`. All keyframes share the same radius format.
#[unsafe(method(radiusFormat))]
#[unsafe(method_family = none)]
pub fn radiusFormat(&self) -> MTLAttributeFormat;
#[cfg(feature = "MTLStageInputOutputDescriptor")]
/// Setter for [`radiusFormat`][Self::radiusFormat].
#[unsafe(method(setRadiusFormat:))]
#[unsafe(method_family = none)]
pub fn setRadiusFormat(&self, radius_format: MTLAttributeFormat);
/// Sets the stride, in bytes, between radii in the radius buffer.
///
/// You are responsible for ensuring this property is set to a multiple of the size corresponding to the ``radiusFormat``.
/// All keyframes share the same radius stride.
///
/// This property defaults to `0` bytes, indicating that the radii are tightly packed.
#[unsafe(method(radiusStride))]
#[unsafe(method_family = none)]
pub fn radiusStride(&self) -> NSUInteger;
/// Setter for [`radiusStride`][Self::radiusStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setRadiusStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setRadiusStride(&self, radius_stride: NSUInteger);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Assigns an optional index buffer containing references to control points in the control point buffers.
///
/// All keyframes share the same index buffer, with each index representing the first control point of a curve segment.
///
/// You are responsible for ensuring the buffer address of the range is not zero.
#[unsafe(method(indexBuffer))]
#[unsafe(method_family = none)]
pub fn indexBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`indexBuffer`][Self::indexBuffer].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setIndexBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setIndexBuffer(&self, index_buffer: MTL4BufferRange);
#[cfg(feature = "MTLArgument")]
/// Configures the size of the indices the `indexBuffer` contains, which is typically either 16 or 32-bits for each index.
#[unsafe(method(indexType))]
#[unsafe(method_family = none)]
pub fn indexType(&self) -> MTLIndexType;
#[cfg(feature = "MTLArgument")]
/// Setter for [`indexType`][Self::indexType].
#[unsafe(method(setIndexType:))]
#[unsafe(method_family = none)]
pub fn setIndexType(&self, index_type: MTLIndexType);
/// Declares the number of curve segments.
///
/// All keyframes have the same number of curve segments.
#[unsafe(method(segmentCount))]
#[unsafe(method_family = none)]
pub fn segmentCount(&self) -> NSUInteger;
/// Setter for [`segmentCount`][Self::segmentCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setSegmentCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setSegmentCount(&self, segment_count: NSUInteger);
/// Controls the number of control points per curve segment.
///
/// Valid values for this property are `2`, `3`, or `4`. All keyframes have the same number of control points per curve segment.
#[unsafe(method(segmentControlPointCount))]
#[unsafe(method_family = none)]
pub fn segmentControlPointCount(&self) -> NSUInteger;
/// Setter for [`segmentControlPointCount`][Self::segmentControlPointCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setSegmentControlPointCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setSegmentControlPointCount(&self, segment_control_point_count: NSUInteger);
#[cfg(feature = "MTLAccelerationStructure")]
/// Controls the curve type.
///
/// Defaults to `MTLCurveTypeRound`. All keyframes share the same curve type.
#[unsafe(method(curveType))]
#[unsafe(method_family = none)]
pub fn curveType(&self) -> MTLCurveType;
#[cfg(feature = "MTLAccelerationStructure")]
/// Setter for [`curveType`][Self::curveType].
#[unsafe(method(setCurveType:))]
#[unsafe(method_family = none)]
pub fn setCurveType(&self, curve_type: MTLCurveType);
#[cfg(feature = "MTLAccelerationStructure")]
/// Sets the curve basis function, determining how Metal interpolates the control points.
///
/// Defaults to `MTLCurveBasisBSpline`. All keyframes share the same curve basis function.
#[unsafe(method(curveBasis))]
#[unsafe(method_family = none)]
pub fn curveBasis(&self) -> MTLCurveBasis;
#[cfg(feature = "MTLAccelerationStructure")]
/// Setter for [`curveBasis`][Self::curveBasis].
#[unsafe(method(setCurveBasis:))]
#[unsafe(method_family = none)]
pub fn setCurveBasis(&self, curve_basis: MTLCurveBasis);
#[cfg(feature = "MTLAccelerationStructure")]
/// Configures the type of curve end caps.
///
/// Defaults to `MTLCurveEndCapsNone`. All keyframes share the same end cap type.
#[unsafe(method(curveEndCaps))]
#[unsafe(method_family = none)]
pub fn curveEndCaps(&self) -> MTLCurveEndCaps;
#[cfg(feature = "MTLAccelerationStructure")]
/// Setter for [`curveEndCaps`][Self::curveEndCaps].
#[unsafe(method(setCurveEndCaps:))]
#[unsafe(method_family = none)]
pub fn setCurveEndCaps(&self, curve_end_caps: MTLCurveEndCaps);
);
}
/// Methods declared on superclass `NSObject`.
impl MTL4AccelerationStructureMotionCurveGeometryDescriptor {
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 MTL4AccelerationStructureMotionCurveGeometryDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
/// Descriptor for an instance acceleration structure.
///
/// 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.
///
/// 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/mtl4instanceaccelerationstructuredescriptor?language=objc)
#[unsafe(super(
MTL4AccelerationStructureDescriptor,
MTLAccelerationStructureDescriptor,
NSObject
))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(feature = "MTLAccelerationStructure")]
pub struct MTL4InstanceAccelerationStructureDescriptor;
);
#[cfg(feature = "MTLAccelerationStructure")]
extern_conformance!(
unsafe impl NSCopying for MTL4InstanceAccelerationStructureDescriptor {}
);
#[cfg(feature = "MTLAccelerationStructure")]
unsafe impl CopyingHelper for MTL4InstanceAccelerationStructureDescriptor {
type Result = Self;
}
#[cfg(feature = "MTLAccelerationStructure")]
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4InstanceAccelerationStructureDescriptor {}
);
#[cfg(feature = "MTLAccelerationStructure")]
impl MTL4InstanceAccelerationStructureDescriptor {
extern_methods!(
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// 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 instanceDescriptorBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`instanceDescriptorBuffer`][Self::instanceDescriptorBuffer].
#[unsafe(method(setInstanceDescriptorBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setInstanceDescriptorBuffer(
&self,
instance_descriptor_buffer: MTL4BufferRange,
);
/// Sets the stride, in bytes, between instance descriptors the instance descriptor buffer references.
///
/// 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 instanceDescriptorStride(&self) -> NSUInteger;
/// Setter for [`instanceDescriptorStride`][Self::instanceDescriptorStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setInstanceDescriptorStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setInstanceDescriptorStride(&self, instance_descriptor_stride: NSUInteger);
/// Controls the number of instance descriptors in the instance descriptor buffer references.
#[unsafe(method(instanceCount))]
#[unsafe(method_family = none)]
pub fn instanceCount(&self) -> NSUInteger;
/// Setter for [`instanceCount`][Self::instanceCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setInstanceCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setInstanceCount(&self, instance_count: NSUInteger);
/// Sets 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 instanceDescriptorType(&self) -> MTLAccelerationStructureInstanceDescriptorType;
/// Setter for [`instanceDescriptorType`][Self::instanceDescriptorType].
#[unsafe(method(setInstanceDescriptorType:))]
#[unsafe(method_family = none)]
pub fn setInstanceDescriptorType(
&self,
instance_descriptor_type: MTLAccelerationStructureInstanceDescriptorType,
);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// 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 motionTransformBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`motionTransformBuffer`][Self::motionTransformBuffer].
#[unsafe(method(setMotionTransformBuffer:))]
#[unsafe(method_family = none)]
pub fn setMotionTransformBuffer(&self, motion_transform_buffer: MTL4BufferRange);
/// Controls the total number of motion transforms in the motion transform buffer.
#[unsafe(method(motionTransformCount))]
#[unsafe(method_family = none)]
pub fn motionTransformCount(&self) -> NSUInteger;
/// Setter for [`motionTransformCount`][Self::motionTransformCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setMotionTransformCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setMotionTransformCount(&self, motion_transform_count: NSUInteger);
/// 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 instanceTransformationMatrixLayout(&self) -> MTLMatrixLayout;
/// Setter for [`instanceTransformationMatrixLayout`][Self::instanceTransformationMatrixLayout].
#[unsafe(method(setInstanceTransformationMatrixLayout:))]
#[unsafe(method_family = none)]
pub fn setInstanceTransformationMatrixLayout(
&self,
instance_transformation_matrix_layout: MTLMatrixLayout,
);
/// Controls 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 motionTransformType(&self) -> MTLTransformType;
/// Setter for [`motionTransformType`][Self::motionTransformType].
#[unsafe(method(setMotionTransformType:))]
#[unsafe(method_family = none)]
pub fn setMotionTransformType(&self, motion_transform_type: MTLTransformType);
/// Specify 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 motionTransformStride(&self) -> NSUInteger;
/// Setter for [`motionTransformStride`][Self::motionTransformStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setMotionTransformStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setMotionTransformStride(&self, motion_transform_stride: NSUInteger);
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(feature = "MTLAccelerationStructure")]
impl MTL4InstanceAccelerationStructureDescriptor {
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>;
);
}
#[cfg(feature = "MTLAccelerationStructure")]
impl DefaultRetained for MTL4InstanceAccelerationStructureDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
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)]
#[cfg(feature = "MTLAccelerationStructure")]
pub struct MTL4IndirectInstanceAccelerationStructureDescriptor;
);
#[cfg(feature = "MTLAccelerationStructure")]
extern_conformance!(
unsafe impl NSCopying for MTL4IndirectInstanceAccelerationStructureDescriptor {}
);
#[cfg(feature = "MTLAccelerationStructure")]
unsafe impl CopyingHelper for MTL4IndirectInstanceAccelerationStructureDescriptor {
type Result = Self;
}
#[cfg(feature = "MTLAccelerationStructure")]
extern_conformance!(
unsafe impl NSObjectProtocol for MTL4IndirectInstanceAccelerationStructureDescriptor {}
);
#[cfg(feature = "MTLAccelerationStructure")]
impl MTL4IndirectInstanceAccelerationStructureDescriptor {
extern_methods!(
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// 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 instanceDescriptorBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`instanceDescriptorBuffer`][Self::instanceDescriptorBuffer].
#[unsafe(method(setInstanceDescriptorBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setInstanceDescriptorBuffer(
&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 instanceDescriptorStride(&self) -> NSUInteger;
/// Setter for [`instanceDescriptorStride`][Self::instanceDescriptorStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setInstanceDescriptorStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setInstanceDescriptorStride(&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 maxInstanceCount(&self) -> NSUInteger;
/// Setter for [`maxInstanceCount`][Self::maxInstanceCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setMaxInstanceCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setMaxInstanceCount(&self, max_instance_count: NSUInteger);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// 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 instanceCountBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`instanceCountBuffer`][Self::instanceCountBuffer].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setInstanceCountBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setInstanceCountBuffer(&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 instanceDescriptorType(&self) -> MTLAccelerationStructureInstanceDescriptorType;
/// Setter for [`instanceDescriptorType`][Self::instanceDescriptorType].
#[unsafe(method(setInstanceDescriptorType:))]
#[unsafe(method_family = none)]
pub fn setInstanceDescriptorType(
&self,
instance_descriptor_type: MTLAccelerationStructureInstanceDescriptorType,
);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// 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 motionTransformBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`motionTransformBuffer`][Self::motionTransformBuffer].
#[unsafe(method(setMotionTransformBuffer:))]
#[unsafe(method_family = none)]
pub fn setMotionTransformBuffer(&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 maxMotionTransformCount(&self) -> NSUInteger;
/// Setter for [`maxMotionTransformCount`][Self::maxMotionTransformCount].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setMaxMotionTransformCount:))]
#[unsafe(method_family = none)]
pub unsafe fn setMaxMotionTransformCount(&self, max_motion_transform_count: NSUInteger);
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// 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 motionTransformCountBuffer(&self) -> MTL4BufferRange;
#[cfg(all(feature = "MTL4BufferRange", feature = "MTLGPUAddress"))]
/// Setter for [`motionTransformCountBuffer`][Self::motionTransformCountBuffer].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setMotionTransformCountBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn setMotionTransformCountBuffer(
&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 instanceTransformationMatrixLayout(&self) -> MTLMatrixLayout;
/// Setter for [`instanceTransformationMatrixLayout`][Self::instanceTransformationMatrixLayout].
#[unsafe(method(setInstanceTransformationMatrixLayout:))]
#[unsafe(method_family = none)]
pub fn setInstanceTransformationMatrixLayout(
&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 motionTransformType(&self) -> MTLTransformType;
/// Setter for [`motionTransformType`][Self::motionTransformType].
#[unsafe(method(setMotionTransformType:))]
#[unsafe(method_family = none)]
pub fn setMotionTransformType(&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 motionTransformStride(&self) -> NSUInteger;
/// Setter for [`motionTransformStride`][Self::motionTransformStride].
///
/// # Safety
///
/// This might not be bounds-checked.
#[unsafe(method(setMotionTransformStride:))]
#[unsafe(method_family = none)]
pub unsafe fn setMotionTransformStride(&self, motion_transform_stride: NSUInteger);
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(feature = "MTLAccelerationStructure")]
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>;
);
}
#[cfg(feature = "MTLAccelerationStructure")]
impl DefaultRetained for MTL4IndirectInstanceAccelerationStructureDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}