VulkanEngine 0.1
Graphics engine using Vulkan
Loading...
Searching...
No Matches
VulkanEngine::Descriptor Class Referenceabstract

#include <Descriptor.h>

Inheritance diagram for VulkanEngine::Descriptor:
VulkanEngine::ShaderImage< format, image_type, tiling, sample_count_flags > VulkanEngine::UniformBuffer< T >

Public Member Functions

 Descriptor (uint32_t _binding, uint32_t _desciptor_count, vk::DescriptorType _vk_descriptor_type, vk::ShaderStageFlags _vk_shader_stage_flags)
 Constructor.
 
 ~Descriptor ()
 Destructor.
 
const vk::DescriptorSetLayoutBinding getVkDescriptorSetLayoutBinding () const
 
const vk::DescriptorPoolSize getVkDescriptorPoolSize () const
 
virtual void appendVkDescriptorSets (std::shared_ptr< std::vector< vk::WriteDescriptorSet > > write_descriptor_sets, std::shared_ptr< std::vector< vk::CopyDescriptorSet > > copy_descriptor_sets, const vk::DescriptorSet &destination_set)=0
 

Protected Attributes

uint32_t binding
 The binding index.
 
uint32_t descriptor_count
 The number of descriptors represented.
 
vk::DescriptorType vk_descriptor_type
 The type of descriptor represented.
 
vk::ShaderStageFlags vk_shader_stage_flags
 

Detailed Description

Base class for any classes which interface with the Vulkan resource descriptor concept.

Member Function Documentation

◆ appendVkDescriptorSets()

virtual void VulkanEngine::Descriptor::appendVkDescriptorSets ( std::shared_ptr< std::vector< vk::WriteDescriptorSet > >  write_descriptor_sets,
std::shared_ptr< std::vector< vk::CopyDescriptorSet > >  copy_descriptor_sets,
const vk::DescriptorSet &  destination_set 
)
pure virtual

Appends any write descriptor sets or copy descriptor sets which belong to this Descriptor to the given vectors.

Parameters
[out]write_descriptor_setsAny vk::WriteDescriptorSets of the descriptor should be appended to this vector.
[out]copy_descriptor_setsAny vk::CopyDescriptorSets of the descriptor should be appended to this vector.
destination_setThe destination descriptor set of the write and copy descriptor sets.

Implemented in VulkanEngine::ShaderImage< format, image_type, tiling, sample_count_flags >, and VulkanEngine::UniformBuffer< T >.

◆ getVkDescriptorPoolSize()

const vk::DescriptorPoolSize VulkanEngine::Descriptor::getVkDescriptorPoolSize ( ) const
Returns
A vk::DescriptorPoolSize describing this descriptor for creating a descriptor pool.

◆ getVkDescriptorSetLayoutBinding()

const vk::DescriptorSetLayoutBinding VulkanEngine::Descriptor::getVkDescriptorSetLayoutBinding ( ) const
Returns
The vk::DescriptorSetLayoutBinding for this UniformBuffer.

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