vkGetRenderingAreaGranularityKHR - 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 the framebuffer in the RenderPassBeginInfo.
• 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 the framebuffer in the RenderPassBeginInfo.

Valid Usage (Implicit)

• device must be a valid Device handle

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

See Also

VK_KHR_maintenance5, Device, Extent2D, RenderingAreaInfoKHR

vkCmdBindIndexBuffer2KHR - 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.

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 flag
• 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_EXT, the indexTypeUint8 feature must be enabled
• 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

• 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 graphics operations
• This command must only be called outside of a video coding scope
• Both of buffer, and commandBuffer 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

'

See Also

VK_KHR_maintenance5, Buffer, CommandBuffer, DeviceSize, IndexType

vkGetImageSubresourceLayout2KHR - Retrieve information about an image subresource

Description

getImageSubresourceLayout2KHR 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 getImageSubresourceLayout2KHR with a image created with tiling equal to IMAGE_TILING_OPTIMAL, but the members of SubresourceLayout2KHR::subresourceLayout will have undefined values in this case.

Note

Structures chained from ImageSubresource2KHR::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 ImageCreateInfo when image was created
• The arrayLayer member of pSubresource must be less than the arrayLayers specified in ImageCreateInfo when image was created
• If format of the image is a color format, tiling of the image is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, and does not have a multi-planar image format, 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 image 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 ImageSubresource2KHR structure
• pLayout must be a valid pointer to a SubresourceLayout2KHR structure
• image must have been created, allocated, or retrieved from device

See Also

VK_KHR_maintenance5, Device, Image, ImageSubresource2KHR, SubresourceLayout2KHR

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

Description

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

Valid Usage (Implicit)

See Also

VK_KHR_maintenance5, Device, DeviceImageSubresourceInfoKHR, SubresourceLayout2KHR

VkBufferUsageFlags2CreateInfoKHR - 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, BufferUsageFlags2KHR, StructureType

VkPipelineCreateFlags2CreateInfoKHR - 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, PipelineCreateFlags2KHR, StructureType

VkPhysicalDeviceMaintenance5FeaturesKHR - Structure describing whether the implementation supports maintenance5 functionality

Members

This structure describes the following feature:

Description

If the PhysicalDeviceMaintenance5FeaturesKHR 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. PhysicalDeviceMaintenance5FeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_KHR_maintenance5, Bool32, StructureType

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

Description

If the PhysicalDeviceMaintenance5PropertiesKHR 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, Bool32, StructureType

VkRenderingAreaInfoKHR - Structure describing rendering area granularity query info

Valid Usage (Implicit)

See Also

VK_KHR_maintenance5, Format, StructureType, getRenderingAreaGranularityKHR

VkImageSubresource2KHR - Structure specifying an image subresource

Valid Usage (Implicit)

See Also

VK_EXT_host_image_copy, VK_EXT_image_compression_control, VK_KHR_maintenance5, DeviceImageSubresourceInfoKHR, ImageSubresource, StructureType, getImageSubresourceLayout2EXT, getImageSubresourceLayout2KHR

VkSubresourceLayout2KHR - Structure specifying subresource layout

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2_KHR

• 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 ImageCompressionPropertiesEXT or SubresourceHostMemcpySizeEXT
• The sType value of each struct in the pNext chain must be unique

See Also

VK_EXT_host_image_copy, VK_EXT_image_compression_control, VK_KHR_maintenance5, StructureType, SubresourceLayout, getDeviceImageSubresourceLayoutKHR, getImageSubresourceLayout2EXT, getImageSubresourceLayout2KHR

VkDeviceImageSubresourceInfoKHR - Image creation information for querying subresource layout

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 ImageCreateInfo when image was created
• The arrayLayer member of pSubresource must be less than the arrayLayers specified in ImageCreateInfo when image was created
• If format of the image is a color format, tiling of the image is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, and does not have a multi-planar image format, 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 image 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)

• sType must be STRUCTURE_TYPE_DEVICE_IMAGE_SUBRESOURCE_INFO_KHR

• pNext must be NULL
• pCreateInfo must be a valid pointer to a valid ImageCreateInfo structure
• pSubresource must be a valid pointer to a valid ImageSubresource2KHR structure

