Vulkan-Docs/doc/specs/vulkan/man/VkDescriptorImageInfo.txt

69 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/
VkDescriptorImageInfo(3)
========================
Name
----
VkDescriptorImageInfo - Structure specifying descriptor image info
C Specification
---------------
// refBegin VkDescriptorImageInfo - Structure specifying descriptor image info
The sname:VkDescriptorImageInfo structure is defined as:
include::../structs/VkDescriptorImageInfo.txt[]
Members
-------
* pname:sampler is a sampler handle, and is used in descriptor updates for
types ename:VK_DESCRIPTOR_TYPE_SAMPLER and
ename:VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER if the binding being
updated does not use immutable samplers.
* pname:imageView is an image view handle, and is used in descriptor
updates for types ename:VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE,
ename:VK_DESCRIPTOR_TYPE_STORAGE_IMAGE,
ename:VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and
ename:VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT.
* pname:imageLayout is the layout that the image will be in at the time
this descriptor is accessed. pname:imageLayout is used in descriptor
updates for types ename:VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE,
ename:VK_DESCRIPTOR_TYPE_STORAGE_IMAGE,
ename:VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and
ename:VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT.
Description
-----------
Members of sname:VkDescriptorImageInfo that are not used in an update (as
described above) are ignored.
include::../validity/structs/VkDescriptorImageInfo.txt[]
See Also
--------
elink:VkImageLayout, slink:VkImageView, slink:VkSampler, slink:VkWriteDescriptorSet
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkDescriptorImageInfo
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]