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

Aberta Para iniciantes
#551 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
72/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
cpp
Domínio
documentation

Direção de pesquisa

Leia as seções Layout transitions e Transition barrier masks na página do tutorial vinculada e compare onde os parâmetros de pipelineBarrier() são explicados com onde as máscaras são definidas. Mova ou condense a explicação conforme proposto para que os leitores encontrem os detalhes junto com seu uso; o trabalho estará concluído quando a seção anterior mencionar brevemente que as máscaras serão explicadas adiante e a explicação detalhada aparecer em Transition barrier masks.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
C++
Estrelas
444
Forks
145
Métricas de merge de PRs
Nenhum PR com merge em 30d

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de KhronosGroup/Vulkan-Tutorial

Todas as issues de KhronosGroup/Vulkan-Tutorial

Issues semelhantes

Mais issues de C++

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.