byte-engine 0.1.0

A composable Rust game engine focused on graphics, input, audio, physics, and retained UI.
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
/// The `GPUVertexDataManager` is responsible for managing the vertex data buffers used in the visibility pipeline.
/// It tracks buffer offsets and counts for various resources, and provides handles to the vertex data buffers.
/// It performs uploads to the GPU of mesh resources.
#[derive(Clone)]
pub(super) struct GPUVertexDataManager {
	/// Tracks buffer offsets and counts for various resources.
	visibility_info: VisibilityInfo,
	/// Tracks the compact immutable vertex ranges consumed by GPU skinning.
	skinning_source_vertex_count: u32,

	/// Vertex positions buffer for rendered meshes.
	pub vertex_positions_buffer: ghi::BufferHandle<[(f32, f32, f32); MAX_VERTICES]>,
	/// Vertex normals buffer for rendered meshes.
	pub vertex_normals_buffer: ghi::BufferHandle<[(f32, f32, f32); MAX_VERTICES]>,
	/// Vertex UVs buffer for rendered meshes.
	pub vertex_uvs_buffer: ghi::BufferHandle<[(f32, f32); MAX_VERTICES]>,
	/// Indices laid out as indices into the vertex buffers
	pub vertex_indices_buffer: ghi::BufferHandle<[u16; MAX_PRIMITIVE_TRIANGLES]>,
	/// Indices laid out as indices into the `vertex_indices_buffer`
	pub primitive_indices_buffer: ghi::BufferHandle<[[u8; 3]; MAX_TRIANGLES]>,
	/// Buffer that stores the meshlet records.
	pub meshlets_data_buffer: ghi::BufferHandle<[ShaderMeshletData; MAX_MESHLETS]>,
	/// Bind-pose positions packed only for primitives that participate in GPU skinning.
	pub(super) skinning_rest_positions_buffer: ghi::BufferHandle<[[f32; 3]; MAX_VERTICES]>,
	/// Bind-pose normals packed only for primitives that participate in GPU skinning.
	pub(super) skinning_rest_normals_buffer: ghi::BufferHandle<[[f32; 3]; MAX_VERTICES]>,
	/// Four palette-local u16 joint indices packed into eight bytes per skinned vertex.
	pub(super) skinning_joints_buffer: ghi::BufferHandle<[[u16; 4]; MAX_VERTICES]>,
	/// Four normalized linear-blend weights packed beside each skinned vertex's joints.
	pub(super) skinning_weights_buffer: ghi::BufferHandle<[[f32; 4]; MAX_VERTICES]>,
}

impl GPUVertexDataManager {
	pub fn new(context: &mut ghi::implementation::Context) -> Self {
		let vertex_positions_buffer_handle = context.build_buffer(
			ghi::buffer::Builder::new(ghi::Uses::Vertex | ghi::Uses::AccelerationStructureBuild | ghi::Uses::Storage)
				.name("Visibility Vertex Positions Buffer")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);
		let vertex_normals_buffer_handle = context.build_buffer(
			ghi::buffer::Builder::new(ghi::Uses::Vertex | ghi::Uses::AccelerationStructureBuild | ghi::Uses::Storage)
				.name("Visibility Vertex Normals Buffer")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);
		let vertex_uv_buffer_handle = context.build_buffer(
			ghi::buffer::Builder::new(ghi::Uses::Vertex | ghi::Uses::AccelerationStructureBuild | ghi::Uses::Storage)
				.name("Visibility Vertex UV Buffer")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);
		let vertex_indices_buffer_handle = context.build_buffer(
			ghi::buffer::Builder::new(ghi::Uses::Index | ghi::Uses::AccelerationStructureBuild | ghi::Uses::Storage)
				.name("Visibility Index Buffer")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);
		let primitive_indices_buffer_handle = context.build_buffer(
			ghi::buffer::Builder::new(ghi::Uses::Index | ghi::Uses::AccelerationStructureBuild | ghi::Uses::Storage)
				.name("Visibility Primitive Indices Buffer")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);
		let meshlets_data_buffer = context.build_buffer::<[ShaderMeshletData; MAX_MESHLETS]>(
			ghi::buffer::Builder::new(ghi::Uses::Storage)
				.name("Visibility Meshlets Data")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);
		let skinning_rest_positions_buffer = context.build_buffer::<[[f32; 3]; MAX_VERTICES]>(
			ghi::buffer::Builder::new(ghi::Uses::Storage)
				.name("Visibility Skinning Rest Positions")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);
		let skinning_rest_normals_buffer = context.build_buffer::<[[f32; 3]; MAX_VERTICES]>(
			ghi::buffer::Builder::new(ghi::Uses::Storage)
				.name("Visibility Skinning Rest Normals")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);
		let skinning_joints_buffer = context.build_buffer::<[[u16; 4]; MAX_VERTICES]>(
			ghi::buffer::Builder::new(ghi::Uses::Storage)
				.name("Visibility Skinning Joints")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);
		let skinning_weights_buffer = context.build_buffer::<[[f32; 4]; MAX_VERTICES]>(
			ghi::buffer::Builder::new(ghi::Uses::Storage)
				.name("Visibility Skinning Weights")
				.device_accesses(ghi::DeviceAccesses::HostToDevice),
		);

		Self {
			visibility_info: VisibilityInfo::default(),
			skinning_source_vertex_count: 0,
			vertex_positions_buffer: vertex_positions_buffer_handle,
			vertex_normals_buffer: vertex_normals_buffer_handle,
			vertex_uvs_buffer: vertex_uv_buffer_handle,
			vertex_indices_buffer: vertex_indices_buffer_handle,
			primitive_indices_buffer: primitive_indices_buffer_handle,
			meshlets_data_buffer,
			skinning_rest_positions_buffer,
			skinning_rest_normals_buffer,
			skinning_joints_buffer,
			skinning_weights_buffer,
		}
	}