See Also

VK_KHR_maintenance5, ImageCreateInfo, ImageSubresource2KHR, StructureType, getDeviceImageSubresourceLayoutKHR

VkPipelineCreateFlagBits2KHR - Bitmask controlling how a pipeline is created

Description

• PIPELINE_CREATE_2_DISABLE_OPTIMIZATION_BIT_KHR specifies that the created pipeline will not be optimized. Using this flag may reduce the time taken to create the pipeline.

• PIPELINE_CREATE_2_ALLOW_DERIVATIVES_BIT_KHR specifies that the pipeline to be created is allowed to be the parent of a pipeline that will be created in a subsequent pipeline creation call.
• PIPELINE_CREATE_2_DERIVATIVE_BIT_KHR specifies that the pipeline to be created will be a child of a previously created parent pipeline.
• PIPELINE_CREATE_2_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR specifies that any shader input variables decorated as ViewIndex will be assigned values as if they were decorated as DeviceIndex.
• PIPELINE_CREATE_2_DISPATCH_BASE_BIT_KHR specifies that a compute pipeline can be used with cmdDispatchBase with a non-zero base workgroup.
• PIPELINE_CREATE_2_DEFER_COMPILE_BIT_NV specifies that a pipeline is created with all shaders in the deferred state. Before using the pipeline the application must call compileDeferredNV exactly once on each shader in the pipeline before using the pipeline.
• PIPELINE_CREATE_2_CAPTURE_STATISTICS_BIT_KHR specifies that the shader compiler should capture statistics for the pipeline executables produced by the compile process which can later be retrieved by calling getPipelineExecutableStatisticsKHR. Enabling this flag must not affect the final compiled pipeline but may disable pipeline caching or otherwise affect pipeline creation time.
• PIPELINE_CREATE_2_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR specifies that the shader compiler should capture the internal representations of pipeline executables produced by the compile process which can later be retrieved by calling getPipelineExecutableInternalRepresentationsKHR. Enabling this flag must not affect the final compiled pipeline but may disable pipeline caching or otherwise affect pipeline creation time. When capturing IR from pipelines created with pipeline libraries, there is no guarantee that IR from libraries can be retrieved from the linked pipeline. Applications should retrieve IR from each library, and any linked pipelines, separately.
• PIPELINE_CREATE_2_LIBRARY_BIT_KHR specifies that the pipeline cannot be used directly, and instead defines a pipeline library that can be combined with other pipelines using the PipelineLibraryCreateInfoKHR structure. This is available in ray tracing and graphics pipelines.
• PIPELINE_CREATE_2_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR specifies that an any-hit shader will always be present when an any-hit shader would be executed. A NULL any-hit shader is an any-hit shader which is effectively SHADER_UNUSED_KHR, such as from a shader group consisting entirely of zeros.
• PIPELINE_CREATE_2_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR specifies that a closest hit shader will always be present when a closest hit shader would be executed. A NULL closest hit shader is a closest hit shader which is effectively SHADER_UNUSED_KHR, such as from a shader group consisting entirely of zeros.
• PIPELINE_CREATE_2_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR specifies that a miss shader will always be present when a miss shader would be executed. A NULL miss shader is a miss shader which is effectively SHADER_UNUSED_KHR, such as from a shader group consisting entirely of zeros.
• PIPELINE_CREATE_2_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR specifies that an intersection shader will always be present when an intersection shader would be executed. A NULL intersection shader is an intersection shader which is effectively SHADER_UNUSED_KHR, such as from a shader group consisting entirely of zeros.
• PIPELINE_CREATE_2_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR specifies that triangle primitives will be skipped during traversal using OpTraceRayKHR.
• PIPELINE_CREATE_2_RAY_TRACING_SKIP_AABBS_BIT_KHR specifies that AABB primitives will be skipped during traversal using OpTraceRayKHR.
• PIPELINE_CREATE_2_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR specifies that the shader group handles can be saved and reused on a subsequent run (e.g. for trace capture and replay).
• PIPELINE_CREATE_2_INDIRECT_BINDABLE_BIT_NV specifies that the pipeline can be used in combination with https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#device-generated-commands.
• PIPELINE_CREATE_2_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_KHR specifies that pipeline creation will fail if a compile is required for creation of a valid Pipeline object; PIPELINE_COMPILE_REQUIRED will be returned by pipeline creation, and the Pipeline will be set to NULL_HANDLE.
• When creating multiple pipelines, PIPELINE_CREATE_2_EARLY_RETURN_ON_FAILURE_BIT_KHR specifies that control will be returned to the application if any individual pipeline returns a result which is not SUCCESS rather than continuing to create additional pipelines.
• PIPELINE_CREATE_2_RAY_TRACING_ALLOW_MOTION_BIT_NV specifies that the pipeline is allowed to use OpTraceRayMotionNV.
• PIPELINE_CREATE_2_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR specifies that the pipeline will be used with a fragment shading rate attachment.
• PIPELINE_CREATE_2_RENDERING_FRAGMENT_DENSITY_MAP_ATTACHMENT_BIT_EXT specifies that the pipeline will be used with a fragment density map attachment.
• PIPELINE_CREATE_2_LINK_TIME_OPTIMIZATION_BIT_EXT specifies that pipeline libraries being linked into this library should have link time optimizations applied. If this bit is omitted, implementations should instead perform linking as rapidly as possible.
• PIPELINE_CREATE_2_RETAIN_LINK_TIME_OPTIMIZATION_INFO_BIT_EXT specifies that pipeline libraries should retain any information necessary to later perform an optimal link with PIPELINE_CREATE_2_LINK_TIME_OPTIMIZATION_BIT_EXT.
• PIPELINE_CREATE_2_DESCRIPTOR_BUFFER_BIT_EXT specifies that a pipeline will be used with descriptor buffers, rather than descriptor sets.
• PIPELINE_CREATE_2_COLOR_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT specifies that the pipeline may be used with an attachment feedback loop including color attachments.
• PIPELINE_CREATE_2_DEPTH_STENCIL_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT specifies that the pipeline may be used with an attachment feedback loop including depth-stencil attachments.
• PIPELINE_CREATE_2_RAY_TRACING_OPACITY_MICROMAP_BIT_EXT specifies that the pipeline can be used with acceleration structures which reference an opacity micromap array.
• PIPELINE_CREATE_2_RAY_TRACING_DISPLACEMENT_MICROMAP_BIT_NV specifies that the pipeline can be used with aceleration structures which reference a displacement micromap array.
• PIPELINE_CREATE_2_NO_PROTECTED_ACCESS_BIT_EXT specifies that the pipeline must not be bound to a protected command buffer.
• PIPELINE_CREATE_2_PROTECTED_ACCESS_ONLY_BIT_EXT specifies that the pipeline must not be bound to an unprotected command buffer.

