Skip to content

Bump PipelineLayoutVk for inline constants. based on #750 #751

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
TheMostDiligent merged 1 commit into from
Jan 2, 2026
Merged

Bump PipelineLayoutVk for inline constants. based on #750 #751

Show file tree
Hide file tree
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
19 changes: 17 additions & 2 deletions Graphics/GraphicsEngineVulkan/include/PipelineLayoutVk.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2019-2025 Diligent Graphics LLC
* Copyright 2019-2026 Diligent Graphics LLC
* Copyright 2015-2019 Egor Yusov
*
* Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -47,7 +47,9 @@ class PipelineLayoutVk
PipelineLayoutVk();
~PipelineLayoutVk();

void Create(RenderDeviceVkImpl* pDeviceVk, RefCntAutoPtr<PipelineResourceSignatureVkImpl> ppSignatures[], Uint32 SignatureCount) noexcept(false);
void Create(RenderDeviceVkImpl* pDeviceVk,
RefCntAutoPtr<PipelineResourceSignatureVkImpl> ppSignatures[],
Uint32 SignatureCount) noexcept(false);
void Release(RenderDeviceVkImpl* pDeviceVkImpl, Uint64 CommandQueueMask);

VkPipelineLayout GetVkPipelineLayout() const { return m_VkPipelineLayout; }
Expand All @@ -59,6 +61,17 @@ class PipelineLayoutVk
return m_FirstDescrSetIndex[Index];
}

struct PushConstantInfo
{
Uint32 Size = 0;
VkShaderStageFlags StageFlags = 0;
Uint32 SignatureIndex = ~0u;
Uint32 ResourceIndex = ~0u;

constexpr explicit operator bool() const { return Size != 0; }
};
const PushConstantInfo& GetPushConstantInfo() const { return m_PushConstantInfo; }

private:
VulkanUtilities::PipelineLayoutWrapper m_VkPipelineLayout;

Expand All @@ -70,6 +83,8 @@ class PipelineLayoutVk
// (Maximum is MAX_RESOURCE_SIGNATURES * 2)
Uint8 m_DescrSetCount = 0;

PushConstantInfo m_PushConstantInfo;

#ifdef DILIGENT_DEBUG
Uint32 m_DbgMaxBindIndex = 0;
#endif
Expand Down
67 changes: 56 additions & 11 deletions Graphics/GraphicsEngineVulkan/src/PipelineLayoutVk.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2019-2025 Diligent Graphics LLC
* Copyright 2019-2026 Diligent Graphics LLC
* Copyright 2015-2019 Egor Yusov
*
* Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -59,7 +59,9 @@
}
}

void PipelineLayoutVk::Create(RenderDeviceVkImpl* pDeviceVk, RefCntAutoPtr<PipelineResourceSignatureVkImpl> ppSignatures[], Uint32 SignatureCount) noexcept(false)
void PipelineLayoutVk::Create(RenderDeviceVkImpl* pDeviceVk,

Check notice

Code scanning / CodeQL

No raw arrays in interfaces Note

Raw arrays should not be used in interfaces. A container class should be used instead.
RefCntAutoPtr<PipelineResourceSignatureVkImpl> ppSignatures[],
Uint32 SignatureCount) noexcept(false)
{
VERIFY(m_DescrSetCount == 0 && !m_VkPipelineLayout, "This pipeline layout is already initialized");

Expand Down Expand Up @@ -92,6 +94,27 @@
#ifdef DILIGENT_DEBUG
m_DbgMaxBindIndex = std::max(m_DbgMaxBindIndex, Uint32{pSignature->GetDesc().BindingIndex});
#endif

// Vulkan allows only one push constant range per pipeline layout.
// Diligent API allows multiple inline constant resources, so we promote only the first inline constant
// from resource signatures to push constants. Other inline constants remain uniform buffers.
if (!m_PushConstantInfo)
{
for (Uint32 r = 0; r < pSignature->GetTotalResourceCount(); ++r)
{
const PipelineResourceDesc& ResDesc = pSignature->GetResourceDesc(r);
if (ResDesc.Flags & PIPELINE_RESOURCE_FLAG_INLINE_CONSTANTS)
{
VERIFY_EXPR(ResDesc.ArraySize > 0);
// For inline constants, ArraySize contains the number of 32-bit constants.
m_PushConstantInfo.Size = ResDesc.ArraySize * sizeof(Uint32);
m_PushConstantInfo.StageFlags = ShaderTypesToVkShaderStageFlags(ResDesc.ShaderStages);
m_PushConstantInfo.SignatureIndex = BindInd;
m_PushConstantInfo.ResourceIndex = r;
break;
}
}
}
}
VERIFY_EXPR(DescSetLayoutCount <= MAX_RESOURCE_SIGNATURES * 2);

Expand All @@ -114,19 +137,41 @@
") used by the pipeline layout exceeds device limit (", Limits.maxDescriptorSetStorageBuffersDynamic, ")");
}

// Validate push constant size against device limits
if (m_PushConstantInfo.Size > Limits.maxPushConstantsSize)
{
LOG_ERROR_AND_THROW("Push constant size (", m_PushConstantInfo.Size,
" bytes) exceeds device limit (", Limits.maxPushConstantsSize, " bytes)");
}

VERIFY(m_DescrSetCount <= std::numeric_limits<decltype(m_DescrSetCount)>::max(),
"Descriptor set count (", DescSetLayoutCount, ") exceeds the maximum representable value");

VkPipelineLayoutCreateInfo PipelineLayoutCI = {};
VkPipelineLayoutCreateInfo PipelineLayoutCI{};
PipelineLayoutCI.sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO;
PipelineLayoutCI.pNext = nullptr;
PipelineLayoutCI.flags = 0; // reserved for future use
PipelineLayoutCI.setLayoutCount = DescSetLayoutCount;
PipelineLayoutCI.pSetLayouts = DescSetLayoutCount ? DescSetLayouts.data() : nullptr;

// Set up push constant range if present
VkPushConstantRange PushConstantRange{};
if (m_PushConstantInfo)
{
PushConstantRange.stageFlags = m_PushConstantInfo.StageFlags;
PushConstantRange.offset = 0;
PushConstantRange.size = m_PushConstantInfo.Size;

PipelineLayoutCI.pushConstantRangeCount = 1;
PipelineLayoutCI.pPushConstantRanges = &PushConstantRange;
}
else
{
PipelineLayoutCI.pushConstantRangeCount = 0;
PipelineLayoutCI.pPushConstantRanges = nullptr;
}

PipelineLayoutCI.sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO;
PipelineLayoutCI.pNext = nullptr;
PipelineLayoutCI.flags = 0; // reserved for future use
PipelineLayoutCI.setLayoutCount = DescSetLayoutCount;
PipelineLayoutCI.pSetLayouts = DescSetLayoutCount ? DescSetLayouts.data() : nullptr;
PipelineLayoutCI.pushConstantRangeCount = 0;
PipelineLayoutCI.pPushConstantRanges = nullptr;
m_VkPipelineLayout = pDeviceVk->GetLogicalDevice().CreatePipelineLayout(PipelineLayoutCI);
m_VkPipelineLayout = pDeviceVk->GetLogicalDevice().CreatePipelineLayout(PipelineLayoutCI);

m_DescrSetCount = static_cast<Uint8>(DescSetLayoutCount);
}
Expand Down
Loading