VkImageStencilUsage2CreateInfoKHR(3)

Name

VkImageStencilUsage2CreateInfoKHR - Specify separate 64-bit usage flags for the stencil aspect of a depth-stencil image

C Specification

The VkImageStencilUsage2CreateInfoKHR structure is defined as:

// Provided by VK_KHR_extended_flags with VK_VERSION_1_2 or VK_EXT_separate_stencil_usage
typedef struct VkImageStencilUsage2CreateInfoKHR {
    VkStructureType          sType;
    void*                    pNext;
    VkImageUsageFlags2KHR    stencilUsage;
} VkImageStencilUsage2CreateInfoKHR;

Members

  • sType is a VkStructureType value identifying this structure.

  • pNext is NULL or a pointer to a structure extending this structure.

  • stencilUsage is a bitmask of VkImageUsageFlagBits2KHR describing the intended usage of the stencil aspect of the image.

Description

If the pNext chain of VkImageCreateInfo includes a VkImageStencilUsage2CreateInfoKHR structure, then that structure includes the usage flags specific to the stencil aspect of the image for an image with a depth-stencil format.

This structure specifies image usages which only apply to the stencil aspect of a depth/stencil format image. When this structure is included in the pNext chain of VkImageCreateInfo, the stencil aspect of the image must only be used as specified by stencilUsage. Use of other aspects of an image are unaffected by this structure.

This structure can also be included in the pNext chain of VkPhysicalDeviceImageFormatInfo2 to query additional capabilities specific to image creation parameter combinations including a separate set of usage flags for the stencil aspect of the image using vkGetPhysicalDeviceImageFormatProperties2. When this structure is not included in the pNext chain of VkPhysicalDeviceImageFormatInfo2 then the implicit value of stencilUsage matches that of VkPhysicalDeviceImageFormatInfo2::usage.

Valid Usage
Valid Usage (Implicit)

Document Notes

For more information, see the Vulkan Specification.

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.