ShaderParams.hpp

Go to the documentation of this file.

/**********************************************************************************/
/* This file is part of Berserk Engine project                                    */
/* https://github.com/EgorOrachyov/Berserk                                        */
/**********************************************************************************/
/* MIT License                                                                    */
/*                                                                                */
/* Copyright (c) 2018 - 2021 Egor Orachyov                                        */
/*                                                                                */
/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
/* of this software and associated documentation files (the "Software"), to deal  */
/* in the Software without restriction, including without limitation the rights   */
/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
/* copies of the Software, and to permit persons to whom the Software is          */
/* furnished to do so, subject to the following conditions:                       */
/*                                                                                */
/* 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.                                                                      */
/**********************************************************************************/
 
#ifndef BERSERK_SHADERPARAMS_HPP
#define BERSERK_SHADERPARAMS_HPP
 
#include <core/Config.hpp>
#include <core/Typedefs.hpp>
#include <core/string/StringName.hpp>
#include <rhi/RHIDefs.hpp>
 
#include <unordered_map>
#include <vector>
 
BRK_NS_BEGIN
 
enum class ShaderParamType : uint8 {
    Texture,
    Data,
    Unknown
};
 
struct ShaderParam {
    StringName name;
    StringName uiName;
    String description;
    String defaultValue;
    uint32 arraySize = 1;
    uint32 info = 0xffffffff;
    ShaderParamType type = ShaderParamType::Unknown;
    RHIShaderDataType typeData = RHIShaderDataType::Unknown;
    RHIShaderParamType typeParam = RHIShaderParamType::Unknown;
};
 
class ShaderParams final : public RefCnt {
public:
    static const uint32 INVALID_ID = 0xffffffff;
 
    struct ShaderParamLight {
        uint32 info = 0xffffffff;
        uint32 arraySize = 0u;
        ShaderParamType type = ShaderParamType::Unknown;
        RHIShaderDataType typeData = RHIShaderDataType::Unknown;
        RHIShaderParamType typeParam = RHIShaderParamType::Unknown;
    };
 
    struct DataParamInfo {
        uint32 offset = 0;
        uint32 size = 0;
    };
 
    struct TextureParamInfo {
        uint32 offset = 0;
    };
 
    BRK_API explicit ShaderParams(std::vector<ShaderParam> params);
    BRK_API ~ShaderParams() override = default;
 
    BRK_API bool HasParam(const StringName &name) const;
 
    BRK_API uint32 GetParamId(const StringName &name) const;
    BRK_API const ShaderParam *GetParam(const StringName &name) const;
    BRK_API const ShaderParamLight *GetParamLight(const StringName &name) const;
    BRK_API const ShaderParam &GetParam(uint32 id) const;
    BRK_API const ShaderParamLight &GetParamLight(uint32 id) const;
 
    BRK_API const std::unordered_map<StringName, uint32> &GetParamLookUp() const { return mParamLookUp; }
    BRK_API const std::vector<ShaderParam> &GetParams() const { return mParams; }
    BRK_API const std::vector<ShaderParamLight> &GetParamsLight() const { return mParamsLight; }
    BRK_API const std::vector<DataParamInfo> &GetDataParamsInfo() const { return mDataParamsInfo; }
    BRK_API const std::vector<TextureParamInfo> &GetTextureParamsInfo() const { return mTextureParamsInfo; }
    BRK_API const std::vector<unsigned char> &GetDefaultDataValues() const { return mDefaultDataValues; }
 
    uint32 GetDataSize() const { return mDataSize; }
    uint32 GetTexturesCount() const { return mTexturesCount; }
 
protected:
    void Build();
    void InitDefaults();
 
private:
    std::unordered_map<StringName, uint32> mParamLookUp; 
    std::vector<ShaderParam> mParams;                    
    std::vector<ShaderParamLight> mParamsLight;          
    std::vector<DataParamInfo> mDataParamsInfo;          
    std::vector<TextureParamInfo> mTextureParamsInfo;    
    std::vector<unsigned char> mDefaultDataValues;       
    uint32 mDataSize = 0;                                
    uint32 mTexturesCount = 0;                           
};
 
BRK_NS_END
 
#endif//BERSERK_SHADERPARAMS_HPP