2016-02-16 09:53:44 +00:00
|
|
|
vkEnumeratePhysicalDevices(3)
|
|
|
|
|
=============================
|
|
|
|
|
|
|
|
|
|
Name
|
|
|
|
|
----
|
|
|
|
|
vkEnumeratePhysicalDevices - Enumerates the physical devices accessible to a Vulkan instance.
|
|
|
|
|
|
|
|
|
|
C Specification
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
include::../protos/vkEnumeratePhysicalDevices.txt[]
|
|
|
|
|
|
|
|
|
|
Parameters
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
pname:instance::
|
|
|
|
|
A handle to the instance to be used to enumerate devices.
|
|
|
|
|
|
|
|
|
|
pname:pPhysicalDeviceCount::
|
|
|
|
|
A pointer to a variable containing the maximum number of devices to enumerate.
|
|
|
|
|
|
|
|
|
|
pname:pPhysicalDevices::
|
|
|
|
|
A pointer to an array that will be filled with handles to the enumerated devices.
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
fname:vkEnumeratePhysicalDevices generates a list of the physical devices accessible to the
|
|
|
|
|
instance of Vulkan specified in pname:instance.
|
|
|
|
|
|
|
|
|
|
pname:pPhysicalDeviceCount is a pointer to a variable which contains the number of devices to
|
|
|
|
|
enumerate. pname:pPhysicalDeviceCount must not be code:NULL. pname:pPhysicalDevices is a
|
|
|
|
|
pointer to an array of sname:VkPhysicalDevice handles which will be filled with handles
|
|
|
|
|
to the enumerated devices.
|
|
|
|
|
|
|
|
|
|
If pname:pPhysicalDevices is code:NULL, then the initial value of the variable pointed to
|
|
|
|
|
by pname:pPhysicalDeviceCount is ignored and this variable is overwritten with the number of
|
|
|
|
|
physical devices accessible to pname:instance.
|
|
|
|
|
|
|
|
|
|
If pname:pPhysicalDevices is not code:NULL, then pname:pPhysicalDeviceCount should point
|
|
|
|
|
to a variable that has been initialized with the size of the array pointed to by pname:pPhysicalDevices.
|
|
|
|
|
No more than this number of physical device handles will be written into the output array.
|
|
|
|
|
The actual number of device handles written into pname:pPhysicalDevices is then written into
|
Change log for April 29, 2016 Vulkan 1.0.12 spec update:
* Bump API patch number and header version number to 12 for this
update.
Github Issues:
* Change valid usage statements intended to be "sub-points" to
be actual sub-points (public issue 66).
* Replace double negation in description of
slink:VkRenderPassBeginInfo::pname:pClearValues (based on public
merge 142).
* Cleanup minor typos in spec, ref pages and XML, including those
proposed in public pull requests 144, 150, 151, 167, 168, 181, and
186.
* Use *strict subset* in describing the partial order of memory
property types for slink:VkMemoryType, and update the style guide
accordingly (public issue 190).
* Fix various "a image" -> "an image" typos (public issue 191).
* Note in the <<fundamentals-validusage,Valid Usage>> and
<<extensions-interactions,Extension Interactions>> sections that
structures defined by extensions which may be passed in structure
chains using the ptext:pNext member must: include initial
ptext:sType and ptext:pNext members (public issue 192).
Internal Issues:
* Remove duplicate language from the description of the pname:fence
parameter to flink:vkQueueSubmit and improve validity language
(internal issue 91).
* Added documentation for "optional" attribute to XML readme.tex/pdf
(internal issue 149).
* Clarify the host-side data validity rules and behavior of
flink:vkFlushMappedMemoryRanges and
flink:vkInvalidateMappedMemoryRanges (internal issue 266).
Other Commits:
* Added clarification to flink:vkCmdFillBuffer regarding the use of
ename:VK_WHOLE_SIZE.
* Fixed and documented implementation of "validextensionstructs"
attribute. in XML processing scripts and readme.tex/pdf.
* Add missing validity statements to flink:vkResetEvent and
flink:vkCmdResetEvent.
* Fix validity for the
ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag.
Correct all the draw/dispatch commands to mention optimally tiled
images as well as linear tiled images, and say image VIEWS instead
of images. Add validity statement to flink:vkCmdBlitImage
* Replace the {apiname} macro with hardcoded "Vulkan", now that we've
committed to that name.
* Add the VK_AMD_rasterization_order extension to vk.xml.
2016-04-29 12:53:46 +00:00
|
|
|
the variable pointed to by pname:pPhysicalDeviceCount.
|
2016-02-16 09:53:44 +00:00
|
|
|
|
|
|
|
|
include::../validity/protos/vkEnumeratePhysicalDevices.txt[]
|
|
|
|
|
|
|
|
|
|
See Also
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
flink:vkGetPhysicalDeviceFeatures, flink:vkCreateDevice
|
|
|
|
|
|
|
|
|
|
include::footer.txt[]
|