Clarify how descriptor pool capacity is shared across descriptor sets

Open Beginner friendly
#545 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
cpp
Domain
documentation

Research direction

The issue points to the Descriptor pool section at 05_Uniform_buffers/01_Descriptor_pool_and_sets.html#_descriptor_pool. Read that section and clarify that descriptor counts apply to the whole pool and are shared by sets allocated from it. Done when the explanation explicitly resolves whether the count is total or per set.

Written by the indexing model from the issue text.

Description

Hi! I was reading the Descriptor pool section and found this sentence a little ambiguous:

We first need to describe which descriptor types our descriptor sets are going to contain and how many of them, using vk::DescriptorPoolSize structures.

I wasn't sure whether the descriptor counts refer to the entire pool or to each descriptor set.

For example, with:

vk::DescriptorPoolSize poolSize{
    .type = vk::DescriptorType::eUniformBuffer,
    .descriptorCount = 3
};

Does this mean 3 uniform buffer descriptors in total, shared by all sets allocated from the pool, or 3 descriptors per set?

The following explanation helps, but I think it would be clearer to state this explicitly. Maybe something like:

These counts are for the entire pool, not for each descriptor set. All descriptor sets allocated from the pool share this capacity.

Thanks for maintaining the tutorial!

Dominant language
C++
Stars
444
Forks
145
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from KhronosGroup/Vulkan-Tutorial

All issues in KhronosGroup/Vulkan-Tutorial

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.