KhronosGroup / Vulkan-Docs

The Vulkan API Specification and related tools
Other
2.7k stars 452 forks source link

Confusiing wording in docs for VkAttachmentLoadOp #2353

Closed not-magic closed 1 month ago

not-magic commented 2 months ago

The docs for the VkAttachmentLoadOp page specify:

VkAttachmentLoadOp - Specify how contents of an attachment are initialized at the beginning of a subpass

However the docs in VkAttachmentDescription say:

loadOp is a VkAttachmentLoadOp value specifying how the contents of color and depth components of the attachment are treated at the beginning of the subpass where it is first used.

That context at the end where it is first used should be included in the docs for VkAttachmentLoadOp because otherwise it suggests the load op is applied on every subpass.

Similar issues exist on VkAttachmentStoreOp

oddhack commented 2 months ago

I will fix the short description in the refpage to be consistent, thanks.