KhronosGroup / KhronosGroup/Vulkan-Docs

VkImageSubresourceRange depth\stencil aspectMask underrestricted

Open
#714 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
3.3k
Forks
549
Avg merge
5d 5h
Merged PRs (30d)
2

Description

`VkImageSubresourceRange` has this restriction:

> `aspectMask` **must** be only `VK_IMAGE_ASPECT_COLOR_BIT`, `VK_IMAGE_ASPECT_DEPTH_BIT` or `VK_IMAGE_ASPECT_STENCIL_BIT` if `format` is a color, depth-only or stencil-only format, respectively, except if `format` is a multi-planar format. If using a depth/stencil format with both depth and stencil components, `aspectMask` **must** include at least one of `VK_IMAGE_ASPECT_DEPTH_BIT` and `VK_IMAGE_ASPECT_STENCIL_BIT`, and **can** include both.

Aside: It should be converted to VU(s) for clarity.

Now, considering depth-only and stencil-only images can only have appropriate aspect mask flag, it would follow depth\stencil image should be restricted only to those two aspect masks too.
But strict reading of the above quote seems to allow any flag bits as long as `DEPTH` or `STENCIL` is also included.

Contributor guide

Open the contributing guide

Research direction

Locate the VkImageSubresourceRange aspectMask restriction in the Vulkan specification and compare its wording for color, depth-only, stencil-only, and combined depth/stencil formats. Clarify the valid flags and convert the restriction to VU(s), then verify that the specification clearly describes the permitted depth/stencil aspect masks.

Written by the indexing model from the issue text.

Assessment

Domain
computer-graphics, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.