Skip to content

Commit 9e783e2

Browse files
authored
Clarify zeDeviceGetCommandQueueGroupProperties doc (#406)
Signed-off-by: Neil R. Spruit <neil.r.spruit@intel.com>
1 parent 8bf884c commit 9e783e2

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

scripts/core/device.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -463,9 +463,9 @@ ordinal: "1"
463463
analogue:
464464
- "**vkGetPhysicalDeviceQueueFamilyProperties**"
465465
details:
466-
- "Properties are reported for each physical command queue type supported by the device."
466+
- "Properties are reported for each physical command queue group available on the device."
467467
- "Multiple calls to this function will return properties in the same order."
468-
- "The order in which the properties are returned defines the command queue group's ordinal."
468+
- "The order in which the properties are returned is defined by the command queue group's ordinal."
469469
- "The application may call this function from simultaneous threads."
470470
- "The implementation of this function should be lock-free."
471471
params:
@@ -475,14 +475,16 @@ params:
475475
- type: uint32_t*
476476
name: pCount
477477
desc: |
478-
[in,out] pointer to the number of command queue group properties.
479-
if count is zero, then the driver shall update the value with the total number of command queue group properties available.
480-
if count is greater than the number of command queue group properties available, then the driver shall update the value with the correct number of command queue group properties available.
478+
[in,out] pointer to the number of available command queue groups.
479+
If count is zero, then the driver shall update the value with the total number of command queue groups available.
480+
If count is less than the number of command queue groups available, then the driver shall only retrieve command queue group properties for the given number of command queue groups.
481+
If count is greater than or equal to the number of command queue groups available, then the driver shall retrieve command queue group properties for all available command queue groups.
481482
- type: "$x_command_queue_group_properties_t*"
482483
name: pCommandQueueGroupProperties
483484
desc: |
484485
[in,out][optional][range(0, *pCount)] array of query results for command queue group properties.
485-
if count is less than the number of command queue group properties available, then driver shall only retrieve that number of command queue group properties.
486+
If count is less than the number of command queue groups available, then the driver shall only retrieve that number of command queue group properties.
487+
The order of properties in the array corresponds to the command queue group ordinal.
486488
--- #--------------------------------------------------------------------------
487489
type: enum
488490
desc: "Supported device memory property flags"

0 commit comments

Comments
 (0)