shadow.h

Go to the documentation of this file.

#pragma once
#include "glm/gtc/type_ptr.hpp"
#include <engine/engine_export.h>
 
#include <engine/ecs/ecs.h>
#include <engine/rendering/camera.h>
#include <engine/rendering/light.h>
#include <engine/rendering/batch_collector.h>
#include <engine/rendering/model.h>
#include <engine/rendering/pipeline/pipeline.h>
 
#include <base/basetypes.hpp>
#include <context/context.hpp>
 
#include <engine/ecs/ecs.h>
#include <engine/rendering/gpu_program.h>
#include <graphics/graphics.h>
#include <hpp/small_vector.hpp>
 
namespace unravel
{
namespace shadow
{
struct LightType
{
    enum Enum
    {
        SpotLight,
        PointLight,
        DirectionalLight,
 
        Count
    };
};
 
struct DepthImpl
{
    enum Enum
    {
        InvZ,
        Linear,
 
        Count
    };
};
 
struct PackDepth
{
    enum Enum
    {
        RGBA,
        VSM,
 
        Count
    };
};
 
struct SmImpl
{
    enum Enum
    {
        Hard,
        PCF,
        PCSS,
        VSM,
        ESM,
 
        Count
    };
};
 
struct SmType
{
    enum Enum
    {
        Single,
        Omni,
        Cascade,
 
        Count
    };
};
 
struct TetrahedronFaces
{
    enum Enum
    {
        Green,
        Yellow,
        Blue,
        Red,
 
        Count
    };
};
 
struct ProjType
{
    enum Enum
    {
        Horizontal,
        Vertical,
 
        Count
    };
};
 
struct ShadowMapRenderTargets
{
    enum Enum
    {
        First,
        Second,
        Third,
        Fourth,
 
        Count
    };
};
 
struct PosNormalTexcoordVertex
{
    float m_x;
    float m_y;
    float m_z;
    uint32_t m_normal;
    float m_u;
    float m_v;
};
 
struct Light
{
    union Position
    {
        struct
        {
            float m_x;
            float m_y;
            float m_z;
            float m_w;
        };
 
        float m_v[4];
    };
 
    union SpotDirectionInner
    {
        struct
        {
            float m_x;
            float m_y;
            float m_z;
            float m_inner;
        };
 
        float m_v[4];
    };
 
