ResourceRequirements.h

#pragma once
 
/* <editor-fold desc="MIT License">
 
Copyright(c) 2018 Robert Osfield
 
Permission 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:
 
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
THE 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.
 
</editor-fold> */
 
#include <vsg/nodes/Bin.h>
#include <vsg/state/BufferInfo.h>
#include <vsg/state/Descriptor.h>
#include <vsg/state/ImageInfo.h>
#include <vsg/state/ResourceHints.h>
#include <vsg/vk/DescriptorPool.h>
 
#include <map>
#include <set>
#include <stack>
 
namespace vsg
{
    class VSG_DECLSPEC ResourceRequirements
    {
    public:
        ResourceRequirements(ref_ptr<ResourceHints> hints = {});
        ResourceRequirements(const ResourceRequirements& rhs) = default;
 
        ResourceRequirements& operator=(const ResourceRequirements& rhs) = default;
 
        void apply(const ResourceHints& resourceHints);
 
        uint32_t computeNumDescriptorSets() const;
        DescriptorPoolSizes computeDescriptorPoolSizes() const;
 
        struct BinDetails
        {
            std::set<int32_t> indices;
            std::set<const Bin*> bins;
        };
 
        using Descriptors = std::set<const Descriptor*>;
        using DescriptorSets = std::set<const DescriptorSet*>;
        using DescriptorTypeMap = std::map<VkDescriptorType, uint32_t>;
        using Views = std::map<const View*, BinDetails>;
        using BinStack = std::stack<BinDetails>;
 
        struct DynamicData
        {
            BufferInfoList bufferInfos;
            ImageInfoList imageInfos;
 
            explicit operator bool() const noexcept { return !bufferInfos.empty() || !imageInfos.empty(); }
 
            void clear()
            {
                bufferInfos.clear();
                imageInfos.clear();
            }
 
            void add(const DynamicData& dd)
            {
                bufferInfos.insert(bufferInfos.end(), dd.bufferInfos.begin(), dd.bufferInfos.end());
                imageInfos.insert(imageInfos.end(), dd.imageInfos.begin(), dd.imageInfos.end());
            }
        };
 
        DynamicData earlyDynamicData;
        DynamicData lateDynamicData;
 
        Descriptors descriptors;
        DescriptorSets descriptorSets;
        DescriptorTypeMap descriptorTypeMap;
        Views views;
        BinStack binStack;
 
        uint32_t maxSlot = 0;
        uint32_t externalNumDescriptorSets = 0;
        bool containsPagedLOD = false;
 
        VkDeviceSize minimumBufferSize = 16 * 1024 * 1024;
        VkDeviceSize minimumDeviceMemorySize = 16 * 1024 * 1024;
    };
    VSG_type_name(vsg::ResourceRequirements);
 
    class VSG_DECLSPEC CollectResourceRequirements : public Inherit<ConstVisitor, CollectResourceRequirements>
    {
    public:
        CollectResourceRequirements() { overrideMask = vsg::MASK_ALL; }
 
        ResourceRequirements requirements;
 
        ref_ptr<ResourceHints> createResourceHints(uint32_t tileMultiplier = 1) const;
 
        using ConstVisitor::apply;
 
        bool checkForResourceHints(const Object& object);
 
        void apply(const Object& object) override;
        void apply(const ResourceHints& resourceHints) override;
        void apply(const Node& node) override;
        void apply(const StateGroup& stategroup) override;
        void apply(const StateCommand& stateCommand) override;
        void apply(const DescriptorSet& descriptorSet) override;
        void apply(const Descriptor& descriptor) override;
        void apply(const DescriptorBuffer& descriptorBuffer) override;
        void apply(const DescriptorImage& descriptorImage) override;
        void apply(const PagedLOD& plod) override;
        void apply(const View& view) override;
        void apply(const DepthSorted& depthSorted) override;
        void apply(const Bin& bin) override;
        void apply(const Geometry& geometry) override;
        void apply(const VertexDraw& vid) override;
        void apply(const VertexIndexDraw& vid) override;
        void apply(const BindVertexBuffers& bvb) override;
        void apply(const BindIndexBuffer& bib) override;
 
        inline void apply(ref_ptr<BufferInfo> bufferInfo)
        {
            if (bufferInfo && bufferInfo->data && bufferInfo->data->dynamic())
            {
                if (bufferInfo->data->properties.dataVariance == DYNAMIC_DATA)
                {
                    requirements.earlyDynamicData.bufferInfos.push_back(bufferInfo);
                }
                else // DYNAMIC_DATA_TRANSFER_AFTER_RECORD)
                {
                    requirements.lateDynamicData.bufferInfos.push_back(bufferInfo);
                }
            }
        }
 
        inline void apply(ref_ptr<ImageInfo> imageInfo)
        {
            if (imageInfo && imageInfo->imageView && imageInfo->imageView->image)
            {
                auto& data = imageInfo->imageView->image->data;
                if (data && data->dynamic())
                {
                    if (data->properties.dataVariance == DYNAMIC_DATA)
                    {
                        requirements.earlyDynamicData.imageInfos.push_back(imageInfo);
                    }
                    else // DYNAMIC_DATA_TRANSFER_AFTER_RECORD)
                    {
                        requirements.lateDynamicData.imageInfos.push_back(imageInfo);
                    }
                }
            }
        }
 
    protected:
        uint32_t _numResourceHintsAbove = 0;
 
        bool registerDescriptor(const Descriptor& descriptor);
    };
    VSG_type_name(vsg::CollectResourceRequirements);
 
} // namespace vsg