RV_VKShaderReflect.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_VKShaderReflect.h ( RV Library, C++)
 *
 * COMMENTS:
 *      Shader Reflection for SPIR-V modules
 */

#ifndef RV_VKShaderReflect_h
#define RV_VKShaderReflect_h

#include "RV_API.h"

#include "RV_VKPipelineLayout.h" // for RV_VKPushConstantInfo

#include <VE/VE_PhysicalDeviceFeatures.h>

#include <UT/UT_Array.h>
#include <UT/UT_UniquePtr.h>

struct RV_SpvReflectionImpl;
class RV_VKShaderModuleInfo;
class RV_VKDescriptorSetInfo;

class RV_API RV_VKShaderReflect
{
public:
    RV_VKShaderReflect(const RV_VKShaderModuleInfo *module);
    RV_VKShaderReflect(const UT_Array<uint8_t> &binary, VkShaderStageFlagBits stage);
    ~RV_VKShaderReflect();

    RV_VKShaderReflect(const RV_VKShaderReflect& ) = delete;

    // Get Descriptor Layouts
    UT_Array<RV_VKDescriptorSetInfo> getDescriptorLayouts();

    // Get shader stage input variables
    UT_Array<RV_VKAttributeInfo> getInputs();

    // Get shader stage output variables
    UT_Array<RV_VKAttributeInfo> getOutputs();

    // get Push constant ranges
    RV_VKPushConstantInfo getPushConstants();

    // get required Vulkan features to use shader
    VE_PhysicalDeviceFeatures getRequiredFeatures();

    // set required Vulkan features in passed in struct
    void getRequiredFeatures(VE_PhysicalDeviceFeatures &feat);

    // Get the local work group size for compute shaders,
    // or the ids if they are declared as specialization 
    // constants. Sets `is_id` true if the values are ids.
    // returns false if the shader is not compute
    bool getLocalWorkGroupSize(int32& x, int32& y, int32& z, bool& is_id);
    
#if 0
    // Get shader stage output variables
    void* RV_VKShaderReflect::getShaderOutputs();
    // get Specialization Constants
    void* RV_VKShaderReflect::getShaderSpecConstants();
#endif

private:
    UT_UniquePtr<RV_SpvReflectionImpl> myImpl;
    friend RV_SpvReflectionImpl;
};

#endif