vkGetRenderingAreaGranularity - Returns the granularity for dynamic rendering optimal render area

Description

The conditions leading to an optimal renderArea are:

• the offset.x member in renderArea is a multiple of the width member of the returned Extent2D (the horizontal granularity).
• the offset.y member in renderArea is a multiple of the height member of the returned Extent2D (the vertical granularity).
• either the extent.width member in renderArea is a multiple of the horizontal granularity or offset.x+extent.width is equal to the width of each attachment used in the render pass instance.
• either the extent.height member in renderArea is a multiple of the vertical granularity or offset.y+extent.height is equal to the height of each attachment used in the render pass instance.

Valid Usage (Implicit)

• device must be a valid Device handle

• pRenderingAreaInfo must be a valid pointer to a valid RenderingAreaInfo structure
• pGranularity must be a valid pointer to a Extent2D structure

See Also

VK_KHR_maintenance5, VK_VERSION_1_4, Device, Extent2D, RenderingAreaInfo

vkCmdBindIndexBuffer2 - Bind an index buffer to a command buffer

Description

size specifies the bound size of the index buffer starting from offset. If size is WHOLE_SIZE then the bound size is from offset to the end of the buffer.

If the maintenance6 feature is enabled, buffer can be NULL_HANDLE. If buffer is NULL_HANDLE and the nullDescriptor feature is enabled, every index fetched results in a value of zero.

Valid Usage

• offset must be less than the size of buffer

• The sum of offset and the base address of the range of DeviceMemory object that is backing buffer, must be a multiple of the size of the type indicated by indexType
• buffer must have been created with the BUFFER_USAGE_INDEX_BUFFER_BIT usage flag set
• If buffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• indexType must not be INDEX_TYPE_NONE_KHR
• If indexType is INDEX_TYPE_UINT8, the indexTypeUint8 feature must be enabled
• If the maintenance6 feature is not enabled, buffer must not be NULL_HANDLE
• If buffer is NULL_HANDLE, offset must be zero
• If size is not WHOLE_SIZE, size must be a multiple of the size of the type indicated by indexType
• If size is not WHOLE_SIZE, the sum of offset and size must be less than or equal to the size of buffer

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• If buffer is not NULL_HANDLE, buffer must be a valid Buffer handle
• indexType must be a valid IndexType value
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support QUEUE_GRAPHICS_BIT operations
• This command must only be called outside of a video coding scope
• Both of buffer, and commandBuffer that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdBindIndexBuffer2 is not affected by conditional rendering

See Also

VK_KHR_maintenance5, VK_VERSION_1_4, Buffer, CommandBuffer, DeviceSize, IndexType

vkGetImageSubresourceLayout2 - Retrieve information about an image subresource

Description

getImageSubresourceLayout2 behaves similarly to getImageSubresourceLayout, with the ability to specify extended inputs via chained input structures, and to return extended information via chained output structures.

It is legal to call getImageSubresourceLayout2 with an image created with tiling equal to IMAGE_TILING_OPTIMAL, but the members of SubresourceLayout2::subresourceLayout will have undefined values in this case.

Structures chained from ImageSubresource2::pNext will also be updated when tiling is equal to IMAGE_TILING_OPTIMAL.

Valid Usage

• The aspectMask member of pSubresource must only have a single bit set

• The mipLevel member of pSubresource must be less than the mipLevels specified in image
• The arrayLayer member of pSubresource must be less than the arrayLayers specified in image
• If format of the image is a color format that is not a multi-planar format, and tiling of the image is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, the aspectMask member of pSubresource must be IMAGE_ASPECT_COLOR_BIT
• If format of the image has a depth component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_DEPTH_BIT
• If format of the image has a stencil component, the aspectMask member of pSubresource must contain IMAGE_ASPECT_STENCIL_BIT
• If format of the image does not contain a stencil or depth component, the aspectMask member of pSubresource must not contain IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• If the tiling of the image is IMAGE_TILING_LINEAR and has a multi-planar format, then the aspectMask member of pSubresource must be a single valid multi-planar aspect mask bit
• If image was created with the EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID external memory handle type, then image must be bound to memory
• If the tiling of the image is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then the aspectMask member of pSubresource must be VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT and the index i must be less than the DrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount associated with the image’s format and ImageDrmFormatModifierPropertiesEXT::drmFormatModifier

Valid Usage (Implicit)

• device must be a valid Device handle

• image must be a valid Image handle
• pSubresource must be a valid pointer to a valid ImageSubresource2 structure
• pLayout must be a valid pointer to a SubresourceLayout2 structure
• image must have been created, allocated, or retrieved from device

See Also

VK_EXT_host_image_copy, VK_EXT_image_compression_control, VK_KHR_maintenance5, VK_VERSION_1_4, Device, Image, ImageSubresource2, SubresourceLayout2

vkGetDeviceImageSubresourceLayout - Retrieve information about an image subresource without an image object

Description

getDeviceImageSubresourceLayout behaves similarly to getImageSubresourceLayout2, but uses a ImageCreateInfo structure to specify the image rather than a Image object.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance5, VK_VERSION_1_4, Device, DeviceImageSubresourceInfo, SubresourceLayout2

VkBufferUsageFlags2CreateInfo - Extended buffer usage flags

Description

If this structure is included in the pNext chain of a buffer creation structure, usage is used instead of the corresponding usage value passed in that creation structure, allowing additional usage flags to be specified. If this structure is included in the pNext chain of a buffer query structure, the usage flags of the buffer are returned in usage of this structure, and the usage flags representable in usage of the buffer query structure are also returned in that field.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance5, VK_VERSION_1_4, BufferUsageFlags2, StructureType

VkPipelineCreateFlags2CreateInfo - Extended pipeline create flags

Description

If this structure is included in the pNext chain of a pipeline creation structure, flags is used instead of the corresponding flags value passed in that creation structure, allowing additional creation flags to be specified.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance5, VK_VERSION_1_4, PipelineCreateFlags2, StructureType

VkPhysicalDeviceMaintenance5Features - Structure describing whether the implementation supports maintenance5 functionality

Members

This structure describes the following feature:

Description

If the PhysicalDeviceMaintenance5Features structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceMaintenance5Features, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance5, VK_VERSION_1_4, Bool32, StructureType

VkPhysicalDeviceMaintenance5Properties - Structure describing various implementation-defined properties introduced with VK_KHR_maintenance5

Description

If the PhysicalDeviceMaintenance5Properties structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance5, VK_VERSION_1_4, Bool32, StructureType

VkRenderingAreaInfo - Structure describing rendering area granularity query info

Valid Usage (Implicit)

See Also

VK_KHR_maintenance5, VK_VERSION_1_4, Format, StructureType, getRenderingAreaGranularity, getRenderingAreaGranularity

VkImageSubresource2 - Structure specifying an image subresource

Valid Usage (Implicit)