    Position m_position;
    SpotDirectionInner m_spotDirectionInner;
};
 
struct Uniforms
{
    void init()
    {
        m_ambientPass = 1.0f;
        m_lightingPass = 1.0f;
 
        m_shadowMapBias = 0.003f;
        m_shadowMapOffset = 0.0f;
        m_shadowMapParam0 = 0.5;
        m_shadowMapParam1 = 1.0;
        m_depthValuePow = 1.0f;
        m_showSmCoverage = 1.0f;
        m_shadowMapTexelSize = 1.0f / 512.0f;
 
        m_csmFarDistances[0] = 30.0f;
        m_csmFarDistances[1] = 90.0f;
        m_csmFarDistances[2] = 180.0f;
        m_csmFarDistances[3] = 1000.0f;
 
        m_tetraNormalGreen[0] = 0.0f;
        m_tetraNormalGreen[1] = -0.57735026f;
        m_tetraNormalGreen[2] = 0.81649661f;
 
        m_tetraNormalYellow[0] = 0.0f;
        m_tetraNormalYellow[1] = -0.57735026f;
        m_tetraNormalYellow[2] = -0.81649661f;
 
        m_tetraNormalBlue[0] = -0.81649661f;
        m_tetraNormalBlue[1] = 0.57735026f;
        m_tetraNormalBlue[2] = 0.0f;
 
        m_tetraNormalRed[0] = 0.81649661f;
        m_tetraNormalRed[1] = 0.57735026f;
        m_tetraNormalRed[2] = 0.0f;
 
        m_XNum = 2.0f;
        m_YNum = 2.0f;
        m_XOffset = 10.0f / 512.0f;
        m_YOffset = 10.0f / 512.0f;
 
        u_params0 = bgfx::createUniform("u_params0", bgfx::UniformType::Vec4);
        u_params1 = bgfx::createUniform("u_params1", bgfx::UniformType::Vec4);
        u_params2 = bgfx::createUniform("u_params2", bgfx::UniformType::Vec4);
        u_color = bgfx::createUniform("u_color", bgfx::UniformType::Vec4);
        u_smSamplingParams = bgfx::createUniform("u_smSamplingParams", bgfx::UniformType::Vec4);
        u_csmFarDistances = bgfx::createUniform("u_csmFarDistances", bgfx::UniformType::Vec4);
        u_lightMtx = bgfx::createUniform("u_lightMtx", bgfx::UniformType::Mat4);
 
        u_tetraNormalGreen = bgfx::createUniform("u_tetraNormalGreen", bgfx::UniformType::Vec4);
        u_tetraNormalYellow = bgfx::createUniform("u_tetraNormalYellow", bgfx::UniformType::Vec4);
        u_tetraNormalBlue = bgfx::createUniform("u_tetraNormalBlue", bgfx::UniformType::Vec4);
        u_tetraNormalRed = bgfx::createUniform("u_tetraNormalRed", bgfx::UniformType::Vec4);
 
        u_shadowMapMtx0 = bgfx::createUniform("u_shadowMapMtx0", bgfx::UniformType::Mat4);
        u_shadowMapMtx1 = bgfx::createUniform("u_shadowMapMtx1", bgfx::UniformType::Mat4);
        u_shadowMapMtx2 = bgfx::createUniform("u_shadowMapMtx2", bgfx::UniformType::Mat4);
        u_shadowMapMtx3 = bgfx::createUniform("u_shadowMapMtx3", bgfx::UniformType::Mat4);
 
        u_shadowCutoutBaseColor = bgfx::createUniform("u_base_color", bgfx::UniformType::Vec4);
        u_shadowCutoutSurfaceData = bgfx::createUniform("u_surface_data", bgfx::UniformType::Vec4);
        u_shadowCutoutTiling = bgfx::createUniform("u_tiling", bgfx::UniformType::Vec4);
        s_shadowCutoutColor = bgfx::createUniform("s_tex_color", bgfx::UniformType::Sampler);
    }
 
    void setPtrs(Light* _lightPtr,
                 float* _colorPtr,
                 float* _lightMtxPtr,
                 float* _shadowMapMtx0,
                 float* _shadowMapMtx1,
                 float* _shadowMapMtx2,
                 float* _shadowMapMtx3)
    {
        m_lightMtxPtr = _lightMtxPtr;
        m_colorPtr = _colorPtr;
        m_lightPtr = _lightPtr;
 
        m_shadowMapMtx0 = _shadowMapMtx0;
        m_shadowMapMtx1 = _shadowMapMtx1;
        m_shadowMapMtx2 = _shadowMapMtx2;
        m_shadowMapMtx3 = _shadowMapMtx3;
    }
 
    // Call this once at initialization (frame uniforms persist until changed).
    void submitConstUniforms() const
    {
        bgfx::setUniform(u_tetraNormalGreen, m_tetraNormalGreen);
        bgfx::setUniform(u_tetraNormalYellow, m_tetraNormalYellow);
        bgfx::setUniform(u_tetraNormalBlue, m_tetraNormalBlue);
        bgfx::setUniform(u_tetraNormalRed, m_tetraNormalRed);
    }
 
    // Call this once per frame.
    void submitPerFrameUniforms() const
    {
        bgfx::setUniform(u_params1, m_params1);
        bgfx::setUniform(u_params2, m_params2);
        bgfx::setUniform(u_smSamplingParams, m_paramsBlur);
        bgfx::setUniform(u_csmFarDistances, m_csmFarDistances);
    }
 
    // Call this before each draw call.
    void submitPerDrawUniforms() const
    {
        submitConstUniforms();
        submitPerFrameUniforms();
        bgfx::setUniform(u_shadowMapMtx0, m_shadowMapMtx0);
        bgfx::setUniform(u_shadowMapMtx1, m_shadowMapMtx1);
        bgfx::setUniform(u_shadowMapMtx2, m_shadowMapMtx2);
        bgfx::setUniform(u_shadowMapMtx3, m_shadowMapMtx3);
 
        bgfx::setUniform(u_params0, m_params0);
        bgfx::setUniform(u_lightMtx, m_lightMtxPtr);
        bgfx::setUniform(u_color, m_colorPtr);
    }
 
