blade-graphics 0.8.0

Graphics abstraction for Blade
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
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
use objc2_foundation::{NSArray, NSRange, NSString};
use objc2_metal::{
    self as metal, MTLAccelerationStructureCommandEncoder as _, MTLBlitCommandEncoder,
    MTLCommandBuffer as _, MTLCommandEncoder, MTLComputeCommandEncoder as _,
    MTLCounterSampleBuffer, MTLRenderCommandEncoder,
};
use std::{marker::PhantomData, mem, ptr::NonNull, slice, time::Duration};

/// Key for the ObjC associated object that stores BLAS references on a TLAS.
static ASSOCIATED_BLAS_KEY: u8 = 0;

impl<T: bytemuck::Pod> crate::ShaderBindable for T {
    fn bind_to(&self, ctx: &mut super::PipelineContext, index: u32) {
        let slot = ctx.targets[index as usize] as _;
        let size = mem::size_of::<T>();
        unsafe {
            let ptr = NonNull::new_unchecked(self as *const _ as *mut _);
            if let Some(encoder) = ctx.vs_encoder {
                encoder.setVertexBytes_length_atIndex(ptr, size, slot);
            }
            if let Some(encoder) = ctx.fs_encoder {
                encoder.setFragmentBytes_length_atIndex(ptr, size, slot);
            }
            if let Some(encoder) = ctx.cs_encoder {
                encoder.setBytes_length_atIndex(ptr, size, slot);
            }
        }
    }
}
impl crate::ShaderBindable for super::TextureView {
    fn bind_to(&self, ctx: &mut super::PipelineContext, index: u32) {
        let slot = ctx.targets[index as usize] as _;
        let value = Some(self.as_ref());
        unsafe {
            if let Some(encoder) = ctx.vs_encoder {
                encoder.setVertexTexture_atIndex(value, slot);
            }
            if let Some(encoder) = ctx.fs_encoder {
                encoder.setFragmentTexture_atIndex(value, slot);
            }
            if let Some(encoder) = ctx.cs_encoder {
                encoder.setTexture_atIndex(value, slot);
            }
        }
    }
}
impl<'a, const N: crate::ResourceIndex> crate::ShaderBindable for &'a crate::TextureArray<N> {
    fn bind_to(&self, _ctx: &mut super::PipelineContext, _index: u32) {
        unimplemented!()
    }
}
impl crate::ShaderBindable for super::Sampler {
    fn bind_to(&self, ctx: &mut super::PipelineContext, index: u32) {
        let slot = ctx.targets[index as usize] as _;
        let value = Some(self.as_ref());
        unsafe {
            if let Some(encoder) = ctx.vs_encoder {
                encoder.setVertexSamplerState_atIndex(value, slot);
            }
            if let Some(encoder) = ctx.fs_encoder {
                encoder.setFragmentSamplerState_atIndex(value, slot);
            }
            if let Some(encoder) = ctx.cs_encoder {
                encoder.setSamplerState_atIndex(value, slot);
            }
        }
    }
}
impl crate::ShaderBindable for crate::BufferPiece {
    fn bind_to(&self, ctx: &mut super::PipelineContext, index: u32) {
        let slot = ctx.targets[index as usize] as _;
        let value = Some(self.buffer.as_ref());
        unsafe {
            if let Some(encoder) = ctx.vs_encoder {
                encoder.setVertexBuffer_offset_atIndex(value, self.offset as usize, slot);
            }
            if let Some(encoder) = ctx.fs_encoder {
                encoder.setFragmentBuffer_offset_atIndex(value, self.offset as usize, slot);
            }
            if let Some(encoder) = ctx.cs_encoder {
                encoder.setBuffer_offset_atIndex(value, self.offset as usize, slot);
            }
        }
    }
}
impl<'a, const N: crate::ResourceIndex> crate::ShaderBindable for &'a crate::BufferArray<N> {
    fn bind_to(&self, _ctx: &mut super::PipelineContext, _index: u32) {
        unimplemented!()
    }
}
impl crate::ShaderBindable for crate::AccelerationStructure {
    fn bind_to(&self, ctx: &mut super::PipelineContext, index: u32) {
        let slot = ctx.targets[index as usize] as _;
        let value = Some(self.as_ref());
        // Metal requires useResource for the TLAS and all referenced BLAS,
        // otherwise the GPU may not have them resident in memory.
        // The BLAS pointers are stored as an ObjC associated object (NSData)
        // on the TLAS, set during build_top_level.
        let tlas_resource: &objc2::runtime::ProtocolObject<dyn metal::MTLResource> =
            unsafe { &*(self.raw as *const _) };
        let (blas_ptr, blas_count) = unsafe {
            let data = objc2::ffi::objc_getAssociatedObject(
                self.raw as *const objc2::runtime::AnyObject,
                &ASSOCIATED_BLAS_KEY as *const _ as *const std::ffi::c_void,
            );
            if data.is_null() {
                (NonNull::dangling(), 0)
            } else {
                let data: &objc2_foundation::NSData = &*(data as *const _);
                let bytes = data.as_bytes_unchecked();
                let len = bytes.len() / mem::size_of::<*mut ()>();
                (NonNull::new_unchecked(bytes.as_ptr() as *mut _), len)
            }
        };
        unsafe {
            if let Some(encoder) = ctx.vs_encoder {
                let stages = metal::MTLRenderStages::Vertex;
                encoder.setVertexAccelerationStructure_atBufferIndex(value, slot);
                encoder.useResource_usage_stages(
                    tlas_resource,
                    metal::MTLResourceUsage::Read,
                    stages,
                );
                if blas_count != 0 {
                    encoder.useResources_count_usage_stages(
                        blas_ptr,
                        blas_count,
                        metal::MTLResourceUsage::Read,
                        stages,
                    );
                }
            }
            if let Some(encoder) = ctx.fs_encoder {
                let stages = metal::MTLRenderStages::Fragment;
                encoder.setFragmentAccelerationStructure_atBufferIndex(value, slot);
                encoder.useResource_usage_stages(
                    tlas_resource,
                    metal::MTLResourceUsage::Read,
                    stages,
                );
                if blas_count != 0 {
                    encoder.useResources_count_usage_stages(
                        blas_ptr,
                        blas_count,
                        metal::MTLResourceUsage::Read,
                        stages,
                    );
                }
            }
            if let Some(encoder) = ctx.cs_encoder {
                encoder.setAccelerationStructure_atBufferIndex(value, slot);
                encoder.useResource_usage(tlas_resource, metal::MTLResourceUsage::Read);
                if blas_count != 0 {
                    encoder.useResources_count_usage(
                        blas_ptr,
                        blas_count,
                        metal::MTLResourceUsage::Read,
                    );
                }
            }
        }
    }
}
impl<'a, const N: crate::ResourceIndex> crate::ShaderBindable
    for &'a crate::AccelerationStructureArray<N>
{
    fn bind_to(&self, _ctx: &mut super::PipelineContext, _index: u32) {
        unimplemented!()
    }
}

