VkMemoryBarrier - Structure specifying a global memory barrier

Description

The first access scope is limited to access types in the source access mask specified by srcAccessMask and, if a MemoryBarrierAccessFlags3KHR is passed in pNext, srcAccessMask3.

The second access scope is limited to access types in the destination access mask specified by dstAccessMask and, if a MemoryBarrierAccessFlags3KHR is passed in pNext, dstAccessMask3.

Valid Usage (Implicit)

See Also

VK_VERSION_1_0, AccessFlags, StructureType, cmdPipelineBarrier, cmdWaitEvents

VkBufferMemoryBarrier - Structure specifying a buffer memory barrier

Description

The first access scope is limited to access to memory through the specified buffer range, via access types in the source access mask specified by srcAccessMask and, if a MemoryBarrierAccessFlags3KHR is passed in pNext, srcAccessMask3. If the source access mask includes ACCESS_HOST_WRITE_BIT, a memory domain operation is performed where available memory in the host domain is also made available to the device domain.

The second access scope is limited to access to memory through the specified buffer range, via access types in the destination access mask specified by dstAccessMask and, if a MemoryBarrierAccessFlags3KHR is passed in pNext, dstAccessMask3. If the destination access mask includes ACCESS_HOST_WRITE_BIT or ACCESS_HOST_READ_BIT, a memory domain operation is performed where available memory in the device domain is also made available to the host domain.

Host writes to device memory that was allocated without MEMORY_PROPERTY_HOST_COHERENT_BIT have to be flushed with flushMappedMemoryRanges before they can be accessed safely on the device. Similarly, device writes to such memory have to be invalidated with invalidateMappedMemoryRanges before they can be accessed safely on the host.

Memory allocated with MEMORY_PROPERTY_HOST_COHERENT_BIT does not need to have these additional operations performed.

If srcQueueFamilyIndex is not equal to dstQueueFamilyIndex, and srcQueueFamilyIndex is equal to the current queue family, then the memory barrier defines a queue family release operation for the specified buffer range, and if dependencyFlags did not include DEPENDENCY_QUEUE_FAMILY_OWNERSHIP_TRANSFER_USE_ALL_STAGES_BIT_KHR, the second synchronization scope of the calling command does not apply to this operation.

If dstQueueFamilyIndex is not equal to srcQueueFamilyIndex, and dstQueueFamilyIndex is equal to the current queue family, then the memory barrier defines a queue family acquire operation for the specified buffer range, and if dependencyFlags did not include DEPENDENCY_QUEUE_FAMILY_OWNERSHIP_TRANSFER_USE_ALL_STAGES_BIT_KHR, the first synchronization scope of the calling command does not apply to this operation.

Valid Usage

• offset must be less than the size of buffer

• If size is not equal to WHOLE_SIZE, size must be greater than 0
• If size is not equal to WHOLE_SIZE, size must be less than or equal to than the size of buffer minus offset
• If buffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• If buffer was created with a sharing mode of SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex and dstQueueFamilyIndex are not equal, srcQueueFamilyIndex must be QUEUE_FAMILY_EXTERNAL, QUEUE_FAMILY_FOREIGN_EXT, or a valid queue family
• If buffer was created with a sharing mode of SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex and dstQueueFamilyIndex are not equal, dstQueueFamilyIndex must be QUEUE_FAMILY_EXTERNAL, QUEUE_FAMILY_FOREIGN_EXT, or a valid queue family
• If the VK_KHR_external_memory extension is not enabled, and the value of ApplicationInfo::apiVersion used to create the Instance is not greater than or equal to Version 1.1, srcQueueFamilyIndex must not be QUEUE_FAMILY_EXTERNAL
• If the VK_KHR_external_memory extension is not enabled, and the value of ApplicationInfo::apiVersion used to create the Instance is not greater than or equal to Version 1.1, dstQueueFamilyIndex must not be QUEUE_FAMILY_EXTERNAL
• If the VK_EXT_queue_family_foreign extension is not enabled srcQueueFamilyIndex must not be QUEUE_FAMILY_FOREIGN_EXT
• If the VK_EXT_queue_family_foreign extension is not enabled dstQueueFamilyIndex must not be QUEUE_FAMILY_FOREIGN_EXT
• If the synchronization2 feature is not enabled, and buffer was created with a sharing mode of SHARING_MODE_CONCURRENT, at least one of srcQueueFamilyIndex and dstQueueFamilyIndex must be QUEUE_FAMILY_IGNORED
• If the synchronization2 feature is not enabled, and buffer was created with a sharing mode of SHARING_MODE_CONCURRENT, srcQueueFamilyIndex must be QUEUE_FAMILY_IGNORED or QUEUE_FAMILY_EXTERNAL
• If the synchronization2 feature is not enabled, and buffer was created with a sharing mode of SHARING_MODE_CONCURRENT, dstQueueFamilyIndex must be QUEUE_FAMILY_IGNORED or QUEUE_FAMILY_EXTERNAL

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER

