RV_VKShaderModule.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        RV_VKShaderModule.h ( RV Library, C++)
 *
 * COMMENTS:
 *      Shader Modules for Vulkan Pipelines
 */

#ifndef RV_VKShaderModule_h
#define RV_VKShaderModule_h

#include "RV_API.h"

#include <UT/UT_String.h>

#include <VE/VE_VK.h>
#include "RV_Instance.h"
#include "RV_VKEnum.h"
#include "RV_VKShaderReflect.h"

#include <UT/UT_NonCopyable.h>

class RV_VKShaderModuleInfo;
class RV_VKShaderModule;

/// RAII wrapper class for Vk Shader Module
class RV_API RV_VKShaderModule
{
public:
    ~RV_VKShaderModule();
    UT_NON_COPYABLE(RV_VKShaderModule);

    /// create a shader module with an info struct. Allows safety checks to 
    /// be done before creation loaded
    static RV_VKShaderModulePtr create(
            RV_Instance* inst,
            const RV_VKShaderModuleInfo *info);

    /// create a module from raw binary. Must be valid SPIR-V binary for the instance,
    /// or will get undefined behavior
    static RV_VKShaderModulePtr create(
            RV_Instance* inst,
            const UT_Array<uint8>& binary,
            VkShaderStageFlagBits stage);

    VkShaderModule getVkShaderModule() const { return myVkModule; }
    VkShaderStageFlagBits getStage() const { return myStage; }

    RV_VKShaderModule(
            RV_Instance* inst,
            VkShaderStageFlagBits stage,
            VkShaderModule vk_module);

    RV_Instance* myInst = nullptr;
    VkShaderModule myVkModule = VK_NULL_HANDLE;
    VkShaderStageFlagBits myStage = VK_SHADER_STAGE_VERTEX_BIT;
};

/// Info loaded from file, used to create VK Shader Module
class RV_API RV_VKShaderModuleInfo
{
public:
    ~RV_VKShaderModuleInfo();
    UT_NON_COPYABLE(RV_VKShaderModuleInfo);

    static RV_VKShaderModuleInfoPtr create(
            RV_Instance* inst,
            const UT_String &name,
            VkShaderStageFlagBits stage,
            const UT_Array<uint8>& src);

    VkShaderStageFlagBits getStage() const
        {   return myStage;   }

    RV_VKShaderReflect& getReflection() const
        {
            UT_ASSERT(myReflection);
            return *myReflection;
        }

    const UT_Array<uint8>& getBinary() const
        {
            UT_ASSERT(myBinary.size() > 0);
            return myBinary;
        }

    RV_VKShaderModuleInfo(
            const UT_String &name,
            VkShaderStageFlagBits stage,
            const UT_Array<uint8>& binary,
            UT_UniquePtr<RV_VKShaderReflect> reflection);
protected:
    VkShaderStageFlagBits myStage = VK_SHADER_STAGE_VERTEX_BIT;
    UT_String myName;
    UT_Array<uint8> myBinary;
    UT_UniquePtr<RV_VKShaderReflect> myReflection;

    friend class RV_VKShaderReflect;
};

RV_API RV_VKShaderModuleInfoPtr RVloadShaderFileSource(
            RV_Instance* inst,
            const UT_StringHolder& name,
            VkShaderStageFlagBits stage,
            const char* filename);

#endif