atmospheric_pass_perez.h

Go to the documentation of this file.

/*
 * This example demonstrates:
 * - Usage of Perez sky model [1] to render a dynamic sky.
 * - Rendering a mesh with a lightmap, shading of which is driven by the same parameters as the sky.
 *
 * Typically, the sky is rendered using cubemaps or other environment maps.
 * This approach can provide a high-quality sky, but the downside is that the
 * image is static. To achieve daytime changes in sky appearance, there is a need
 * in a dynamic model.
 *
 * Perez "An All-Weather Model for Sky Luminance Distribution" is a simple,
 * but good enough model which is, in essence, a function that
 * interpolates a sky color. As input, it requires several turbidity
 * coefficients, a color at zenith and direction to the sun.
 * Turbidity coefficients are taken from [2], which are computed using more
 * complex physically based models. Color at zenith depends on daytime and can
 * vary depending on many factors.
 *
 * In the code below, there are two tables that contain sky and sun luminance
 * which were computed using code from [3]. Luminance in those tables
 * represents actual scale of light energy that comes from sun compared to
 * the sky.
 *
 * The sky is driven by luminance of the sky, while the material of the
 * landscape is driven by both, the luminance of the sky and the sun. The
 * lightening model is very simple and consists of two parts: directional
 * light and hemisphere light. The first is used for the sun while the second
 * is used for the sky. Additionally, the second part is modulated by a
 * lightmap to achieve ambient occlusion effect.
 *
 * References
 * ==========
 *
 * [1] R. Perez, R. Seals, and J. Michalsky."An All-Weather Model for Sky Luminance Distribution".
 *     Solar Energy, Volume 50, Number 3 (March 1993), pp. 235-245.
 *
 * [2] A. J. Preetham, Peter Shirley, and Brian Smits. "A Practical Analytic Model for Daylight",
 *     Proceedings of the 26th Annual Conference on Computer Graphics and Interactive Techniques,
 *     1999, pp. 91-100.
 *     https://www.cs.utah.edu/~shirley/papers/sunsky/sunsky.pdf
 *
 * [3] E. Lengyel, Game Engine Gems, Volume One. Jones & Bartlett Learning, 2010. pp. 219 - 234
 *
 */
 
#pragma once
 
#include <engine/rendering/camera.h>
#include <engine/rendering/gpu_program.h>
 
#include <graphics/index_buffer.h>
#include <graphics/vertex_buffer.h>
#include <graphics/vertex_decl.h>
#include <graphics/render_view.h>
 
namespace unravel
{
 
namespace detail
{
 
// Controls sun position according to time, month, and observer's latitude.
// Sun position computation based on Earth's orbital elements:
// https://nssdc.gsfc.nasa.gov/planetary/factsheet/earthfact.html
class sun_controller
{
public:
    enum class month : int
    {
        january = 0,
        jebruary,
        march,
        april,
        may,
        june,
        july,
        august,
        september,
        october,
        november,
        december
    };
 
    sun_controller()
        : north_dir_(1.0f, 0.0f, 0.0f)
        , sun_dir_(0.0f, -1.0f, 0.0f)
        , up_dir_(0.0f, 1.0f, 0.0f)
        , latitude_(50.0f)
        , month_(month::june)
        , ecliptic_obliquity_(bx::toRad(23.4f))
        , delta_(0.0f)
    {
    }
 
    void update(float _time)
    {
        calculate_sun_orbit();
        update_sun_position(_time - 12.0f);
    }
 
    bx::Vec3 north_dir_;
    bx::Vec3 sun_dir_;
    bx::Vec3 up_dir_;
    float latitude_;
    month month_;
 
private:
    void calculate_sun_orbit()
    {
        const float day = 30.0f * float(month_) + 15.0f;
        float lambda = 280.46f + 0.9856474f * day;
        lambda = bx::toRad(lambda);
        delta_ = bx::asin(bx::sin(ecliptic_obliquity_) * bx::sin(lambda));
    }
 
    void update_sun_position(float _hour)
    {
        const float latitude = bx::toRad(latitude_);
        const float hh = _hour * bx::kPi / 12.0f;
        const float azimuth =
            bx::atan2(bx::sin(hh), bx::cos(hh) * bx::sin(latitude) - bx::tan(delta_) * bx::cos(latitude));
 
        const float altitude =
            bx::asin(bx::sin(latitude) * bx::sin(delta_) + bx::cos(latitude) * bx::cos(delta_) * bx::cos(hh));
 
        const bx::Quaternion rot0 = bx::fromAxisAngle(up_dir_, -azimuth);
        const bx::Vec3 dir = bx::mul(north_dir_, rot0);
        const bx::Vec3 uxd = bx::cross(up_dir_, dir);
 
        const bx::Quaternion rot1 = bx::fromAxisAngle(uxd, altitude);
        sun_dir_ = bx::mul(dir, rot1);
    }
 
    float ecliptic_obliquity_;
    float delta_;
};
 
} // namespace detail
 
class atmospheric_pass_perez
{
public:
    atmospheric_pass_perez() = default;
    ~atmospheric_pass_perez();
 
