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"

class RV_API RV_VKShaderModule
{
public:
    static RV_VKShaderModule* createModule(
            RV_Instance* inst,
            const UT_String &name,
            VkShaderStageFlagBits stage,
            const UT_Array<uint8_t>& src);

    VkShaderModule getVkShaderModule() const { return myVkModule; }
    VkShaderStageFlagBits getStage() const { return myStage; }
    RV_VKShaderReflect& getReflection() const { return *myReflection; }
    const UT_Array<uint8_t>& getBinary() const { return myBinary; }

    ~RV_VKShaderModule();
    RV_VKShaderModule(const RV_VKShaderModule&) = delete;

protected:
    RV_VKShaderModule(
            RV_Instance* inst,
            const UT_String &name,
            VkShaderStageFlagBits stage,
            const UT_Array<uint8_t>& binary,
            VkShaderModule vk_module);
    VkShaderModule myVkModule = VK_NULL_HANDLE;
    VkShaderStageFlagBits myStage = VK_SHADER_STAGE_VERTEX_BIT;

    RV_Instance* myInst = nullptr;

    UT_String myName;
    UT_Array<uint8_t> myBinary;
    UT_UniquePtr<RV_VKShaderReflect> myReflection;

    friend class RV_VKShaderReflect;
};


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

#endif