Material.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_MATERIAL_HPP
#define BERSERK_MATERIAL_HPP
 
#include <core/Config.hpp>
#include <core/Typedefs.hpp>
#include <core/math/TMatMxN.hpp>
#include <core/math/TVecN.hpp>
#include <render/material/MaterialParams.hpp>
#include <render/shader/Shader.hpp>
#include <rhi/RHISampler.hpp>
#include <rhi/RHITexture.hpp>
 
#include <vector>
 
BRK_NS_BEGIN
 
class Material final : public RefCnt {
public:
    BRK_API explicit Material(Ref<const Shader> shader);
 
    BRK_API ~Material() override = default;
 
    BRK_API void SetName(StringName name);
    BRK_API void SetDescription(String description);
 
    BRK_API void SetTexture(const StringName &name, Ref<RHITexture> texture, Ref<RHISampler> sampler, uint32 arrayIndex = 0);
 
    BRK_API void SetFloat1(const StringName &name, float value, uint32 arrayIndex = 0);
 
    BRK_API void SetFloat2(const StringName &name, const Vec2f &value, uint32 arrayIndex = 0);
 
    BRK_API void SetFloat3(const StringName &name, const Vec3f &value, uint32 arrayIndex = 0);
 
    BRK_API void SetFloat4(const StringName &name, const Vec4f &value, uint32 arrayIndex = 0);
 
    BRK_API void SetInt1(const StringName &name, int32 value, uint32 arrayIndex = 0);
 
    BRK_API void SetInt2(const StringName &name, const Vec2i &value, uint32 arrayIndex = 0);
 
    BRK_API void SetInt3(const StringName &name, const Vec3i &value, uint32 arrayIndex = 0);
 
    BRK_API void SetInt4(const StringName &name, const Vec4i &value, uint32 arrayIndex = 0);
 
    BRK_API void SetUInt1(const StringName &name, uint32 value, uint32 arrayIndex = 0);
 
    BRK_API void SetUInt2(const StringName &name, const Vec2u &value, uint32 arrayIndex = 0);
 
    BRK_API void SetUInt3(const StringName &name, const Vec3u &value, uint32 arrayIndex = 0);
 
    BRK_API void SetUInt4(const StringName &name, const Vec4u &value, uint32 arrayIndex = 0);
 
    BRK_API void SetBool1(const StringName &name, bool value, uint32 arrayIndex = 0);
 
    BRK_API void SetBool2(const StringName &name, const Vec2b &value, uint32 arrayIndex = 0);
 
    BRK_API void SetBool3(const StringName &name, const Vec3b &value, uint32 arrayIndex = 0);
 
    BRK_API void SetBool4(const StringName &name, const Vec4b &value, uint32 arrayIndex = 0);
 
    BRK_API void SetMat2(const StringName &name, const Mat2x2f &value, uint32 arrayIndex = 0);
 
    BRK_API void SetMat3(const StringName &name, const Mat3x3f &value, uint32 arrayIndex = 0);
 
    BRK_API void SetMat4(const StringName &name, const Mat4x4f &value, uint32 arrayIndex = 0);
 
    BRK_API void UpdatePack();
 
    BRK_API bool IsDirty() const { return mIsDirty; }
 
    BRK_API const StringName &GetName() const { return mName; }
    BRK_API const String &GetDescription() const { return mDescription; }
    BRK_API const Ref<const Shader> &GetShader() const { return mShader; }
    BRK_API const Ref<const ShaderTechnique> &GetTechnique() const { return mTechnique; }
    BRK_API const ShaderVariation &GetVariation() const { return mShader->GetVariation(); }
 
    BRK_API Ref<const MaterialParams> GetPackedParams() const { return mPackedParams.As<const MaterialParams>(); }
 
private:
    friend class MaterialParams;
 
    void SetDataParam(const StringName &name, RHIShaderDataType type, const void *data, uint32 arrayIndex);
    const std::vector<Ref<RHISampler>> &GetSamplers() const { return mSamplers; }
    const std::vector<Ref<RHITexture>> &GetTextures() const { return mTextures; }
    const std::vector<unsigned char> &GetDataParams() const { return mDataParams; }
 
private:
    StringName mName;    
    String mDescription; 
    Ref<const Shader> mShader;             
    Ref<const ShaderTechnique> mTechnique; 
    Ref<MaterialParams> mPackedParams;     
    std::vector<Ref<RHISampler>> mSamplers; 
    std::vector<Ref<RHITexture>> mTextures; 
    std::vector<unsigned char> mDataParams; 
    bool mIsDirty = true; 
};
 
BRK_NS_END
 
#endif//BERSERK_MATERIAL_HPP