impl super::TimingData {
    fn add(&mut self, label: &str) -> usize {
        let counter_index = self.pass_names.len() * 2;
        self.pass_names.push(label.to_string());
        counter_index
    }
}

impl super::CommandEncoder {
    fn begin_pass(&mut self, label: &str) {
        if self.enable_debug_groups {
            //HACK: close the previous group
            if self.has_open_debug_group {
                self.raw.as_mut().unwrap().popDebugGroup();
            } else {
                self.has_open_debug_group = true;
            }
            let string = NSString::from_str(label);
            self.raw.as_mut().unwrap().pushDebugGroup(&string);
        }
    }

    pub(super) fn finish(&mut self) -> super::RawCommandBuffer {
        if self.has_open_debug_group {
            self.raw.as_mut().unwrap().popDebugGroup();
        }
        self.raw.take().unwrap()
    }

    pub fn transfer(&mut self, label: &str) -> super::TransferCommandEncoder<'_> {
        self.begin_pass(label);
        let raw = objc2::rc::autoreleasepool(|_| unsafe {
            let descriptor = metal::MTLBlitPassDescriptor::new();
            if let Some(ref mut td_array) = self.timing_datas {
                let td = td_array.first_mut().unwrap();
                let counter_index = td.add(label);
                let sba = descriptor
                    .sampleBufferAttachments()
                    .objectAtIndexedSubscript(0);
                sba.setSampleBuffer(Some(&td.sample_buffer));
                sba.setStartOfEncoderSampleIndex(counter_index);
                sba.setEndOfEncoderSampleIndex(counter_index + 1);
            }

            self.raw
                .as_mut()
                .unwrap()
                .blitCommandEncoderWithDescriptor(&descriptor)
                .unwrap()
        });
        super::TransferCommandEncoder {
            raw,
            phantom: PhantomData,
        }
    }

    pub fn acceleration_structure(
        &mut self,
        label: &str,
    ) -> super::AccelerationStructureCommandEncoder<'_> {
        let raw = objc2::rc::autoreleasepool(|_| unsafe {
            let descriptor = metal::MTLAccelerationStructurePassDescriptor::new();

            if let Some(ref mut td_array) = self.timing_datas {
                let td = td_array.first_mut().unwrap();
                let counter_index = td.add(label);
                let sba = descriptor
                    .sampleBufferAttachments()
                    .objectAtIndexedSubscript(0);
                sba.setSampleBuffer(Some(&td.sample_buffer));
                sba.setStartOfEncoderSampleIndex(counter_index);
                sba.setEndOfEncoderSampleIndex(counter_index + 1);
            }

            self.raw
                .as_mut()
                .unwrap()
                .accelerationStructureCommandEncoderWithDescriptor(&descriptor)
        });
        super::AccelerationStructureCommandEncoder {
            raw,
            phantom: PhantomData,
        }
    }

    pub fn compute(&mut self, label: &str) -> super::ComputeCommandEncoder<'_> {
        let raw = objc2::rc::autoreleasepool(|_| unsafe {
            let descriptor = metal::MTLComputePassDescriptor::new();
            if self.enable_dispatch_type {
                descriptor.setDispatchType(metal::MTLDispatchType::Concurrent);
            }

            if let Some(ref mut td_array) = self.timing_datas {
                let td = td_array.first_mut().unwrap();
                let counter_index = td.add(label);
                let sba = descriptor
                    .sampleBufferAttachments()
                    .objectAtIndexedSubscript(0);
                sba.setSampleBuffer(Some(&td.sample_buffer));
                sba.setStartOfEncoderSampleIndex(counter_index);
                sba.setEndOfEncoderSampleIndex(counter_index + 1);
            }

            self.raw
                .as_mut()
                .unwrap()
                .computeCommandEncoderWithDescriptor(&descriptor)
                .unwrap()
        });
        super::ComputeCommandEncoder {
            raw,
            phantom: PhantomData,
        }
    }

    pub fn render(
        &mut self,
        label: &str,
        targets: crate::RenderTargetSet,
    ) -> super::RenderCommandEncoder<'_> {
        let raw = objc2::rc::autoreleasepool(|_| {
            let descriptor = unsafe { metal::MTLRenderPassDescriptor::new() };

            for (i, rt) in targets.colors.iter().enumerate() {
                let at_descriptor =
                    unsafe { descriptor.colorAttachments().objectAtIndexedSubscript(i) };
                at_descriptor.setTexture(Some(rt.view.as_ref()));

                let load_action = match rt.init_op {
                    crate::InitOp::Load => metal::MTLLoadAction::Load,
                    crate::InitOp::Clear(color) => {
                        let clear_color = map_clear_color(color);
                        at_descriptor.setClearColor(clear_color);
                        metal::MTLLoadAction::Clear
                    }
                    crate::InitOp::DontCare => metal::MTLLoadAction::DontCare,
                };
                at_descriptor.setLoadAction(load_action);

                let store_action = match rt.finish_op {
                    crate::FinishOp::Store | crate::FinishOp::Ignore => {
                        metal::MTLStoreAction::Store
                    }
                    crate::FinishOp::Discard => metal::MTLStoreAction::DontCare,
                    crate::FinishOp::ResolveTo(ref view) => {
                        at_descriptor.setResolveTexture(Some(view.as_ref()));
                        metal::MTLStoreAction::MultisampleResolve
                    }
                };
                at_descriptor.setStoreAction(store_action);
            }

            if let Some(ref rt) = targets.depth_stencil {
                if rt.view.aspects.contains(crate::TexelAspects::DEPTH) {
                    let at_descriptor = descriptor.depthAttachment();
                    at_descriptor.setTexture(Some(rt.view.as_ref()));
                    let load_action = match rt.init_op {
                        crate::InitOp::Load => metal::MTLLoadAction::Load,
                        crate::InitOp::Clear(color) => {
                            let clear_depth = color.depth_clear_value();
                            at_descriptor.setClearDepth(clear_depth as f64);
                            metal::MTLLoadAction::Clear
                        }
                        crate::InitOp::DontCare => metal::MTLLoadAction::DontCare,
                    };
                    let store_action = match rt.finish_op {
                        crate::FinishOp::Store | crate::FinishOp::Ignore => {
                            metal::MTLStoreAction::Store
                        }
                        crate::FinishOp::Discard => metal::MTLStoreAction::DontCare,
                        crate::FinishOp::ResolveTo(_) => panic!("Can't resolve depth texture"),
                    };
                    at_descriptor.setLoadAction(load_action);
                    at_descriptor.setStoreAction(store_action);
                }

                if rt.view.aspects.contains(crate::TexelAspects::STENCIL) {
                    let at_descriptor = descriptor.stencilAttachment();
                    at_descriptor.setTexture(Some(rt.view.as_ref()));

                    let load_action = match rt.init_op {
                        crate::InitOp::Load => metal::MTLLoadAction::Load,
                        crate::InitOp::Clear(color) => {
                            let clear_stencil = color.stencil_clear_value();
                            at_descriptor.setClearStencil(clear_stencil);
                            metal::MTLLoadAction::Clear
                        }
                        crate::InitOp::DontCare => metal::MTLLoadAction::DontCare,
                    };
                    let store_action = match rt.finish_op {
                        crate::FinishOp::Store | crate::FinishOp::Ignore => {
                            metal::MTLStoreAction::Store
                        }
                        crate::FinishOp::Discard => metal::MTLStoreAction::DontCare,
                        crate::FinishOp::ResolveTo(_) => panic!("Can't resolve stencil texture"),
                    };

                    at_descriptor.setLoadAction(load_action);
                    at_descriptor.setStoreAction(store_action);
                }
            }

            if let Some(ref mut td_array) = self.timing_datas {
                let td = td_array.first_mut().unwrap();
                let counter_index = td.add(label);
                unsafe {
                    let sba = descriptor
                        .sampleBufferAttachments()
                        .objectAtIndexedSubscript(0);
                    sba.setSampleBuffer(Some(&td.sample_buffer));
                    sba.setStartOfVertexSampleIndex(counter_index);
                    sba.setEndOfFragmentSampleIndex(counter_index + 1);
                }
            }

            self.raw
                .as_mut()
                .unwrap()
                .renderCommandEncoderWithDescriptor(&descriptor)
                .unwrap()
        });

        super::RenderCommandEncoder {
            raw,
            phantom: PhantomData,
        }
    }
}