• pNext must be NULL or a pointer to a valid instance of ExternalMemoryAcquireUnmodifiedEXT
• The sType value of each structure in the pNext chain must be unique
• buffer must be a valid Buffer handle

See Also

VK_VERSION_1_0, AccessFlags, Buffer, DeviceSize, StructureType, cmdPipelineBarrier, cmdWaitEvents

VkImageMemoryBarrier - Structure specifying the parameters of an image memory barrier

Description

The first access scope is limited to access to memory through the specified image subresource range, via access types in the source access mask specified by srcAccessMask. If srcAccessMask includes ACCESS_HOST_WRITE_BIT, memory writes performed by that access type are also made visible, as that access type is not performed through a resource.

The second access scope is limited to access to memory through the specified image subresource range, via access types in the destination access mask specified by dstAccessMask. If dstAccessMask includes ACCESS_HOST_WRITE_BIT or ACCESS_HOST_READ_BIT, available memory writes are also made visible to accesses of those types, as those access types are not performed through a resource.

If srcQueueFamilyIndex is not equal to dstQueueFamilyIndex, and srcQueueFamilyIndex is equal to the current queue family, then the memory barrier defines a queue family release operation for the specified image subresource range, and if dependencyFlags did not include DEPENDENCY_QUEUE_FAMILY_OWNERSHIP_TRANSFER_USE_ALL_STAGES_BIT_KHR, the second synchronization scope of the calling command does not apply to this operation.

If dstQueueFamilyIndex is not equal to srcQueueFamilyIndex, and dstQueueFamilyIndex is equal to the current queue family, then the memory barrier defines a queue family acquire operation for the specified image subresource range, and if dependencyFlags did not include DEPENDENCY_QUEUE_FAMILY_OWNERSHIP_TRANSFER_USE_ALL_STAGES_BIT_KHR, the first synchronization scope of the calling command does not apply to this operation.

If the synchronization2 feature is not enabled or oldLayout is not equal to newLayout, oldLayout and newLayout define an image layout transition for the specified image subresource range.

If the synchronization2 feature is enabled, srcQueueFamilyIndex and dstQueueFamilyIndex are equal, and oldLayout and newLayout are also equal, the layout values are ignored and the image contents are preserved regardless of the values of oldLayout, newLayout, and the current layout of the image.

If image is a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT and the maintenance9 feature is enabled, the baseArrayLayer and layerCount members of subresourceRange specify the subset of slices of the 3D image affected by the memory barrier, including the layout transition. Any slices of a 3D image not included in subresourceRange are not affected by the memory barrier and remain in their existing layout.

If image has a multi-planar format and the image is disjoint, then including IMAGE_ASPECT_COLOR_BIT in the aspectMask member of subresourceRange is equivalent to including IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, and (for three-plane formats only) IMAGE_ASPECT_PLANE_2_BIT.

Valid Usage

