Vulkan-Docs/doc/specs/vulkan/man/vkEnumerateInstanceLayerPro...

66 lines
2.0 KiB
Plaintext

// 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/
vkEnumerateInstanceLayerProperties(3)
=====================================
Name
----
vkEnumerateInstanceLayerProperties - Returns up to requested number of global layer properties.
C Specification
---------------
// refBegin vkEnumerateInstanceLayerProperties Returns up to requested number of global layer properties.
To query the available layers, call:
include::../protos/vkEnumerateInstanceLayerProperties.txt[]
Parameters
----------
* pname:pPropertyCount is a pointer to an integer related to the number of
layer properties available or queried, as described below.
* pname:pProperties is either `NULL` or a pointer to an array of
slink:VkLayerProperties structures.
Description
-----------
If pname:pProperties is `NULL`, then the number of layer properties available
is returned in pname:pPropertyCount. Otherwise, pname:pPropertyCount must:
point to a variable set by the user to the number of elements in the
pname:pProperties array, and on return the variable is overwritten with the
number of structures actually written to pname:pProperties. If
pname:pPropertyCount is less than the number of layer properties available, at
most pname:pPropertyCount structures will be written. If pname:pPropertyCount
is smaller than the number of layers available, ename:VK_INCOMPLETE will be
returned instead of ename:VK_SUCCESS, to indicate that not all the available
layer properties were returned.
include::../validity/protos/vkEnumerateInstanceLayerProperties.txt[]
See Also
--------
slink:VkLayerProperties
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkEnumerateInstanceLayerProperties
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]