Mandrill 2025.6.0
Loading...
Searching...
No Matches
Mandrill::Descriptor Class Reference

Descriptor class for managing Vulkan descriptor sets. More...

#include <Descriptor.h>

Public Member Functions

MANDRILL_API Descriptor (ptr< Device > pDevice, const std::vector< DescriptorDesc > &desc, VkDescriptorSetLayout layout)
 Create a new descriptor.
 
MANDRILL_API ~Descriptor ()
 Destructor for descriptor.
 
MANDRILL_API void bind (VkCommandBuffer cmd, VkPipelineBindPoint bindPoint, VkPipelineLayout pipelineLayout, uint32_t firstSet, std::vector< uint32_t > offsets)
 Bind descriptor with vector of dynamic offsets.
 
MANDRILL_API void bind (VkCommandBuffer cmd, VkPipelineBindPoint bindPoint, VkPipelineLayout pipelineLayout, uint32_t firstSet, uint32_t offset)
 Bind descriptor with one dynamic offset.
 
MANDRILL_API void bind (VkCommandBuffer cmd, VkPipelineBindPoint bindPoint, VkPipelineLayout pipelineLayout, uint32_t firstSet)
 Bind descriptor.
 
MANDRILL_API VkDescriptorSet getSet () const
 Get the descriptor set handle.
 

Detailed Description

Descriptor class for managing Vulkan descriptor sets.

Constructor & Destructor Documentation

◆ Descriptor()

Descriptor::Descriptor ( ptr< Device pDevice,
const std::vector< DescriptorDesc > &  desc,
VkDescriptorSetLayout  layout 
)

Create a new descriptor.

Parameters
pDeviceDevice to use
descDescription of the descriptor being created
layoutLayout to use

Member Function Documentation

◆ bind() [1/3]

MANDRILL_API void Mandrill::Descriptor::bind ( VkCommandBuffer  cmd,
VkPipelineBindPoint  bindPoint,
VkPipelineLayout  pipelineLayout,
uint32_t  firstSet 
)
inline

Bind descriptor.

Parameters
cmdCommand buffer to use
bindPointBind point in pipeline
pipelineLayoutLayout of pipeline
firstSetAt which index to put the start of the descriptor
Returns

◆ bind() [2/3]

MANDRILL_API void Mandrill::Descriptor::bind ( VkCommandBuffer  cmd,
VkPipelineBindPoint  bindPoint,
VkPipelineLayout  pipelineLayout,
uint32_t  firstSet,
std::vector< uint32_t >  offsets 
)
inline

Bind descriptor with vector of dynamic offsets.

Parameters
cmdCommand buffer to use
bindPointBind point in pipeline
pipelineLayoutLayout of pipeline
firstSetAt which index to put the start of the descriptor
offsetsVector of dynamic offsets
Returns

◆ bind() [3/3]

MANDRILL_API void Mandrill::Descriptor::bind ( VkCommandBuffer  cmd,
VkPipelineBindPoint  bindPoint,
VkPipelineLayout  pipelineLayout,
uint32_t  firstSet,
uint32_t  offset 
)
inline

Bind descriptor with one dynamic offset.

Parameters
cmdCommand buffer to use
bindPointBind point in pipeline
pipelineLayoutLayout of pipeline
firstSetAt which index to put the start of the descriptor
offsetA dynamic offset
Returns

◆ getSet()

MANDRILL_API VkDescriptorSet Mandrill::Descriptor::getSet ( ) const
inline

Get the descriptor set handle.

Returns
Descriptor set handle

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