UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FVulkanDescriptorSetWriter Class Reference

#include <VulkanDescriptorSets.h>

Public Member Functions

 FVulkanDescriptorSetWriter ()
 
const FVulkanDSetKeyGetKey () const
 
const VkWriteDescriptorSetGetWriteDescriptors () const
 
const uint32 GetNumWrites () const
 
bool WriteUniformBuffer (uint32 DescriptorIndex, VkBuffer BufferHandle, uint32 HandleId, VkDeviceSize Offset, VkDeviceSize Range)
 
bool WriteDynamicUniformBuffer (uint32 DescriptorIndex, VkBuffer BufferHandle, uint32 HandleId, VkDeviceSize Offset, VkDeviceSize Range, uint32 DynamicOffset)
 
bool WriteSampler (uint32 DescriptorIndex, const FVulkanSamplerState &Sampler)
 
bool WriteImage (uint32 DescriptorIndex, const FVulkanView::FTextureView &TextureView, VkImageLayout Layout)
 
bool WriteInputAttachment (uint32 DescriptorIndex, const FVulkanView::FTextureView &TextureView, VkImageLayout Layout)
 
bool WriteStorageImage (uint32 DescriptorIndex, const FVulkanView::FTextureView &TextureView, VkImageLayout Layout)
 
bool WriteStorageTexelBuffer (uint32 DescriptorIndex, const FVulkanView::FTypedBufferView &View)
 
bool WriteStorageBuffer (uint32 DescriptorIndex, const FVulkanView::FStructuredBufferView &View)
 
bool WriteUniformTexelBuffer (uint32 DescriptorIndex, const FVulkanView::FTypedBufferView &View)
 
bool WriteAccelerationStructure (uint32 DescriptorIndex, VkAccelerationStructureKHR InAccelerationStructure)
 
void SetDescriptorSet (VkDescriptorSet DescriptorSet)
 

Protected Member Functions

template<VkDescriptorType DescriptorType>
bool WriteBuffer (uint32 DescriptorIndex, VkBuffer BufferHandle, uint32 HandleId, VkDeviceSize Offset, VkDeviceSize Range, uint32 DynamicOffset=0)
 
template<VkDescriptorType DescriptorType>
bool WriteTextureView (uint32 DescriptorIndex, const FVulkanView::FTextureView &TextureView, VkImageLayout Layout)
 
template<VkDescriptorType DescriptorType>
bool WriteBufferView (uint32 DescriptorIndex, const FVulkanView::FTypedBufferView &View)
 
uint32 SetupDescriptorWrites (const TArray< VkDescriptorType > &Types, FVulkanHashableDescriptorInfo *InHashableDescriptorInfos, VkWriteDescriptorSet *InWriteDescriptors, VkDescriptorImageInfo *InImageInfo, VkDescriptorBufferInfo *InBufferInfo, uint8 *InBindingToDynamicOffsetMap, VkWriteDescriptorSetAccelerationStructureKHR *InAccelerationStructuresWriteDescriptors, VkAccelerationStructureKHR *InAccelerationStructures, const FVulkanSamplerState &DefaultSampler, const FVulkanView::FTextureView &DefaultImageView)
 
void CheckAllWritten ()
 
void Reset ()
 
void SetWritten (uint32 DescriptorIndex)
 
void SetWrittenBase (uint32 DescriptorIndex)
 
void InitWrittenMasks (uint32 NumDescriptorWrites)
 

Protected Attributes

VkWriteDescriptorSetWriteDescriptors
 
uint8BindingToDynamicOffsetMap
 
uint32DynamicOffsets
 
uint32 NumWrites
 
FVulkanHashableDescriptorInfoHashableDescriptorInfos
 
FVulkanDSetKey Key
 
bool bIsKeyDirty
 
bool bHasVolatileResources = false
 
TArray< uint32, TInlineAllocator< 2 > > WrittenMask
 
TArray< uint32, TInlineAllocator< 2 > > BaseWrittenMask
 

Friends

class FVulkanCommonPipelineDescriptorState
 
class FVulkanComputePipelineDescriptorState
 
class FVulkanGraphicsPipelineDescriptorState
 
class FVulkanDescriptorSetCache
 

Constructor & Destructor Documentation

◆ FVulkanDescriptorSetWriter()

FVulkanDescriptorSetWriter::FVulkanDescriptorSetWriter ( )
inline

Member Function Documentation

◆ CheckAllWritten()

void FVulkanDescriptorSetWriter::CheckAllWritten ( )
protected

◆ GetKey()

const FVulkanDSetKey & FVulkanDescriptorSetWriter::GetKey ( ) const
inline

◆ GetNumWrites()

const uint32 FVulkanDescriptorSetWriter::GetNumWrites ( ) const
inline

◆ GetWriteDescriptors()

const VkWriteDescriptorSet * FVulkanDescriptorSetWriter::GetWriteDescriptors ( ) const
inline

◆ InitWrittenMasks()

void FVulkanDescriptorSetWriter::InitWrittenMasks ( uint32  NumDescriptorWrites)
protected

◆ Reset()

void FVulkanDescriptorSetWriter::Reset ( )
protected

◆ SetDescriptorSet()

void FVulkanDescriptorSetWriter::SetDescriptorSet ( VkDescriptorSet  DescriptorSet)
inline

◆ SetupDescriptorWrites()

