// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/

vkEnumeratePhysicalDevices(3)
=============================

Name
----
vkEnumeratePhysicalDevices - Enumerates the physical devices accessible to a Vulkan instance.

C Specification
---------------

// refBegin vkEnumeratePhysicalDevices Enumerates the physical devices accessible to a Vulkan instance.

To retrieve a list of physical device objects representing the
physical devices installed in the system, call:

include::../api/protos/vkEnumeratePhysicalDevices.txt[]


Parameters
----------

  * pname:instance is a handle to a Vulkan instance previously created
    with fname:vkCreateInstance.
  * pname:pPhysicalDeviceCount is a pointer to an integer related to the
    number of physical devices available or queried, as described below.
  * pname:pPhysicalDevices is either `NULL` or a pointer to an
    array of sname:VkPhysicalDevice handles.


Description
-----------

If pname:pPhysicalDevices is `NULL`, then the number of physical devices
available is returned in pname:pPhysicalDeviceCount. Otherwise,
pname:pPhysicalDeviceCount must: point to a variable set by the user to
the number of elements in the pname:pPhysicalDevices array, and on
return the variable is overwritten with the number of structures actually
written to pname:pPhysicalDevices. If
pname:pPhysicalDeviceCount is less than the number of physical devices
available, at most pname:pPhysicalDeviceCount structures will be
written. If pname:pPhysicalDeviceCount is smaller than the number of
physical devices available, ename:VK_INCOMPLETE will be returned instead of
ename:VK_SUCCESS, to indicate that not all the available physical devices
were returned.

include::../validity/protos/vkEnumeratePhysicalDevices.txt[]


See Also
--------

slink:VkInstance, slink:VkPhysicalDevice


Document Notes
--------------

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkEnumeratePhysicalDevices

This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.

include::footer.txt[]