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

63 lines
1.8 KiB
Plaintext

VkImageMemoryBarrier(3)
=======================
Name
----
VkImageMemoryBarrier - Structure specifying the parameters of an image memory barrier.
C Specification
---------------
include::../structs/VkImageMemoryBarrier.txt[]
Fields
------
pname:sType::
Structure type. Must be ename:VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER.
pname:pNext::
Pointer to next structure in the structure chain when applicable.
pname:outputMask::
Types of writes to the image to flush (see elink:VkMemoryOutputFlags for more detail).
pname:inputMask::
Types of reads from the image to invalidate (see elink:VkMemoryInputFlags for more detail).
pname:oldLayout::
Current layout the image is expected to be in (see elink:VkImageLayout for more detail).
pname:newLayout::
New layout the image should be transferred to (see elink:VkImageLayout for more detail).
pname:srcQueueFamilyIndex::
Identifies the source queue family to transfer ownership of the image from.
A value of ename:VK_QUEUE_FAMILY_IGNORED indicates that this member should be ignored.
pname:dstQueueFamilyIndex::
Identifies the destination queue family to transfer ownership of the image to.
A value of ename:VK_QUEUE_FAMILY_IGNORED indicates that this member should be ignored.
pname:image::
Image object the memory barrier applies to.
pname:subresourceRange::
Sub-range of the image the memory barrier applies to.
Description
-----------
This structure specifies the parameters of an image memory barrier that can
be passed in the ptext:ppMemBarriers parameter of flink:vkCmdPipelineBarrier
and flink:vkCmdWaitEvents.
include::../validity/structs/VkImageMemoryBarrier.txt[]
See Also
--------
flink:vkCmdPipelineBarrier, flink:vkCmdWaitEvents, slink:VkMemoryBarrier, slink:VkBufferMemoryBarrier
include::footer.txt[]