scene_renderer_params.h

Go to the documentation of this file.

#pragma once
 
#include <liboscar/graphics/anti_aliasing_level.h>
#include <liboscar/graphics/color.h>
#include <liboscar/maths/matrix4x4.h>
#include <liboscar/maths/vector.h>
 
#include <array>
 
namespace osc
{
    // the parameters associated with a single call to `SceneRenderer::render`
    struct SceneRendererParams final {
 
        static constexpr Color default_light_color()
        {
            return {248.0f / 255.0f, 247.0f / 255.0f, 247.0f / 255.0f};
        }
 
        static constexpr Color default_background_color()
        {
            return {0.89f, 0.89f, 0.89f};
        }
 
        static constexpr Vector3 default_floor_position()
        {
            return {0.0f, -0.001f, 0.0f};
        }
 
    private:
        static constexpr size_t c_num_rim_groups = 2;
    public:
        static constexpr size_t num_rim_groups()
        {
            return c_num_rim_groups;
        }
 
        friend bool operator==(const SceneRendererParams&, const SceneRendererParams&) = default;
 
        // output parameters
        Vector2 dimensions = {1.0f, 1.0f};  // desired dimensions in device-independent pixels
        float device_pixel_ratio = 1.0f;
        AntiAliasingLevel anti_aliasing_level = AntiAliasingLevel::none();
 
        // flags
        bool draw_mesh_normals = false;
        bool draw_rims = true;
        bool draw_shadows = true;
        bool draw_floor = true;
        bool order_independent_transparency = true;
 
        // camera parameters
        float near_clipping_plane = 0.1f;
        float far_clipping_plane = 100.0f;
        Matrix4x4 view_matrix = identity<Matrix4x4>();
        Matrix4x4 projection_matrix = identity<Matrix4x4>();
        Vector3 viewer_position = {0.0f, 0.0f, 0.0f};
 
        // shading parameters
        Vector3 light_direction = {-0.34f, -0.25f, 0.05f};
        Color light_color = default_light_color();
        float ambient_strength = 0.01f;
        float diffuse_strength = 0.55f;
        float specular_strength = 0.7f;
        float specular_shininess = 6.0f;
        Color background_color = default_background_color();
        std::array<Color, c_num_rim_groups> rim_group_colors = std::to_array<Color>({
            Color{0.95f, 0.4f, 0.0f, 1.0f},
            Color{0.95f, 0.2f, 0.0f, 0.4f},
        });
        Vector2 rim_thickness = {1.0f, 1.0f};  // desired screen-space rim thickness in device-independent pixels.
 
        // scene parameters
        Vector3 floor_position = default_floor_position();
        float fixup_scale_factor = 1.0f;
    };
}