objc2-metal-performance-shaders 0.3.2

Bindings to the MetalPerformanceShaders framework
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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
//! 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::*;

/// [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpsmatrixrandomdistribution?language=objc)
// NS_OPTIONS
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct MPSMatrixRandomDistribution(pub NSUInteger);
bitflags::bitflags! {
    impl MPSMatrixRandomDistribution: NSUInteger {
        #[doc(alias = "MPSMatrixRandomDistributionDefault")]
        const Default = 1;
        #[doc(alias = "MPSMatrixRandomDistributionUniform")]
        const Uniform = 2;
        #[doc(alias = "MPSMatrixRandomDistributionNormal")]
        const Normal = 3;
    }
}

unsafe impl Encode for MPSMatrixRandomDistribution {
    const ENCODING: Encoding = NSUInteger::ENCODING;
}

unsafe impl RefEncode for MPSMatrixRandomDistribution {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

extern_class!(
    /// Dependencies: This depends on Metal.framework
    ///
    /// Decribes properties of a distribution of random values.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpsmatrixrandomdistributiondescriptor?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct MPSMatrixRandomDistributionDescriptor;
);

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

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

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

impl MPSMatrixRandomDistributionDescriptor {
    extern_methods!(
        /// The type of distribution.
        #[unsafe(method(distributionType))]
        #[unsafe(method_family = none)]
        pub unsafe fn distributionType(&self) -> MPSMatrixRandomDistribution;

        /// Setter for [`distributionType`][Self::distributionType].
        #[unsafe(method(setDistributionType:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setDistributionType(&self, distribution_type: MPSMatrixRandomDistribution);

        /// For distributions of values bounded below, this value describes the minimum.
        #[unsafe(method(minimum))]
        #[unsafe(method_family = none)]
        pub unsafe fn minimum(&self) -> c_float;

        /// Setter for [`minimum`][Self::minimum].
        #[unsafe(method(setMinimum:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setMinimum(&self, minimum: c_float);

        /// For distributions of values bounded above, this value describes the maximum.
        #[unsafe(method(maximum))]
        #[unsafe(method_family = none)]
        pub unsafe fn maximum(&self) -> c_float;

        /// Setter for [`maximum`][Self::maximum].
        #[unsafe(method(setMaximum:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setMaximum(&self, maximum: c_float);

        /// The value to use for distributions described by their mean.
        #[unsafe(method(mean))]
        #[unsafe(method_family = none)]
        pub unsafe fn mean(&self) -> c_float;

        /// Setter for [`mean`][Self::mean].
        #[unsafe(method(setMean:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setMean(&self, mean: c_float);

        /// The value to use for distributions described by their standardDeviation.
        #[unsafe(method(standardDeviation))]
        #[unsafe(method_family = none)]
        pub unsafe fn standardDeviation(&self) -> c_float;

        /// Setter for [`standardDeviation`][Self::standardDeviation].
        #[unsafe(method(setStandardDeviation:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setStandardDeviation(&self, standard_deviation: c_float);

        /// Make a descriptor for a uniform distribution of floating point values in
        /// the range [minimum, maximum).
        ///
        /// Parameter `minimum`: The lower bound of the range.
        ///
        /// Parameter `maximum`: The upper bound of the range.
        ///
        /// Returns: A valid MPSMatrixRandomDistribution object or nil, if failure.
        #[unsafe(method(uniformDistributionDescriptorWithMinimum:maximum:))]
        #[unsafe(method_family = none)]
        pub unsafe fn uniformDistributionDescriptorWithMinimum_maximum(
            minimum: c_float,
            maximum: c_float,
        ) -> Retained<MPSMatrixRandomDistributionDescriptor>;

        /// Make a descriptor for a normal distribution of floating point values.
        ///
        /// Parameter `mean`: The mean of the distribution
        ///
        /// Parameter `standardDeviation`: The standard deviation of the distribution.
        ///
        /// Returns: A valid MPSMatrixRandomDistribution object or nil if failure.
        #[unsafe(method(normalDistributionDescriptorWithMean:standardDeviation:))]
        #[unsafe(method_family = none)]
        pub unsafe fn normalDistributionDescriptorWithMean_standardDeviation(
            mean: c_float,
            standard_deviation: c_float,
        ) -> Retained<MPSMatrixRandomDistributionDescriptor>;

        /// Make a descriptor for a truncated normal distribution of floating point values.
        ///
        /// Parameter `mean`: The mean of the distribution
        ///
        /// Parameter `standardDeviation`: The standard deviation of the distribution.
        ///
        /// Parameter `minimum`: The lower bound of the distribution
        ///
        /// Parameter `maximum`: The upper bound of the distribution
        ///
        /// Returns: A valid MPSMatrixRandomDistribution object or nil if failure.
        #[unsafe(method(normalDistributionDescriptorWithMean:standardDeviation:minimum:maximum:))]
        #[unsafe(method_family = none)]
        pub unsafe fn normalDistributionDescriptorWithMean_standardDeviation_minimum_maximum(
            mean: c_float,
            standard_deviation: c_float,
            minimum: c_float,
            maximum: c_float,
        ) -> Retained<MPSMatrixRandomDistributionDescriptor>;

        /// Make a descriptor for a default distribution.
        ///
        /// Returns: A valid MPSMatrixRandomDistribution object or nil, if failure.
        #[unsafe(method(defaultDistributionDescriptor))]
        #[unsafe(method_family = none)]
        pub unsafe fn defaultDistributionDescriptor(
        ) -> Retained<MPSMatrixRandomDistributionDescriptor>;
    );
}

/// Methods declared on superclass `NSObject`.
impl MPSMatrixRandomDistributionDescriptor {
    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!(
    /// Kernels that implement random number generation.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpsmatrixrandom?language=objc)
    #[unsafe(super(MPSKernel, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
    pub struct MPSMatrixRandom;
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSCoding for MPSMatrixRandom {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSCopying for MPSMatrixRandom {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSMatrixRandom {
    type Result = Self;
}

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSObjectProtocol for MPSMatrixRandom {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSSecureCoding for MPSMatrixRandom {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
impl MPSMatrixRandom {
    extern_methods!(
        #[cfg(feature = "MPSCoreTypes")]
        /// The type of the data which makes up the values of the result.
        /// Supported values are:
        /// MPSDataTypeUInt32
        /// MPSDataTypeFloat32
        ///
        /// Default is MPSDataTypeUInt32
        #[unsafe(method(destinationDataType))]
        #[unsafe(method_family = none)]
        pub unsafe fn destinationDataType(&self) -> MPSDataType;

        /// The distribution from which to generate random values.
        ///
        /// Default is MPSMatrixRandomDistributionDefault
        #[unsafe(method(distributionType))]
        #[unsafe(method_family = none)]
        pub unsafe fn distributionType(&self) -> MPSMatrixRandomDistribution;

        /// The starting index in the destination batch.
        #[unsafe(method(batchStart))]
        #[unsafe(method_family = none)]
        pub unsafe fn batchStart(&self) -> NSUInteger;

        /// Setter for [`batchStart`][Self::batchStart].
        #[unsafe(method(setBatchStart:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setBatchStart(&self, batch_start: NSUInteger);

        /// The size of the batch to process.
        #[unsafe(method(batchSize))]
        #[unsafe(method_family = none)]
        pub unsafe fn batchSize(&self) -> NSUInteger;

        /// Setter for [`batchSize`][Self::batchSize].
        #[unsafe(method(setBatchSize:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setBatchSize(&self, batch_size: NSUInteger);

        #[unsafe(method(initWithDevice:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithDevice(
            this: Allocated<Self>,
            device: &ProtocolObject<dyn MTLDevice>,
        ) -> Retained<Self>;

        /// Encode a MPSMatrixRandom kernel into a command Buffer.
        ///
        /// Parameter `commandBuffer`: A valid MTLCommandBuffer to receive the encoded filter
        ///
        /// Parameter `destinationVector`: A valid MPSVector to contain the result.
        #[unsafe(method(encodeToCommandBuffer:destinationVector:))]
        #[unsafe(method_family = none)]
        pub unsafe fn encodeToCommandBuffer_destinationVector(
            &self,
            command_buffer: &ProtocolObject<dyn MTLCommandBuffer>,
            destination_vector: &MPSVector,
        );

        /// Encode a MPSMatrixRandom kernel into a command Buffer.
        ///
        /// Parameter `commandBuffer`: A valid MTLCommandBuffer to receive the encoded filter
        ///
        /// Parameter `destinationMatrix`: A valid MPSMatrix to contain the result.
        #[unsafe(method(encodeToCommandBuffer:destinationMatrix:))]
        #[unsafe(method_family = none)]
        pub unsafe fn encodeToCommandBuffer_destinationMatrix(
            &self,
            command_buffer: &ProtocolObject<dyn MTLCommandBuffer>,
            destination_matrix: &MPSMatrix,
        );
    );
}

/// Methods declared on superclass `MPSKernel`.
#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
impl MPSMatrixRandom {
    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>>;

        /// 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 `NSObject`.
#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
impl MPSMatrixRandom {
    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!(
    /// Generates random numbers using a Mersenne Twister algorithm
    /// suitable for GPU execution.  It uses a period of 2**11214.
    /// For further details see:
    /// Mutsuo Saito. A Variant of Mersenne Twister Suitable for Graphic Processors. arXiv:1005.4973
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpsmatrixrandommtgp32?language=objc)
    #[unsafe(super(MPSMatrixRandom, MPSKernel, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
    pub struct MPSMatrixRandomMTGP32;
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSCoding for MPSMatrixRandomMTGP32 {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSCopying for MPSMatrixRandomMTGP32 {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSMatrixRandomMTGP32 {
    type Result = Self;
}

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSObjectProtocol for MPSMatrixRandomMTGP32 {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSSecureCoding for MPSMatrixRandomMTGP32 {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
impl MPSMatrixRandomMTGP32 {
    extern_methods!(
        /// initialize a MPSMatrixRandomMTGP32 filter to generate 32-bit unsigned
        /// integer values with an initial seed of 0.
        ///
        /// Parameter `device`: The device the filter will run on
        #[unsafe(method(initWithDevice:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithDevice(
            this: Allocated<Self>,
            device: &ProtocolObject<dyn MTLDevice>,
        ) -> Retained<Self>;

        #[cfg(feature = "MPSCoreTypes")]
        /// initialize a MPSMatrixRandomMTGP32 filter
        ///
        /// Parameter `device`: The device the filter will run on
        ///
        /// Parameter `destinationDataType`: The data type of the result.
        ///
        /// Parameter `seed`: The seed to initialize the random number generators with.
        ///
        /// Parameter `distributionDescriptor`: A descriptor containing information about the distribution.
        #[unsafe(method(initWithDevice:destinationDataType:seed:distributionDescriptor:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithDevice_destinationDataType_seed_distributionDescriptor(
            this: Allocated<Self>,
            device: &ProtocolObject<dyn MTLDevice>,
            destination_data_type: MPSDataType,
            seed: NSUInteger,
            distribution_descriptor: &MPSMatrixRandomDistributionDescriptor,
        ) -> Retained<Self>;

        /// Synchronize internal MTGP32 state between GPU and CPU.
        ///
        /// Parameter `commandBuffer`: The command buffer on which to encode the synchronization.
        #[unsafe(method(synchronizeStateOnCommandBuffer:))]
        #[unsafe(method_family = none)]
        pub unsafe fn synchronizeStateOnCommandBuffer(
            &self,
            command_buffer: &ProtocolObject<dyn MTLCommandBuffer>,
        );

        #[cfg(feature = "MPSCoreTypes")]
        /// initialize a MPSMatrixRandomMTGP32 filter using a default distribution.
        ///
        /// Parameter `device`: The device the filter will run on
        ///
        /// Parameter `destinationDataType`: The data type of the result.
        ///
        /// Parameter `seed`: The seed to initialize the random number generators with.
        #[unsafe(method(initWithDevice:destinationDataType:seed:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithDevice_destinationDataType_seed(
            this: Allocated<Self>,
            device: &ProtocolObject<dyn MTLDevice>,
            destination_data_type: MPSDataType,
            seed: NSUInteger,
        ) -> Retained<Self>;

        /// # 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 = "MPSCore", feature = "MPSKernel"))]
impl MPSMatrixRandomMTGP32 {
    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 = "MPSCore", feature = "MPSKernel"))]
impl MPSMatrixRandomMTGP32 {
    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!(
    /// Generates random numbers using a counter based algorithm.
    /// For further details see:
    /// John K. Salmon, Mark A. Moraes, Ron O. Dror, and David E. Shaw. Parallel Random Numbers: As Easy as 1, 2, 3.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/metalperformanceshaders/mpsmatrixrandomphilox?language=objc)
    #[unsafe(super(MPSMatrixRandom, MPSKernel, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
    pub struct MPSMatrixRandomPhilox;
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSCoding for MPSMatrixRandomPhilox {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSCopying for MPSMatrixRandomPhilox {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
unsafe impl CopyingHelper for MPSMatrixRandomPhilox {
    type Result = Self;
}

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSObjectProtocol for MPSMatrixRandomPhilox {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
extern_conformance!(
    unsafe impl NSSecureCoding for MPSMatrixRandomPhilox {}
);

#[cfg(all(feature = "MPSCore", feature = "MPSKernel"))]
impl MPSMatrixRandomPhilox {
    extern_methods!(
        /// initialize a MPSMatrixRandomPhilox filter to generate 32-bit unsigned
        /// integer values with an initial seed of 0.
        ///
        /// Parameter `device`: The device the filter will run on
        #[unsafe(method(initWithDevice:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithDevice(
            this: Allocated<Self>,
            device: &ProtocolObject<dyn MTLDevice>,
        ) -> Retained<Self>;

        #[cfg(feature = "MPSCoreTypes")]
        /// initialize a MPSMatrixRandomPhilox filter
        ///
        /// Parameter `device`: The device the filter will run on
        ///
        /// Parameter `destinationDataType`: The data type of the result.
        ///
        /// Parameter `seed`: The seed to initialize the random number generators with.
        ///
        /// Parameter `distributionDescriptor`: A descriptor containing information about the distribution.
        #[unsafe(method(initWithDevice:destinationDataType:seed:distributionDescriptor:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithDevice_destinationDataType_seed_distributionDescriptor(
            this: Allocated<Self>,
            device: &ProtocolObject<dyn MTLDevice>,
            destination_data_type: MPSDataType,
            seed: NSUInteger,
            distribution_descriptor: &MPSMatrixRandomDistributionDescriptor,
        ) -> Retained<Self>;

        #[cfg(feature = "MPSCoreTypes")]
        /// initialize a MPSMatrixRandomPhilox filter using a default distribution.
        ///
        /// Parameter `device`: The device the filter will run on
        ///
        /// Parameter `destinationDataType`: The data type of the result.
        ///
        /// Parameter `seed`: The seed to initialize the random number generators with.
        #[unsafe(method(initWithDevice:destinationDataType:seed:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithDevice_destinationDataType_seed(
            this: Allocated<Self>,
            device: &ProtocolObject<dyn MTLDevice>,
            destination_data_type: MPSDataType,
            seed: NSUInteger,
        ) -> Retained<Self>;

        /// # 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 = "MPSCore", feature = "MPSKernel"))]
impl MPSMatrixRandomPhilox {
    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 = "MPSCore", feature = "MPSKernel"))]
impl MPSMatrixRandomPhilox {
    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>;
    );
}