vsg: include/vsg/vk/DescriptorPool.h Source File

vsg 1.1.3 VulkanSceneGraph library

Loading...
Searching...
No Matches
DescriptorPool.h
1#pragma once
2
3/* <editor-fold desc="MIT License">
4
5Copyright(c) 2018 Robert Osfield
6
7Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8
9The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10
11THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
12
13</editor-fold> */
14
15#include <vsg/state/DescriptorSet.h>
16
17namespace vsg
18{
19
21 class VSG_DECLSPEC DescriptorPool : public Inherit<Object, DescriptorPool>
22 {
23 public:
24 DescriptorPool(Device* device, uint32_t maxSets, const DescriptorPoolSizes& descriptorPoolSizes);
25
26 operator VkDescriptorPool() const { return _descriptorPool; }
27 VkDescriptorPool vk() const { return _descriptorPool; }
28
29 Device* getDevice() { return _device; }
30 const Device* getDevice() const { return _device; }
31
33 ref_ptr<DescriptorSet::Implementation> allocateDescriptorSet(DescriptorSetLayout* descriptorSetLayout);
34
36 void freeDescriptorSet(ref_ptr<DescriptorSet::Implementation> dsi);
37
39 bool getAvailability(uint32_t& maxSets, DescriptorPoolSizes& descriptorPoolSizes) const;
40
44 mutable std::mutex mutex;
45
46 protected:
47 virtual ~DescriptorPool();
48
49 VkDescriptorPool _descriptorPool;
50 ref_ptr<Device> _device;
51
52 uint32_t _availableDescriptorSet;
53 DescriptorPoolSizes _availableDescriptorPoolSizes;
54
55 std::list<ref_ptr<DescriptorSet::Implementation>> _recyclingList;
56 };
57 VSG_type_name(vsg::DescriptorPool);
58
59} // namespace vsg
vsg::DescriptorPool
DescriptorPool encapsulates management of VkDescriptorPool.
Definition DescriptorPool.h:22
vsg::DescriptorPool::allocateDescriptorSet
ref_ptr< DescriptorSet::Implementation > allocateDescriptorSet(DescriptorSetLayout *descriptorSetLayout)
allocate or reuse available DescriptorSet::Implementation - called automatically when compiling Descr...
vsg::DescriptorPool::freeDescriptorSet
void freeDescriptorSet(ref_ptr< DescriptorSet::Implementation > dsi)
free DescriptorSet::Implementation for reuse - called automatically by destruction of DescriptorSet o...
vsg::DescriptorPool::getAvailability
bool getAvailability(uint32_t &maxSets, DescriptorPoolSizes &descriptorPoolSizes) const
get the stats of the available DescriptorSets/Descriptors
vsg::DescriptorPool::mutex
std::mutex mutex
Definition DescriptorPool.h:44
vsg::DescriptorSetLayout
DescriptorSetLayout encapsulates VkDescriptorSetLayout and VkDescriptorSetLayoutCreateInfo settings u...
Definition DescriptorSetLayout.h:28
vsg::Device
Device encapsulates VkDevice, a logical handle to the PhysicalDevice with capabilities specified duri...
Definition Device.h:37
vsg::Inherit
Definition Inherit.h:28
vsg::ref_ptr
Definition ref_ptr.h:22