	/// Writes a mesh resource to GPU storage and returns its GPU mesh data.
	/// Does not check if the resource is already loaded.
	/// This operation uploads mesh data but does not make the mesh ready for rendering.
	pub fn write_gpu_mesh_data_and_return_mesh_object_for_mesh_resource<'slf, 'buffer>(
		&'slf mut self,
		c: &mut ghi::implementation::CommandBufferRecording,
		staging_data_buffer: ghi::BaseBufferHandle,
		slice: &mut utils::BufferAllocator<'buffer>,
		resource_request: &mut Reference<Mesh>,
	) -> Option<MeshData> {
		let mesh_resource = resource_request.resource();

		let Some(positions_stream) = mesh_resource.position_stream() else {
			log::error!("Mesh resource does not contain vertex position stream");
			return None;
		};

		let Some(normals_stream) = mesh_resource.normal_stream() else {
			log::error!("Mesh resource does not contain vertex normal stream");
			return None;
		};

		let Some(uvs_stream) = mesh_resource.uv_stream() else {
			log::error!("Mesh resource does not contain vertex uv stream");
			return None;
		};

		let Some(vertex_indices_stream) = mesh_resource.vertex_indices_stream() else {
			log::error!("Mesh resource does not contain vertex index stream");
			return None;
		};

		let Some(triangle_indices_stream) = mesh_resource.triangle_indices_stream() else {
			log::error!("Mesh resource does not contain triangle index stream");
			return None;
		};

		let Some(meshlet_indices_stream) = mesh_resource.meshlet_indices_stream() else {
			log::error!("Mesh resource does not contain meshlet index stream");
			return None;
		};

		let Some(meshlets_stream) = mesh_resource.meshlets_stream() else {
			log::error!("Mesh resource does not contain meshlet stream");
			return None;
		};

		let has_skinned_primitives = mesh_resource.primitives.iter().any(|primitive| primitive.skin.is_some());
		let joints_stream = if has_skinned_primitives {
			let Some(stream) = mesh_resource.vertex_stream(VertexSemantics::Joints).cloned() else {
				log::error!(
					"Skinned mesh is missing the joint-index stream. The most likely cause is that the mesh was baked without complete skinning vertex attributes."
				);
				return None;
			};
			Some(stream)
		} else {
			None
		};
		let weights_stream = if has_skinned_primitives {
			let Some(stream) = mesh_resource.vertex_stream(VertexSemantics::Weights).cloned() else {
				log::error!(
					"Skinned mesh is missing the vertex-weight stream. The most likely cause is that the mesh was baked without complete skinning vertex attributes."
				);
				return None;
			};
			Some(stream)
		} else {
			None
		};

		// Validate every source range before recording any copies so malformed resources cannot partially consume compact skinning storage.
		let mut additional_skinning_vertices = 0usize;
		for (primitive_index, primitive) in mesh_resource.primitives.iter().enumerate() {
			if primitive.skin.is_none() {
				continue;
			}

			if validate_skinning_primitive_stream(
				primitive,
				primitive_index,
				&positions_stream,
				VertexSemantics::Position,
				SKINNING_POSITION_STRIDE,
			)
			.is_err() || validate_skinning_primitive_stream(
				primitive,
				primitive_index,
				&normals_stream,
				VertexSemantics::Normal,
				SKINNING_NORMAL_STRIDE,
			)
			.is_err() || validate_skinning_primitive_stream(
				primitive,
				primitive_index,
				joints_stream
					.as_ref()
					.expect("A skinned mesh has a validated joint-index aggregate stream."),
				VertexSemantics::Joints,
				SKINNING_JOINTS_STRIDE,
			)
			.is_err() || validate_skinning_primitive_stream(
				primitive,
				primitive_index,
				weights_stream
					.as_ref()
					.expect("A skinned mesh has a validated vertex-weight aggregate stream."),
				VertexSemantics::Weights,
				SKINNING_WEIGHTS_STRIDE,
			)
			.is_err()
			{
				return None;
			}

			let Some(updated_count) = additional_skinning_vertices.checked_add(primitive.vertex_count as usize) else {
				log::error!(
					"Skinned mesh vertex count is too large. The most likely cause is corrupted primitive metadata containing an overflowing vertex count."
				);
				return None;
			};
			additional_skinning_vertices = updated_count;
		}

		assert_eq!(meshlet_indices_stream.stride, 1, "Meshlet index stream is not u8");
		assert_eq!(vertex_indices_stream.stride, 2, "Vertex index stream is not u16");
		assert_eq!(
			meshlets_stream.stride, RESOURCE_MESHLET_STRIDE,
			"Meshlet stream stride does not match the packed meshlet bounds record"
		);
		assert_eq!(
			meshlet_indices_stream.count() % 3,
			0,
			"Meshlet index stream does not contain complete triangles"
		);

		let vertex_count = positions_stream.count();
		let primitive_count = vertex_indices_stream.count();
		let triangle_count = meshlet_indices_stream.count() / 3;
		let total_meshlet_count = meshlets_stream.count();
		let vertex_offset = self.visibility_info.vertex_count as usize;
		let primitive_offset = self.visibility_info.primitives_count as usize;
		let triangle_offset = self.visibility_info.triangle_count as usize;

		self.ensure_geometry_capacity(vertex_count, primitive_count, triangle_count, total_meshlet_count);
		self.ensure_skinning_source_capacity(additional_skinning_vertices);

		let mut meshlet_stream_buffer = vec![0u8; meshlets_stream.size];

		// Mesh uploads can follow byte-packed index data, so sources reused by GPU skinning begin on transfer-compatible boundaries.
		let (vertex_positions_staging_offset, vertex_positions_buffer) =
			slice.take_with_offset_aligned(positions_stream.size, std::mem::align_of::<f32>());
		let (vertex_normals_staging_offset, vertex_normals_buffer) =
			slice.take_with_offset_aligned(normals_stream.size, std::mem::align_of::<f32>());
		let (vertex_uv_staging_offset, vertex_uv_buffer) = slice.take_with_offset(uvs_stream.size);
		let (vertex_indices_staging_offset, vertex_indices_buffer) = slice.take_with_offset(vertex_indices_stream.size);
		let (primitive_indices_staging_offset, primitive_indices_buffer) = slice.take_with_offset(meshlet_indices_stream.size);
		let skinning_staging = match (&joints_stream, &weights_stream) {
			(Some(joints_stream), Some(weights_stream)) => {
				let (joints_offset, joints_buffer) =
					slice.take_with_offset_aligned(joints_stream.size, std::mem::align_of::<u32>());
				let (weights_offset, weights_buffer) =
					slice.take_with_offset_aligned(weights_stream.size, std::mem::align_of::<f32>());
				Some((joints_offset, joints_buffer, weights_offset, weights_buffer))
			}
			_ => None,
		};
		let skinning_staging_offsets = skinning_staging
			.as_ref()
			.map(|(joints_offset, _, weights_offset, _)| (*joints_offset, *weights_offset));

		let mut buffer_allocator = utils::BufferAllocator::new(&mut meshlet_stream_buffer);

		let mut streams = Vec::with_capacity(if has_skinned_primitives { 8 } else { 6 });
		streams.push(resource_management::stream::StreamMut::new(
			"Vertex.Position",
			vertex_positions_buffer,
		));
		streams.push(resource_management::stream::StreamMut::new(
			"Vertex.Normal",
			vertex_normals_buffer,
		));
		streams.push(resource_management::stream::StreamMut::new("Vertex.UV", vertex_uv_buffer));
		streams.push(resource_management::stream::StreamMut::new(
			"VertexIndices",
			vertex_indices_buffer,
		));
		streams.push(resource_management::stream::StreamMut::new(
			"MeshletIndices",
			primitive_indices_buffer,
		));
		streams.push(resource_management::stream::StreamMut::new(
			"Meshlets",
			buffer_allocator.take(meshlets_stream.size),
		));
		if let Some((_, joints_buffer, _, weights_buffer)) = skinning_staging {
			streams.push(resource_management::stream::StreamMut::new("Vertex.Joints", joints_buffer));
			streams.push(resource_management::stream::StreamMut::new("Vertex.Weights", weights_buffer));
		}

		let Ok(load_target) = resource_request.load(streams.into()) else {
			log::warn!("Failed to load mesh data");
			return None;
		};

		c.copy_buffers(&[
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				vertex_positions_staging_offset,
				self.vertex_positions_buffer.into(),
				vertex_offset * std::mem::size_of::<(f32, f32, f32)>(),
				positions_stream.size,
			),
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				vertex_normals_staging_offset,
				self.vertex_normals_buffer.into(),
				vertex_offset * std::mem::size_of::<(f32, f32, f32)>(),
				normals_stream.size,
			),
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				vertex_uv_staging_offset,
				self.vertex_uvs_buffer.into(),
				vertex_offset * std::mem::size_of::<(f32, f32)>(),
				uvs_stream.size,
			),
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				vertex_indices_staging_offset,
				self.vertex_indices_buffer.into(),
				primitive_offset * std::mem::size_of::<u16>(),
				vertex_indices_stream.size,
			),
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				primitive_indices_staging_offset,
				self.primitive_indices_buffer.into(),
				triangle_offset * std::mem::size_of::<[u8; 3]>(),
				meshlet_indices_stream.size,
			),
		]);

		let Reference {
			resource: Mesh { primitives, .. },
			..
		} = resource_request;

		let vcps = primitives
			.iter()
			.scan(0, |state, p| {
				let offset = *state;
				*state += p.vertex_count;
				offset.into()
			})
			.collect::<Vec<_>>();

		let skinning_rest_positions_buffer = self.skinning_rest_positions_buffer;
		let skinning_rest_normals_buffer = self.skinning_rest_normals_buffer;
		let skinning_joints_buffer = self.skinning_joints_buffer;
		let skinning_weights_buffer = self.skinning_weights_buffer;
		let skinning_source_start = self.skinning_source_vertex_count;
		let mut skinning_source_vertex_cursor = skinning_source_start;

		let meshlets_per_primitive = primitives
			.iter()
			.zip(vcps.iter())
			.scan(
				(0, 0, 0),
				|(mesh_primitive_counter, mesh_triangle_counter, mesh_meshlet_counter), (primitive, vcps)| {
					let vertex_offset = *vcps;
					let primitive_offset = *mesh_primitive_counter;
					let triangle_offset = *mesh_triangle_counter;
					let meshlet_offset = *mesh_meshlet_counter;

					let (skinning_source_vertex_offset, skinning_vertex_count) = if primitive.skin.is_some() {
						let position_stream = primitive
							.stream(Streams::Vertices(VertexSemantics::Position))
							.expect("Skinned primitive position metadata was validated before recording copies.");
						let normal_stream = primitive
							.stream(Streams::Vertices(VertexSemantics::Normal))
							.expect("Skinned primitive normal metadata was validated before recording copies.");
						let joints_stream = primitive
							.stream(Streams::Vertices(VertexSemantics::Joints))
							.expect("Skinned primitive joint metadata was validated before recording copies.");
						let weights_stream = primitive
							.stream(Streams::Vertices(VertexSemantics::Weights))
							.expect("Skinned primitive weight metadata was validated before recording copies.");
						let (joints_staging_offset, weights_staging_offset) = skinning_staging_offsets
							.expect("Skinned primitive staging streams were allocated before loading the resource.");

						let source_vertex_offset = skinning_source_vertex_cursor;
						let destination_vertex_offset = source_vertex_offset as usize;

						// A shared compact vertex index addresses all four immutable inputs, avoiding per-stream remapping in the compute pass.
						c.copy_buffers(&[
							ghi::BufferCopyDescriptor::new(
								staging_data_buffer,
								vertex_positions_staging_offset + position_stream.offset,
								skinning_rest_positions_buffer.into(),
								destination_vertex_offset * SKINNING_POSITION_STRIDE,
								position_stream.size,
							),
							ghi::BufferCopyDescriptor::new(
								staging_data_buffer,
								vertex_normals_staging_offset + normal_stream.offset,
								skinning_rest_normals_buffer.into(),
								destination_vertex_offset * SKINNING_NORMAL_STRIDE,
								normal_stream.size,
							),
							ghi::BufferCopyDescriptor::new(
								staging_data_buffer,
								joints_staging_offset + joints_stream.offset,
								skinning_joints_buffer.into(),
								destination_vertex_offset * SKINNING_JOINTS_STRIDE,
								joints_stream.size,
							),
							ghi::BufferCopyDescriptor::new(
								staging_data_buffer,
								weights_staging_offset + weights_stream.offset,
								skinning_weights_buffer.into(),
								destination_vertex_offset * SKINNING_WEIGHTS_STRIDE,
								weights_stream.size,
							),
						]);

						skinning_source_vertex_cursor = skinning_source_vertex_cursor
							.checked_add(primitive.vertex_count)
							.expect("Validated skinning source vertex counts fit in the compact buffer cursor.");
						(Some(source_vertex_offset), primitive.vertex_count)
					} else {
						(None, 0)
					};

					let meshlets = if let Some(stream) = primitive.meshlet_stream() {
						let m = load_target.stream("Meshlets").unwrap();
						let meshlet_stream = &m.buffer()[stream.offset..stream.offset + stream.size];

						meshlet_stream
							.chunks_exact(RESOURCE_MESHLET_STRIDE)
							.map(read_resource_meshlet)
							.scan(
								(0, 0),
								|(primitive_primitive_counter, primitive_triangle_counter), meshlet| {
									let meshlet_primitive_count = meshlet.primitive_count;
									let meshlet_triangle_count = meshlet.triangle_count;

									let primitive_offset = *primitive_primitive_counter;
									let triangle_offset = *primitive_triangle_counter;

									// Update vertex and triangle offsets per meshlet, relative to the primitive
									*primitive_primitive_counter += meshlet_primitive_count;
									*primitive_triangle_counter += meshlet_triangle_count;

									// Update vertex, triangle and meshlet offsets per meshlet, relative to the mesh
									*mesh_primitive_counter += meshlet_primitive_count;
									*mesh_triangle_counter += meshlet_triangle_count;
									*mesh_meshlet_counter += 1;

									ShaderMeshletData {
										primitive_offset,
										triangle_offset,
										primitive_count: meshlet_primitive_count,
										triangle_count: meshlet_triangle_count,
										center_radius: meshlet.center_radius,
										cone_apex_cutoff: meshlet.cone_apex_cutoff,
										cone_axis: meshlet.cone_axis,
									}
									.into()
								},
							)
							.collect::<Vec<_>>()
					} else {
						panic!();
					};

					(
						MeshPrimitive {
							meshlet_count: meshlets.len() as u32,
							meshlet_offset,
							vertex_offset,
							primitive_offset,
							triangle_offset,
							skinning_source_vertex_offset,
							skinning_vertex_count,
						},
						meshlets,
					)
						.into()
				},
			)
			.collect::<Vec<_>>();

		debug_assert_eq!(
			skinning_source_vertex_cursor - skinning_source_start,
			additional_skinning_vertices as u32
		);
		self.skinning_source_vertex_count = skinning_source_vertex_cursor;

		let meshlets_data = meshlets_per_primitive
			.iter()
			.flat_map(|(_, meshlets)| meshlets.iter().copied())
			.collect::<Vec<_>>();
		debug_assert_eq!(meshlets_data.len(), total_meshlet_count);

		let meshlets_data_size = std::mem::size_of_val(meshlets_data.as_slice());
		let (meshlets_data_staging_offset, meshlets_data_bytes) = slice.take_with_offset(meshlets_data_size);
		meshlets_data_bytes.copy_from_slice(as_byte_slice(meshlets_data.as_slice()));
		c.copy_buffers(&[ghi::BufferCopyDescriptor::new(
			staging_data_buffer,
			meshlets_data_staging_offset,
			self.meshlets_data_buffer.into(),
			self.visibility_info.meshlet_count as usize * std::mem::size_of::<ShaderMeshletData>(),
			meshlets_data_size,
		)]);

		let primitives = meshlets_per_primitive.iter().map(|(p, _)| p.clone()).collect::<Vec<_>>();

		let meshlet_offset = self.visibility_info.meshlet_count;

		let acceleration_structure = if let Some(triangle_indices_stream) = None as Option<resource_management::types::Stream> {
			let index_format = match triangle_indices_stream.stride {
				2 => ghi::DataTypes::U16,
				4 => ghi::DataTypes::U32,
				_ => panic!("Unsupported index format"),
			};

			// let bottom_level_acceleration_structure =
			// 	c.create_bottom_level_acceleration_structure(&ghi::BottomLevelAccelerationStructure {
			// 		description: ghi::BottomLevelAccelerationStructureDescriptions::Mesh {
			// 			vertex_count: positions_stream.count() as u32,
			// 			vertex_position_encoding: ghi::Encodings::FloatingPoint,
			// 			triangle_count: triangle_indices_stream.count() as u32 / 3,
			// 			index_format,
			// 		},
			// 	});

			// ray_tracing.pending_meshes.push(MeshState::Build { mesh_handle: mesh.resource_id.to_string() });

			None
		} else {
			None
		};

		let mesh = MeshData {
			vertex_offset: self.visibility_info.vertex_count,
			primitive_offset: self.visibility_info.primitives_count,
			triangle_offset: self.visibility_info.triangle_count,
			meshlet_offset,
			acceleration_structure,
			primitives,
		};

		self.update_visibility_info_stats(vertex_count, primitive_count, triangle_count, total_meshlet_count);

		Some(mesh)
	}

	/// Writes mesh data to GPU storage and returns its GPU mesh data.
	///
	/// # Returns
	///
	/// Returns the updated buffer allocator with the uploaded mesh data.
	pub fn write_gpu_mesh_data_and_return_mesh_object_for_mesh_generator<'slf, 'buffer>(
		&'slf mut self,
		generator: &dyn MeshGenerator,
		c: &mut ghi::implementation::CommandBufferRecording,
		staging_data_buffer: ghi::BaseBufferHandle,
		slice: &mut utils::BufferAllocator<'buffer>,
	) -> Option<MeshData> {
		let positions = generator.positions();
		let normals = generator.normals();
		let uvs = generator.uvs();
		let indices = generator.indices().iter().map(|&index| index as u16).collect::<Vec<_>>();

		if positions.len() != normals.len() || positions.len() != uvs.len() {
			log::error!(
				"Generated mesh attributes are inconsistent. The most likely cause is that the mesh generator returned mismatched vertex attribute counts."
			);
			return None;
		}

		let (vertex_indices, primitive_indices, meshlets) =
			Self::build_generated_meshlets(&indices, positions.as_ref()).ok()?;

		self.ensure_geometry_capacity(positions.len(), vertex_indices.len(), primitive_indices.len(), meshlets.len());

		let vertex_offset = self.visibility_info.vertex_count as usize;
		let primitive_offset = self.visibility_info.primitives_count as usize;
		let triangle_offset = self.visibility_info.triangle_count as usize;
		let meshlet_offset = self.visibility_info.meshlet_count as usize;

		let (vertex_positions_staging_offset, vertex_positions_buffer) =
			slice.take_with_offset(std::mem::size_of_val(positions.as_ref()));
		vertex_positions_buffer.copy_from_slice(as_byte_slice(positions.as_ref()));

		let (vertex_normals_staging_offset, vertex_normals_buffer) =
			slice.take_with_offset(std::mem::size_of_val(normals.as_ref()));
		vertex_normals_buffer.copy_from_slice(as_byte_slice(normals.as_ref()));

		let (vertex_uv_staging_offset, vertex_uv_buffer) = slice.take_with_offset(std::mem::size_of_val(uvs.as_ref()));
		vertex_uv_buffer.copy_from_slice(as_byte_slice(uvs.as_ref()));

		let (vertex_indices_staging_offset, indices_buffer) =
			slice.take_with_offset(std::mem::size_of_val(vertex_indices.as_slice()));
		indices_buffer.copy_from_slice(as_byte_slice(vertex_indices.as_slice()));

		let (primitive_indices_staging_offset, primitive_indices_buffer) =
			slice.take_with_offset(std::mem::size_of_val(primitive_indices.as_slice()));
		primitive_indices_buffer.copy_from_slice(as_byte_slice(primitive_indices.as_slice()));

		let (meshlets_data_staging_offset, meshlets_data_buffer) =
			slice.take_with_offset(std::mem::size_of_val(meshlets.as_slice()));
		meshlets_data_buffer.copy_from_slice(as_byte_slice(meshlets.as_slice()));

		c.copy_buffers(&[
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				vertex_positions_staging_offset,
				self.vertex_positions_buffer.into(),
				vertex_offset * std::mem::size_of::<(f32, f32, f32)>(),
				std::mem::size_of_val(positions.as_ref()),
			),
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				vertex_normals_staging_offset,
				self.vertex_normals_buffer.into(),
				vertex_offset * std::mem::size_of::<(f32, f32, f32)>(),
				std::mem::size_of_val(normals.as_ref()),
			),
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				vertex_uv_staging_offset,
				self.vertex_uvs_buffer.into(),
				vertex_offset * std::mem::size_of::<(f32, f32)>(),
				std::mem::size_of_val(uvs.as_ref()),
			),
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				vertex_indices_staging_offset,
				self.vertex_indices_buffer.into(),
				primitive_offset * std::mem::size_of::<u16>(),
				std::mem::size_of_val(vertex_indices.as_slice()),
			),
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				primitive_indices_staging_offset,
				self.primitive_indices_buffer.into(),
				triangle_offset * std::mem::size_of::<[u8; 3]>(),
				std::mem::size_of_val(primitive_indices.as_slice()),
			),
			ghi::BufferCopyDescriptor::new(
				staging_data_buffer,
				meshlets_data_staging_offset,
				self.meshlets_data_buffer.into(),
				meshlet_offset * std::mem::size_of::<ShaderMeshletData>(),
				std::mem::size_of_val(meshlets.as_slice()),
			),
		]);

		let mesh = MeshData {
			vertex_offset: self.visibility_info.vertex_count,
			primitive_offset: self.visibility_info.primitives_count,
			triangle_offset: self.visibility_info.triangle_count,
			meshlet_offset: self.visibility_info.meshlet_count,
			acceleration_structure: None,
			primitives: vec![MeshPrimitive {
				meshlet_count: meshlets.len() as u32,
				meshlet_offset: 0,
				vertex_offset: 0,
				primitive_offset: 0,
				triangle_offset: 0,
				skinning_source_vertex_offset: None,
				skinning_vertex_count: 0,
			}],
		};

		self.update_visibility_info_stats(positions.len(), vertex_indices.len(), primitive_indices.len(), meshlets.len());

		Some(mesh)
	}

	fn build_generated_meshlets(
		indices: &[u16],
		positions: &[(f32, f32, f32)],
	) -> Result<(Vec<u16>, Vec<[u8; 3]>, Vec<ShaderMeshletData>), ()> {
		if !indices.len().is_multiple_of(3) {
			log::error!(
				"Generated mesh indices are invalid. The most likely cause is that the mesh generator returned a triangle list whose index count is not divisible by three."
			);
			return Err(());
		}

		let mut vertex_indices = Vec::new();
		let mut primitive_indices = Vec::new();
		let mut meshlets = Vec::new();

		let mut meshlet_vertex_indices = Vec::<u16>::new();
		let mut meshlet_triangles = Vec::<[u8; 3]>::new();

		for triangle in indices.chunks_exact(3) {
			let unique_vertices = triangle
				.iter()
				.filter(|index| !meshlet_vertex_indices.contains(index))
				.count();

			if !meshlet_triangles.is_empty()
				&& (meshlet_vertex_indices.len() + unique_vertices > VERTEX_COUNT as usize
					|| meshlet_triangles.len() >= TRIANGLE_COUNT as usize)
			{
				Self::push_generated_meshlet(
					&mut vertex_indices,
					&mut primitive_indices,
					&mut meshlets,
					&mut meshlet_vertex_indices,
					&mut meshlet_triangles,
					positions,
				)?;
			}

			let mut local_triangle = [0u8; 3];

			for (slot, index) in triangle.iter().enumerate() {
				let local_index = if let Some(existing) = meshlet_vertex_indices.iter().position(|value| value == index) {
					existing
				} else {
					meshlet_vertex_indices.push(*index);
					meshlet_vertex_indices.len() - 1
				};

				local_triangle[slot] = local_index as u8;
			}

			meshlet_triangles.push(local_triangle);
		}

		Self::push_generated_meshlet(
			&mut vertex_indices,
			&mut primitive_indices,
			&mut meshlets,
			&mut meshlet_vertex_indices,
			&mut meshlet_triangles,
			positions,
		)?;

		Ok((vertex_indices, primitive_indices, meshlets))
	}

	fn push_generated_meshlet(
		vertex_indices: &mut Vec<u16>,
		primitive_indices: &mut Vec<[u8; 3]>,
		meshlets: &mut Vec<ShaderMeshletData>,
		meshlet_vertex_indices: &mut Vec<u16>,
		meshlet_triangles: &mut Vec<[u8; 3]>,
		positions: &[(f32, f32, f32)],
	) -> Result<(), ()> {
		if meshlet_triangles.is_empty() {
			return Ok(());
		}

		let primitive_offset = vertex_indices.len() as u32;
		let triangle_offset = primitive_indices.len() as u32;
		let primitive_count = u32::try_from(meshlet_vertex_indices.len()).map_err(|_| {
			log::error!(
				"Generated meshlet exceeds vertex limits. The most likely cause is that too many unique vertices were packed into a single meshlet."
			);
		})?;
		let triangle_count = u32::try_from(meshlet_triangles.len()).map_err(|_| {
			log::error!(
				"Generated meshlet exceeds triangle limits. The most likely cause is that too many triangles were packed into a single meshlet."
			);
		})?;
		let center_radius = Self::generated_meshlet_center_radius(meshlet_vertex_indices, positions);

		vertex_indices.extend(meshlet_vertex_indices.iter().copied());
		primitive_indices.extend(meshlet_triangles.iter().copied());
		meshlets.push(ShaderMeshletData {
			primitive_offset,
			triangle_offset,
			primitive_count,
			triangle_count,
			center_radius,
			cone_apex_cutoff: [0.0, 0.0, 0.0, 2.0],
			cone_axis: [0.0, 0.0, 1.0, 0.0],
		});

		meshlet_vertex_indices.clear();
		meshlet_triangles.clear();

		Ok(())
	}

	/// Computes a conservative object-space bounding sphere for a generated meshlet.
	fn generated_meshlet_center_radius(meshlet_vertex_indices: &[u16], positions: &[(f32, f32, f32)]) -> [f32; 4] {
		let mut min = [f32::INFINITY; 3];
		let mut max = [f32::NEG_INFINITY; 3];

		for &index in meshlet_vertex_indices {
			let position = positions[index as usize];
			let values = [position.0, position.1, position.2];
			for axis in 0..3 {
				min[axis] = min[axis].min(values[axis]);
				max[axis] = max[axis].max(values[axis]);
			}
		}

		let center = [(min[0] + max[0]) * 0.5, (min[1] + max[1]) * 0.5, (min[2] + max[2]) * 0.5];
		let mut radius_squared = 0.0f32;

		for &index in meshlet_vertex_indices {
			let position = positions[index as usize];
			let delta = [position.0 - center[0], position.1 - center[1], position.2 - center[2]];
			radius_squared = radius_squared.max(delta[0] * delta[0] + delta[1] * delta[1] + delta[2] * delta[2]);
		}

		[center[0], center[1], center[2], radius_squared.sqrt()]
	}

	fn update_visibility_info_stats(
		&mut self,
		vertex_count: usize,
		primitive_count: usize,
		triangle_count: usize,
		total_meshlet_count: usize,
	) {
		self.visibility_info.vertex_count += vertex_count as u32;
		self.visibility_info.primitives_count += primitive_count as u32;
		self.visibility_info.triangle_count += triangle_count as u32;
		self.visibility_info.meshlet_count += total_meshlet_count as u32;
	}

	fn ensure_geometry_capacity(
		&self,
		additional_vertices: usize,
		additional_primitives: usize,
		additional_triangles: usize,
		additional_meshlets: usize,
	) {
		let total_vertices = self.visibility_info.vertex_count as usize + additional_vertices;
		if total_vertices > MAX_VERTICES {
			panic!(
				"Visibility vertex buffer limit exceeded. The most likely cause is that the scene contains more vertex data than the visibility pipeline supports."
			);
		}

		let total_primitives = self.visibility_info.primitives_count as usize + additional_primitives;
		if total_primitives > MAX_PRIMITIVE_TRIANGLES {
			panic!(
				"Visibility primitive index limit exceeded. The most likely cause is that the scene contains more primitive index data than the visibility pipeline supports."
			);
		}

		let total_triangles = self.visibility_info.triangle_count as usize + additional_triangles;
		if total_triangles > MAX_TRIANGLES {
			panic!(
				"Visibility triangle index limit exceeded. The most likely cause is that the scene contains more triangle index data than the visibility pipeline supports."
			);
		}

		let total_meshlets = self.visibility_info.meshlet_count as usize + additional_meshlets;
		if total_meshlets > MAX_MESHLETS {
			panic!(
				"Visibility meshlet limit exceeded. The most likely cause is that the scene contains more meshlets than the visibility pipeline supports."
			);
		}
	}

	/// Rejects uploads that cannot fit in the compact immutable skinning source buffers.
	fn ensure_skinning_source_capacity(&self, additional_vertices: usize) {
		let Some(total_vertices) = (self.skinning_source_vertex_count as usize).checked_add(additional_vertices) else {
			panic!(
				"Visibility skinning source vertex count overflowed. The most likely cause is corrupted mesh metadata containing an invalid vertex count."
			);
		};
		if total_vertices > MAX_VERTICES {
			panic!(
				"Visibility skinning source buffer limit exceeded. The most likely cause is that the scene contains more skinned vertex data than the visibility pipeline supports."
			);
		}
	}
}