uint32 FVulkanDescriptorSetWriter::SetupDescriptorWrites ( const TArray< VkDescriptorType > &  Types,
FVulkanHashableDescriptorInfo InHashableDescriptorInfos,
VkWriteDescriptorSet InWriteDescriptors,
VkDescriptorImageInfo InImageInfo,
VkDescriptorBufferInfo InBufferInfo,
uint8 InBindingToDynamicOffsetMap,
VkWriteDescriptorSetAccelerationStructureKHR InAccelerationStructuresWriteDescriptors,
VkAccelerationStructureKHR InAccelerationStructures,
const FVulkanSamplerState DefaultSampler,
const FVulkanView::FTextureView DefaultImageView 
)
protected

◆ SetWritten()

void FVulkanDescriptorSetWriter::SetWritten ( uint32  DescriptorIndex)
protected

◆ SetWrittenBase()

void FVulkanDescriptorSetWriter::SetWrittenBase ( uint32  DescriptorIndex)
protected

◆ WriteAccelerationStructure()

bool FVulkanDescriptorSetWriter::WriteAccelerationStructure ( uint32  DescriptorIndex,
VkAccelerationStructureKHR  InAccelerationStructure 
)
inline

◆ WriteBuffer()

template<VkDescriptorType DescriptorType>
bool FVulkanDescriptorSetWriter::WriteBuffer ( uint32  DescriptorIndex,
VkBuffer  BufferHandle,
uint32  HandleId,
VkDeviceSize  Offset,
VkDeviceSize  Range,
uint32  DynamicOffset = 0 
)
inlineprotected

◆ WriteBufferView()

template<VkDescriptorType DescriptorType>
bool FVulkanDescriptorSetWriter::WriteBufferView ( uint32  DescriptorIndex,
const FVulkanView::FTypedBufferView View 
)
inlineprotected

◆ WriteDynamicUniformBuffer()

bool FVulkanDescriptorSetWriter::WriteDynamicUniformBuffer ( uint32  DescriptorIndex,
VkBuffer  BufferHandle,
uint32  HandleId,
VkDeviceSize  Offset,
VkDeviceSize  Range,
uint32  DynamicOffset 
)
inline

◆ WriteImage()

bool FVulkanDescriptorSetWriter::WriteImage ( uint32  DescriptorIndex,
const FVulkanView::FTextureView TextureView,
VkImageLayout  Layout 
)
inline

◆ WriteInputAttachment()

bool FVulkanDescriptorSetWriter::WriteInputAttachment ( uint32  DescriptorIndex,
const FVulkanView::FTextureView TextureView,
VkImageLayout  Layout 
)
inline

◆ WriteSampler()

bool FVulkanDescriptorSetWriter::WriteSampler ( uint32  DescriptorIndex,
const FVulkanSamplerState Sampler 
)
inline

◆ WriteStorageBuffer()

bool FVulkanDescriptorSetWriter::WriteStorageBuffer ( uint32  DescriptorIndex,
const FVulkanView::FStructuredBufferView View 
)
inline

◆ WriteStorageImage()

bool FVulkanDescriptorSetWriter::WriteStorageImage ( uint32  DescriptorIndex,
const FVulkanView::FTextureView TextureView,
VkImageLayout  Layout 
)
inline

◆ WriteStorageTexelBuffer()

bool FVulkanDescriptorSetWriter::WriteStorageTexelBuffer ( uint32  DescriptorIndex,
const FVulkanView::FTypedBufferView View 
)
inline

◆ WriteTextureView()

template<VkDescriptorType DescriptorType>
bool FVulkanDescriptorSetWriter::WriteTextureView ( uint32  DescriptorIndex,
const FVulkanView::FTextureView TextureView,
VkImageLayout  Layout 
)
inlineprotected

◆ WriteUniformBuffer()

bool FVulkanDescriptorSetWriter::WriteUniformBuffer ( uint32  DescriptorIndex,
VkBuffer  BufferHandle,
uint32  HandleId,
VkDeviceSize  Offset,
VkDeviceSize  Range 
)
inline

◆ WriteUniformTexelBuffer()

bool FVulkanDescriptorSetWriter::WriteUniformTexelBuffer ( uint32  DescriptorIndex,
const FVulkanView::FTypedBufferView View 
)
inline

Friends And Related Symbol Documentation

◆ FVulkanCommonPipelineDescriptorState

◆ FVulkanComputePipelineDescriptorState

◆ FVulkanDescriptorSetCache

◆ FVulkanGraphicsPipelineDescriptorState

Member Data Documentation

◆ BaseWrittenMask

TArray<uint32, TInlineAllocator<2> > FVulkanDescriptorSetWriter::BaseWrittenMask
protected

◆ bHasVolatileResources

bool FVulkanDescriptorSetWriter::bHasVolatileResources = false
protected

◆ BindingToDynamicOffsetMap

uint8* FVulkanDescriptorSetWriter::BindingToDynamicOffsetMap
protected

◆ bIsKeyDirty

bool FVulkanDescriptorSetWriter::bIsKeyDirty
mutableprotected

◆ DynamicOffsets

uint32* FVulkanDescriptorSetWriter::DynamicOffsets
protected

◆ HashableDescriptorInfos

FVulkanHashableDescriptorInfo* FVulkanDescriptorSetWriter::HashableDescriptorInfos
protected

◆ Key

FVulkanDSetKey FVulkanDescriptorSetWriter::Key
mutableprotected

◆ NumWrites

uint32 FVulkanDescriptorSetWriter::NumWrites
protected

◆ WriteDescriptors

VkWriteDescriptorSet* FVulkanDescriptorSetWriter::WriteDescriptors
protected

◆ WrittenMask

TArray<uint32, TInlineAllocator<2> > FVulkanDescriptorSetWriter::WrittenMask
protected

The documentation for this class was generated from the following files: