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

Đang mở Phù hợp với người mới
#551 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
cpp
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc các phần Layout transitions và Transition barrier masks trên trang hướng dẫn được liên kết, sau đó so sánh vị trí giải thích các tham số của pipelineBarrier() với vị trí thiết lập các mask tương ứng. Di chuyển hoặc rút gọn phần giải thích như đề xuất để người đọc gặp các chi tiết cùng với nơi chúng được sử dụng; hoàn tất khi phần trước đó đề cập ngắn gọn rằng các mask sẽ được giải thích sau và phần giải thích chi tiết xuất hiện trong Transition barrier masks.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
C++
Star
444
Fork
145
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của KhronosGroup/Vulkan-Tutorial

Tất cả issue của KhronosGroup/Vulkan-Tutorial

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.