VulkanBuffer.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: VulkanBuffer
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "VulkanDefines.h"
#include "VulkanDevice.h"
#include "NDEVRGraphics/Headers/GraphicsBuffer.h"
#include "Database/Headers/TableColumn.h"
#include "Base/Headers/XYZColor.h"
#include "Base/Headers/ACIColor.h"
#include "Base/Headers/Pointer.hpp"
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Stores bools to be sent to both the Vertex and Fragment shaders in the Vulkan space
    **/
    class VulkanBuffer : public GraphicsBuffer
    {
    public:
        VulkanBuffer(const String& label, const ConstPointer<VulkanDevice>& vulkan_instance);
        VulkanBuffer(const TableColumn& reference_data, const ConstPointer<VulkanDevice>& vulkan_instance);
        VulkanBuffer(VulkanBuffer&& vulkan_buffer) noexcept;
        ~VulkanBuffer();
        void insertRows(uint04 location, uint04 add_size) final override;
        void setSize(uint04 buffer_size) final override;
        void updateRegion(const TableColumn& column, uint04 offset, uint04 size) override;
        void copyData(const TableColumn& reference_data, bool set_type) override;
        void cleanup() override;
 
        VkBuffer getVKBuffer() const;
        VkVertexInputBindingDescription getBindingDescription(uint04 number) const;
        VkFormat getFormat(uint01 vertex_index) const;
        VkFormat getFormat() const;
        void copyBuffer(VkBuffer srcBuffer, VkBuffer dstBuffer, uint04 src_start, uint04 dst_start, uint04 size, bool wait_for_completion);
        void copyData(const VulkanBuffer& reference_data, bool set_type);
    public:
        static uint04 findMemoryType(const VulkanDevice& device, uint04 typeFilter, uint04 properties);
        static VkBuffer createVKBuffer(uint04& allocation_size, const VulkanDevice& device, uint04 size, uint04 object_size, uint04 usage, uint04 properties, VkDeviceMemory& bufferMemory);
    private:
        uint04 getFlags() const;
        void getFromVideoCard(bool copy_existing) override;
        void sendToVideoCard(bool copy_existing) override;
        void* mapMemory(size_t offset, size_t size) const override;
        void unmapMemory() const override;
    private:
        ConstPointer<VulkanDevice> m_device;
        VkDeviceMemory m_device_memory;
        VkBuffer m_vertex_buffer;
    };
}