• If layouts are not ignored, oldLayout must be IMAGE_LAYOUT_UNDEFINED or the current layout of the image subresources affected by the barrier

• If layouts are not ignored, newLayout must not be IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_ZERO_INITIALIZED_EXT or IMAGE_LAYOUT_PREINITIALIZED
• If image was created with a sharing mode of SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex and dstQueueFamilyIndex are not equal, srcQueueFamilyIndex must be QUEUE_FAMILY_EXTERNAL, QUEUE_FAMILY_FOREIGN_EXT, or a valid queue family
• If image was created with a sharing mode of SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex and dstQueueFamilyIndex are not equal, dstQueueFamilyIndex must be QUEUE_FAMILY_EXTERNAL, QUEUE_FAMILY_FOREIGN_EXT, or a valid queue family
• If the VK_KHR_external_memory extension is not enabled, and the value of ApplicationInfo::apiVersion used to create the Instance is not greater than or equal to Version 1.1, srcQueueFamilyIndex must not be QUEUE_FAMILY_EXTERNAL
• If the VK_KHR_external_memory extension is not enabled, and the value of ApplicationInfo::apiVersion used to create the Instance is not greater than or equal to Version 1.1, dstQueueFamilyIndex must not be QUEUE_FAMILY_EXTERNAL
• If the VK_EXT_queue_family_foreign extension is not enabled srcQueueFamilyIndex must not be QUEUE_FAMILY_FOREIGN_EXT
• If the VK_EXT_queue_family_foreign extension is not enabled dstQueueFamilyIndex must not be QUEUE_FAMILY_FOREIGN_EXT
• subresourceRange.baseMipLevel must be less than the mipLevels specified in ImageCreateInfo when image was created
• If subresourceRange.levelCount is not REMAINING_MIP_LEVELS, subresourceRange.baseMipLevel + subresourceRange.levelCount must be less than or equal to the mipLevels specified in ImageCreateInfo when image was created
• If image is not a 3D image or was created without IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, or the maintenance9 feature is not enabled, subresourceRange.baseArrayLayer must be less than the arrayLayers specified in ImageCreateInfo when image was created
• If the maintenance9 feature is enabled and image is a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, subresourceRange.baseArrayLayer must be less than the depth computed from baseMipLevel and extent.depth specified in ImageCreateInfo when image was created, according to the formula defined in Image Mip Level Sizing
• If the maintenance9 feature is enabled and image is a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set and either subresourceRange.baseArrayLayer is not equal to 0 or subresourceRange.layerCount is not equal to REMAINING_ARRAY_LAYERS, subresourceRange.levelCount must be 1
• If image is not a 3D image or was created without IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, or the maintenance9 feature is not enabled, and subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, subresourceRange.baseArrayLayer + subresourceRange.layerCount must be less than or equal to the arrayLayers specified in ImageCreateInfo when image was created
• If the maintenance9 feature is enabled, subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, and image is a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, subresourceRange.baseArrayLayer + subresourceRange.layerCount must be less than or equal to the depth computed from baseMipLevel and extent.depth specified in ImageCreateInfo when image was created, according to the formula defined in Image Mip Level Sizing
• If image is non-sparse then the image or each specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object
• If image has a color format that is single-plane, then the aspectMask member of subresourceRange must be IMAGE_ASPECT_COLOR_BIT
• If image has a color format and is not disjoint, then the aspectMask member of subresourceRange must be IMAGE_ASPECT_COLOR_BIT
• If image has a multi-planar format and the image is disjoint, then the aspectMask member of subresourceRange must include at least one multi-planar aspect mask bit or IMAGE_ASPECT_COLOR_BIT
• If image has a depth/stencil format with both depth and stencil and the separateDepthStencilLayouts feature is not enabled, then the aspectMask member of subresourceRange must include both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
• If image has a depth/stencil format with both depth and stencil and the separateDepthStencilLayouts feature is enabled, then the aspectMask member of subresourceRange must include either or both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
• If image has a depth-only format then the aspectMask member of subresourceRange must be IMAGE_ASPECT_DEPTH_BIT
• If image has a stencil-only format then the aspectMask member of subresourceRange must be IMAGE_ASPECT_STENCIL_BIT
• If the aspectMask member of subresourceRange includes IMAGE_ASPECT_DEPTH_BIT, oldLayout and newLayout must not be one of IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If the aspectMask member of subresourceRange includes IMAGE_ASPECT_STENCIL_BIT, oldLayout and newLayout must not be one of IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
• subresourceRange.aspectMask must be valid for the format the image was created with
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL then image must have been created with the IMAGE_USAGE_COLOR_ATTACHMENT_BIT usage flag set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL then image must have been created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage flag set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL then image must have been created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage flag set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL then image must have been created with the IMAGE_USAGE_SAMPLED_BIT or IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage flag set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL then image must have been created with the IMAGE_USAGE_TRANSFER_SRC_BIT usage flag set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL then image must have been created with the IMAGE_USAGE_TRANSFER_DST_BIT usage flag set
• If the zeroInitializeDeviceMemory feature is not enabled, oldLayout must not be IMAGE_LAYOUT_ZERO_INITIALIZED_EXT
• If oldLayout is IMAGE_LAYOUT_ZERO_INITIALIZED_EXT, then all subresources must be included in the barrier
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL then image must have been created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage flag set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL then image must have been created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage flag set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL then image must have been created with at least one of the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, IMAGE_USAGE_SAMPLED_BIT, or IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage flags set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL then image must have been created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage flag set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL then image must have been created with at least one of the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, IMAGE_USAGE_SAMPLED_BIT, or IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage flags set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL then image must have been created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage flag set
• If the synchronization2 feature is not enabled, oldLayout must not be IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
• If the synchronization2 feature is not enabled, newLayout must not be IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_ATTACHMENT_OPTIMAL, image must have been created with the IMAGE_USAGE_COLOR_ATTACHMENT_BIT or IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage flag set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_READ_ONLY_OPTIMAL, image must have been created with at least one of the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, IMAGE_USAGE_SAMPLED_BIT, or IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage flags set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR then image must have been created with the IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR usage flag set
• If layouts are not ignored, oldLayout or newLayout is VK_IMAGE_LAYOUT_VIDEO_DECODE_SRC_KHR then image must have been created with the VK_IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR usage flag set
• If layouts are not ignored, oldLayout or newLayout is VK_IMAGE_LAYOUT_VIDEO_DECODE_DST_KHR then image must have been created with the VK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR usage flag set
• If layouts are not ignored, oldLayout or newLayout is VK_IMAGE_LAYOUT_VIDEO_DECODE_DPB_KHR then image must have been created with the VK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR usage flag set
• If layouts are not ignored, oldLayout or newLayout is VK_IMAGE_LAYOUT_VIDEO_ENCODE_SRC_KHR then image must have been created with the VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR usage flag set
• If layouts are not ignored, oldLayout or newLayout is VK_IMAGE_LAYOUT_VIDEO_ENCODE_DST_KHR then image must have been created with the VK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR usage flag set
• If layouts are not ignored, oldLayout or newLayout is VK_IMAGE_LAYOUT_VIDEO_ENCODE_DPB_KHR then image must have been created with the VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR usage flag set
• If layouts are not ignored, oldLayout or newLayout is VK_IMAGE_LAYOUT_VIDEO_ENCODE_QUANTIZATION_MAP_KHR then image must have been created with the VK_IMAGE_USAGE_VIDEO_ENCODE_QUANTIZATION_DELTA_MAP_BIT_KHR or VK_IMAGE_USAGE_VIDEO_ENCODE_EMPHASIS_MAP_BIT_KHR usage flags set
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT then image must have been created with either the IMAGE_USAGE_COLOR_ATTACHMENT_BIT or IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage flags set, and the IMAGE_USAGE_INPUT_ATTACHMENT_BIT or IMAGE_USAGE_SAMPLED_BIT usage flags set, and the IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT usage flag set
• If the attachmentFeedbackLoopLayout feature is not enabled, newLayout must not be IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT
• If layouts are not ignored, oldLayout or newLayout is IMAGE_LAYOUT_RENDERING_LOCAL_READ then image must have been created with either the IMAGE_USAGE_STORAGE_BIT usage flag set, or with both the IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage flag and either of the IMAGE_USAGE_COLOR_ATTACHMENT_BIT or IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage flags set
• If the dynamicRenderingLocalRead feature is not enabled, oldLayout must not be IMAGE_LAYOUT_RENDERING_LOCAL_READ
• If the dynamicRenderingLocalRead feature is not enabled, newLayout must not be IMAGE_LAYOUT_RENDERING_LOCAL_READ
• If the synchronization2 feature is not enabled, and image was created with a sharing mode of SHARING_MODE_CONCURRENT, at least one of srcQueueFamilyIndex and dstQueueFamilyIndex must be QUEUE_FAMILY_IGNORED
• If the synchronization2 feature is not enabled, and image was created with a sharing mode of SHARING_MODE_CONCURRENT, srcQueueFamilyIndex must be QUEUE_FAMILY_IGNORED or QUEUE_FAMILY_EXTERNAL
• If the synchronization2 feature is not enabled, and image was created with a sharing mode of SHARING_MODE_CONCURRENT, dstQueueFamilyIndex must be QUEUE_FAMILY_IGNORED or QUEUE_FAMILY_EXTERNAL
• If dstQueueFamilyIndex is QUEUE_FAMILY_EXTERNAL and image was created with EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT or EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT in ExternalMemoryImageCreateInfo::handleTypes, newLayout must be IMAGE_LAYOUT_GENERAL
• If srcQueueFamilyIndex is QUEUE_FAMILY_EXTERNAL and image was created with EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT or EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT in ExternalMemoryImageCreateInfo::handleTypes, oldLayout must be IMAGE_LAYOUT_GENERAL or IMAGE_LAYOUT_UNDEFINED

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of ExternalMemoryAcquireUnmodifiedEXT or SampleLocationsInfoEXT
• The sType value of each structure in the pNext chain must be unique
• oldLayout must be a valid ImageLayout value
• newLayout must be a valid ImageLayout value
• image must be a valid Image handle
• subresourceRange must be a valid ImageSubresourceRange structure