    void submitShadowCutoutState(const shadow_cutout_state& cutout) const
    {
        if(cutout.color_map)
        {
            bgfx::setTexture(0, s_shadowCutoutColor, cutout.color_map->native_handle());
        }
        bgfx::setUniform(u_shadowCutoutBaseColor, math::value_ptr(cutout.base_color.value));
        const math::vec4 surface_data{0.0f, 0.0f, 0.0f, cutout.alpha_test_value};
        bgfx::setUniform(u_shadowCutoutSurfaceData, math::value_ptr(surface_data));
        const math::vec4 tiling{cutout.tiling.x, cutout.tiling.y, 0.0f, 0.0f};
        bgfx::setUniform(u_shadowCutoutTiling, math::value_ptr(tiling));
    }
 
    void destroy()
    {
        auto safe_destroy = [](bgfx::UniformHandle& handle)
        {
            if(bgfx::isValid(handle))
            {
                bgfx::destroy(handle);
                handle = {bgfx::kInvalidHandle};
            }
        };
        safe_destroy(u_params0);
        safe_destroy(u_params1);
        safe_destroy(u_params2);
        safe_destroy(u_color);
        safe_destroy(u_smSamplingParams);
        safe_destroy(u_csmFarDistances);
 
        safe_destroy(u_tetraNormalGreen);
        safe_destroy(u_tetraNormalYellow);
        safe_destroy(u_tetraNormalBlue);
        safe_destroy(u_tetraNormalRed);
 
        safe_destroy(u_shadowMapMtx0);
        safe_destroy(u_shadowMapMtx1);
        safe_destroy(u_shadowMapMtx2);
        safe_destroy(u_shadowMapMtx3);
 
        safe_destroy(u_shadowCutoutBaseColor);
        safe_destroy(u_shadowCutoutSurfaceData);
        safe_destroy(u_shadowCutoutTiling);
        safe_destroy(s_shadowCutoutColor);
 
        safe_destroy(u_lightMtx);
    }
 
    union
    {
        struct
        {
            float m_ambientPass;
            float m_lightingPass;
            float m_unused00;
            float m_numSplits;
        };
 
        float m_params0[4];
    };
 
    union
    {
        struct
        {
            float m_shadowMapBias;
            float m_shadowMapOffset;
            float m_shadowMapParam0;
            float m_shadowMapParam1;
        };
 
        float m_params1[4];
    };
 
    union
    {
        struct
        {
            float m_depthValuePow;
            float m_showSmCoverage;
            float m_shadowMapTexelSize;
            float m_unused23;
        };
 
        float m_params2[4];
    };
 
    union
    {
        struct
        {
            float m_XNum;
            float m_YNum;
            float m_XOffset;
            float m_YOffset;
        };
 
        float m_paramsBlur[4];
    };
 
    float m_tetraNormalGreen[3];
    float m_tetraNormalYellow[3];
    float m_tetraNormalBlue[3];
    float m_tetraNormalRed[3];
    float m_csmFarDistances[4];
 
    float* m_lightMtxPtr;
    float* m_colorPtr;
    Light* m_lightPtr;
    float* m_shadowMapMtx0;
    float* m_shadowMapMtx1;
    float* m_shadowMapMtx2;
    float* m_shadowMapMtx3;
 
private:
    bgfx::UniformHandle u_params0;
    bgfx::UniformHandle u_params1;
    bgfx::UniformHandle u_params2;
    bgfx::UniformHandle u_color;
    bgfx::UniformHandle u_smSamplingParams;
    bgfx::UniformHandle u_csmFarDistances;
 
    bgfx::UniformHandle u_tetraNormalGreen;
    bgfx::UniformHandle u_tetraNormalYellow;
    bgfx::UniformHandle u_tetraNormalBlue;
    bgfx::UniformHandle u_tetraNormalRed;
 
    bgfx::UniformHandle u_shadowMapMtx0;
    bgfx::UniformHandle u_shadowMapMtx1;
    bgfx::UniformHandle u_shadowMapMtx2;
    bgfx::UniformHandle u_shadowMapMtx3;
 