It is valid to set both PIPELINE_CREATE_2_ALLOW_DERIVATIVES_BIT_KHR and PIPELINE_CREATE_2_DERIVATIVE_BIT_KHR. This allows a pipeline to be both a parent and possibly a child in a pipeline hierarchy. See Pipeline Derivatives for more information.

When an implementation is looking up a pipeline in a pipeline cache, if that pipeline is being created using linked libraries, implementations should always return an equivalent pipeline created with PIPELINE_CREATE_2_LINK_TIME_OPTIMIZATION_BIT_EXT if available, whether or not that bit was specified.

Note

Using PIPELINE_CREATE_2_LINK_TIME_OPTIMIZATION_BIT_EXT (or not) when linking pipeline libraries is intended as a performance tradeoff between host and device. If the bit is omitted, linking should be faster and produce a pipeline more rapidly, but performance of the pipeline on the target device may be reduced. If the bit is included, linking may be slower but should produce a pipeline with device performance comparable to a monolithically created pipeline. Using both options can allow latency-sensitive applications to generate a suboptimal but usable pipeline quickly, and then perform an optimal link in the background, substituting the result for the suboptimally linked pipeline as soon as it is available.

See Also

VK_KHR_maintenance5

VkBufferUsageFlagBits2KHR - Bitmask controlling how a pipeline is created

See Also

VK_KHR_maintenance5