#[hidden_trait::expose]
impl crate::traits::CommandEncoder for super::CommandEncoder {
    type Texture = super::Texture;
    type Frame = super::Frame;

    fn start(&mut self) {
        if let Some(ref mut td_array) = self.timing_datas {
            self.timings.clear();
            td_array.rotate_left(1);
            let td = td_array.first_mut().unwrap();
            if !td.pass_names.is_empty() {
                let ns_data = unsafe {
                    td.sample_buffer
                        .resolveCounterRange(NSRange::new(0, td.pass_names.len() * 2))
                        .unwrap()
                };
                let counters = unsafe {
                    slice::from_raw_parts(
                        ns_data.as_bytes_unchecked().as_ptr() as *const u64,
                        ns_data.len() / mem::size_of::<u64>(),
                    )
                };
                for (name, chunk) in td.pass_names.drain(..).zip(counters.chunks(2)) {
                    let duration = Duration::from_nanos(chunk[1] - chunk[0]);
                    self.timings.push((name, duration));
                }
            }
        }

        let queue = self.queue.lock().unwrap();
        self.raw = Some(objc2::rc::autoreleasepool(|_| unsafe {
            use metal::MTLCommandQueue as _;
            let cmd_buf = queue.commandBufferWithUnretainedReferences().unwrap();
            if !self.name.is_empty() {
                cmd_buf.setLabel(Some(&NSString::from_str(&self.name)));
            }
            cmd_buf
        }));
        self.has_open_debug_group = false;
    }