    bgfx::UniformHandle u_shadowCutoutBaseColor;
    bgfx::UniformHandle u_shadowCutoutSurfaceData;
    bgfx::UniformHandle u_shadowCutoutTiling;
    bgfx::UniformHandle s_shadowCutoutColor;
 
    bgfx::UniformHandle u_lightMtx;
};
 
struct RenderState
{
    enum Enum
    {
        Default = 0,
 
        ShadowMap_PackDepth,
        ShadowMap_PackDepthHoriz,
        ShadowMap_PackDepthVert,
 
        Custom_BlendLightTexture,
        Custom_DrawPlaneBottom,
 
        Count
    };
 
    uint64_t m_state;
    uint32_t m_blendFactorRgba;
    uint32_t m_fstencil;
    uint32_t m_bstencil;
};
 
struct PosColorTexCoord0Vertex : gfx::vertex<PosColorTexCoord0Vertex>
{
    float m_x;
    float m_y;
    float m_z;
    uint32_t m_rgba;
    float m_u;
    float m_v;
 
    static void init(gfx::vertex_layout& decl)
    {
        decl.begin()
            .add(bgfx::Attrib::Position, 3, bgfx::AttribType::Float)
            .add(bgfx::Attrib::Color0, 4, bgfx::AttribType::Uint8, true)
            .add(bgfx::Attrib::TexCoord0, 2, bgfx::AttribType::Float)
            .end();
    }
};
 
struct PosVertex : gfx::vertex<PosVertex>
{
    float m_x;
    float m_y;
    float m_z;
    static void init(gfx::vertex_layout& decl)
    {
        decl.begin().add(bgfx::Attrib::Position, 3, bgfx::AttribType::Float).end();
    }
};
 
struct Programs
{
    void init(rtti::context& ctx);
 
    void destroy()
    {
        // Pack depth.
        for(uint8_t ii = 0; ii < DepthImpl::Count; ++ii)
        {
            for(uint8_t jj = 0; jj < PackDepth::Count; ++jj)
            {
                m_packDepth[ii][jj].reset();
                m_packDepthInstanced[ii][jj].reset();
                m_packDepthSkinned[ii][jj].reset();
                m_packDepthCutout[ii][jj].reset();
                m_packDepthInstancedCutout[ii][jj].reset();
                m_packDepthSkinnedCutout[ii][jj].reset();
            }
        }
 
        // Draw depth.
        for(uint8_t ii = 0; ii < PackDepth::Count; ++ii)
        {
            m_drawDepth[ii].reset();
        }
 
        // Hblur.
        for(uint8_t ii = 0; ii < PackDepth::Count; ++ii)
        {
            m_hBlur[ii].reset();
        }
 
        // Vblur.
        for(uint8_t ii = 0; ii < PackDepth::Count; ++ii)
        {
            m_vBlur[ii].reset();
        }
 
        // Misc.
        m_black.reset();
    }
 