See Also

VK_VERSION_1_0, AccessFlags, Image, ImageLayout, ImageSubresourceRange, StructureType, cmdPipelineBarrier, cmdWaitEvents

VkPipelineCacheHeaderVersionOne - Structure describing the layout of the pipeline cache header

Description

Unlike most structures declared by the Vulkan API, all fields of this structure are written with the least significant byte first, regardless of host byte-order.

The C language specification does not define the packing of structure members. This layout assumes tight structure member packing, with members laid out in the order listed in the structure, and the intended size of the structure is 32 bytes. If a compiler produces code that diverges from that pattern, applications must employ another method to set values at the correct offsets.

Valid Usage (Implicit)

See Also

VK_VERSION_1_0, PipelineCacheHeaderVersion

VkDrawIndirectCommand - Structure specifying an indirect drawing command

Description

The members of DrawIndirectCommand have the same meaning as the similarly named parameters of cmdDraw.

Valid Usage

• If the bound graphics pipeline state was created with PipelineVertexInputDivisorStateCreateInfo in the pNext chain of GraphicsPipelineCreateInfo::pVertexInputState, any member of PipelineVertexInputDivisorStateCreateInfo::pVertexBindingDivisors has a value other than 1 in divisor, and PhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0

• If shader objects are used for drawing or the bound graphics pipeline state was created with the DYNAMIC_STATE_VERTEX_INPUT_EXT dynamic state enabled, any member of the pVertexBindingDescriptions parameter to the cmdSetVertexInputEXT call that sets this dynamic state has a value other than 1 in divisor, and PhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0
• If the drawIndirectFirstInstance feature is not enabled, firstInstance must be 0