    fn init_texture(&mut self, _texture: super::Texture) {}

    fn present(&mut self, frame: super::Frame) {
        self.raw.as_mut().unwrap().presentDrawable(&frame.drawable);
    }

    fn timings(&self) -> &crate::Timings {
        &self.timings
    }
}

#[hidden_trait::expose]
impl crate::traits::TransferEncoder for super::TransferCommandEncoder<'_> {
    type BufferPiece = crate::BufferPiece;
    type TexturePiece = crate::TexturePiece;

    fn fill_buffer(&mut self, dst: crate::BufferPiece, size: u64, value: u8) {
        let range = NSRange {
            location: dst.offset as usize,
            length: size as usize,
        };
        self.raw
            .fillBuffer_range_value(dst.buffer.as_ref(), range, value);
    }

    fn copy_buffer_to_buffer(
        &mut self,
        src: crate::BufferPiece,
        dst: crate::BufferPiece,
        size: u64,
    ) {
        unsafe {
            self.raw
                .copyFromBuffer_sourceOffset_toBuffer_destinationOffset_size(
                    src.buffer.as_ref(),
                    src.offset as usize,
                    dst.buffer.as_ref(),
                    dst.offset as usize,
                    size as usize,
                )
        };
    }
    fn copy_texture_to_texture(
        &mut self,
        src: crate::TexturePiece,
        dst: crate::TexturePiece,
        size: crate::Extent,
    ) {
        unsafe {
            self.raw.copyFromTexture_sourceSlice_sourceLevel_sourceOrigin_sourceSize_toTexture_destinationSlice_destinationLevel_destinationOrigin(
                src.texture.as_ref(),
                src.array_layer as usize,
                src.mip_level as usize,
                map_origin(&src.origin),
                map_extent(&size),
                dst.texture.as_ref(),
                dst.array_layer as usize,
                dst.mip_level as usize,
                map_origin(&dst.origin),
            )
        };
    }

    fn copy_buffer_to_texture(
        &mut self,
        src: crate::BufferPiece,
        bytes_per_row: u32,
        dst: crate::TexturePiece,
        size: crate::Extent,
    ) {
        unsafe {
            self.raw.copyFromBuffer_sourceOffset_sourceBytesPerRow_sourceBytesPerImage_sourceSize_toTexture_destinationSlice_destinationLevel_destinationOrigin_options(
                src.buffer.as_ref(),
                src.offset as usize,
                bytes_per_row as usize,
                0,
                map_extent(&size),
                dst.texture.as_ref(),
                dst.array_layer as usize,
                dst.mip_level as usize,
                map_origin(&dst.origin),
                metal::MTLBlitOption::empty(),
            )
        };
    }

    fn copy_texture_to_buffer(
        &mut self,
        src: crate::TexturePiece,
        dst: crate::BufferPiece,
        bytes_per_row: u32,
        size: crate::Extent,
    ) {
        unsafe {
            self.raw.copyFromTexture_sourceSlice_sourceLevel_sourceOrigin_sourceSize_toBuffer_destinationOffset_destinationBytesPerRow_destinationBytesPerImage_options(
                src.texture.as_ref(),
                src.array_layer as usize,
                src.mip_level as usize,
                map_origin(&src.origin),
                map_extent(&size),
                dst.buffer.as_ref(),
                dst.offset as usize,
                bytes_per_row as usize,
                0,
                metal::MTLBlitOption::empty(),
            )
        };
    }
}

