Consider moving the pipeline barrier explanation closer to where the parameters are set

未关闭 适合新手
#551 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
72/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
cpp
领域
documentation

调研方向

阅读链接教程页面中的 Layout transitions 和 Transition barrier masks 部分,然后比较 pipelineBarrier() 参数的说明位置与其 mask 的设置位置。按提议移动或精简说明,让读者在看到这些参数的用法时也能看到相关细节;完成的标准是前面的部分简要说明 mask 会在后文介绍,而详细说明出现在 Transition barrier masks 中。

由索引模型根据 Issue 内容生成。

描述

In the Layout transitions section, the tutorial says:

The right values depend on the old and new layout, so we’ll get back to this once we’ve figured out which transitions we’re going to use.

However, the tutorial then spends several paragraphs explaining the parameters of pipelineBarrier(), including pipeline stages, access types, eByRegion, and different types of memory barriers. The actual stage and access masks are not set until the later Transition barrier masks section.

I found this order a bit confusing for a few reasons:

  • The tutorial tells readers that these parameters will be handled later, but immediately goes into a fairly detailed explanation of them.
  • The two layout transitions (UNDEFINED → TRANSFER_DST_OPTIMAL and TRANSFER_DST_OPTIMAL → SHADER_READ_ONLY_OPTIMAL) have already been introduced at this point, so the reason given for postponing the parameters is also a little unclear.
  • By the time the parameters are actually set, the reader has already moved through several other topics.

I think it would be easier to follow if the earlier section briefly mentioned that the stage and access masks would be filled in later, and left the detailed explanation for the Transition barrier masks section, where readers can immediately see how those parameters are used.

I don't think leaving the implementation incomplete is a problem by itself. It's mainly the placement of the explanation that makes the section harder to follow.

主要语言
C++
星标
444
派生
145
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

KhronosGroup/Vulkan-Tutorial 的其他 Issue

查看 KhronosGroup/Vulkan-Tutorial 的全部 Issue

相似的 Issue

更多 C++ Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。