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

Offen Anfängerfreundlich
#551 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
72/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
cpp
Bereich
documentation

Rechercherichtung

Lies die Abschnitte Layout transitions und Transition barrier masks auf der verlinkten Tutorialseite und vergleiche, wo die Parameter von pipelineBarrier() erklärt werden und wo ihre Masken gesetzt werden. Verschiebe oder kürze die Erklärung wie vorgeschlagen, damit Leser die Details zusammen mit ihrer Verwendung finden; abgeschlossen ist die Änderung, wenn der frühere Abschnitt kurz darauf hinweist, dass die Masken später behandelt werden, und die ausführliche Erklärung in Transition barrier masks erscheint.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
C++
Sterne
444
Forks
145
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus KhronosGroup/Vulkan-Tutorial

Alle Issues in KhronosGroup/Vulkan-Tutorial

Ähnliche Issues

Weitere Issues zu C++

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.