impl Drop for super::TransferCommandEncoder<'_> {
    fn drop(&mut self) {
        self.raw.endEncoding();
    }
}

#[hidden_trait::expose]
impl crate::traits::AccelerationStructureEncoder
    for super::AccelerationStructureCommandEncoder<'_>
{
    type AccelerationStructure = crate::AccelerationStructure;
    type AccelerationStructureMesh = crate::AccelerationStructureMesh;
    type BufferPiece = crate::BufferPiece;

    fn build_bottom_level(
        &mut self,
        acceleration_structure: super::AccelerationStructure,
        meshes: &[crate::AccelerationStructureMesh],
        scratch_data: crate::BufferPiece,
    ) {
        let descriptor = super::make_bottom_level_acceleration_structure_desc(meshes);
        self.raw
            .buildAccelerationStructure_descriptor_scratchBuffer_scratchBufferOffset(
                acceleration_structure.as_ref(),
                &descriptor,
                scratch_data.buffer.as_ref(),
                scratch_data.offset as usize,
            );
    }

    fn build_top_level(
        &mut self,
        acceleration_structure: super::AccelerationStructure,
        bottom_level: &[super::AccelerationStructure],
        instance_count: u32,
        instance_data: crate::BufferPiece,
        scratch_data: crate::BufferPiece,
    ) {
        let mut primitive_acceleration_structures = Vec::with_capacity(bottom_level.len());
        for blas in bottom_level {
            primitive_acceleration_structures.push(blas.as_retained());
        }
        let descriptor = metal::MTLInstanceAccelerationStructureDescriptor::descriptor();
        descriptor.setInstancedAccelerationStructures(Some(&NSArray::from_retained_slice(
            &primitive_acceleration_structures,
        )));
        descriptor.setInstanceCount(instance_count as usize);
        unsafe {
            descriptor.setInstanceDescriptorType(
                metal::MTLAccelerationStructureInstanceDescriptorType::UserID,
            );
            descriptor.setInstanceDescriptorBuffer(Some(instance_data.buffer.as_ref()));
            descriptor.setInstanceDescriptorBufferOffset(instance_data.offset as usize);
        }

        self.raw
            .buildAccelerationStructure_descriptor_scratchBuffer_scratchBufferOffset(
                acceleration_structure.as_ref(),
                &descriptor,
                scratch_data.buffer.as_ref(),
                scratch_data.offset as usize,
            );

        // Store BLAS pointers as an associated object on the TLAS so that
        // `useResources` can be called automatically on bind.
        let blas_ptrs: Vec<*mut _> = bottom_level.iter().map(|blas| blas.raw).collect();
        let data = objc2_foundation::NSData::with_bytes(unsafe {
            std::slice::from_raw_parts(
                blas_ptrs.as_ptr() as *const u8,
                blas_ptrs.len() * std::mem::size_of::<*mut ()>(),
            )
        });
        unsafe {
            objc2::ffi::objc_setAssociatedObject(
                acceleration_structure.raw as *mut objc2::runtime::AnyObject,
                &ASSOCIATED_BLAS_KEY as *const _ as *const std::ffi::c_void,
                objc2::rc::Retained::as_ptr(&data) as *mut objc2::runtime::AnyObject,
                objc2::ffi::OBJC_ASSOCIATION_RETAIN_NONATOMIC,
            );
        }
    }
}