const RESOURCE_MESHLET_STRIDE: usize = 52;
const SKINNING_POSITION_STRIDE: usize = std::mem::size_of::<[f32; 3]>();
const SKINNING_NORMAL_STRIDE: usize = std::mem::size_of::<[f32; 3]>();
const SKINNING_JOINTS_STRIDE: usize = std::mem::size_of::<[u16; 4]>();
const SKINNING_WEIGHTS_STRIDE: usize = std::mem::size_of::<[f32; 4]>();

const _: () = {
	assert!(SKINNING_POSITION_STRIDE == 12);
	assert!(SKINNING_NORMAL_STRIDE == 12);
	assert!(SKINNING_JOINTS_STRIDE == 8);
	assert!(SKINNING_WEIGHTS_STRIDE == 16);
};

/// Validates a primitive-local skinning stream against its loaded aggregate stream.
fn validate_skinning_primitive_stream(
	primitive: &ResourcePrimitive,
	primitive_index: usize,
	aggregate_stream: &ResourceStream,
	semantic: VertexSemantics,
	expected_stride: usize,
) -> Result<(), ()> {
	if aggregate_stream.stride != expected_stride || !aggregate_stream.size.is_multiple_of(expected_stride) {
		log::error!(
			"Skinned mesh {semantic:?} stream has invalid aggregate metadata. The most likely cause is that the mesh was baked with an incompatible vertex format; expected stride {expected_stride}, found stride {} and size {}.",
			aggregate_stream.stride,
			aggregate_stream.size
		);
		return Err(());
	}

	let Some(primitive_stream) = primitive.stream(Streams::Vertices(semantic)) else {
		log::error!(
			"Skinned primitive {primitive_index} is missing its {semantic:?} stream. The most likely cause is that the mesh was baked without complete per-primitive skinning metadata."
		);
		return Err(());
	};

	let Some(expected_size) = (primitive.vertex_count as usize).checked_mul(expected_stride) else {
		log::error!(
			"Skinned primitive {primitive_index} has invalid {semantic:?} stream metadata. The most likely cause is an overflowing vertex count in the baked mesh."
		);
		return Err(());
	};
	if primitive_stream.stride != expected_stride
		|| primitive_stream.size != expected_size
		|| !primitive_stream.offset.is_multiple_of(expected_stride)
	{
		log::error!(
			"Skinned primitive {primitive_index} has invalid {semantic:?} stream metadata. The most likely cause is that its offset, stride, or byte size does not match its {} vertices; expected vertex-aligned offset, stride {expected_stride}, and size {expected_size}, found offset {}, stride {}, and size {}.",
			primitive.vertex_count,
			primitive_stream.offset,
			primitive_stream.stride,
			primitive_stream.size
		);
		return Err(());
	}

	let Some(stream_end) = primitive_stream.offset.checked_add(primitive_stream.size) else {
		log::error!(
			"Skinned primitive {primitive_index} has an invalid {semantic:?} stream range. The most likely cause is an overflowing byte offset in the baked mesh."
		);
		return Err(());
	};
	if stream_end > aggregate_stream.size {
		log::error!(
			"Skinned primitive {primitive_index} has an out-of-bounds {semantic:?} stream range. The most likely cause is that its primitive-local range does not refer to the baked aggregate stream."
		);
		return Err(());
	}

	Ok(())
}

