VulkanVertexManager.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
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 "Design/Headers/Model.h"
#include "VulkanBuffer.h"
#include "VulkanShader.h"
 
enum VkIndexType;
struct VkVertexInputAttributeDescription;
struct VkVertexInputBindingDescription;
struct VkPipelineShaderStageCreateInfo;
namespace NDEVR
{
    class GraphicsUpdateArguments;
    /**--------------------------------------------------------------------------------------------------
    \brief Manages all vertices in a specific Scene object for interfacing with Vulkan.
    **/
    class VulkanVertexManager
    {
    public:
        VulkanVertexManager(const ConstPointer<VulkanDevice>& device);
        VulkanVertexManager(const VulkanVertexManager& m_pipeline) = delete;
        ~VulkanVertexManager();
        Time lastDependencyUpdate() const { return m_last_push_update_time; }
        Time lastUpdateTime() const { return m_last_updated_time; }
        
        void updateUniformBuffer(GraphicsUpdateArguments& args);
 
        void setScene(const Scene& scene);
        void commit();
        void updateExtraBuffer(GraphicsUpdateArguments& args, const String& extra_property);
        void updateExtraBuffer(GraphicsUpdateArguments& args, const Scene& scene, const String& extra_property);
        Buffer<VkBuffer> getRenderBuffers(GraphicsUpdateArguments& args, const String& extra_property) const;
        VkIndexType indexType() const;
        Buffer<VkVertexInputAttributeDescription, uint04, ObjectAllocator<true>> attributeDescriptions(GraphicsUpdateArguments& args, const String& extra_property, uint04 offset) const;
        Buffer<VkVertexInputBindingDescription, uint04, ObjectAllocator<true>> bindingDescriptions(GraphicsUpdateArguments& args, const String& extra_property, uint04 offset) const;
        void getShaderCreateInfo(PrimitiveMode mode, Buffer<VkPipelineShaderStageCreateInfo, uint04, ObjectAllocator<true>>& buffer, bool has_grid, bool has_image) const;
        ConstPointer<VulkanShader> getShader(PrimitiveMode mode, bool has_grid, bool has_image) const;
        ConstPointer<GraphicsBuffer> indexBuffer() const;
        BitFlag vertexFlags() const { return m_vertex_flags; };
        void createPipeline(GraphicsUpdateArguments& args, DynamicPointer<VulkanShaderManager>& shader_manager);
#ifdef VULKAN_FAN_CONVERSION
        void setFanToStripBounds(UUID bounds_id, const Bounds<1, uint04>& bounds);
        void clearFanToStripBounds();
        void removeFanToStripBounds(UUID bounds_id);
#endif
        VkVertexInputBindingDescription getDescription(const Scene& scene, const String& channel, uint04 offset) const;
        VkVertexInputAttributeDescription getAttribute(const Scene& scene, const String& channel, uint04 offset) const;
        ConstPointer<GraphicsBuffer> getRenderBuffer(const Scene& scene, const String& 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(const Scene& scene, GraphicsUpdateArguments& args, DynamicPointer<VulkanShaderManager>& shader_manager);
        void updateBuffer(const Scene& scene, GraphicsUpdateArguments& args);
        void updateIndexBuffer(const Scene& scene, GraphicsUpdateArguments& args);
        void updateVertexBuffer(const Scene& scene, GraphicsUpdateArguments& args, VertexProperty property);
        ConstPointer<VulkanDevice> m_device;
        mutable DynamicPointer<GraphicsBuffer> m_index_buffer;
        mutable DynamicPointer<GraphicsBuffer> m_vertex_flags_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, DynamicPointer<GraphicsBuffer>> m_extra_properties;
        BitFlag m_vertex_flags;
        Time m_last_updated_time;
        Time m_last_push_update_time;
        bool m_needs_pipeline_update;
        bool m_needs_index_buffer_update;
#ifdef VULKAN_FAN_CONVERSION
        Dictionary<UUID, Bounds<1, uint04>> m_fan_to_strip_sections;
#endif
    };
}