    gpu_program::ptr m_black;
    gpu_program::ptr m_vBlur[PackDepth::Count];
    gpu_program::ptr m_hBlur[PackDepth::Count];
    gpu_program::ptr m_drawDepth[PackDepth::Count];
    gpu_program::ptr m_packDepth[DepthImpl::Count][PackDepth::Count];
    gpu_program::ptr m_packDepthSkinned[DepthImpl::Count][PackDepth::Count];
    gpu_program::ptr m_packDepthInstanced[DepthImpl::Count][PackDepth::Count];
    gpu_program::ptr m_packDepthCutout[DepthImpl::Count][PackDepth::Count];
    gpu_program::ptr m_packDepthSkinnedCutout[DepthImpl::Count][PackDepth::Count];
    gpu_program::ptr m_packDepthInstancedCutout[DepthImpl::Count][PackDepth::Count];
};
 
struct ShadowMapSettings
{
#define SHADOW_FLOAT_PARAM(_name)                                                                                      \
    float _name{}, _name##Min{}, _name##Max{}, _name##Step                                                             \
    {                                                                                                                  \
    }
    SHADOW_FLOAT_PARAM(m_sizePwrTwo);
    SHADOW_FLOAT_PARAM(m_depthValuePow);
    SHADOW_FLOAT_PARAM(m_near);
    SHADOW_FLOAT_PARAM(m_far);
    SHADOW_FLOAT_PARAM(m_bias);
    SHADOW_FLOAT_PARAM(m_normalOffset);
    SHADOW_FLOAT_PARAM(m_customParam0);
    SHADOW_FLOAT_PARAM(m_customParam1);
    SHADOW_FLOAT_PARAM(m_xNum);
    SHADOW_FLOAT_PARAM(m_yNum);
    SHADOW_FLOAT_PARAM(m_xOffset);
    SHADOW_FLOAT_PARAM(m_yOffset);
    bool m_doBlur{};
    gpu_program* m_progPack{};
    gpu_program* m_progPackSkinned{};
    gpu_program* m_progPackInstanced{};
#undef SHADOW_FLOAT_PARAM
};
 
struct SceneSettings
{
    LightType::Enum m_lightType;
    DepthImpl::Enum m_depthImpl;
    SmImpl::Enum m_smImpl;
    float m_spotOuterAngle;
    float m_spotInnerAngle;
    float m_fovXAdjust;
    float m_fovYAdjust;
    float m_coverageSpotL;
    float m_splitDistribution;
    int m_numSplits;
    bool m_updateLights;
    bool m_updateScene;
    bool m_drawDepthBuffer;
    bool m_showSmCoverage;
    bool m_stencilPack;
    bool m_stabilize;
};
 
struct ClearValues
{
    ClearValues(uint32_t _clearRgba = 0x30303000, float _clearDepth = 1.0f, uint8_t _clearStencil = 0)
        : clear_rgba(_clearRgba)
        , clear_depth(_clearDepth)
        , clear_stencil(_clearStencil)
    {
    }
 
    uint32_t clear_rgba;
    float clear_depth;
    uint8_t clear_stencil;
};
 
struct frustum_calculation_method
{
    enum Enum
    {
        legacy,          // Original fixed frustum calculation
        adaptive,        // Altitude-aware adaptive frustum
        hybrid,          // Combination of both approaches
 
        count
    };
};
 
struct csm_optimization_flags
{
    enum Enum
    {
        none                    = 0,
        altitude_compensation   = 1 << 0,  // Adjust frustum based on camera altitude
        scene_bounds_fitting    = 1 << 1,  // Fit to actual scene bounds
        dynamic_split_weights   = 1 << 2,  // Adjust split distribution dynamically
        stabilized_light_matrix = 1 << 3,  // Improve light matrix positioning
 
        all = altitude_compensation | scene_bounds_fitting | dynamic_split_weights | stabilized_light_matrix
    };
};
 
struct adaptive_shadow_params
{
    float altitude_scale_factor = 0.5f;      // How much altitude affects frustum extension
    float min_altitude_boost = 0.05f;       // Minimum altitude compensation
    float max_altitude_boost = 100.0f;      // Maximum altitude compensation
    float scene_bounds_margin = 1.2f;       // Margin factor for scene bounds fitting
    float split_weight_bias = 0.1f;         // Bias for dynamic split weight adjustment
};
 
struct shadow_visibility_data
{
    entt::handle entity;
    unravel::lod_data lod_data;
};
using shadow_map_models_t = hpp::small_vector<shadow_visibility_data>;
 
class shadowmap_generator
{
public:
    shadowmap_generator();
    ~shadowmap_generator();
 
    void init(rtti::context& ctx);
    void deinit();
    void deinit_textures();
    void deinit_uniforms();
 
    void update(const camera& cam, const light& l, const math::transform& ltrans, bool is_active);
    auto already_updated() const -> bool;
 
    void generate_shadowmaps(const shadow_map_models_t& model, const camera& cam, ::unravel::rendering::pipeline_stats* stats = nullptr);
 
    auto get_depth_type() const -> PackDepth::Enum;
    auto get_rt_texture(uint8_t split) const -> bgfx::TextureHandle;
    auto get_depth_render_program(PackDepth::Enum depth) const -> gpu_program::ptr;
    void submit_uniforms(uint8_t stage) const;
 
