Skip to content

Fix shader cursor doc to use getBindingRangeFirstDescriptorRangeIndex. #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 7, 2025
Merged

Fix shader cursor doc to use getBindingRangeFirstDescriptorRangeIndex. #169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/shader-cursors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -772,7 +772,7 @@ The `write()` operations of this Vulkan RHI shader object are similar to those o
```cpp
void VulkanShaderObject::write(ShaderOffset offset, Texture* texture)
{
uint32_t bindingIndex = m_typeLayout->getBindingRangeIndexOffset(
uint32_t bindingIndex = m_typeLayout->getBindingRangeFirstDescriptorRangeIndex(
offset.bindingRangeIndex);

VkDescriptorImageInfo image;
Expand Down Expand Up @@ -813,7 +813,7 @@ VkDescriptorType mapToDescriptorType(slang::BindingType bindingRangeType)

This RHI code is able to remain simple and clean because the Slang reflection API provides methods that directly query the information that an RHI needs to know (in this case, in order to fill out the fields of a `VkWriteDescriptorSet`):

* The `slang::TypeLayoutReflection::getBindingRangeIndexOffset()` method translates the target-independent binding range index into the Vulkan binding index
* The `slang::TypeLayoutReflection::getBindingRangeFirstDescriptorRangeIndex()` method translates the target-independent binding range index into the Vulkan binding index
* The `slang::TypeLayoutReflection::getBindingRangeType()` method provides information about the binding range that can be mapped directly to the `VkDescriptorType`

### Is that really all the code that is needed?
Expand Down