See Also

VK_VERSION_1_0, cmdDrawIndirect

VkDrawIndexedIndirectCommand - Structure specifying an indexed indirect drawing command

Description

The members of DrawIndexedIndirectCommand have the same meaning as the similarly named parameters of cmdDrawIndexed.

Valid Usage

• If the bound graphics pipeline state was created with PipelineVertexInputDivisorStateCreateInfo in the pNext chain of GraphicsPipelineCreateInfo::pVertexInputState, any member of PipelineVertexInputDivisorStateCreateInfo::pVertexBindingDivisors has a value other than 1 in divisor, and PhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0

• If shader objects are used for drawing or the bound graphics pipeline state was created with the DYNAMIC_STATE_VERTEX_INPUT_EXT dynamic state enabled, any member of the pVertexBindingDescriptions parameter to the cmdSetVertexInputEXT call that sets this dynamic state has a value other than 1 in divisor, and PhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0
• If the robustBufferAccess2 feature is not enabled, (indexSize × (firstIndex + indexCount) + offset) must be less than or equal to the size of the bound index buffer, with indexSize being based on the type specified by indexType, where the index buffer, indexType, and offset are specified via cmdBindIndexBuffer or cmdBindIndexBuffer2. If cmdBindIndexBuffer2 is used to bind the index buffer, the size of the bound index buffer is cmdBindIndexBuffer2::size
• If the drawIndirectFirstInstance feature is not enabled, firstInstance must be 0