    // Configuration methods for improved shadow mapping
    void set_frustum_calculation_method(frustum_calculation_method::Enum method) { frustum_method_ = method; }
    auto get_frustum_calculation_method() const -> frustum_calculation_method::Enum { return frustum_method_; }
    
    void set_csm_optimization_flags(uint32_t flags) { csm_optimization_flags_ = flags; }
    auto get_csm_optimization_flags() const -> uint32_t { return csm_optimization_flags_; }
    
    void enable_adaptive_shadows(bool enable) { 
        if(enable) {
            frustum_method_ = frustum_calculation_method::adaptive;
            csm_optimization_flags_ = csm_optimization_flags::all;
        } else {
            frustum_method_ = frustum_calculation_method::legacy;
            csm_optimization_flags_ = csm_optimization_flags::none;
        }
    }
 
    // Adaptive parameter configuration methods
    void set_adaptive_params(const adaptive_shadow_params& params) { adaptive_params_ = params; }
    auto get_adaptive_params() const -> const adaptive_shadow_params& { return adaptive_params_; }
    
    void set_altitude_scale_factor(float factor) { adaptive_params_.altitude_scale_factor = factor; }
    auto get_altitude_scale_factor() const -> float { return adaptive_params_.altitude_scale_factor; }
    
    void set_altitude_boost_range(float min_boost, float max_boost) {
        adaptive_params_.min_altitude_boost = min_boost;
        adaptive_params_.max_altitude_boost = max_boost;
    }
    
    auto get_min_altitude_boost() const -> float { return adaptive_params_.min_altitude_boost; }
    auto get_max_altitude_boost() const -> float { return adaptive_params_.max_altitude_boost; }
 
private:
    auto render_scene_into_shadowmap(uint8_t shadowmap_1_id,
                                     const shadow_map_models_t& models,
                                     const math::frustum frustums[ShadowMapRenderTargets::Count],
                                     ShadowMapSettings* currentSmSettings,
                                     const camera* cam,
                                     ::unravel::rendering::pipeline_stats* stats = nullptr) -> bool;
    
    void submit_batched_shadow_geometry_cascade(shadow_batch_collector& collector,
                                               uint8_t viewId, 
                                               ShadowMapSettings* currentSmSettings,
                                               const RenderState& renderState,
                                               ::unravel::rendering::pipeline_stats* stats = nullptr);
 
    ClearValues clear_values_;
 
    float color_[4];
    Light point_light_;
    Light directional_light_;
 
    float light_mtx_[16];
    float shadow_map_mtx_[ShadowMapRenderTargets::Count][16];
 
    ShadowMapSettings sm_settings_[LightType::Count][DepthImpl::Count][SmImpl::Count];
    SceneSettings settings_;
 
    uint16_t current_shadow_map_size_{};
    uint8_t current_num_splits_{};
 
    Uniforms uniforms_;
    Programs programs_;
 
    float light_view_[ShadowMapRenderTargets::Count][16];
    float light_proj_[ShadowMapRenderTargets::Count][16];
 
    math::frustum light_frustums_[ShadowMapRenderTargets::Count];
 
    bgfx::UniformHandle tex_color_{bgfx::kInvalidHandle};
    bgfx::UniformHandle shadow_map_[ShadowMapRenderTargets::Count];
    bgfx::FrameBufferHandle rt_shadow_map_[ShadowMapRenderTargets::Count];
    bgfx::FrameBufferHandle rt_blur_{bgfx::kInvalidHandle};
 
    bool valid_{};
 
    uint64_t last_update_ = -1;
    
    // Static mesh batching system for shadow maps - one collector per cascade/view
    std::vector<shadow_batch_collector> cascade_batch_collectors_;
    
    std::shared_ptr<int> sentinel_ = std::make_shared<int>(0);
 
    // New configuration members
    frustum_calculation_method::Enum frustum_method_ = frustum_calculation_method::legacy;
    uint32_t csm_optimization_flags_ = csm_optimization_flags::none;
    
    // Additional parameters for adaptive calculations
    adaptive_shadow_params adaptive_params_;
};
 
} // namespace shadow
} // namespace unravel