VulkanRenderDefinition.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: VulkanRenderDefinition
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "VulkanDefines.h"
#include "VulkanDevice.h"
#include "Base/Headers/Pointer.hpp"
#include "Base/Headers/Buffer.hpp"
struct VkAttachmentDescription;
DEFINE_NON_DISPATCHABLE_HANDLE(VkRenderPass);
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Creates specific information for performing a render pass within Vulkan.
    **/
    class VulkanRenderDefinition
    {
    public:
        VulkanRenderDefinition(const DynamicPointer<VulkanDevice>& instance);
        ~VulkanRenderDefinition();
        void cleanup();
        void setDevice(const ConstPointer<VulkanDevice>& instance);
        void createRenderPass(uint04 multisample, bool is_grab_image);
        Buffer<VkAttachmentDescription, uint04, ObjectAllocator<true>> getAttachments(uint04 multisample_count, bool is_grab_image, uint08 format) const;
        VkRenderPass renderPass(uint04 multisample, bool is_grab_image) const;
        void setSwapChainImageFormat(VkFormat format) { m_swap_chain_image_format = format; };
        VkFormat getSwapChainImageFormat(bool is_grab_image) const;
    protected:
        ConstPointer<VulkanDevice> m_device;
        Dictionary<uint04, VkRenderPass> m_render_pass_khr;
        Dictionary<uint04, VkRenderPass> m_render_pass_grab;
        VkFormat m_swap_chain_image_format;
        bool m_use_depth;
 
    };
}