forked from intel/llvm
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathexp-command-buffer.yml
1289 lines (1289 loc) · 61.8 KB
/
exp-command-buffer.yml
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
#
# Copyright (C) 2022 Intel Corporation
#
# Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
# See LICENSE.TXT
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#
# See YaML.md for syntax definition
#
--- #--------------------------------------------------------------------------
type: header
desc: "Intel $OneApi Unified Runtime Experimental APIs for Command-Buffers"
ordinal: "99"
--- #--------------------------------------------------------------------------
type: enum
extend: true
typed_etors: true
desc: "Extension enums to $x_device_info_t to support command-buffers."
name: $x_device_info_t
etors:
- name: COMMAND_BUFFER_SUPPORT_EXP
value: "0x1000"
desc: "[$x_bool_t] Returns true if the device supports the use of command-buffers."
- name: COMMAND_BUFFER_UPDATE_CAPABILITIES_EXP
desc: "[$x_device_command_buffer_update_capability_flags_t] Command-buffer update capabilities of the device"
value: "0x1001"
- name: COMMAND_BUFFER_EVENT_SUPPORT_EXP
value: "0x1002"
desc: "[$x_bool_t] Returns true if the device supports using event objects for command synchronization outside of a command-buffer."
--- #--------------------------------------------------------------------------
type: enum
desc: "Device kernel execution capability"
class: $xDevice
name: $x_device_command_buffer_update_capability_flags_t
etors:
- name: KERNEL_ARGUMENTS
value: "$X_BIT(0)"
desc: "Device supports updating the kernel arguments in command-buffer commands."
- name: LOCAL_WORK_SIZE
value: "$X_BIT(1)"
desc: "Device supports updating the local work-group size in command-buffer commands."
- name: GLOBAL_WORK_SIZE
value: "$X_BIT(2)"
desc: "Device supports updating the global work-group size in command-buffer commands."
- name: GLOBAL_WORK_OFFSET
value: "$X_BIT(3)"
desc: "Device supports updating the global work offset in command-buffer commands."
- name: KERNEL_HANDLE
value: "$X_BIT(4)"
desc: "Device supports updating the kernel handle in command-buffer commands."
- name: EVENTS
value: "$X_BIT(5)"
desc: "Device supports updating the event parameters in command-buffer commands."
--- #--------------------------------------------------------------------------
type: enum
extend: true
desc: "Experimental Command Buffer result type enums."
name: $x_result_t
etors:
- name: ERROR_INVALID_COMMAND_BUFFER_EXP
value: "0x1000"
desc: "Invalid Command-Buffer"
- name: ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
value: "0x1001"
desc: "Sync point is not valid for the command-buffer"
- name: ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
value: "0x1002"
desc: "Sync point wait list is invalid"
- name: ERROR_INVALID_COMMAND_BUFFER_COMMAND_HANDLE_EXP
value: "0x1003"
desc: "Handle to command-buffer command is invalid"
--- #--------------------------------------------------------------------------
type: enum
extend: true
desc: "Extend enumeration of Command Buffer Structure Type."
name: $x_structure_type_t
etors:
- name: EXP_COMMAND_BUFFER_DESC
desc: $x_exp_command_buffer_desc_t
value: "0x1000"
- name: EXP_COMMAND_BUFFER_UPDATE_KERNEL_LAUNCH_DESC
desc: $x_exp_command_buffer_update_kernel_launch_desc_t
value: "0x1001"
- name: EXP_COMMAND_BUFFER_UPDATE_MEMOBJ_ARG_DESC
desc: $x_exp_command_buffer_update_memobj_arg_desc_t
value: "0x1002"
- name: EXP_COMMAND_BUFFER_UPDATE_POINTER_ARG_DESC
desc: $x_exp_command_buffer_update_pointer_arg_desc_t
value: "0x1003"
- name: EXP_COMMAND_BUFFER_UPDATE_VALUE_ARG_DESC
desc: $x_exp_command_buffer_update_value_arg_desc_t
value: "0x1004"
--- #--------------------------------------------------------------------------
type: enum
extend: true
desc: "Extend command type enumeration for Command-Buffer experimental feature."
name: $x_command_t
etors:
- name: COMMAND_BUFFER_ENQUEUE_EXP
desc: Event created by $xCommandBufferEnqueueExp
value: "0x1000"
--- #--------------------------------------------------------------------------
type: enum
desc: "Command-buffer query information type"
class: $xCommandBuffer
name: $x_exp_command_buffer_info_t
typed_etors: True
etors:
- name: REFERENCE_COUNT
desc: |
[uint32_t] Reference count of the command-buffer object.
The reference count returned should be considered immediately stale.
It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
- name: DESCRIPTOR
desc: |
[$x_exp_command_buffer_desc_t] Returns a $x_exp_command_buffer_desc_t
with the properties of the command-buffer. Returned values may differ
from those passed on construction if the property was ignored by the
adapter.
--- #--------------------------------------------------------------------------
type: enum
desc: "Command-buffer command query information type"
class: $xCommandBuffer
name: $x_exp_command_buffer_command_info_t
typed_etors: True
etors:
- name: REFERENCE_COUNT
desc: |
[uint32_t] Reference count of the command-buffer object.
The reference count returned should be considered immediately stale.
It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
--- #--------------------------------------------------------------------------
type: macro
desc: "The extension string which defines support for command-buffers which is returned when querying device extensions."
name: $X_COMMAND_BUFFER_EXTENSION_STRING_EXP
value: "\"$x_exp_command_buffer\""
--- #--------------------------------------------------------------------------
type: struct
desc: "Command-Buffer Descriptor Type"
name: $x_exp_command_buffer_desc_t
base: $x_base_desc_t
members:
- type: $x_bool_t
name: isUpdatable
desc: "[in] Commands in a finalized command-buffer can be updated."
- type: $x_bool_t
name: isInOrder
desc: "[in] Commands in a command-buffer may be executed in-order without explicit dependencies."
- type: $x_bool_t
name: enableProfiling
desc: "[in] Command-buffer profiling is enabled."
--- #--------------------------------------------------------------------------
type: struct
desc: "Descriptor type for updating a kernel command memobj argument."
base: $x_base_desc_t
name: $x_exp_command_buffer_update_memobj_arg_desc_t
members:
- type: uint32_t
name: argIndex
desc: "[in] Argument index."
- type: "const ur_kernel_arg_mem_obj_properties_t *"
name: pProperties
desc: "[in][optional] Pointer to memory object properties."
- type: $x_mem_handle_t
name: hNewMemObjArg
desc: "[in][optional] Handle of memory object to set at argument index."
--- #--------------------------------------------------------------------------
type: struct
desc: "Descriptor type for updating a kernel command pointer argument."
base: $x_base_desc_t
name: $x_exp_command_buffer_update_pointer_arg_desc_t
members:
- type: uint32_t
name: argIndex
desc: "[in] Argument index."
- type: "const ur_kernel_arg_pointer_properties_t *"
name: pProperties
desc: "[in][optional] Pointer to USM pointer properties."
- type: "const void *"
name: pNewPointerArg
desc: "[in][optional] USM pointer to memory location holding the argument value to set at argument index."
--- #--------------------------------------------------------------------------
type: struct
desc: "Descriptor type for updating a kernel command value argument."
base: $x_base_desc_t
name: $x_exp_command_buffer_update_value_arg_desc_t
members:
- type: uint32_t
name: argIndex
desc: "[in] Argument index."
- type: size_t
name: argSize
desc: "[in] Argument size."
- type: "const ur_kernel_arg_value_properties_t *"
name: pProperties
desc: "[in][optional] Pointer to value properties."
- type: "const void *"
name: pNewValueArg
desc: "[in][optional] Argument value representing matching kernel arg type to set at argument index."
--- #--------------------------------------------------------------------------
type: struct
desc: "Descriptor type for updating a kernel launch command."
base: $x_base_desc_t
name: $x_exp_command_buffer_update_kernel_launch_desc_t
members:
- type: $x_kernel_handle_t
name: hNewKernel
desc: |
[in][optional] The new kernel handle. If this parameter is nullptr, the current kernel handle in `hCommand`
will be used. If a kernel handle is passed, it must be a valid kernel alternative as defined in
$xCommandBufferAppendKernelLaunchExp.
- type: uint32_t
name: numNewMemObjArgs
desc: "[in] Length of pNewMemObjArgList."
- type: uint32_t
name: numNewPointerArgs
desc: "[in] Length of pNewPointerArgList."
- type: uint32_t
name: numNewValueArgs
desc: "[in] Length of pNewValueArgList."
- type: uint32_t
name: newWorkDim
desc: "[in] Number of work dimensions in the kernel ND-range, from 1-3."
- type: "const $x_exp_command_buffer_update_memobj_arg_desc_t*"
name: pNewMemObjArgList
desc: "[in][optional][range(0, numNewMemObjArgs)] An array describing the new kernel mem obj arguments for the command."
- type: "const $x_exp_command_buffer_update_pointer_arg_desc_t*"
name: pNewPointerArgList
desc: "[in][optional][range(0, numNewPointerArgs)] An array describing the new kernel pointer arguments for the command."
- type: "const $x_exp_command_buffer_update_value_arg_desc_t*"
name: pNewValueArgList
desc: "[in][optional][range(0, numNewValueArgs)] An array describing the new kernel value arguments for the command."
- type: "size_t*"
name: pNewGlobalWorkOffset
desc: |
[in][optional][range(0, newWorkDim)] Array of newWorkDim unsigned values that describe the offset used
to calculate the global ID. If this parameter is nullptr, the current global work offset will be used. This parameter is required if `newWorkDim` is different from the current work dimensions
in the command.
- type: "size_t*"
name: pNewGlobalWorkSize
desc: |
[in][optional][range(0, newWorkDim)] Array of newWorkDim unsigned values that describe the number of
global work-items. If this parameter is nullptr, the current global work size in `hCommand` will be used.
This parameter is required if `newWorkDim` is different from the current work dimensions in the command.
- type: "size_t*"
name: pNewLocalWorkSize
desc: |
[in][optional][range(0, newWorkDim)] Array of newWorkDim unsigned values that describe the number of
work-items that make up a work-group. If `pNewGlobalWorkSize` is set and `pNewLocalWorkSize` is nullptr,
then the runtime implementation will choose the local work size. If `pNewGlobalWorkSize` is nullptr and
`pNewLocalWorkSize` is nullptr, the current local work size in the command will be used.
--- #--------------------------------------------------------------------------
type: typedef
desc: "A value that identifies a command inside of a command-buffer, used for defining dependencies between commands in the same command-buffer."
class: $xCommandBuffer
name: $x_exp_command_buffer_sync_point_t
value: uint32_t
--- #--------------------------------------------------------------------------
type: handle
desc: "Handle of Command-Buffer object"
class: $xCommandBuffer
name: "$x_exp_command_buffer_handle_t"
--- #--------------------------------------------------------------------------
type: handle
desc: "Handle of a Command-Buffer command"
class: $xCommandBuffer
name: "$x_exp_command_buffer_command_handle_t"
--- #--------------------------------------------------------------------------
type: function
desc: "Create a Command-Buffer object"
class: $xCommandBuffer
name: CreateExp
decl: static
details:
- "Create a command-buffer object."
params:
- type: $x_context_handle_t
name: hContext
desc: "[in] Handle of the context object."
- type: $x_device_handle_t
name: hDevice
desc: "[in] Handle of the device object."
- type: "const $x_exp_command_buffer_desc_t*"
name: pCommandBufferDesc
desc: "[in] Command-buffer descriptor."
- type: "$x_exp_command_buffer_handle_t*"
name: phCommandBuffer
desc: "[out][alloc] Pointer to command-Buffer handle."
returns:
- $X_RESULT_ERROR_INVALID_CONTEXT
- $X_RESULT_ERROR_INVALID_DEVICE
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If `pCommandBufferDesc->isUpdatable` is true and `hDevice` returns 0
for the $X_DEVICE_INFO_COMMAND_BUFFER_UPDATE_CAPABILITIES_EXP query."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Increment the command-buffer object's reference count."
class: $xCommandBuffer
name: RetainExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in][retain] Handle of the command-buffer object."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_OUT_OF_RESOURCES
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
--- #--------------------------------------------------------------------------
type: function
desc: "Decrement the command-buffer object's reference count and delete the command-buffer object if the reference count becomes zero."
class: $xCommandBuffer
name: ReleaseExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in][release] Handle of the command-buffer object."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_OUT_OF_RESOURCES
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
--- #--------------------------------------------------------------------------
type: function
desc: "Stop recording on a command-buffer object such that no more commands can be appended and make it ready to enqueue."
class: $xCommandBuffer
name: FinalizeExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] Handle of the command-buffer object."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_OPERATION
- "If `hCommandBuffer` has already been finalized"
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Append a kernel execution command to a command-buffer object."
class: $xCommandBuffer
name: AppendKernelLaunchExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] Handle of the command-buffer object."
- type: $x_kernel_handle_t
name: hKernel
desc: "[in] Kernel to append."
- type: uint32_t
name: workDim
desc: "[in] Dimension of the kernel execution."
- type: "const size_t*"
name: pGlobalWorkOffset
desc: "[in] Offset to use when executing kernel."
- type: "const size_t*"
name: pGlobalWorkSize
desc: "[in] Global work size to use when executing kernel."
- type: "const size_t*"
name: pLocalWorkSize
desc: "[in][optional] Local work size to use when executing kernel. If this parameter is nullptr, then a local work size will be generated by the implementation."
- type: uint32_t
name: "numKernelAlternatives"
desc: "[in] The number of kernel alternatives provided in phKernelAlternatives."
- type: $x_kernel_handle_t*
name: "phKernelAlternatives"
desc: |
[in][optional][range(0, numKernelAlternatives)] List of kernel handles that might be used to update the kernel in this
command after the command-buffer is finalized. The default kernel `hKernel` is implicitly marked as an alternative. It's
invalid to specify it as part of this list.
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: "$x_exp_command_buffer_sync_point_t*"
name: pSyncPoint
desc: "[out][optional] Sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional][alloc] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional][alloc] Handle to this command. Only available if the
command-buffer is updatable."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_KERNEL
- $X_RESULT_ERROR_INVALID_WORK_DIMENSION
- $X_RESULT_ERROR_INVALID_WORK_GROUP_SIZE
- $X_RESULT_ERROR_INVALID_VALUE:
- "`phKernelAlternatives == NULL && numKernelAlternatives > 0`"
- "`phKernelAlternatives != NULL && numKernelAlternatives == 0`"
- "If `phKernelAlternatives` contains `hKernel`"
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If the device associated with `hCommandBuffer` does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and either `phEvent` or `phEventWaitList` are not NULL."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
- $X_RESULT_ERROR_INVALID_OPERATION
- "phCommand is not NULL and hCommandBuffer is not updatable."
--- #--------------------------------------------------------------------------
type: function
desc: "Append a USM memcpy command to a command-buffer object."
class: $xCommandBuffer
name: AppendUSMMemcpyExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] Handle of the command-buffer object."
- type: "void*"
name: pDst
desc: "[in] Location the data will be copied to."
- type: "const void*"
name: pSrc
desc: "[in] The data to be copied."
- type: "size_t"
name: size
desc: "[in] The number of bytes to copy."
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: "$x_exp_command_buffer_sync_point_t*"
name: pSyncPoint
desc: "[out][optional] Sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional][alloc] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional][alloc] Handle to this command."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_SIZE:
- "`size == 0`"
- "If `size` is higher than the allocation size of `pSrc` or `pDst`"
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If the device associated with `hCommandBuffer` does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and either `phEvent` or `phEventWaitList` are not NULL."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Append a USM fill command to a command-buffer object."
class: $xCommandBuffer
name: AppendUSMFillExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] handle of the command-buffer object."
- type: "void*"
name: pMemory
desc: "[in] pointer to USM allocated memory to fill."
- type: "const void*"
name: pPattern
desc: "[in] pointer to the fill pattern."
- type: "size_t"
name: patternSize
desc: "[in] size in bytes of the pattern."
- type: "size_t"
name: size
desc: "[in] fill size in bytes, must be a multiple of patternSize."
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: "$x_exp_command_buffer_sync_point_t*"
name: pSyncPoint
desc: "[out][optional] sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional][alloc] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional][alloc] Handle to this command."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_SIZE:
- "`patternSize == 0 || size == 0`"
- "`patternSize > size`"
- "`size % patternSize != 0`"
- "If `size` is higher than the allocation size of `ptr`"
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If the device associated with `hCommandBuffer` does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and either `phEvent` or `phEventWaitList` are not NULL."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Append a memory copy command to a command-buffer object."
class: $xCommandBuffer
name: AppendMemBufferCopyExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] Handle of the command-buffer object."
- type: $x_mem_handle_t
name: hSrcMem
desc: "[in] The data to be copied."
- type: $x_mem_handle_t
name: hDstMem
desc: "[in] The location the data will be copied to."
- type: "size_t"
name: srcOffset
desc: "[in] Offset into the source memory."
- type: "size_t"
name: dstOffset
desc: "[in] Offset into the destination memory"
- type: "size_t"
name: size
desc: "[in] The number of bytes to be copied."
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: "$x_exp_command_buffer_sync_point_t*"
name: pSyncPoint
desc: "[out][optional] Sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional][alloc] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional][alloc] Handle to this command."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If the device associated with `hCommandBuffer` does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and either `phEvent` or `phEventWaitList` are not NULL."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Append a memory write command to a command-buffer object."
class: $xCommandBuffer
name: AppendMemBufferWriteExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] Handle of the command-buffer object."
- type: $x_mem_handle_t
name: hBuffer
desc: "[in] Handle of the buffer object."
- type: "size_t"
name: offset
desc: "[in] Offset in bytes in the buffer object."
- type: "size_t"
name: size
desc: "[in] Size in bytes of data being written."
- type: "const void*"
name: pSrc
desc: "[in] Pointer to host memory where data is to be written from."
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: "$x_exp_command_buffer_sync_point_t*"
name: pSyncPoint
desc: "[out][optional] Sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional][alloc] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional][alloc] Handle to this command."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If the device associated with `hCommandBuffer` does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and either `phEvent` or `phEventWaitList` are not NULL."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Append a memory read command to a command-buffer object."
class: $xCommandBuffer
name: AppendMemBufferReadExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] Handle of the command-buffer object."
- type: $x_mem_handle_t
name: hBuffer
desc: "[in] Handle of the buffer object."
- type: "size_t"
name: offset
desc: "[in] Offset in bytes in the buffer object."
- type: "size_t"
name: size
desc: "[in] Size in bytes of data being written."
- type: "void*"
name: pDst
desc: "[in] Pointer to host memory where data is to be written to."
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: "$x_exp_command_buffer_sync_point_t*"
name: pSyncPoint
desc: "[out][optional] Sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional][alloc] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional][alloc] Handle to this command."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If the device associated with `hCommandBuffer` does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and either `phEvent` or `phEventWaitList` are not NULL."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Append a rectangular memory copy command to a command-buffer object."
class: $xCommandBuffer
name: AppendMemBufferCopyRectExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] Handle of the command-buffer object."
- type: $x_mem_handle_t
name: hSrcMem
desc: "[in] The data to be copied."
- type: $x_mem_handle_t
name: hDstMem
desc: "[in] The location the data will be copied to."
- type: $x_rect_offset_t
name: srcOrigin
desc: "[in] Origin for the region of data to be copied from the source."
- type: $x_rect_offset_t
name: dstOrigin
desc: "[in] Origin for the region of data to be copied to in the destination."
- type: $x_rect_region_t
name: region
desc: "[in] The extents describing the region to be copied."
- type: "size_t"
name: srcRowPitch
desc: "[in] Row pitch of the source memory."
- type: "size_t"
name: srcSlicePitch
desc: "[in] Slice pitch of the source memory."
- type: "size_t"
name: dstRowPitch
desc: "[in] Row pitch of the destination memory."
- type: "size_t"
name: dstSlicePitch
desc: "[in] Slice pitch of the destination memory."
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: $x_exp_command_buffer_sync_point_t*
name: pSyncPoint
desc: "[out][optional] Sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional][alloc] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional][alloc] Handle to this command."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If the device associated with `hCommandBuffer` does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and either `phEvent` or `phEventWaitList` are not NULL."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Append a rectangular memory write command to a command-buffer object."
class: $xCommandBuffer
name: AppendMemBufferWriteRectExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] Handle of the command-buffer object."
- type: $x_mem_handle_t
name: hBuffer
desc: "[in] Handle of the buffer object."
- type: $x_rect_offset_t
name: bufferOffset
desc: "[in] 3D offset in the buffer."
- type: $x_rect_offset_t
name: hostOffset
desc: "[in] 3D offset in the host region."
- type: $x_rect_region_t
name: region
desc: "[in] 3D rectangular region descriptor: width, height, depth."
- type: "size_t"
name: bufferRowPitch
desc: "[in] Length of each row in bytes in the buffer object."
- type: "size_t"
name: bufferSlicePitch
desc: "[in] Length of each 2D slice in bytes in the buffer object being written."
- type: "size_t"
name: hostRowPitch
desc: "[in] Length of each row in bytes in the host memory region pointed to by pSrc."
- type: "size_t"
name: hostSlicePitch
desc: "[in] Length of each 2D slice in bytes in the host memory region pointed to by pSrc."
- type: "void*"
name: pSrc
desc: "[in] Pointer to host memory where data is to be written from."
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: $x_exp_command_buffer_sync_point_t*
name: pSyncPoint
desc: "[out][optional] Sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional][alloc] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional][alloc] Handle to this command."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If the device associated with `hCommandBuffer` does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and either `phEvent` or `phEventWaitList` are not NULL."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Append a rectangular memory read command to a command-buffer object."
class: $xCommandBuffer
name: AppendMemBufferReadRectExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] Handle of the command-buffer object."
- type: $x_mem_handle_t
name: hBuffer
desc: "[in] Handle of the buffer object."
- type: $x_rect_offset_t
name: bufferOffset
desc: "[in] 3D offset in the buffer."
- type: $x_rect_offset_t
name: hostOffset
desc: "[in] 3D offset in the host region."
- type: $x_rect_region_t
name: region
desc: "[in] 3D rectangular region descriptor: width, height, depth."
- type: "size_t"
name: bufferRowPitch
desc: "[in] Length of each row in bytes in the buffer object."
- type: "size_t"
name: bufferSlicePitch
desc: "[in] Length of each 2D slice in bytes in the buffer object being read."
- type: "size_t"
name: hostRowPitch
desc: "[in] Length of each row in bytes in the host memory region pointed to by pDst."
- type: "size_t"
name: hostSlicePitch
desc: "[in] Length of each 2D slice in bytes in the host memory region pointed to by pDst."
- type: "void*"
name: pDst
desc: "[in] Pointer to host memory where data is to be read into."
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: $x_exp_command_buffer_sync_point_t*
name: pSyncPoint
desc: "[out][optional] Sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional] Handle to this command."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_UNSUPPORTED_FEATURE:
- "If the device associated with `hCommandBuffer` does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and either `phEvent` or `phEventWaitList` are not NULL."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Append a memory fill command to a command-buffer object."
class: $xCommandBuffer
name: AppendMemBufferFillExp
params:
- type: $x_exp_command_buffer_handle_t
name: hCommandBuffer
desc: "[in] handle of the command-buffer object."
- type: $x_mem_handle_t
name: hBuffer
desc: "[in] handle of the buffer object."
- type: "const void*"
name: pPattern
desc: "[in] pointer to the fill pattern."
- type: "size_t"
name: patternSize
desc: "[in] size in bytes of the pattern."
- type: "size_t"
name: offset
desc: "[in] offset into the buffer."
- type: "size_t"
name: size
desc: "[in] fill size in bytes, must be a multiple of patternSize."
- type: uint32_t
name: numSyncPointsInWaitList
desc: "[in] The number of sync points in the provided dependency list."
- type: "const $x_exp_command_buffer_sync_point_t*"
name: pSyncPointWaitList
desc: "[in][optional] A list of sync points that this command depends on.
May be ignored if command-buffer is in-order."
- type: uint32_t
name: numEventsInWaitList
desc: "[in] Size of the event wait list."
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events."
- type: $x_exp_command_buffer_sync_point_t*
name: pSyncPoint
desc: "[out][optional] sync point associated with this command."
- type: $x_event_handle_t*
name: phEvent
desc: "[out][optional][alloc] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer."
- type: "$x_exp_command_buffer_command_handle_t*"
name: phCommand
desc: "[out][optional][alloc] Handle to this command."
returns:
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP:
- "`pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0`"
- "`pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0`"
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "If `offset + size` results in an out-of-bounds access."
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"