impl Drop for super::AccelerationStructureCommandEncoder<'_> {
    fn drop(&mut self) {
        self.raw.endEncoding();
    }
}

impl super::ComputeCommandEncoder<'_> {
    pub fn with<'p>(
        &'p mut self,
        pipeline: &'p super::ComputePipeline,
    ) -> super::ComputePipelineContext<'p> {
        self.raw.pushDebugGroup(&NSString::from_str(&pipeline.name));
        self.raw.setComputePipelineState(&pipeline.raw);
        if let Some(index) = pipeline.layout.sizes_buffer_slot {
            //TODO: get real sizes? shouldn't matter without bounds checks
            let runtime_sizes = [0u8; 8];
            unsafe {
                self.raw.setBytes_length_atIndex(
                    NonNull::new(runtime_sizes.as_ptr() as *const _ as *mut _).unwrap(),
                    runtime_sizes.len(),
                    index as _,
                );
            }
        }
        for (index, &size) in pipeline.wg_memory_sizes.iter().enumerate() {
            unsafe {
                self.raw
                    .setThreadgroupMemoryLength_atIndex(size as _, index);
            }
        }

        super::ComputePipelineContext {
            encoder: self.raw.as_ref(),
            wg_size: pipeline.wg_size,
            group_mappings: &pipeline.layout.group_mappings,
        }
    }
}

impl Drop for super::ComputeCommandEncoder<'_> {
    fn drop(&mut self) {
        self.raw.endEncoding();
    }
}

impl crate::ScissorRect {
    const fn to_metal(&self) -> metal::MTLScissorRect {
        metal::MTLScissorRect {
            x: self.x as _,
            y: self.y as _,
            width: self.w as _,
            height: self.h as _,
        }
    }
}
impl crate::Viewport {
    const fn to_metal(&self) -> metal::MTLViewport {
        metal::MTLViewport {
            originX: self.x as _,
            originY: self.y as _,
            width: self.w as _,
            height: self.h as _,
            znear: self.depth.start as _,
            // TODO: broken on some Intel GPUs
            // https://github.com/gfx-rs/wgpu/blob/ee3ae0e549fe01c4b699cf68f9b67ae8ea807564/wgpu-hal/src/metal/mod.rs#L298
            zfar: self.depth.end as _,
        }
    }
}

#[hidden_trait::expose]
impl crate::traits::RenderEncoder for super::RenderCommandEncoder<'_> {
    fn set_scissor_rect(&mut self, rect: &crate::ScissorRect) {
        self.raw.setScissorRect(rect.to_metal());
    }

    fn set_viewport(&mut self, viewport: &crate::Viewport) {
        self.raw.setViewport(viewport.to_metal());
    }

    fn set_stencil_reference(&mut self, stencil_reference: u32) {
        self.raw.setStencilReferenceValue(stencil_reference);
    }
}