See Also

VK_VERSION_1_0, cmdDrawIndexedIndirect

VkDispatchIndirectCommand - Structure specifying an indirect dispatching command

Description

The members of DispatchIndirectCommand have the same meaning as the corresponding parameters of cmdDispatch.

Valid Usage

See Also

VK_VERSION_1_0, cmdDispatchIndirect

VkBaseOutStructure - Base structure for a read-only pointer chain

Description

BaseOutStructure can be used to facilitate iterating through a structure pointer chain that returns data back to the application.

See Also

VK_VERSION_1_0, BaseOutStructure, StructureType, getPipelinePropertiesEXT

VkBaseInStructure - Base structure for a read-only pointer chain

Description

BaseInStructure can be used to facilitate iterating through a read-only structure pointer chain.

See Also

VK_VERSION_1_0, BaseInStructure, StructureType

VkPipelineCacheHeaderVersion - Encode pipeline cache version

Description

• PIPELINE_CACHE_HEADER_VERSION_ONE specifies version one of the pipeline cache, described by PipelineCacheHeaderVersionOne.

• PIPELINE_CACHE_HEADER_VERSION_DATA_GRAPH_QCOM specifies a pipeline cache for offline built data graph models, described by PipelineCacheHeaderVersionDataGraphQCOM.

See Also

VK_VERSION_1_0, PipelineCacheHeaderVersionDataGraphQCOM, PipelineCacheHeaderVersionOne, createPipelineCache, getPipelineCacheData

VkObjectType - Specify an enumeration to track object handle types

Description

'

ObjectType and Vulkan Handle Relationship

See Also

VK_VERSION_1_0, DebugUtilsObjectNameInfoEXT, DebugUtilsObjectTagInfoEXT, DeviceMemoryReportCallbackDataEXT, getPrivateData, getPrivateData, setPrivateData, setPrivateData

VkVendorId - Khronos vendor IDs

Description

Khronos vendor IDs may be allocated by vendors at any time. Only the latest canonical versions of this Specification, of the corresponding vk.xml API Registry, and of the corresponding vulkan_core.h header file must contain all reserved Khronos vendor IDs.

Only Khronos vendor IDs are given symbolic names at present. PCI vendor IDs returned by the implementation can be looked up in the PCI-SIG database.

See Also

VK_VERSION_1_0