    struct run_params
    {
        math::vec3 light_direction = math::normalize(math::vec3(0.2f, -0.8f, 1.0f));
 
        // [1.9 - 10.0f]
        float turbidity = 1.9f;
 
        int cloud_mode = 2;
        float cloud_coverage = 0.52f;
        float cloud_base_altitude = 27500.0f;
        float cloud_top_altitude = 35000.0f;
        float cloud_time = 0.0f;
        float cloud_density = 1.5f;
        float cloud_absorption = 0.08f;
        float cloud_light_absorption = 0.10f;
        float sky_brightness = 1.0f;
        float irradiance_intensity = 0.15f;
 
        float cloud_vol_uv_scale = 0.00008f;
        float cloud_vol_edge_width = 0.20f;
        float cloud_vol_shape_power = 1.12f;
        float cloud_vol_detail_erode = 0.48f;
        float cloud_vol_macro_strength = 0.36f;
        float cloud_vol_coarse_scale = 0.38f;
        float cloud_vol_base_mix = 0.45f;
        float cloud_vol_sun_intensity = 24.0f;
    };
 
    auto init(rtti::context& ctx) -> bool;
    void run(gfx::frame_buffer::ptr input, const camera& camera, gfx::render_view& rview, delta_t dt, const run_params& params);
 
private:
 
    struct atmospheric_program : uniforms_cache
    {
        void cache_uniforms()
        {
            cache_uniform(program.get(), u_sunLuminance, "u_sunLuminance", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_skyLuminanceXYZ, "u_skyLuminanceXYZ", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_skyLuminance, "u_skyLuminance", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_sunDirection, "u_sunDirection", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_parameters, "u_parameters", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_perezCoeff, "u_perezCoeff", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_cloudParams, "u_cloudParams", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_cloudParams2, "u_cloudParams2", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), s_cloudTex, "s_cloudTex", gfx::uniform_type::Sampler);
            cache_uniform(program.get(), s_cloudNoise2D, "s_cloudNoise2D", gfx::uniform_type::Sampler);
        }
 
        gfx::program::uniform_ptr u_sunLuminance;
        gfx::program::uniform_ptr u_skyLuminanceXYZ;
        gfx::program::uniform_ptr u_skyLuminance;
        gfx::program::uniform_ptr u_sunDirection;
 
        gfx::program::uniform_ptr u_parameters;
        gfx::program::uniform_ptr u_perezCoeff;
        gfx::program::uniform_ptr u_cloudParams;
        gfx::program::uniform_ptr u_cloudParams2;
        gfx::program::uniform_ptr s_cloudTex;
        gfx::program::uniform_ptr s_cloudNoise2D;
 
        std::unique_ptr<gpu_program> program;
 
    } atmospheric_program_;
 
    struct cloud_program : uniforms_cache
    {
        void cache_uniforms()
        {
            cache_uniform(program.get(), u_skyLuminanceXYZ, "u_skyLuminanceXYZ", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_skyLuminance, "u_skyLuminance", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_sunLuminance, "u_sunLuminance", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_sunDirection, "u_sunDirection", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_parameters, "u_parameters", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_perezCoeff, "u_perezCoeff", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_cloudParams, "u_cloudParams", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_cloudParams2, "u_cloudParams2", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_cloudParams3, "u_cloudParams3", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_cloudParams4, "u_cloudParams4", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), s_cloudNoise, "s_cloudNoise", gfx::uniform_type::Sampler);
            cache_uniform(program.get(), s_cloudHistory, "s_cloudHistory", gfx::uniform_type::Sampler);
            cache_uniform(program.get(), u_cloudFrame, "u_cloudFrame", gfx::uniform_type::Vec4);
            cache_uniform(program.get(), u_prevViewProj, "u_prevViewProj", gfx::uniform_type::Mat4);
        }
 
        gfx::program::uniform_ptr u_skyLuminanceXYZ;
        gfx::program::uniform_ptr u_skyLuminance;
        gfx::program::uniform_ptr u_sunLuminance;
        gfx::program::uniform_ptr u_sunDirection;
        gfx::program::uniform_ptr u_parameters;
        gfx::program::uniform_ptr u_perezCoeff;
        gfx::program::uniform_ptr u_cloudParams;
        gfx::program::uniform_ptr u_cloudParams2;
        gfx::program::uniform_ptr u_cloudParams3;
        gfx::program::uniform_ptr u_cloudParams4;
        gfx::program::uniform_ptr u_cloudFrame;
        gfx::program::uniform_ptr u_prevViewProj;
        gfx::program::uniform_ptr s_cloudNoise;
        gfx::program::uniform_ptr s_cloudHistory;
 
        std::unique_ptr<gpu_program> program;
 
    } cloud_program_;
 
 
    std::unique_ptr<gfx::vertex_buffer> vb_;
    std::unique_ptr<gfx::index_buffer> ib_;
 
    detail::sun_controller sun_;
};
} // namespace unravel