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
//! 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 objc2_metal::*;
use crate::*;
extern_class!(
/// Dependencies: This depends on Metal.framework.
///
/// The MPSCNNArithmeticGradientState is used to hold the clamp mask used by both
/// MPSCNNArithmetic forward filter and MPSCNNArithmeticGradient backward filter.
/// The MPSCNNArithmetic forward filter populates the MPSCNNArithmeticGradientState
/// object and the MPSCNNArithmeticGradient backward filter consumes the state
/// object.
///
/// The clamp mask is stored internally and is not accessible by the user.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnarithmeticgradientstate?language=objc)
#[unsafe(super(MPSNNBinaryGradientState, MPSState, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(
feature = "MPSCore",
feature = "MPSNNGradientState",
feature = "MPSState"
))]
pub struct MPSCNNArithmeticGradientState;
);
#[cfg(all(
feature = "MPSCore",
feature = "MPSNNGradientState",
feature = "MPSState"
))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNArithmeticGradientState {}
);
#[cfg(all(
feature = "MPSCore",
feature = "MPSNNGradientState",
feature = "MPSState"
))]
impl MPSCNNArithmeticGradientState {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSState`.
#[cfg(all(
feature = "MPSCore",
feature = "MPSNNGradientState",
feature = "MPSState"
))]
impl MPSCNNArithmeticGradientState {
extern_methods!(
/// Create a MPSState holding a temporary MTLBuffer
///
/// Parameter `cmdBuf`: The command buffer against which the temporary resource is allocated
///
/// Parameter `bufferSize`: The size of the buffer in bytes
#[unsafe(method(temporaryStateWithCommandBuffer:bufferSize:))]
#[unsafe(method_family = none)]
pub unsafe fn temporaryStateWithCommandBuffer_bufferSize(
cmd_buf: &ProtocolObject<dyn MTLCommandBuffer>,
buffer_size: usize,
) -> Retained<Self>;
/// Create a MPSState holding a temporary MTLTexture
///
/// Parameter `cmdBuf`: The command buffer against which the temporary resource is allocated
///
/// Parameter `descriptor`: A descriptor for the new temporary texture
#[unsafe(method(temporaryStateWithCommandBuffer:textureDescriptor:))]
#[unsafe(method_family = none)]
pub unsafe fn temporaryStateWithCommandBuffer_textureDescriptor(
cmd_buf: &ProtocolObject<dyn MTLCommandBuffer>,
descriptor: &MTLTextureDescriptor,
) -> Retained<Self>;
/// Create a new autoreleased temporary state object without underlying resource
///
/// Parameter `cmdBuf`: The command buffer with which the temporary resource is associated
#[unsafe(method(temporaryStateWithCommandBuffer:))]
#[unsafe(method_family = none)]
pub unsafe fn temporaryStateWithCommandBuffer(
cmd_buf: &ProtocolObject<dyn MTLCommandBuffer>,
) -> Retained<Self>;
#[unsafe(method(initWithDevice:bufferSize:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice_bufferSize(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
buffer_size: usize,
) -> Retained<Self>;
#[unsafe(method(initWithDevice:textureDescriptor:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice_textureDescriptor(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
descriptor: &MTLTextureDescriptor,
) -> Retained<Self>;
/// Create a MPSState with a non-temporary MTLResource
///
/// Parameter `resource`: A MTLBuffer or MTLTexture. May be nil.
///
/// # Safety
///
/// - `resource` may need to be synchronized.
/// - `resource` may be unretained, you must ensure it is kept alive while in use.
#[unsafe(method(initWithResource:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithResource(
this: Allocated<Self>,
resource: Option<&ProtocolObject<dyn MTLResource>>,
) -> Retained<Self>;
/// Initialize a non-temporary state to hold a number of textures and buffers
///
/// The allocation of each resource will be deferred until it is needed.
/// This occurs when -resource or -resourceAtIndex: is called.
///
/// Parameter `resourceList`: The list of resources to create.
#[unsafe(method(initWithDevice:resourceList:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice_resourceList(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
resource_list: &MPSStateResourceList,
) -> Retained<Self>;
/// Initialize a temporary state to hold a number of textures and buffers
///
/// The textures occur first in sequence
#[unsafe(method(temporaryStateWithCommandBuffer:resourceList:))]
#[unsafe(method_family = none)]
pub unsafe fn temporaryStateWithCommandBuffer_resourceList(
command_buffer: &ProtocolObject<dyn MTLCommandBuffer>,
resource_list: &MPSStateResourceList,
) -> Retained<Self>;
/// Create a state object with a list of MTLResources
///
/// Because MPS prefers deferred allocation of resources
/// your application should use -initWithTextures:bufferSizes:bufferCount:
/// whenever possible. This method is useful for cases when the
/// MTLResources must be initialized by the CPU.
///
/// # Safety
///
/// - `resources` generic may need to be synchronized.
/// - `resources` generic may be unretained, you must ensure it is kept alive while in use.
#[unsafe(method(initWithResources:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithResources(
this: Allocated<Self>,
resources: Option<&NSArray<ProtocolObject<dyn MTLResource>>>,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(
feature = "MPSCore",
feature = "MPSNNGradientState",
feature = "MPSState"
))]
impl MPSCNNArithmeticGradientState {
extern_methods!(
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
/// [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnarithmeticgradientstatebatch?language=objc)
#[cfg(all(
feature = "MPSCore",
feature = "MPSNNGradientState",
feature = "MPSState"
))]
pub type MPSCNNArithmeticGradientStateBatch = NSArray<MPSCNNArithmeticGradientState>;
extern_class!(
/// Dependencies: This depends on Metal.framework
///
/// The MPSCNNArithmetic filter takes two source images, a primary source image and a
/// secondary source image, and outputs a single destination image. It applies an
/// element-wise arithmetic operator to each pixel in a primary source image and a
/// corresponding pixel in a secondary source image over a specified region.
///
/// The supported arithmetic operators are the following:
/// - Addition
/// - Subtraction
/// - Multiplication
/// - Division
/// - Comparison
///
/// This filter takes additional parameters: primaryScale, secondaryScale, and bias. The default
/// value for primaryScale and secondaryScale is 1.0f. The default value for bias is 0.0f. This
/// filter applies primaryScale, secondaryScale, and bias to the primary source pixel (x) and
/// secondary source pixel (y) in the following way:
/// - Addition: result = ((primaryScale * x) + (secondaryScale * y)) + bias
/// - Subtraction: result = ((primaryScale * x) - (secondaryScale * y)) + bias
/// - Multiplicaton: result = ((primaryScale * x) * (secondaryScale * y)) + bias
/// - Division: result = ((primaryScale * x) / (secondaryScale * y)) + bias
/// - Comparison: Unused.
///
/// To clamp the result of an arithmetic operation, where
/// result = clamp(result, minimumValue, maximumValue),
/// set the minimumValue and maximumValue appropriately. The default value of minimumValue
/// is -FLT_MAX. The default value of maximumValue is FLT_MAX.
///
/// This filter also takes the following additional parameters:
/// - primaryStrideInPixelsX, primaryStrideInPixelsY, primaryStrideInFeatureChannels
/// - secondaryStrideInPixelsX, secondaryStrideInPixelsY, secondaryStrideInFeatureChannels
/// These parameters can be used to control broadcasting for the data stored in the primary and
/// secondary source images. For example, setting all strides for the primary source image to 0
/// will result in the primarySource image being treated as a scalar value. The only supported
/// values are 0 or 1. The default value of these parameters is 1.
///
/// The number of output feature channels remains the same as the number of input feature
/// channels.
///
/// You must use one of the sub-classes of MPSImageArithmetic.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnarithmetic?language=objc)
#[unsafe(super(MPSCNNBinaryKernel, MPSKernel, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSCNNArithmetic;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSCNNArithmetic {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSCNNArithmetic {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSCNNArithmetic {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNArithmetic {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSCNNArithmetic {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNArithmetic {
extern_methods!(
#[unsafe(method(primaryScale))]
#[unsafe(method_family = none)]
pub unsafe fn primaryScale(&self) -> c_float;
/// Setter for [`primaryScale`][Self::primaryScale].
#[unsafe(method(setPrimaryScale:))]
#[unsafe(method_family = none)]
pub unsafe fn setPrimaryScale(&self, primary_scale: c_float);
#[unsafe(method(secondaryScale))]
#[unsafe(method_family = none)]
pub unsafe fn secondaryScale(&self) -> c_float;
/// Setter for [`secondaryScale`][Self::secondaryScale].
#[unsafe(method(setSecondaryScale:))]
#[unsafe(method_family = none)]
pub unsafe fn setSecondaryScale(&self, secondary_scale: c_float);
#[unsafe(method(bias))]
#[unsafe(method_family = none)]
pub unsafe fn bias(&self) -> c_float;
/// Setter for [`bias`][Self::bias].
#[unsafe(method(setBias:))]
#[unsafe(method_family = none)]
pub unsafe fn setBias(&self, bias: c_float);
/// The primarySource stride in the feature channel dimension. The only supported values are 0 or 1.
/// The default value for each dimension is 1.
#[unsafe(method(primaryStrideInFeatureChannels))]
#[unsafe(method_family = none)]
pub unsafe fn primaryStrideInFeatureChannels(&self) -> NSUInteger;
/// Setter for [`primaryStrideInFeatureChannels`][Self::primaryStrideInFeatureChannels].
#[unsafe(method(setPrimaryStrideInFeatureChannels:))]
#[unsafe(method_family = none)]
pub unsafe fn setPrimaryStrideInFeatureChannels(
&self,
primary_stride_in_feature_channels: NSUInteger,
);
/// The secondarySource stride in the feature channel dimension. The only supported values are 0 or 1.
/// The default value for each dimension is 1.
#[unsafe(method(secondaryStrideInFeatureChannels))]
#[unsafe(method_family = none)]
pub unsafe fn secondaryStrideInFeatureChannels(&self) -> NSUInteger;
/// Setter for [`secondaryStrideInFeatureChannels`][Self::secondaryStrideInFeatureChannels].
#[unsafe(method(setSecondaryStrideInFeatureChannels:))]
#[unsafe(method_family = none)]
pub unsafe fn setSecondaryStrideInFeatureChannels(
&self,
secondary_stride_in_feature_channels: NSUInteger,
);
/// minimumValue is to clamp the result of an arithmetic operation:
/// result = clamp(result, minimumValue, maximumValue).
/// The default value of minimumValue is -FLT_MAX.
#[unsafe(method(minimumValue))]
#[unsafe(method_family = none)]
pub unsafe fn minimumValue(&self) -> c_float;
/// Setter for [`minimumValue`][Self::minimumValue].
#[unsafe(method(setMinimumValue:))]
#[unsafe(method_family = none)]
pub unsafe fn setMinimumValue(&self, minimum_value: c_float);
/// maximumValue is used to clamp the result of an arithmetic operation:
/// result = clamp(result, minimumValue, maximumValue).
/// The default value of maximumValue is FLT_MAX.
#[unsafe(method(maximumValue))]
#[unsafe(method_family = none)]
pub unsafe fn maximumValue(&self) -> c_float;
/// Setter for [`maximumValue`][Self::maximumValue].
#[unsafe(method(setMaximumValue:))]
#[unsafe(method_family = none)]
pub unsafe fn setMaximumValue(&self, maximum_value: c_float);
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
#[cfg(all(
feature = "MPSImage",
feature = "MPSNNGradientState",
feature = "MPSState"
))]
/// Encode call that operates on a state for later consumption by a gradient kernel in training
///
/// This is the older style of encode which reads the offset, doesn't change it,
/// and ignores the padding method.
///
/// Parameter `commandBuffer`: The command buffer
///
/// Parameter `primaryImage`: A MPSImage to use as the source images for the filter.
///
/// Parameter `secondaryImage`: A MPSImage to use as the source images for the filter.
///
/// Parameter `destinationState`: MPSCNNArithmeticGradientState to be consumed by the gradient layer
///
/// Parameter `destinationImage`: A valid MPSImage to be overwritten by result image. destinationImage
/// may not alias primarySourceImage or secondarySourceImage.
#[unsafe(method(encodeToCommandBuffer:primaryImage:secondaryImage:destinationState:destinationImage:))]
#[unsafe(method_family = none)]
pub unsafe fn encodeToCommandBuffer_primaryImage_secondaryImage_destinationState_destinationImage(
&self,
command_buffer: &ProtocolObject<dyn MTLCommandBuffer>,
primary_image: &MPSImage,
secondary_image: &MPSImage,
destination_state: &MPSCNNArithmeticGradientState,
destination_image: &MPSImage,
);
#[cfg(all(
feature = "MPSImage",
feature = "MPSNDArray",
feature = "MPSNNGradientState",
feature = "MPSState"
))]
/// Encode call that operates on a state for later consumption by a gradient kernel in training
///
/// This is the older style of encode which reads the offset, doesn't change it,
/// and ignores the padding method. Multiple images are processed concurrently.
/// All images must have MPSImage.numberOfImages = 1.
///
/// Parameter `commandBuffer`: A valid MTLCommandBuffer to receive the encoded filter
///
/// Parameter `primaryImages`: An array of MPSImage objects containing the primary source images.
///
/// Parameter `secondaryImages`: An array MPSImage objects containing the secondary source images.
///
/// Parameter `destinationStates`: An array of MPSCNNArithmeticGradientStateBatch to be consumed by the gradient layer
///
/// Parameter `destinationImages`: An array of MPSImage objects to contain the result images.
/// destinationImages may not alias primarySourceImages or secondarySourceImages
/// in any manner.
#[unsafe(method(encodeBatchToCommandBuffer:primaryImages:secondaryImages:destinationStates:destinationImages:))]
#[unsafe(method_family = none)]
pub unsafe fn encodeBatchToCommandBuffer_primaryImages_secondaryImages_destinationStates_destinationImages(
&self,
command_buffer: &ProtocolObject<dyn MTLCommandBuffer>,
primary_images: &MPSImageBatch,
secondary_images: &MPSImageBatch,
destination_states: &MPSCNNArithmeticGradientStateBatch,
destination_images: &MPSImageBatch,
);
);
}
/// Methods declared on superclass `MPSCNNBinaryKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNArithmetic {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNArithmetic {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNArithmetic {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
extern_class!(
/// Dependencies: This depends on Metal.framework.
///
/// Specifies the addition operator.
/// For each pixel in the primary source image (x) and each pixel in a secondary source image (y),
/// it applies the following function: result = ((primaryScale * x) + (secondaryScale * y)) + bias.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnadd?language=objc)
#[unsafe(super(MPSCNNArithmetic, MPSCNNBinaryKernel, MPSKernel, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSCNNAdd;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSCNNAdd {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSCNNAdd {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSCNNAdd {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNAdd {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSCNNAdd {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNAdd {
extern_methods!(
/// Initialize the addition operator.
///
/// Parameter `device`: The device the filter will run on.
///
/// Returns: A valid MPSCNNAdd object or nil, if failure.
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNBinaryKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNAdd {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNAdd {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNAdd {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
extern_class!(
/// Dependencies: This depends on Metal.framework.
///
/// Specifies the subtraction operator.
/// For each pixel in the primary source image (x) and each pixel in a secondary source image (y),
/// it applies the following function: result = ((primaryScale * x) - (secondaryScale * y)) + bias.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnsubtract?language=objc)
#[unsafe(super(MPSCNNArithmetic, MPSCNNBinaryKernel, MPSKernel, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSCNNSubtract;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSCNNSubtract {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSCNNSubtract {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSCNNSubtract {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNSubtract {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSCNNSubtract {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNSubtract {
extern_methods!(
/// Initialize the subtraction operator
///
/// Parameter `device`: The device the filter will run on.
///
/// Returns: A valid MPSCNNSubtract object or nil, if failure.
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNBinaryKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNSubtract {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNSubtract {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNSubtract {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
extern_class!(
/// Dependencies: This depends on Metal.framework.
///
/// Specifies the multiplication operator.
/// For each pixel in the primary source image (x) and each pixel in a secondary source image (y),
/// it applies the following function: result = ((primaryScale * x) * (secondaryScale * y)) + bias.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnmultiply?language=objc)
#[unsafe(super(MPSCNNArithmetic, MPSCNNBinaryKernel, MPSKernel, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSCNNMultiply;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSCNNMultiply {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSCNNMultiply {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSCNNMultiply {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNMultiply {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSCNNMultiply {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNMultiply {
extern_methods!(
/// Initialize the multiplication operator
///
/// Parameter `device`: The device the filter will run on.
///
/// Returns: A valid MPSCNNMultiply object or nil, if failure.
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNBinaryKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNMultiply {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNMultiply {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNMultiply {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
extern_class!(
/// Dependencies: This depends on Metal.framework.
///
/// Specifies the division operator.
/// For each pixel in the primary source image (x) and each pixel in a secondary source image (y),
/// it applies the following function: result = ((primaryScale * x) / (secondaryScale * y)) + bias.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnndivide?language=objc)
#[unsafe(super(MPSCNNArithmetic, MPSCNNBinaryKernel, MPSKernel, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSCNNDivide;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSCNNDivide {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSCNNDivide {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSCNNDivide {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNDivide {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSCNNDivide {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNDivide {
extern_methods!(
/// Initialize the division operator
///
/// Parameter `device`: The device the filter will run on.
///
/// Returns: A valid MPSCNNDivide object or nil, if failure.
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNBinaryKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNDivide {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNDivide {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNDivide {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
/// [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpsnncomparisontype?language=objc)
// NS_OPTIONS
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct MPSNNComparisonType(pub NSUInteger);
bitflags::bitflags! {
impl MPSNNComparisonType: NSUInteger {
#[doc(alias = "MPSNNComparisonTypeEqual")]
const Equal = 0;
#[doc(alias = "MPSNNComparisonTypeNotEqual")]
const NotEqual = 1;
#[doc(alias = "MPSNNComparisonTypeLess")]
const Less = 2;
#[doc(alias = "MPSNNComparisonTypeLessOrEqual")]
const LessOrEqual = 3;
#[doc(alias = "MPSNNComparisonTypeGreater")]
const Greater = 4;
#[doc(alias = "MPSNNComparisonTypeGreaterOrEqual")]
const GreaterOrEqual = 5;
}
}
unsafe impl Encode for MPSNNComparisonType {
const ENCODING: Encoding = NSUInteger::ENCODING;
}
unsafe impl RefEncode for MPSNNComparisonType {
const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}
extern_class!(
/// Dependencies: This depends on Metal.framework.
///
/// Specifies the elementwise comparison operator.
/// For each pixel in the primary source image (x) and each pixel in a secondary source image (y),
/// it applies the following function: result = (abs(x-y))
/// <
/// = threshold
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpsnncompare?language=objc)
#[unsafe(super(MPSCNNArithmetic, MPSCNNBinaryKernel, MPSKernel, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSNNCompare;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSNNCompare {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSNNCompare {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSNNCompare {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSNNCompare {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSNNCompare {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSNNCompare {
extern_methods!(
/// The comparison type to use
#[unsafe(method(comparisonType))]
#[unsafe(method_family = none)]
pub unsafe fn comparisonType(&self) -> MPSNNComparisonType;
/// Setter for [`comparisonType`][Self::comparisonType].
#[unsafe(method(setComparisonType:))]
#[unsafe(method_family = none)]
pub unsafe fn setComparisonType(&self, comparison_type: MPSNNComparisonType);
/// The threshold to use when comparing for equality. Two values will
/// be considered to be equal if the absolute value of their difference
/// is less than, or equal, to the specified threshold:
/// result = |b - a|
/// <
/// = threshold
#[unsafe(method(threshold))]
#[unsafe(method_family = none)]
pub unsafe fn threshold(&self) -> c_float;
/// Setter for [`threshold`][Self::threshold].
#[unsafe(method(setThreshold:))]
#[unsafe(method_family = none)]
pub unsafe fn setThreshold(&self, threshold: c_float);
/// Initialize the comparison operator
///
/// Parameter `device`: The device the filter will run on.
///
/// Returns: A valid MPSNNCompare object or nil, if failure.
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNBinaryKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSNNCompare {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSNNCompare {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSNNCompare {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
extern_class!(
/// Dependencies: This depends on Metal.framework
///
/// The MPSCNNArithmeticGradient filter is the backward filter for the MPSCNNArithmetic
/// forward filter.
///
/// The forward filter takes two inputs, primary and secondary source images, and produces
/// a single output image. Thus, going backwards requires two separate filters (one for
/// the primary source image and one for the secondary source image) that take multiple
/// inputs and produce a single output. The secondarySourceFilter property is used to
/// indicate whether the filter is operating on the primary or secondary source image from
/// the forward pass.
///
/// All the arithmetic gradient filters require the following inputs: gradient image from
/// the previous layer (going backwards) and all the applicable input source images from
/// the forward pass.
///
/// The forward filter takes the following additional parameters:
/// - primaryStrideInPixelsX, primaryStrideInPixelsY, primaryStrideInFeatureChannels
/// - secondaryStrideInPixelsX, secondaryStrideInPixelsY, secondaryStrideInFeatureChannels
/// These parameters can be used in the forward filter to control broadcasting for the data
/// stored in the primary and secondary source images. For example, setting all strides for
/// the primary source image to 0 will result in the primarySource image being treated as a
/// single pixel. The only supported values are 0 or 1. The default value of these parameters
/// is 1.
///
/// The first input to the backward filter is the gradient image from the previous layer
/// (going backwards), so there are no broadcasting parameters for this input. For the
/// backward filter, the broadcasting parameters for the second input must match the
/// broadcasting parameters set for the same image in the forward filter.
///
/// In the backward pass, broadcasting results in a reduction operation (sum) across all of the
/// applicable broadcasting dimensions (rows, columns, feature channels, or any combination
/// thereof) to produce the destination image of the size that matches the primary/secondary
/// input images used in the forward pass.
///
/// In the case of no broadcasting, the following arithmetic gradient operations are copy
/// operations (that can be optimized away by the graph interface):
/// - Add (primarySource, secondarySource)
/// - Subtract (primarySource)
///
/// Similarly to the forward filter, this backward filter takes additional parameters:
/// primaryScale, secondaryScale, and bias. The default value for primaryScale and secondaryScale
/// is 1.0f. The default value for bias is 0.0f. This filter applies primaryScale to the primary
/// source image, applies the secondaryScale to the secondary source image, where appropriate,
/// and applies bias to the result, i.e.:
/// result = ((primaryScale * x) [insert operation] (secondaryScale * y)) + bias.
///
/// The subtraction gradient filter for the secondary source image requires that the primaryScale
/// property is set to -1.0f (for x - y, d/dy(x - y) = -1).
///
/// In the forward filter, there is support for clamping the result of the available operations,
/// where result = clamp(result, minimumValue, maximumValue). The clamp backward operation is
/// not supported in the arithmetic gradient filters. If you require this functionality, it can
/// be implemented by performing a clamp backward operation before calling the arithmetic gradient
/// filters. You would need to apply the following function on the incomping gradient input image:
/// f(x) = ((minimumValue
/// <
/// x)
/// &
/// &
/// (x
/// <
/// maximumValue)) ? 1 : 0, where x is the original result
/// (before clamping) of the forward arithmetic filter.
///
/// The number of output feature channels remains the same as the number of input feature
/// channels.
///
/// You must use one of the sub-classes of MPSImageArithmeticGradient.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnarithmeticgradient?language=objc)
#[unsafe(super(MPSCNNGradientKernel, MPSCNNBinaryKernel, MPSKernel, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSCNNArithmeticGradient;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSCNNArithmeticGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSCNNArithmeticGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSCNNArithmeticGradient {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNArithmeticGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSCNNArithmeticGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNArithmeticGradient {
extern_methods!(
#[unsafe(method(primaryScale))]
#[unsafe(method_family = none)]
pub unsafe fn primaryScale(&self) -> c_float;
/// Setter for [`primaryScale`][Self::primaryScale].
#[unsafe(method(setPrimaryScale:))]
#[unsafe(method_family = none)]
pub unsafe fn setPrimaryScale(&self, primary_scale: c_float);
#[unsafe(method(secondaryScale))]
#[unsafe(method_family = none)]
pub unsafe fn secondaryScale(&self) -> c_float;
/// Setter for [`secondaryScale`][Self::secondaryScale].
#[unsafe(method(setSecondaryScale:))]
#[unsafe(method_family = none)]
pub unsafe fn setSecondaryScale(&self, secondary_scale: c_float);
#[unsafe(method(bias))]
#[unsafe(method_family = none)]
pub unsafe fn bias(&self) -> c_float;
/// Setter for [`bias`][Self::bias].
#[unsafe(method(setBias:))]
#[unsafe(method_family = none)]
pub unsafe fn setBias(&self, bias: c_float);
/// The secondarySource stride in the feature channel dimension. The only supported values are 0 or 1.
/// The default value for each dimension is 1.
#[unsafe(method(secondaryStrideInFeatureChannels))]
#[unsafe(method_family = none)]
pub unsafe fn secondaryStrideInFeatureChannels(&self) -> NSUInteger;
/// Setter for [`secondaryStrideInFeatureChannels`][Self::secondaryStrideInFeatureChannels].
#[unsafe(method(setSecondaryStrideInFeatureChannels:))]
#[unsafe(method_family = none)]
pub unsafe fn setSecondaryStrideInFeatureChannels(
&self,
secondary_stride_in_feature_channels: NSUInteger,
);
/// minimumValue is to clamp the result of an arithmetic operation:
/// result = clamp(result, minimumValue, maximumValue).
/// The default value of minimumValue is -FLT_MAX.
#[unsafe(method(minimumValue))]
#[unsafe(method_family = none)]
pub unsafe fn minimumValue(&self) -> c_float;
/// Setter for [`minimumValue`][Self::minimumValue].
#[unsafe(method(setMinimumValue:))]
#[unsafe(method_family = none)]
pub unsafe fn setMinimumValue(&self, minimum_value: c_float);
/// maximumValue is used to clamp the result of an arithmetic operation:
/// result = clamp(result, minimumValue, maximumValue).
/// The default value of maximumValue is FLT_MAX.
#[unsafe(method(maximumValue))]
#[unsafe(method_family = none)]
pub unsafe fn maximumValue(&self) -> c_float;
/// Setter for [`maximumValue`][Self::maximumValue].
#[unsafe(method(setMaximumValue:))]
#[unsafe(method_family = none)]
pub unsafe fn setMaximumValue(&self, maximum_value: c_float);
/// The isSecondarySourceFilter property is used to indicate whether the arithmetic gradient
/// filter is operating on the primary or secondary source image from the forward pass.
#[unsafe(method(isSecondarySourceFilter))]
#[unsafe(method_family = none)]
pub unsafe fn isSecondarySourceFilter(&self) -> bool;
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
#[unsafe(method(initWithDevice:isSecondarySourceFilter:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice_isSecondarySourceFilter(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
is_secondary_source_filter: bool,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNGradientKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNArithmeticGradient {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNArithmeticGradient {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNArithmeticGradient {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
extern_class!(
/// Dependencies: This depends on Metal.framework.
///
/// Specifies the addition gradient operator.
/// This arithmetic gradient filter requires the following inputs: gradient image from
/// the previous layer (going backwards) and either the primary or the secondary source
/// image from the forward pass. You will need a separate filter for the primary and
/// secondary source images.
///
/// Without broadcasting, the arithmetic add gradient operation is a copy operation on
/// the input gradient image. It is the same operation for both the primary and secondary
/// source images (for x + y, d/dx(x + y) = 1, d/dy(x + y) = 1). This copy operation can
/// be optimized away by the graph interface.
///
/// Setting the broadcasting parameters results in a reduction operation (sum) across all
/// of the applicable broadcasting dimensions (rows, columns, feature channels, or any
/// combination thereof) to produce the destination image of the size that matches the
/// primary/secondary input images used in the forward pass.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnaddgradient?language=objc)
#[unsafe(super(
MPSCNNArithmeticGradient,
MPSCNNGradientKernel,
MPSCNNBinaryKernel,
MPSKernel,
NSObject
))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSCNNAddGradient;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSCNNAddGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSCNNAddGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSCNNAddGradient {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNAddGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSCNNAddGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNAddGradient {
extern_methods!(
/// Initialize the addition gradient operator.
///
/// Parameter `device`: The device the filter will run on.
///
/// Parameter `isSecondarySourceFilter`: A boolean indicating whether the arithmetic gradient
/// filter is operating on the primary or secondary source image from the forward pass.
///
/// Returns: A valid MPSCNNAddGradient object or nil, if failure.
#[unsafe(method(initWithDevice:isSecondarySourceFilter:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice_isSecondarySourceFilter(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
is_secondary_source_filter: bool,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNArithmeticGradient`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNAddGradient {
extern_methods!(
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNGradientKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNAddGradient {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNAddGradient {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNAddGradient {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
extern_class!(
/// Dependencies: This depends on Metal.framework.
///
/// Specifies the subtraction gradient operator.
/// This arithmetic gradient filter requires the following inputs: gradient image from
/// the previous layer (going backwards) and either the primary or the secondary source
/// image from the forward pass. You will need a separate filter for the primary and
/// secondary source images.
///
/// Without broadcasting, the arithmetic subtract gradient operation for the primary
/// source image is a copy operation on the input gradient image (for x - y, d/dx(x - y) = 1).
/// This copy operation can be optimized away by the graph interface.
///
/// For the secondary source image, the result is a negation of the gradient image from
/// the previous layer (for x - y, d/dy(x - y) = -1).
///
/// Setting the broadcasting parameters results in a reduction operation (sum) across all
/// of the applicable broadcasting dimensions (rows, columns, feature channels, or any
/// combination thereof) to produce the destination image of the size that matches the
/// primary/secondary input images used in the forward pass.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnsubtractgradient?language=objc)
#[unsafe(super(
MPSCNNArithmeticGradient,
MPSCNNGradientKernel,
MPSCNNBinaryKernel,
MPSKernel,
NSObject
))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSCNNSubtractGradient;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSCNNSubtractGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSCNNSubtractGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSCNNSubtractGradient {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNSubtractGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSCNNSubtractGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNSubtractGradient {
extern_methods!(
/// Initialize the subtraction gradient operator.
///
/// Parameter `device`: The device the filter will run on.
///
/// Parameter `isSecondarySourceFilter`: A boolean indicating whether the arithmetic gradient
/// filter is operating on the primary or secondary source image from the forward pass.
///
/// Returns: A valid MPSCNNSubtractGradient object or nil, if failure.
#[unsafe(method(initWithDevice:isSecondarySourceFilter:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice_isSecondarySourceFilter(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
is_secondary_source_filter: bool,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNArithmeticGradient`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNSubtractGradient {
extern_methods!(
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNGradientKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNSubtractGradient {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNSubtractGradient {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNSubtractGradient {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}
extern_class!(
/// Dependencies: This depends on Metal.framework.
///
/// Specifies the multiplication gradient operator.
/// This arithmetic gradient filter requires the following inputs: gradient image from
/// the previous layer (going backwards) and either the primary or the secondary source
/// image from the forward pass. You will need a separate filter for the primary and
/// secondary source images.
///
/// Without broadcasting, the arithmetic multiply gradient operation is an element-wise
/// multiplication operation between the gradient image from the previous layer (going
/// backwards) and:
/// - The secondary source image from the forward pass for the primary source filter
/// (for x * y, d/dx(x * y) = y).
/// - The primary source image from the forward pass for the secondary source filter
/// (for x * y, d/dy(x * y) = x).
///
/// Setting the broadcasting parameters results in a reduction operation (sum) across all
/// of the applicable broadcasting dimensions (rows, columns, feature channels, or any
/// combination thereof) to produce the destination image of the size that matches the
/// primary/secondary input images used in the forward pass.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpscnnmultiplygradient?language=objc)
#[unsafe(super(
MPSCNNArithmeticGradient,
MPSCNNGradientKernel,
MPSCNNBinaryKernel,
MPSKernel,
NSObject
))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
pub struct MPSCNNMultiplyGradient;
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCoding for MPSCNNMultiplyGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSCopying for MPSCNNMultiplyGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSCNNMultiplyGradient {
type Result = Self;
}
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSObjectProtocol for MPSCNNMultiplyGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
unsafe impl NSSecureCoding for MPSCNNMultiplyGradient {}
);
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNMultiplyGradient {
extern_methods!(
/// Initialize the multiplication gradient operator.
///
/// Parameter `device`: The device the filter will run on.
///
/// Parameter `isSecondarySourceFilter`: A boolean indicating whether the arithmetic gradient
/// filter is operating on the primary or secondary source image from the forward pass.
///
/// Returns: A valid MPSCNNMultiplyGradient object or nil, if failure.
#[unsafe(method(initWithDevice:isSecondarySourceFilter:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice_isSecondarySourceFilter(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
is_secondary_source_filter: bool,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNArithmeticGradient`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNMultiplyGradient {
extern_methods!(
#[unsafe(method(initWithDevice:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithDevice(
this: Allocated<Self>,
device: &ProtocolObject<dyn MTLDevice>,
) -> Retained<Self>;
);
}
/// Methods declared on superclass `MPSCNNGradientKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNMultiplyGradient {
extern_methods!(
/// NSSecureCoding compatability
///
/// While the standard NSSecureCoding/NSCoding method
/// -initWithCoder: should work, since the file can't
/// know which device your data is allocated on, we
/// have to guess and may guess incorrectly. To avoid
/// that problem, use initWithCoder:device instead.
///
/// Parameter `aDecoder`: The NSCoder subclass with your serialized MPSKernel
///
/// Parameter `device`: The MTLDevice on which to make the MPSKernel
///
/// Returns: A new MPSKernel object, or nil if failure.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:device:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder_device(
this: Allocated<Self>,
a_decoder: &NSCoder,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNMultiplyGradient {
extern_methods!(
/// Called by NSCoder to decode MPSKernels
///
/// This isn't the right interface to decode a MPSKernel, but
/// it is the one that NSCoder uses. To enable your NSCoder
/// (e.g. NSKeyedUnarchiver) to set which device to use
/// extend the object to adopt the MPSDeviceProvider
/// protocol. Otherwise, the Metal system default device
/// will be used.
///
/// # Safety
///
/// `a_decoder` possibly has further requirements.
#[unsafe(method(initWithCoder:))]
#[unsafe(method_family = init)]
pub unsafe fn initWithCoder(
this: Allocated<Self>,
a_decoder: &NSCoder,
) -> Option<Retained<Self>>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "MPSCNNKernel", feature = "MPSCore", feature = "MPSKernel"))]
impl MPSCNNMultiplyGradient {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub unsafe fn new() -> Retained<Self>;
);
}