/// The `ResourceMeshletData` struct carries meshlet metadata decoded from the packed resource stream.
#[derive(Clone, Copy)]
struct ResourceMeshletData {
	primitive_count: u32,
	triangle_count: u32,
	center_radius: [f32; 4],
	cone_apex_cutoff: [f32; 4],
	cone_axis: [f32; 4],
}

/// Decodes one packed meshlet record without assuming the resource stream is naturally aligned.
fn read_resource_meshlet(bytes: &[u8]) -> ResourceMeshletData {
	debug_assert_eq!(bytes.len(), RESOURCE_MESHLET_STRIDE);

	ResourceMeshletData {
		primitive_count: bytes[0] as u32,
		triangle_count: bytes[1] as u32,
		center_radius: read_f32x4(bytes, 4),
		cone_apex_cutoff: read_f32x4(bytes, 20),
		cone_axis: read_f32x4(bytes, 36),
	}
}

fn read_f32x4(bytes: &[u8], offset: usize) -> [f32; 4] {
	[
		read_f32(bytes, offset),
		read_f32(bytes, offset + 4),
		read_f32(bytes, offset + 8),
		read_f32(bytes, offset + 12),
	]
}

fn read_f32(bytes: &[u8], offset: usize) -> f32 {
	f32::from_le_bytes(
		bytes[offset..offset + 4].try_into().expect(
			"Packed meshlet record is truncated. The most likely cause is that the meshlet stream stride is incorrect.",
		),
	)
}

