VulkanShader.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: Shader
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "VulkanDevice.h"
#include "VulkanDefines.h"
#include "Base/Headers/File.h"
#include "Base/Headers/Pointer.hpp"
#include "Base/Headers/Dictionary.h"
DEFINE_NON_DISPATCHABLE_HANDLE(VkShaderModule);
namespace NDEVR
{
    enum class PrimitiveMode;
    class VulkanInstance;
    /**--------------------------------------------------------------------------------------------------
    \brief A shader program used to render data in Vulkan.
    **/
    class VulkanShader
    {
    public:
        VulkanShader(VulkanShader&& device) noexcept;
        VulkanShader(const ConstPointer<VulkanDevice>& device);
        VulkanShader(const File& file, const ConstPointer<VulkanDevice>& device);
        VulkanShader(const Buffer<char>& data, const ConstPointer<VulkanDevice>& device);
        ~VulkanShader();
        void cleanup();
        void setInstance(const ConstPointer<VulkanDevice>& device);
        void createShader(const File& file);
        void createShader(const Buffer<char>& data);
        
        VkShaderModule vkShader() const { return m_shader; }
    private:
        Buffer<char> m_data;
        VkShaderModule m_shader;
        ConstPointer<VulkanDevice> m_device;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Manages all active shaders in a VulkanSession.
    **/
    class VulkanShaderManager
    {
    public:
        enum ShaderType
        {
              e_simple_points
            , e_points
            , e_linework
            , e_solid
            , e_solid_grid
            , e_solid_texture
            , e_shader_type_size//always here
            , e_all
        };
        VulkanShaderManager(const ConstPointer<VulkanDevice>& device);
        void ensureCreated(const String& name);
        ConstPointer<VulkanShader> getShader(const String& file, ShaderType type);
        void addShader(const String& name, ShaderType type, File& file);
        void addShader(const String& name, ShaderType type, const Buffer<char>& data);
        void setInstance(const ConstPointer<VulkanDevice>& device);
        static inline const String formats[6] = { "points_s", "points", "linework", "solid", "solid_grid", "solid_texture" };
    protected:
        Dictionary<uint08, DynamicPointer<VulkanShader>[ShaderType::e_shader_type_size]> m_shader_map;
        Dictionary<uint08, Buffer<char>[ShaderType::e_shader_type_size]> m_data;
        ConstPointer<VulkanDevice> m_device;
    };
}