vkEnumeratePhysicalDeviceGroups
To retrieve a list of the device groups present in the system, call:
VkResult vkEnumeratePhysicalDeviceGroupsKHR(
VkInstance instance,
uint32_t* pPhysicalDeviceGroupCount,
VkPhysicalDeviceGroupProperties* pPhysicalDeviceGroupProperties);
instance
is a handle to a Vulkan instance previously created with vkCreateInstance.pPhysicalDeviceGroupCount
is a pointer to an integer related to the number of device groups available or queried, as described below.pPhysicalDeviceGroupProperties
is eitherNULL
or a pointer to an array of VkPhysicalDeviceGroupProperties structures.
If pPhysicalDeviceGroupProperties
is NULL
, then the number of device
groups available is returned in pPhysicalDeviceGroupCount
.
Otherwise, pPhysicalDeviceGroupCount
must point to a variable set by
the application to the number of elements in the
pPhysicalDeviceGroupProperties
array, and on return the variable is
overwritten with the number of structures actually written to
pPhysicalDeviceGroupProperties
.
If pPhysicalDeviceGroupCount
is less than the number of device groups
available, at most pPhysicalDeviceGroupCount
structures will be
written, and VK_INCOMPLETE
will be returned instead of
VK_SUCCESS
, to indicate that not all the available device groups were
returned.
Every physical device must be in exactly one device group.
Valid Usage (Implicit)
VUID-vkEnumeratePhysicalDeviceGroups-instance-parameter
instance
must be a valid VkInstance handle
VUID-vkEnumeratePhysicalDeviceGroups-pPhysicalDeviceGroupCount-parameter
pPhysicalDeviceGroupCount
must be a valid pointer to a uint32_t
value
VUID-vkEnumeratePhysicalDeviceGroups-pPhysicalDeviceGroupProperties-parameter
If the value referenced by pPhysicalDeviceGroupCount
is not 0
, and pPhysicalDeviceGroupProperties
is not NULL
, pPhysicalDeviceGroupProperties
must be a valid pointer to an array of pPhysicalDeviceGroupCount
VkPhysicalDeviceGroupProperties structures