impl super::RenderCommandEncoder<'_> {
    pub fn with<'p>(
        &'p mut self,
        pipeline: &'p super::RenderPipeline,
    ) -> super::RenderPipelineContext<'p> {
        self.raw.pushDebugGroup(&NSString::from_str(&pipeline.name));
        self.raw.setRenderPipelineState(&pipeline.raw);
        if let Some(index) = pipeline.layout.sizes_buffer_slot {
            //TODO: get real sizes
            let runtime_sizes = [0u8; 8];
            unsafe {
                self.raw.setVertexBytes_length_atIndex(
                    NonNull::new(runtime_sizes.as_ptr() as *const _ as *mut _).unwrap(),
                    runtime_sizes.len(),
                    index as _,
                );
                self.raw.setFragmentBytes_length_atIndex(
                    NonNull::new(runtime_sizes.as_ptr() as *const _ as *mut _).unwrap(),
                    runtime_sizes.len(),
                    index as _,
                );
            }
        }

        self.raw.setFrontFacingWinding(pipeline.front_winding);
        self.raw.setCullMode(pipeline.cull_mode);
        self.raw.setTriangleFillMode(pipeline.triangle_fill_mode);
        self.raw.setDepthClipMode(pipeline.depth_clip_mode);
        if let Some((ref state, bias)) = pipeline.depth_stencil {
            self.raw.setDepthStencilState(Some(state));
            self.raw.setDepthBias_slopeScale_clamp(
                bias.constant as f32,
                bias.slope_scale,
                bias.clamp,
            );
        }

        super::RenderPipelineContext {
            encoder: self.raw.as_ref(),
            primitive_type: pipeline.primitive_type,
            group_mappings: &pipeline.layout.group_mappings,
        }
    }
}

impl Drop for super::RenderCommandEncoder<'_> {
    fn drop(&mut self) {
        self.raw.endEncoding();
    }
}

#[hidden_trait::expose]
impl crate::traits::PipelineEncoder for super::ComputePipelineContext<'_> {
    fn bind<D: crate::ShaderData>(&mut self, group: u32, data: &D) {
        let info = &self.group_mappings[group as usize];

        data.fill(super::PipelineContext {
            cs_encoder: if info.visibility.contains(crate::ShaderVisibility::COMPUTE) {
                Some(self.encoder.as_ref())
            } else {
                None
            },
            vs_encoder: None,
            fs_encoder: None,
            targets: &info.targets,
        });
    }
}

#[hidden_trait::expose]
impl crate::traits::ComputePipelineEncoder for super::ComputePipelineContext<'_> {
    type BufferPiece = crate::BufferPiece;

    fn dispatch(&mut self, groups: [u32; 3]) {
        let raw_count = metal::MTLSize {
            width: groups[0] as usize,
            height: groups[1] as usize,
            depth: groups[2] as usize,
        };
        self.encoder
            .dispatchThreadgroups_threadsPerThreadgroup(raw_count, self.wg_size);
    }

    fn dispatch_indirect(&mut self, indirect_buf: crate::BufferPiece) {
        unsafe {
            self.encoder
                .dispatchThreadgroupsWithIndirectBuffer_indirectBufferOffset_threadsPerThreadgroup(
                    indirect_buf.buffer.as_ref(),
                    indirect_buf.offset as usize,
                    self.wg_size,
                );
        }
    }
}

impl Drop for super::ComputePipelineContext<'_> {
    fn drop(&mut self) {
        self.encoder.popDebugGroup();
    }
}

#[hidden_trait::expose]
impl crate::traits::PipelineEncoder for super::RenderPipelineContext<'_> {
    fn bind<D: crate::ShaderData>(&mut self, group: u32, data: &D) {
        let info = &self.group_mappings[group as usize];

        data.fill(super::PipelineContext {
            cs_encoder: None,
            vs_encoder: if info.visibility.contains(crate::ShaderVisibility::VERTEX) {
                Some(self.encoder.as_ref())
            } else {
                None
            },
            fs_encoder: if info.visibility.contains(crate::ShaderVisibility::FRAGMENT) {
                Some(self.encoder.as_ref())
            } else {
                None
            },
            targets: &info.targets,
        });
    }
}

#[hidden_trait::expose]
impl crate::traits::RenderEncoder for super::RenderPipelineContext<'_> {
    fn set_scissor_rect(&mut self, rect: &crate::ScissorRect) {
        self.encoder.setScissorRect(rect.to_metal());
    }
    fn set_viewport(&mut self, viewport: &crate::Viewport) {
        self.encoder.setViewport(viewport.to_metal());
    }
    fn set_stencil_reference(&mut self, stencil_reference: u32) {
        self.encoder.setStencilReferenceValue(stencil_reference);
    }
}

