Vulkan-Docs/doc/specs/vulkan/validity/protos/vkEnumeratePhysicalDevices.txt

46 lines
1.6 KiB
Plaintext

// WARNING: DO NOT MODIFY! This file is automatically generated from the vk.xml registry
ifndef::doctype-manpage[]
.Valid Usage
********************************************************************************
endif::doctype-manpage[]
ifdef::doctype-manpage[]
Valid Usage
-----------
endif::doctype-manpage[]
* pname:instance must: be a valid sname:VkInstance handle
* pname:pPhysicalDeviceCount must: be a pointer to a basetype:uint32_t value
* If the value referenced by pname:pPhysicalDeviceCount is not `0`, and pname:pPhysicalDevices is not `NULL`, pname:pPhysicalDevices must: be a pointer to an array of pname:pPhysicalDeviceCount sname:VkPhysicalDevice handles
ifndef::doctype-manpage[]
********************************************************************************
endif::doctype-manpage[]
ifndef::doctype-manpage[]
.Return Codes
********************************************************************************
endif::doctype-manpage[]
ifdef::doctype-manpage[]
Return Codes
------------
endif::doctype-manpage[]
ifndef::doctype-manpage[]
<<fundamentals-successcodes,Success>>::
endif::doctype-manpage[]
ifdef::doctype-manpage[]
On success, this command returns::
endif::doctype-manpage[]
* ename:VK_SUCCESS
* ename:VK_INCOMPLETE
ifndef::doctype-manpage[]
<<fundamentals-errorcodes,Failure>>::
endif::doctype-manpage[]
ifdef::doctype-manpage[]
On failure, this command returns::
endif::doctype-manpage[]
* ename:VK_ERROR_OUT_OF_HOST_MEMORY
* ename:VK_ERROR_OUT_OF_DEVICE_MEMORY
* ename:VK_ERROR_INITIALIZATION_FAILED
ifndef::doctype-manpage[]
********************************************************************************
endif::doctype-manpage[]