VulkanVertexManager.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Graphics
File: VulkanVertexManager
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "VulkanDefines.h"
#include "VulkanBuffer.h"
#include "VulkanShader.h"
#include <NDEVR/DesignObjectBase.h>
enum VkIndexType;
struct VkVertexInputAttributeDescription;
struct VkVertexInputBindingDescription;
struct VkPipelineShaderStageCreateInfo;
namespace NDEVR
{
    class Scene;
    class GraphicsUpdateArguments;
    class VulkanVertexManager
    {
    public:
        VulkanVertexManager(const ConstPointer<VulkanDevice>& device);
        VulkanVertexManager(const VulkanVertexManager& m_pipeline) = delete;
        ~VulkanVertexManager();
        uint08 bufferHash() const { lib_assert(calculateBufferHash() == m_buffer_hash, "Invalid buffer hash"); return m_buffer_hash; }
        Time lastUpdateTime() const { return m_last_updated_time; }
        Time lastBufferUpdateTime() const { return m_last_buffer_update_time; }
        uint08 calculateBufferHash() const;
        void updateUniformBuffer(GraphicsUpdateArguments& args);
        bool needsPipelineUpdate() const { return m_needs_pipeline_update; }
        void setScene(const Scene& scene);
        void commit();
        void updateExtraBuffer(GraphicsUpdateArguments& args, const StringView& extra_property, bool can_rebuild);
        void updateExtraBuffer(GraphicsUpdateArguments& args, const Scene& scene, const StringView& extra_property, bool can_rebuild);
        void getRenderBuffers(VkBuffer* vertex_buffers, GraphicsUpdateArguments& args, const StringView& extra_property) const;
        VkIndexType indexType() const;
        void getAttributeDescriptions(PrimitiveBuffer<VkVertexInputAttributeDescription>& descriptions, GraphicsUpdateArguments& args, const StringView& extra_property, uint04 offset) const;
        void getBindingDescriptions(PrimitiveBuffer<VkVertexInputBindingDescription>& buffer, GraphicsUpdateArguments& args, const StringView& extra_property, uint04 offset) const;
        VkPipelineShaderStageCreateInfo getShaderCreateInfo(VulkanShaderManager::ShaderType shader_type) const;
        ConstPointer<VulkanShader> getShader(VulkanShaderManager::ShaderType shader_type) const;
        VulkanShaderManager::ShaderType getShaderType(PrimitiveMode mode, bool has_grid, bool has_image, bool simple_allowed, bool has_tangent) const;
        ConstPointer<GraphicsBuffer> indexBuffer() const;
        BitFlag vertexFlags() const { return m_vertex_flags; };
        void createPipeline(GraphicsUpdateArguments& args, DynamicPointer<VulkanShaderManager>& shader_manager);
        void updateBuffers(GraphicsUpdateArguments& args);
#ifdef VULKAN_FAN_CONVERSION
        void setFanToStripBounds(UUID bounds_id, const Bounds<1, uint04>& bounds);
        void clearFanToStripBounds();
        void removeFanToStripBounds(UUID bounds_id);
#endif
        VkVertexInputBindingDescription getExtraDescription(const Scene& scene, const StringView& channel, uint04 offset) const;
        VkVertexInputAttributeDescription getAttribute(const Scene& scene, const StringView& channel, uint04 offset) const;
        ConstPointer<GraphicsBuffer> getRenderBuffer(const Scene& scene, const StringView& channel) const;
        uint04 vertexSize() const { return m_vertex_buffer[cast<uint04>(VertexProperty::Position)]->size(); }
        UUID scene() const { return m_scene; }
    protected:
        UUID m_scene;
 
        void updateShader(DynamicPointer<VulkanShaderManager>& shader_manager);
        void updateBuffer(const Scene& scene, GraphicsUpdateArguments& args, bool can_rebuild);
        void updateIndexBuffer(const Scene& scene, bool can_rebuild);
        void updateVertexBuffer(const Scene& scene, VertexProperty property, bool can_rebuild);
        ConstPointer<VulkanDevice> m_device;
        mutable DynamicPointer<GraphicsBuffer> m_index_buffer;
        mutable DynamicPointer<GraphicsBuffer> m_vertex_buffer[cast<uint04>(VertexProperty::BitFlag) + 1];
        mutable bool m_using_vertex_buffer[cast<uint04>(VertexProperty::BitFlag) + 1] = {false, false, false, false, false, false};
        DynamicPointer<VulkanShaderManager> m_shader_manager;
        mutable Dictionary<String, std::pair<bool, DynamicPointer<GraphicsBuffer>>> m_extra_properties;
        Time m_last_updated_time;
        Time m_last_buffer_update_time = Time(0);
        uint08 m_buffer_hash;
        BitFlag m_vertex_flags;
        bool m_needs_pipeline_update = true;
        bool m_needs_buffer_update = true;
        bool m_needs_index_buffer_update = false;
#ifdef VULKAN_FAN_CONVERSION
        Dictionary<UUID, Bounds<1, uint04>> m_fan_to_strip_sections;
#endif
    };
}