#[hidden_trait::expose]
impl crate::traits::RenderPipelineEncoder for super::RenderPipelineContext<'_> {
    type BufferPiece = crate::BufferPiece;

    fn bind_vertex(&mut self, index: u32, vertex_buf: crate::BufferPiece) {
        unsafe {
            self.encoder.setVertexBuffer_offset_atIndex(
                Some(vertex_buf.buffer.as_ref()),
                vertex_buf.offset as usize,
                index as usize,
            );
        }
    }

    fn draw(
        &mut self,
        first_vertex: u32,
        vertex_count: u32,
        first_instance: u32,
        instance_count: u32,
    ) {
        unsafe {
            if first_instance != 0 {
                self.encoder
                    .drawPrimitives_vertexStart_vertexCount_instanceCount_baseInstance(
                        self.primitive_type,
                        first_vertex as _,
                        vertex_count as _,
                        instance_count as _,
                        first_instance as _,
                    );
            } else if instance_count != 1 {
                self.encoder
                    .drawPrimitives_vertexStart_vertexCount_instanceCount(
                        self.primitive_type,
                        first_vertex as _,
                        vertex_count as _,
                        instance_count as _,
                    );
            } else {
                self.encoder.drawPrimitives_vertexStart_vertexCount(
                    self.primitive_type,
                    first_vertex as _,
                    vertex_count as _,
                );
            }
        }
    }

    fn draw_indexed(
        &mut self,
        index_buf: crate::BufferPiece,
        index_type: crate::IndexType,
        index_count: u32,
        base_vertex: i32,
        start_instance: u32,
        instance_count: u32,
    ) {
        let raw_index_type = super::map_index_type(index_type);
        unsafe {
            if base_vertex != 0 || start_instance != 0 {
                self.encoder
                .drawIndexedPrimitives_indexCount_indexType_indexBuffer_indexBufferOffset_instanceCount_baseVertex_baseInstance(
                    self.primitive_type,
                    index_count as _,
                    raw_index_type,
                    index_buf.buffer.as_ref(),
                    index_buf.offset as usize,
                    instance_count as _,
                    base_vertex as _,
                    start_instance as _,
                );
            } else if instance_count != 1 {
                self.encoder.drawIndexedPrimitives_indexCount_indexType_indexBuffer_indexBufferOffset_instanceCount(
                self.primitive_type,
                index_count as _,
                raw_index_type,
                index_buf.buffer.as_ref(),
                index_buf.offset as usize,
                instance_count as _,
            );
            } else {
                self.encoder
                    .drawIndexedPrimitives_indexCount_indexType_indexBuffer_indexBufferOffset(
                        self.primitive_type,
                        index_count as _,
                        raw_index_type,
                        index_buf.buffer.as_ref(),
                        index_buf.offset as usize,
                    );
            }
        }
    }

    fn draw_indirect(&mut self, indirect_buf: crate::BufferPiece) {
        unsafe {
            self.encoder
                .drawPrimitives_indirectBuffer_indirectBufferOffset(
                    self.primitive_type,
                    indirect_buf.buffer.as_ref(),
                    indirect_buf.offset as usize,
                );
        }
    }

    fn draw_indexed_indirect(
        &mut self,
        index_buf: crate::BufferPiece,
        index_type: crate::IndexType,
        indirect_buf: crate::BufferPiece,
    ) {
        let raw_index_type = super::map_index_type(index_type);
        unsafe {
            self.encoder.drawIndexedPrimitives_indexType_indexBuffer_indexBufferOffset_indirectBuffer_indirectBufferOffset(
            self.primitive_type,
            raw_index_type,
            index_buf.buffer.as_ref(),
            index_buf.offset as usize,
            indirect_buf.buffer.as_ref(),
            indirect_buf.offset as usize,
        );
        }
    }
}

impl Drop for super::RenderPipelineContext<'_> {
    fn drop(&mut self) {
        self.encoder.popDebugGroup();
    }
}

fn map_origin(origin: &[u32; 3]) -> metal::MTLOrigin {
    metal::MTLOrigin {
        x: origin[0] as usize,
        y: origin[1] as usize,
        z: origin[2] as usize,
    }
}

fn map_extent(extent: &crate::Extent) -> metal::MTLSize {
    metal::MTLSize {
        width: extent.width as usize,
        height: extent.height as usize,
        depth: extent.depth as usize,
    }
}

fn map_clear_color(color: crate::TextureColor) -> metal::MTLClearColor {
    match color {
        crate::TextureColor::TransparentBlack => metal::MTLClearColor {
            red: 0.0,
            green: 0.0,
            blue: 0.0,
            alpha: 0.0,
        },
        crate::TextureColor::OpaqueBlack => metal::MTLClearColor {
            red: 0.0,
            green: 0.0,
            blue: 0.0,
            alpha: 1.0,
        },
        crate::TextureColor::White => metal::MTLClearColor {
            red: 1.0,
            green: 1.0,
            blue: 1.0,
            alpha: 1.0,
        },
    }
}