/
VK_KHR_synchronization2.hs
5731 lines (5582 loc) · 313 KB
/
VK_KHR_synchronization2.hs
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
{-# language CPP #-}
-- | = Name
--
-- VK_KHR_synchronization2 - device extension
--
-- == VK_KHR_synchronization2
--
-- [__Name String__]
-- @VK_KHR_synchronization2@
--
-- [__Extension Type__]
-- Device extension
--
-- [__Registered Extension Number__]
-- 315
--
-- [__Revision__]
-- 1
--
-- [__Extension and Version Dependencies__]
--
-- - Requires Vulkan 1.0
--
-- - Requires @VK_KHR_get_physical_device_properties2@
--
-- - Requires @VK_KHR_create_renderpass2@
--
-- [__Contact__]
--
-- - Tobias Hector
-- <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_KHR_synchronization2:%20&body=@tobski%20 >
--
-- == Other Extension Metadata
--
-- [Last Modified Date]
-- 2020-12-03 Interactions and External Dependencies:
--
-- - Interacts with @VK_KHR_create_renderpass2@
--
-- [Contributors]
--
-- - Tobias Hector
--
-- == Description
--
-- This extension modifies the original core synchronization APIs to
-- simplify the interface and improve usability of these APIs. It also adds
-- new pipeline stage and access flag types that extend into the 64-bit
-- range, as we have run out within the 32-bit range. The new flags are
-- identical to the old values within the 32-bit range, with new stages and
-- bits beyond that.
--
-- Pipeline stages and access flags are now specified together in memory
-- barrier structures, making the connection between the two more obvious.
-- Additionally, scoping the pipeline stages into the barrier structs
-- allows the use of the @MEMORY_READ@ and @MEMORY_WRITE@ flags without
-- sacrificing precision. The per-stage access flags should be used to
-- disambiguate specific accesses in a given stage or set of stages - for
-- instance, between uniform reads and sampling operations.
--
-- Layout transitions have been simplified as well; rather than requiring a
-- different set of layouts for depth\/stencil\/color attachments, there
-- are generic
-- 'Vulkan.Core10.Enums.ImageLayout.IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR'
-- and 'Vulkan.Core10.Enums.ImageLayout.IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR'
-- layouts which are contextually applied based on the image format. For
-- example, for a depth format image,
-- 'Vulkan.Core10.Enums.ImageLayout.IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR' is
-- equivalent to
-- 'Vulkan.Extensions.VK_KHR_separate_depth_stencil_layouts.IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR'.
-- 'Vulkan.Core10.Enums.ImageLayout.IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR'
-- also functionally replaces
-- 'Vulkan.Core10.Enums.ImageLayout.IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL'.
--
-- Events are now more efficient, because they include memory dependency
-- information when you set them on the device. Previously, this
-- information was only known when waiting on an event, so the dependencies
-- could not be satisfied until the wait occurred. That sometimes meant
-- stalling the pipeline when the wait occurred. The new API provides
-- enough information for implementations to satisfy these dependencies in
-- parallel with other tasks.
--
-- Queue submission has been changed to wrap command buffers and semaphores
-- in extensible structures, which incorporate changes from Vulkan 1.1,
-- <VK_KHR_device_group.html VK_KHR_device_group>, and
-- <VK_KHR_timeline_semaphore.html VK_KHR_timeline_semaphore>. This also
-- adds a pipeline stage to the semaphore signal operation, mirroring the
-- existing pipeline stage specification for wait operations.
--
-- Other miscellaneous changes include:
--
-- - Events can now be specified as interacting only with the device,
-- allowing more efficient access to the underlying object.
--
-- - Image memory barriers that do not perform an image layout transition
-- can be specified by setting @oldLayout@ equal to @newLayout@.
--
-- - E.g. the old and new layout can both be set to
-- 'Vulkan.Core10.Enums.ImageLayout.IMAGE_LAYOUT_UNDEFINED',
-- without discarding data in the image.
--
-- - Queue family ownership transfer parameters are simplified in some
-- cases.
--
-- - Where two synchronization commands need to be matched up (queue
-- transfer operations, events), the dependency information specified
-- in each place must now match completely for consistency.
--
-- - Extensions with commands or functions with a
-- 'Vulkan.Core10.Enums.PipelineStageFlagBits.PipelineStageFlags' or
-- 'Vulkan.Core10.Enums.PipelineStageFlagBits.PipelineStageFlagBits'
-- parameter have had those APIs replaced with equivalents using
-- 'PipelineStageFlags2KHR'.
--
-- - The new event and barrier interfaces are now more extensible for
-- future changes.
--
-- - Relevant pipeline stage masks can now be specified as empty with the
-- new
-- 'Vulkan.Core10.Enums.PipelineStageFlagBits.PIPELINE_STAGE_NONE_KHR'
-- and 'PIPELINE_STAGE_2_NONE_KHR' values.
--
-- - 'MemoryBarrier2KHR' can be chained to
-- 'Vulkan.Core12.Promoted_From_VK_KHR_create_renderpass2.SubpassDependency2',
-- overriding the original 32-bit stage and access masks.
--
-- == New Commands
--
-- - 'cmdPipelineBarrier2KHR'
--
-- - 'cmdResetEvent2KHR'
--
-- - 'cmdSetEvent2KHR'
--
-- - 'cmdWaitEvents2KHR'
--
-- - 'cmdWriteTimestamp2KHR'
--
-- - 'queueSubmit2KHR'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_AMD_buffer_marker VK_AMD_buffer_marker>
-- is supported:
--
-- - 'cmdWriteBufferMarker2AMD'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_device_diagnostic_checkpoints VK_NV_device_diagnostic_checkpoints>
-- is supported:
--
-- - 'getQueueCheckpointData2NV'
--
-- == New Structures
--
-- - 'BufferMemoryBarrier2KHR'
--
-- - 'CommandBufferSubmitInfoKHR'
--
-- - 'DependencyInfoKHR'
--
-- - 'ImageMemoryBarrier2KHR'
--
-- - 'SemaphoreSubmitInfoKHR'
--
-- - 'SubmitInfo2KHR'
--
-- - Extending
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
-- 'Vulkan.Core10.Device.DeviceCreateInfo':
--
-- - 'PhysicalDeviceSynchronization2FeaturesKHR'
--
-- - Extending
-- 'Vulkan.Core12.Promoted_From_VK_KHR_create_renderpass2.SubpassDependency2':
--
-- - 'MemoryBarrier2KHR'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_device_diagnostic_checkpoints VK_NV_device_diagnostic_checkpoints>
-- is supported:
--
-- - 'CheckpointData2NV'
--
-- - Extending
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.QueueFamilyProperties2':
--
-- - 'QueueFamilyCheckpointProperties2NV'
--
-- == New Enums
--
-- - 'AccessFlagBits2KHR'
--
-- - 'PipelineStageFlagBits2KHR'
--
-- - 'SubmitFlagBitsKHR'
--
-- == New Bitmasks
--
-- - 'AccessFlags2KHR'
--
-- - 'PipelineStageFlags2KHR'
--
-- - 'SubmitFlagsKHR'
--
-- == New Enum Constants
--
-- - 'KHR_SYNCHRONIZATION_2_EXTENSION_NAME'
--
-- - 'KHR_SYNCHRONIZATION_2_SPEC_VERSION'
--
-- - Extending 'Vulkan.Core10.Enums.AccessFlagBits.AccessFlagBits':
--
-- - 'Vulkan.Core10.Enums.AccessFlagBits.ACCESS_NONE_KHR'
--
-- - Extending
-- 'Vulkan.Core10.Enums.EventCreateFlagBits.EventCreateFlagBits':
--
-- - 'Vulkan.Core10.Enums.EventCreateFlagBits.EVENT_CREATE_DEVICE_ONLY_BIT_KHR'
--
-- - Extending 'Vulkan.Core10.Enums.ImageLayout.ImageLayout':
--
-- - 'Vulkan.Core10.Enums.ImageLayout.IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR'
--
-- - 'Vulkan.Core10.Enums.ImageLayout.IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR'
--
-- - Extending
-- 'Vulkan.Core10.Enums.PipelineStageFlagBits.PipelineStageFlagBits':
--
-- - 'Vulkan.Core10.Enums.PipelineStageFlagBits.PIPELINE_STAGE_NONE_KHR'
--
-- - Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER_2_KHR'
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_COMMAND_BUFFER_SUBMIT_INFO_KHR'
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_DEPENDENCY_INFO_KHR'
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER_2_KHR'
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_MEMORY_BARRIER_2_KHR'
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_SYNCHRONIZATION_2_FEATURES_KHR'
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_SEMAPHORE_SUBMIT_INFO_KHR'
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_SUBMIT_INFO_2_KHR'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_EXT_blend_operation_advanced VK_EXT_blend_operation_advanced>
-- is supported:
--
-- - Extending 'AccessFlagBits2KHR':
--
-- - 'ACCESS_2_COLOR_ATTACHMENT_READ_NONCOHERENT_BIT_EXT'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_EXT_conditional_rendering VK_EXT_conditional_rendering>
-- is supported:
--
-- - Extending 'AccessFlagBits2KHR':
--
-- - 'ACCESS_2_CONDITIONAL_RENDERING_READ_BIT_EXT'
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_CONDITIONAL_RENDERING_BIT_EXT'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_EXT_fragment_density_map VK_EXT_fragment_density_map>
-- is supported:
--
-- - Extending 'AccessFlagBits2KHR':
--
-- - 'ACCESS_2_FRAGMENT_DENSITY_MAP_READ_BIT_EXT'
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_FRAGMENT_DENSITY_PROCESS_BIT_EXT'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_EXT_transform_feedback VK_EXT_transform_feedback>
-- is supported:
--
-- - Extending 'AccessFlagBits2KHR':
--
-- - 'ACCESS_2_TRANSFORM_FEEDBACK_COUNTER_READ_BIT_EXT'
--
-- - 'ACCESS_2_TRANSFORM_FEEDBACK_COUNTER_WRITE_BIT_EXT'
--
-- - 'ACCESS_2_TRANSFORM_FEEDBACK_WRITE_BIT_EXT'
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_TRANSFORM_FEEDBACK_BIT_EXT'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_acceleration_structure VK_KHR_acceleration_structure>
-- is supported:
--
-- - Extending 'AccessFlagBits2KHR':
--
-- - 'ACCESS_2_ACCELERATION_STRUCTURE_READ_BIT_KHR'
--
-- - 'ACCESS_2_ACCELERATION_STRUCTURE_WRITE_BIT_KHR'
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_ACCELERATION_STRUCTURE_BUILD_BIT_KHR'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_fragment_shading_rate VK_KHR_fragment_shading_rate>
-- is supported:
--
-- - Extending 'AccessFlagBits2KHR':
--
-- - 'ACCESS_2_FRAGMENT_SHADING_RATE_ATTACHMENT_READ_BIT_KHR'
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_ray_tracing_pipeline VK_KHR_ray_tracing_pipeline>
-- is supported:
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_RAY_TRACING_SHADER_BIT_KHR'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_device_diagnostic_checkpoints VK_NV_device_diagnostic_checkpoints>
-- is supported:
--
-- - Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_CHECKPOINT_DATA_2_NV'
--
-- - 'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_2_NV'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_device_generated_commands VK_NV_device_generated_commands>
-- is supported:
--
-- - Extending 'AccessFlagBits2KHR':
--
-- - 'ACCESS_2_COMMAND_PREPROCESS_READ_BIT_NV'
--
-- - 'ACCESS_2_COMMAND_PREPROCESS_WRITE_BIT_NV'
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_COMMAND_PREPROCESS_BIT_NV'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_mesh_shader VK_NV_mesh_shader>
-- is supported:
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_MESH_SHADER_BIT_NV'
--
-- - 'PIPELINE_STAGE_2_TASK_SHADER_BIT_NV'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_ray_tracing VK_NV_ray_tracing>
-- is supported:
--
-- - Extending 'AccessFlagBits2KHR':
--
-- - 'ACCESS_2_ACCELERATION_STRUCTURE_READ_BIT_NV'
--
-- - 'ACCESS_2_ACCELERATION_STRUCTURE_WRITE_BIT_NV'
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_ACCELERATION_STRUCTURE_BUILD_BIT_NV'
--
-- - 'PIPELINE_STAGE_2_RAY_TRACING_SHADER_BIT_NV'
--
-- If
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_shading_rate_image VK_NV_shading_rate_image>
-- is supported:
--
-- - Extending 'AccessFlagBits2KHR':
--
-- - 'ACCESS_2_SHADING_RATE_IMAGE_READ_BIT_NV'
--
-- - Extending 'PipelineStageFlagBits2KHR':
--
-- - 'PIPELINE_STAGE_2_SHADING_RATE_IMAGE_BIT_NV'
--
-- == Examples
--
-- See
-- <https://github.com/KhronosGroup/Vulkan-Docs/wiki/Synchronization-Examples>
--
-- == Version History
--
-- - Revision 1, 2020-12-03 (Tobias Hector)
--
-- - Internal revisions
--
-- = See Also
--
-- 'AccessFlagBits2KHR', 'AccessFlags2KHR', 'BufferMemoryBarrier2KHR',
-- 'CommandBufferSubmitInfoKHR', 'DependencyInfoKHR',
-- 'ImageMemoryBarrier2KHR', 'MemoryBarrier2KHR',
-- 'PhysicalDeviceSynchronization2FeaturesKHR',
-- 'PipelineStageFlagBits2KHR', 'PipelineStageFlags2KHR',
-- 'SemaphoreSubmitInfoKHR', 'SubmitFlagBitsKHR', 'SubmitFlagsKHR',
-- 'SubmitInfo2KHR', 'cmdPipelineBarrier2KHR', 'cmdResetEvent2KHR',
-- 'cmdSetEvent2KHR', 'cmdWaitEvents2KHR', 'cmdWriteTimestamp2KHR',
-- 'queueSubmit2KHR'
--
-- = Document Notes
--
-- For more information, see the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_synchronization2 Vulkan Specification>
--
-- This page is a generated document. Fixes and changes should be made to
-- the generator scripts, not directly.
module Vulkan.Extensions.VK_KHR_synchronization2 ( cmdSetEvent2KHR
, cmdResetEvent2KHR
, cmdWaitEvents2KHR
, cmdWaitEvents2KHRSafe
, cmdPipelineBarrier2KHR
, queueSubmit2KHR
, cmdWriteTimestamp2KHR
, cmdWriteBufferMarker2AMD
, getQueueCheckpointData2NV
, pattern PIPELINE_STAGE_2_SHADING_RATE_IMAGE_BIT_NV
, pattern ACCESS_2_SHADING_RATE_IMAGE_READ_BIT_NV
, pattern PIPELINE_STAGE_2_RAY_TRACING_SHADER_BIT_NV
, pattern PIPELINE_STAGE_2_ACCELERATION_STRUCTURE_BUILD_BIT_NV
, pattern ACCESS_2_ACCELERATION_STRUCTURE_READ_BIT_NV
, pattern ACCESS_2_ACCELERATION_STRUCTURE_WRITE_BIT_NV
, pattern PIPELINE_STAGE_2_TRANSFER_BIT_KHR
, MemoryBarrier2KHR(..)
, ImageMemoryBarrier2KHR(..)
, BufferMemoryBarrier2KHR(..)
, DependencyInfoKHR(..)
, SemaphoreSubmitInfoKHR(..)
, CommandBufferSubmitInfoKHR(..)
, SubmitInfo2KHR(..)
, QueueFamilyCheckpointProperties2NV(..)
, CheckpointData2NV(..)
, PhysicalDeviceSynchronization2FeaturesKHR(..)
, AccessFlags2KHR(..)
, PipelineStageFlags2KHR(..)
, AccessFlagBits2KHR( ACCESS_2_NONE_KHR
, ACCESS_2_INDIRECT_COMMAND_READ_BIT_KHR
, ACCESS_2_INDEX_READ_BIT_KHR
, ACCESS_2_VERTEX_ATTRIBUTE_READ_BIT_KHR
, ACCESS_2_UNIFORM_READ_BIT_KHR
, ACCESS_2_INPUT_ATTACHMENT_READ_BIT_KHR
, ACCESS_2_SHADER_READ_BIT_KHR
, ACCESS_2_SHADER_WRITE_BIT_KHR
, ACCESS_2_COLOR_ATTACHMENT_READ_BIT_KHR
, ACCESS_2_COLOR_ATTACHMENT_WRITE_BIT_KHR
, ACCESS_2_DEPTH_STENCIL_ATTACHMENT_READ_BIT_KHR
, ACCESS_2_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT_KHR
, ACCESS_2_TRANSFER_READ_BIT_KHR
, ACCESS_2_TRANSFER_WRITE_BIT_KHR
, ACCESS_2_HOST_READ_BIT_KHR
, ACCESS_2_HOST_WRITE_BIT_KHR
, ACCESS_2_MEMORY_READ_BIT_KHR
, ACCESS_2_MEMORY_WRITE_BIT_KHR
, ACCESS_2_SHADER_SAMPLED_READ_BIT_KHR
, ACCESS_2_SHADER_STORAGE_READ_BIT_KHR
, ACCESS_2_SHADER_STORAGE_WRITE_BIT_KHR
, ACCESS_2_COLOR_ATTACHMENT_READ_NONCOHERENT_BIT_EXT
, ACCESS_2_FRAGMENT_DENSITY_MAP_READ_BIT_EXT
, ACCESS_2_ACCELERATION_STRUCTURE_WRITE_BIT_KHR
, ACCESS_2_ACCELERATION_STRUCTURE_READ_BIT_KHR
, ACCESS_2_FRAGMENT_SHADING_RATE_ATTACHMENT_READ_BIT_KHR
, ACCESS_2_COMMAND_PREPROCESS_WRITE_BIT_NV
, ACCESS_2_COMMAND_PREPROCESS_READ_BIT_NV
, ACCESS_2_CONDITIONAL_RENDERING_READ_BIT_EXT
, ACCESS_2_TRANSFORM_FEEDBACK_COUNTER_WRITE_BIT_EXT
, ACCESS_2_TRANSFORM_FEEDBACK_COUNTER_READ_BIT_EXT
, ACCESS_2_TRANSFORM_FEEDBACK_WRITE_BIT_EXT
, ..
)
, PipelineStageFlagBits2KHR( PIPELINE_STAGE_2_NONE_KHR
, PIPELINE_STAGE_2_TOP_OF_PIPE_BIT_KHR
, PIPELINE_STAGE_2_DRAW_INDIRECT_BIT_KHR
, PIPELINE_STAGE_2_VERTEX_INPUT_BIT_KHR
, PIPELINE_STAGE_2_VERTEX_SHADER_BIT_KHR
, PIPELINE_STAGE_2_TESSELLATION_CONTROL_SHADER_BIT_KHR
, PIPELINE_STAGE_2_TESSELLATION_EVALUATION_SHADER_BIT_KHR
, PIPELINE_STAGE_2_GEOMETRY_SHADER_BIT_KHR
, PIPELINE_STAGE_2_FRAGMENT_SHADER_BIT_KHR
, PIPELINE_STAGE_2_EARLY_FRAGMENT_TESTS_BIT_KHR
, PIPELINE_STAGE_2_LATE_FRAGMENT_TESTS_BIT_KHR
, PIPELINE_STAGE_2_COLOR_ATTACHMENT_OUTPUT_BIT_KHR
, PIPELINE_STAGE_2_COMPUTE_SHADER_BIT_KHR
, PIPELINE_STAGE_2_ALL_TRANSFER_BIT_KHR
, PIPELINE_STAGE_2_BOTTOM_OF_PIPE_BIT_KHR
, PIPELINE_STAGE_2_HOST_BIT_KHR
, PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR
, PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR
, PIPELINE_STAGE_2_COPY_BIT_KHR
, PIPELINE_STAGE_2_RESOLVE_BIT_KHR
, PIPELINE_STAGE_2_BLIT_BIT_KHR
, PIPELINE_STAGE_2_CLEAR_BIT_KHR
, PIPELINE_STAGE_2_INDEX_INPUT_BIT_KHR
, PIPELINE_STAGE_2_VERTEX_ATTRIBUTE_INPUT_BIT_KHR
, PIPELINE_STAGE_2_PRE_RASTERIZATION_SHADERS_BIT_KHR
, PIPELINE_STAGE_2_MESH_SHADER_BIT_NV
, PIPELINE_STAGE_2_TASK_SHADER_BIT_NV
, PIPELINE_STAGE_2_FRAGMENT_DENSITY_PROCESS_BIT_EXT
, PIPELINE_STAGE_2_RAY_TRACING_SHADER_BIT_KHR
, PIPELINE_STAGE_2_ACCELERATION_STRUCTURE_BUILD_BIT_KHR
, PIPELINE_STAGE_2_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
, PIPELINE_STAGE_2_COMMAND_PREPROCESS_BIT_NV
, PIPELINE_STAGE_2_CONDITIONAL_RENDERING_BIT_EXT
, PIPELINE_STAGE_2_TRANSFORM_FEEDBACK_BIT_EXT
, ..
)
, SubmitFlagsKHR
, SubmitFlagBitsKHR( SUBMIT_PROTECTED_BIT_KHR
, ..
)
, KHR_SYNCHRONIZATION_2_SPEC_VERSION
, pattern KHR_SYNCHRONIZATION_2_SPEC_VERSION
, KHR_SYNCHRONIZATION_2_EXTENSION_NAME
, pattern KHR_SYNCHRONIZATION_2_EXTENSION_NAME
) where
import Vulkan.Internal.Utils (enumReadPrec)
import Vulkan.Internal.Utils (enumShowsPrec)
import Vulkan.Internal.Utils (traceAroundEvent)
import Control.Exception.Base (bracket)
import Control.Monad (unless)
import Control.Monad.IO.Class (liftIO)
import Data.Typeable (eqT)
import Foreign.Marshal.Alloc (allocaBytesAligned)
import Foreign.Marshal.Alloc (callocBytes)
import Foreign.Marshal.Alloc (free)
import GHC.Base (when)
import GHC.IO (throwIO)
import GHC.Ptr (castPtr)
import GHC.Ptr (nullFunPtr)
import Foreign.Ptr (nullPtr)
import Foreign.Ptr (plusPtr)
import GHC.Show (showString)
import Numeric (showHex)
import Control.Monad.Trans.Class (lift)
import Control.Monad.Trans.Cont (evalContT)
import Data.Vector (generateM)
import qualified Data.Vector (imapM_)
import qualified Data.Vector (length)
import Vulkan.CStruct (FromCStruct)
import Vulkan.CStruct (FromCStruct(..))
import Vulkan.CStruct (ToCStruct)
import Vulkan.CStruct (ToCStruct(..))
import Vulkan.Zero (Zero)
import Vulkan.Zero (Zero(..))
import Control.Monad.IO.Class (MonadIO)
import Data.Bits (Bits)
import Data.Bits (FiniteBits)
import Data.String (IsString)
import Data.Type.Equality ((:~:)(Refl))
import Data.Typeable (Typeable)
import Foreign.Storable (Storable)
import Foreign.Storable (Storable(peek))
import Foreign.Storable (Storable(poke))
import qualified Foreign.Storable (Storable(..))
import GHC.Generics (Generic)
import GHC.IO.Exception (IOErrorType(..))
import GHC.IO.Exception (IOException(..))
import Foreign.Ptr (FunPtr)
import Foreign.Ptr (Ptr)
import GHC.Read (Read(readPrec))
import GHC.Show (Show(showsPrec))
import Data.Word (Word32)
import Data.Word (Word64)
import Data.Kind (Type)
import Control.Monad.Trans.Cont (ContT(..))
import Data.Vector (Vector)
import Vulkan.CStruct.Utils (advancePtrBytes)
import Vulkan.Core10.FundamentalTypes (bool32ToBool)
import Vulkan.Core10.FundamentalTypes (boolToBool32)
import Vulkan.CStruct.Extends (forgetExtensions)
import Vulkan.CStruct.Extends (peekSomeCStruct)
import Vulkan.CStruct.Extends (pokeSomeCStruct)
import Vulkan.NamedType ((:::))
import Vulkan.Core10.FundamentalTypes (Bool32)
import Vulkan.Core10.Handles (Buffer)
import Vulkan.Core10.Handles (Buffer(..))
import Vulkan.CStruct.Extends (Chain)
import Vulkan.Core10.Handles (CommandBuffer)
import Vulkan.Core10.Handles (CommandBuffer(..))
import Vulkan.Core10.Handles (CommandBuffer_T)
import Vulkan.Core10.Enums.DependencyFlagBits (DependencyFlags)
import Vulkan.Dynamic (DeviceCmds(pVkCmdPipelineBarrier2KHR))
import Vulkan.Dynamic (DeviceCmds(pVkCmdResetEvent2KHR))
import Vulkan.Dynamic (DeviceCmds(pVkCmdSetEvent2KHR))
import Vulkan.Dynamic (DeviceCmds(pVkCmdWaitEvents2KHR))
import Vulkan.Dynamic (DeviceCmds(pVkCmdWriteBufferMarker2AMD))
import Vulkan.Dynamic (DeviceCmds(pVkCmdWriteTimestamp2KHR))
import Vulkan.Dynamic (DeviceCmds(pVkGetQueueCheckpointData2NV))
import Vulkan.Dynamic (DeviceCmds(pVkQueueSubmit2KHR))
import Vulkan.Core10.FundamentalTypes (DeviceSize)
import Vulkan.Core10.Handles (Event)
import Vulkan.Core10.Handles (Event(..))
import Vulkan.CStruct.Extends (Extends)
import Vulkan.CStruct.Extends (Extendss)
import Vulkan.CStruct.Extends (Extensible(..))
import Vulkan.Core10.Handles (Fence)
import Vulkan.Core10.Handles (Fence(..))
import Vulkan.Core10.FundamentalTypes (Flags)
import Vulkan.Core10.Handles (Image)
import Vulkan.Core10.Enums.ImageLayout (ImageLayout)
import Vulkan.Core10.ImageView (ImageSubresourceRange)
import Vulkan.CStruct.Extends (PeekChain)
import Vulkan.CStruct.Extends (PeekChain(..))
import {-# SOURCE #-} Vulkan.Extensions.VK_KHR_performance_query (PerformanceQuerySubmitInfoKHR)
import Vulkan.CStruct.Extends (PokeChain)
import Vulkan.CStruct.Extends (PokeChain(..))
import Vulkan.Core10.Handles (QueryPool)
import Vulkan.Core10.Handles (QueryPool(..))
import Vulkan.Core10.Handles (Queue)
import Vulkan.Core10.Handles (Queue(..))
import Vulkan.Core10.Handles (Queue_T)
import Vulkan.Core10.Enums.Result (Result)
import Vulkan.Core10.Enums.Result (Result(..))
import {-# SOURCE #-} Vulkan.Extensions.VK_EXT_sample_locations (SampleLocationsInfoEXT)
import Vulkan.Core10.Handles (Semaphore)
import Vulkan.CStruct.Extends (SomeStruct)
import Vulkan.Core10.Enums.StructureType (StructureType)
import Vulkan.Exception (VulkanException(..))
import {-# SOURCE #-} Vulkan.Extensions.VK_KHR_win32_keyed_mutex (Win32KeyedMutexAcquireReleaseInfoKHR)
import {-# SOURCE #-} Vulkan.Extensions.VK_NV_win32_keyed_mutex (Win32KeyedMutexAcquireReleaseInfoNV)
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER_2_KHR))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_CHECKPOINT_DATA_2_NV))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_COMMAND_BUFFER_SUBMIT_INFO_KHR))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_DEPENDENCY_INFO_KHR))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER_2_KHR))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_MEMORY_BARRIER_2_KHR))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_PHYSICAL_DEVICE_SYNCHRONIZATION_2_FEATURES_KHR))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_2_NV))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_SEMAPHORE_SUBMIT_INFO_KHR))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_SUBMIT_INFO_2_KHR))
import Vulkan.Core10.Enums.Result (Result(SUCCESS))
foreign import ccall
#if !defined(SAFE_FOREIGN_CALLS)
unsafe
#endif
"dynamic" mkVkCmdSetEvent2KHR
:: FunPtr (Ptr CommandBuffer_T -> Event -> Ptr DependencyInfoKHR -> IO ()) -> Ptr CommandBuffer_T -> Event -> Ptr DependencyInfoKHR -> IO ()
-- | vkCmdSetEvent2KHR - Set an event object to signaled state
--
-- = Description
--
-- When 'cmdSetEvent2KHR' is submitted to a queue, it defines the first
-- half of memory dependencies defined by @pDependencyInfo@, as well as an
-- event signal operation which sets the event to the signaled state. A
-- memory dependency is defined between the event signal operation and
-- commands that occur earlier in submission order.
--
-- The first
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-dependencies-scopes synchronization scope>
-- and
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-dependencies-access-scopes access scope>
-- are defined by the union of all the memory dependencies defined by
-- @pDependencyInfo@, and are applied to all operations that occur earlier
-- in
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-submission-order submission order>.
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-queue-transfers Queue family ownership transfers>
-- and
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-image-layout-transitions image layout transitions>
-- defined by @pDependencyInfo@ are also included in the first scopes.
--
-- The second
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-dependencies-scopes synchronization scope>
-- includes only the event signal operation, and any
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-queue-transfers queue family ownership transfers>
-- and
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-image-layout-transitions image layout transitions>
-- defined by @pDependencyInfo@.
--
-- The second
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-dependencies-access-scopes access scope>
-- includes only
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-queue-transfers queue family ownership transfers>
-- and
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-image-layout-transitions image layout transitions>.
--
-- Future 'cmdWaitEvents2KHR' commands rely on all values of each element
-- in @pDependencyInfo@ matching exactly with those used to signal the
-- corresponding event. 'Vulkan.Core10.CommandBufferBuilding.cmdWaitEvents'
-- /must/ not be used to wait on the result of a signal operation defined
-- by 'cmdSetEvent2KHR'.
--
-- Note
--
-- The extra information provided by 'cmdSetEvent2KHR' compared to
-- 'Vulkan.Core10.CommandBufferBuilding.cmdSetEvent' allows implementations
-- to more efficiently schedule the operations required to satisfy the
-- requested dependencies. With
-- 'Vulkan.Core10.CommandBufferBuilding.cmdSetEvent', the full dependency
-- information is not known until
-- 'Vulkan.Core10.CommandBufferBuilding.cmdWaitEvents' is recorded, forcing
-- implementations to insert the required operations at that point and not
-- before.
--
-- If @event@ is already in the signaled state when 'cmdSetEvent2KHR' is
-- executed on the device, then 'cmdSetEvent2KHR' has no effect, no event
-- signal operation occurs, and no dependency is generated.
--
-- == Valid Usage
--
-- - #VUID-vkCmdSetEvent2KHR-synchronization2-03824# The
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-synchronization2 synchronization2>
-- feature /must/ be enabled
--
-- - #VUID-vkCmdSetEvent2KHR-dependencyFlags-03825# The @dependencyFlags@
-- member of @dependencyInfo@ /must/ be @0@
--
-- - #VUID-vkCmdSetEvent2KHR-commandBuffer-03826# The current device mask
-- of @commandBuffer@ /must/ include exactly one physical device.
--
-- - #VUID-vkCmdSetEvent2KHR-srcStageMask-03827# The @srcStageMask@
-- member of any element of the @pMemoryBarriers@,
-- @pBufferMemoryBarriers@, or @pImageMemoryBarriers@ members of
-- @pDependencyInfo@ /must/ only include pipeline stages valid for the
-- queue family that was used to create the command pool that
-- @commandBuffer@ was allocated from
--
-- - #VUID-vkCmdSetEvent2KHR-dstStageMask-03828# The @dstStageMask@
-- member of any element of the @pMemoryBarriers@,
-- @pBufferMemoryBarriers@, or @pImageMemoryBarriers@ members of
-- @pDependencyInfo@ /must/ only include pipeline stages valid for the
-- queue family that was used to create the command pool that
-- @commandBuffer@ was allocated from
--
-- == Valid Usage (Implicit)
--
-- - #VUID-vkCmdSetEvent2KHR-commandBuffer-parameter# @commandBuffer@
-- /must/ be a valid 'Vulkan.Core10.Handles.CommandBuffer' handle
--
-- - #VUID-vkCmdSetEvent2KHR-event-parameter# @event@ /must/ be a valid
-- 'Vulkan.Core10.Handles.Event' handle
--
-- - #VUID-vkCmdSetEvent2KHR-pDependencyInfo-parameter# @pDependencyInfo@
-- /must/ be a valid pointer to a valid 'DependencyInfoKHR' structure
--
-- - #VUID-vkCmdSetEvent2KHR-commandBuffer-recording# @commandBuffer@
-- /must/ be in the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#commandbuffers-lifecycle recording state>
--
-- - #VUID-vkCmdSetEvent2KHR-commandBuffer-cmdpool# The
-- 'Vulkan.Core10.Handles.CommandPool' that @commandBuffer@ was
-- allocated from /must/ support graphics, or compute operations
--
-- - #VUID-vkCmdSetEvent2KHR-renderpass# This command /must/ only be
-- called outside of a render pass instance
--
-- - #VUID-vkCmdSetEvent2KHR-commonparent# Both of @commandBuffer@, and
-- @event@ /must/ have been created, allocated, or retrieved from the
-- same 'Vulkan.Core10.Handles.Device'
--
-- == Host Synchronization
--
-- - Host access to @commandBuffer@ /must/ be externally synchronized
--
-- - Host access to the 'Vulkan.Core10.Handles.CommandPool' that
-- @commandBuffer@ was allocated from /must/ be externally synchronized
--
-- == Command Properties
--
-- \'
--
-- +----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
-- | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VkCommandBufferLevel Command Buffer Levels> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#vkCmdBeginRenderPass Render Pass Scope> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VkQueueFlagBits Supported Queue Types> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-pipeline-stages-types Pipeline Type> |
-- +============================================================================================================================+========================================================================================================================+=======================================================================================================================+=====================================================================================================================================+
-- | Primary | Outside | Graphics | |
-- | Secondary | | Compute | |
-- +----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
--
-- = See Also
--
-- 'Vulkan.Core10.Handles.CommandBuffer', 'DependencyInfoKHR',
-- 'Vulkan.Core10.Handles.Event'
cmdSetEvent2KHR :: forall io
. (MonadIO io)
=> -- | @commandBuffer@ is the command buffer into which the command is
-- recorded.
CommandBuffer
-> -- | @event@ is the event that will be signaled.
Event
-> -- | @pDependencyInfo@ is a pointer to a 'DependencyInfoKHR' structure
-- defining the first scopes of this operation.
DependencyInfoKHR
-> io ()
cmdSetEvent2KHR commandBuffer event dependencyInfo = liftIO . evalContT $ do
let vkCmdSetEvent2KHRPtr = pVkCmdSetEvent2KHR (deviceCmds (commandBuffer :: CommandBuffer))
lift $ unless (vkCmdSetEvent2KHRPtr /= nullFunPtr) $
throwIO $ IOError Nothing InvalidArgument "" "The function pointer for vkCmdSetEvent2KHR is null" Nothing Nothing
let vkCmdSetEvent2KHR' = mkVkCmdSetEvent2KHR vkCmdSetEvent2KHRPtr
pDependencyInfo <- ContT $ withCStruct (dependencyInfo)
lift $ traceAroundEvent "vkCmdSetEvent2KHR" (vkCmdSetEvent2KHR' (commandBufferHandle (commandBuffer)) (event) pDependencyInfo)
pure $ ()
foreign import ccall
#if !defined(SAFE_FOREIGN_CALLS)
unsafe
#endif
"dynamic" mkVkCmdResetEvent2KHR
:: FunPtr (Ptr CommandBuffer_T -> Event -> PipelineStageFlags2KHR -> IO ()) -> Ptr CommandBuffer_T -> Event -> PipelineStageFlags2KHR -> IO ()
-- | vkCmdResetEvent2KHR - Reset an event object to non-signaled state
--
-- = Description
--
-- When 'cmdResetEvent2KHR' is submitted to a queue, it defines an
-- execution dependency on commands that were submitted before it, and
-- defines an event unsignal operation which resets the event to the
-- unsignaled state.
--
-- The first
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-dependencies-scopes synchronization scope>
-- includes all commands that occur earlier in
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-submission-order submission order>.
-- The synchronization scope is limited to operations by @stage@ or stages
-- that are
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-pipeline-stages-order logically earlier>
-- than @stage@.
--
-- The second
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-dependencies-scopes synchronization scope>
-- includes only the event unsignal operation.
--
-- If @event@ is already in the unsignaled state when
-- 'Vulkan.Core10.CommandBufferBuilding.cmdResetEvent' is executed on the
-- device, then 'Vulkan.Core10.CommandBufferBuilding.cmdResetEvent' has no
-- effect, no event unsignal operation occurs, and no execution dependency
-- is generated.
--
-- == Valid Usage
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-03929# If the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-geometryShader geometry shaders>
-- feature is not enabled, @stageMask@ /must/ not contain
-- 'PIPELINE_STAGE_2_GEOMETRY_SHADER_BIT_KHR'
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-03930# If the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-tessellationShader tessellation shaders>
-- feature is not enabled, @stageMask@ /must/ not contain
-- 'PIPELINE_STAGE_2_TESSELLATION_CONTROL_SHADER_BIT_KHR' or
-- 'PIPELINE_STAGE_2_TESSELLATION_EVALUATION_SHADER_BIT_KHR'
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-03931# If the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-conditionalRendering conditional rendering>
-- feature is not enabled, @stageMask@ /must/ not contain
-- 'PIPELINE_STAGE_2_CONDITIONAL_RENDERING_BIT_EXT'
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-03932# If the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-fragmentDensityMap fragment density map>
-- feature is not enabled, @stageMask@ /must/ not contain
-- 'PIPELINE_STAGE_2_FRAGMENT_DENSITY_PROCESS_BIT_EXT'
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-03933# If the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-transformFeedback transform feedback>
-- feature is not enabled, @stageMask@ /must/ not contain
-- 'PIPELINE_STAGE_2_TRANSFORM_FEEDBACK_BIT_EXT'
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-03934# If the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-meshShader mesh shaders>
-- feature is not enabled, @stageMask@ /must/ not contain
-- 'PIPELINE_STAGE_2_MESH_SHADER_BIT_NV'
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-03935# If the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-taskShader task shaders>
-- feature is not enabled, @stageMask@ /must/ not contain
-- 'PIPELINE_STAGE_2_TASK_SHADER_BIT_NV'
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-03936# If the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-shadingRateImage shading rate image>
-- feature is not enabled, @stageMask@ /must/ not contain
-- 'PIPELINE_STAGE_2_SHADING_RATE_IMAGE_BIT_NV'
--
-- - #VUID-vkCmdResetEvent2KHR-synchronization2-03829# The
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-synchronization2 synchronization2>
-- feature /must/ be enabled
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-03830# @stageMask@ /must/ not
-- include 'PIPELINE_STAGE_2_HOST_BIT_KHR'
--
-- - #VUID-vkCmdResetEvent2KHR-event-03831# There /must/ be an execution
-- dependency between 'cmdResetEvent2KHR' and the execution of any
-- 'Vulkan.Core10.CommandBufferBuilding.cmdWaitEvents' that includes
-- @event@ in its @pEvents@ parameter
--
-- - #VUID-vkCmdResetEvent2KHR-event-03832# There /must/ be an execution
-- dependency between 'cmdResetEvent2KHR' and the execution of any
-- 'cmdWaitEvents2KHR' that includes @event@ in its @pEvents@ parameter
--
-- - #VUID-vkCmdResetEvent2KHR-commandBuffer-03833# @commandBuffer@’s
-- current device mask /must/ include exactly one physical device.
--
-- == Valid Usage (Implicit)
--
-- - #VUID-vkCmdResetEvent2KHR-commandBuffer-parameter# @commandBuffer@
-- /must/ be a valid 'Vulkan.Core10.Handles.CommandBuffer' handle
--
-- - #VUID-vkCmdResetEvent2KHR-event-parameter# @event@ /must/ be a valid
-- 'Vulkan.Core10.Handles.Event' handle
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-parameter# @stageMask@ /must/ be
-- a valid combination of 'PipelineStageFlagBits2KHR' values
--
-- - #VUID-vkCmdResetEvent2KHR-stageMask-requiredbitmask# @stageMask@
-- /must/ not be @0@
--
-- - #VUID-vkCmdResetEvent2KHR-commandBuffer-recording# @commandBuffer@
-- /must/ be in the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#commandbuffers-lifecycle recording state>
--
-- - #VUID-vkCmdResetEvent2KHR-commandBuffer-cmdpool# The
-- 'Vulkan.Core10.Handles.CommandPool' that @commandBuffer@ was
-- allocated from /must/ support graphics, or compute operations
--
-- - #VUID-vkCmdResetEvent2KHR-renderpass# This command /must/ only be
-- called outside of a render pass instance
--
-- - #VUID-vkCmdResetEvent2KHR-commonparent# Both of @commandBuffer@, and
-- @event@ /must/ have been created, allocated, or retrieved from the
-- same 'Vulkan.Core10.Handles.Device'
--
-- == Host Synchronization
--
-- - Host access to @commandBuffer@ /must/ be externally synchronized
--
-- - Host access to the 'Vulkan.Core10.Handles.CommandPool' that
-- @commandBuffer@ was allocated from /must/ be externally synchronized
--
-- == Command Properties
--
-- \'
--
-- +----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
-- | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VkCommandBufferLevel Command Buffer Levels> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#vkCmdBeginRenderPass Render Pass Scope> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VkQueueFlagBits Supported Queue Types> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-pipeline-stages-types Pipeline Type> |
-- +============================================================================================================================+========================================================================================================================+=======================================================================================================================+=====================================================================================================================================+
-- | Primary | Outside | Graphics | |
-- | Secondary | | Compute | |
-- +----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
--
-- = See Also
--
-- 'Vulkan.Core10.Handles.CommandBuffer', 'Vulkan.Core10.Handles.Event',
-- 'PipelineStageFlags2KHR'
cmdResetEvent2KHR :: forall io
. (MonadIO io)
=> -- | @commandBuffer@ is the command buffer into which the command is
-- recorded.
CommandBuffer
-> -- | @event@ is the event that will be unsignaled.
Event
-> -- | @stageMask@ is a is a 'PipelineStageFlags2KHR' mask of pipeline stages
-- used to determine the first
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-dependencies-scopes synchronization scope>.
("stageMask" ::: PipelineStageFlags2KHR)
-> io ()
cmdResetEvent2KHR commandBuffer event stageMask = liftIO $ do
let vkCmdResetEvent2KHRPtr = pVkCmdResetEvent2KHR (deviceCmds (commandBuffer :: CommandBuffer))
unless (vkCmdResetEvent2KHRPtr /= nullFunPtr) $
throwIO $ IOError Nothing InvalidArgument "" "The function pointer for vkCmdResetEvent2KHR is null" Nothing Nothing
let vkCmdResetEvent2KHR' = mkVkCmdResetEvent2KHR vkCmdResetEvent2KHRPtr
traceAroundEvent "vkCmdResetEvent2KHR" (vkCmdResetEvent2KHR' (commandBufferHandle (commandBuffer)) (event) (stageMask))
pure $ ()
foreign import ccall
#if !defined(SAFE_FOREIGN_CALLS)
unsafe
#endif
"dynamic" mkVkCmdWaitEvents2KHRUnsafe
:: FunPtr (Ptr CommandBuffer_T -> Word32 -> Ptr Event -> Ptr DependencyInfoKHR -> IO ()) -> Ptr CommandBuffer_T -> Word32 -> Ptr Event -> Ptr DependencyInfoKHR -> IO ()
foreign import ccall
"dynamic" mkVkCmdWaitEvents2KHRSafe
:: FunPtr (Ptr CommandBuffer_T -> Word32 -> Ptr Event -> Ptr DependencyInfoKHR -> IO ()) -> Ptr CommandBuffer_T -> Word32 -> Ptr Event -> Ptr DependencyInfoKHR -> IO ()
-- | cmdWaitEvents2KHR with selectable safeness
cmdWaitEvents2KHRSafeOrUnsafe :: forall io
. (MonadIO io)
=> (FunPtr (Ptr CommandBuffer_T -> Word32 -> Ptr Event -> Ptr DependencyInfoKHR -> IO ()) -> Ptr CommandBuffer_T -> Word32 -> Ptr Event -> Ptr DependencyInfoKHR -> IO ())
-> -- | @commandBuffer@ is the command buffer into which the command is
-- recorded.
CommandBuffer
-> -- | @pEvents@ is an array of events to wait on.
("events" ::: Vector Event)
-> -- | @pDependencyInfos@ is an array of 'DependencyInfoKHR' structures,
-- defining the second
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-dependencies-scopes synchronization scope>.