#[derive(Clone, Copy, Default)]
pub struct VisibilityInfo {
	pub instance_count: u32,
	pub triangle_count: u32,
	pub meshlet_count: u32,
	pub vertex_count: u32,
	pub primitives_count: u32,
}

/// The `MeshData` struct stores the geometry ranges needed after a mesh resource
/// enters visibility GPU storage.
#[derive(Debug, Clone)]
pub struct MeshData {
	pub primitives: Vec<MeshPrimitive>,
	/// Base position in the vertex buffer.
	pub vertex_offset: u32,
	pub primitive_offset: u32,
	/// Base triangle position in the primitive-index buffer, stored as index / 3.
	pub triangle_offset: u32,
	/// Base position in the meshlet buffer, relative to the mesh.
	pub meshlet_offset: u32,
	pub acceleration_structure: Option<ghi::BottomLevelAccelerationStructureHandle>,
}

/// The `MeshPrimitive` struct locates one primitive's geometry and optional skinning inputs in visibility buffers.
#[derive(Debug, Clone)]
pub struct MeshPrimitive {
	/// The meshlet count.
	pub meshlet_count: u32,
	/// Base position in the meshlet buffer, relative to the primitive.
	pub meshlet_offset: u32,
	/// Base position in the vertex buffer.
	pub vertex_offset: u32,
	/// Base position in the primitive-index buffer.
	pub primitive_offset: u32,
	/// Base triangle position in the primitive-index buffer, stored as index / 3.
	pub triangle_offset: u32,
	/// The first vertex in the compact immutable skinning source buffers, when this primitive is skinned.
	pub skinning_source_vertex_offset: Option<u32>,
	/// The number of vertices the skinning compute pass writes for this primitive.
	pub skinning_vertex_count: u32,
}

use std::collections::hash_map::Entry;

use ghi::{command_buffer::CommandBufferRecording as _, context::ContextCreate as _};
use resource_management::{
	resources::mesh::{Mesh, Primitive as ResourcePrimitive},
	types::{Stream as ResourceStream, Streams, VertexSemantics},
	Reference,
};
use utils::as_byte_slice;

use crate::rendering::{
	mesh::generator::MeshGenerator,
	pipelines::visibility::{ShaderMeshletData, MAX_MESHLETS, MAX_PRIMITIVE_TRIANGLES, MAX_TRIANGLES, MAX_VERTICES},
	pipelines::visibility::{TRIANGLE_COUNT, VERTEX_COUNT},
};