eevee_lookdev.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <string>
 
#include "DNA_image_types.h"
#include "DNA_vec_types.h"
#include "DNA_world_types.h"
 
#include "BLI_math_vector_types.hh"
 
#include "DRW_gpu_wrapper.hh"
 
#include "draw_pass.hh"
 
struct bNode;
struct bNodeSocketValueFloat;
struct View3D;
 
namespace blender::eevee {
 
class Instance;
class LookdevView;
 
using blender::draw::Framebuffer;
using blender::draw::PassSimple;
using blender::draw::ResourceHandleRange;
using blender::draw::Texture;
using blender::draw::View;
 
/* -------------------------------------------------------------------- */
struct LookdevParameters {
  std::string hdri;
  float rot_z = 0.0f;
  float background_opacity = 0.0f;
  float intensity = 1.0f;
  float blur = 0.0f;
  bool show_scene_world = true;
 
  LookdevParameters();
  LookdevParameters(const ::View3D *v3d);
  bool operator==(const LookdevParameters &other) const;
  bool operator!=(const LookdevParameters &other) const;
};

 
/* -------------------------------------------------------------------- */
 
class LookdevWorld {
 private:
  bNode *environment_node_ = nullptr;
  bNodeSocketValueFloat *intensity_socket_ = nullptr;
  bNodeSocketValueFloat *angle_socket_ = nullptr;
  ::Image *image = nullptr;
  ::World *world = nullptr;
 
  LookdevParameters parameters_;
 
 public:
  LookdevWorld();
  ~LookdevWorld();
 
  /* Returns true if an update was detected. */
  bool sync(const LookdevParameters &new_parameters);
 
  ::World *world_get()
  {
    return world;
  }
 
  float background_opacity_get() const
  {
    return parameters_.background_opacity;
  }
 
  float background_blur_get() const
  {
    return parameters_.blur;
  }
 
  float intensity_get() const
  {
    return parameters_.intensity;
  }
};

 
/* -------------------------------------------------------------------- */
 
class LookdevModule {
 private:
  Instance &inst_;
 
  bool enabled_;
 
  static constexpr int num_spheres = 2;

  enum SphereLOD {
    LOW = 0,
    MEDIUM = 1,
    HIGH = 2,
 
    MAX, /* Max number of level of detail */
  };
 
  std::array<gpu::Batch *, MAX> sphere_lod_ = {};
 
  /* Size and position of the look-dev spheres in world space. */
  float sphere_radius_;
  float3 sphere_position_;
 
  rcti visible_rect_;
 
  /* Dummy textures: required to reuse forward mesh shader and avoid another shader variation. */
  Texture dummy_cryptomatte_tx_;
  Texture dummy_aov_color_tx_;
  Texture dummy_aov_value_tx_;
 
  struct Sphere {
    Framebuffer framebuffer = {"Lookdev.Framebuffer"};
    Texture color_tx_ = {"Lookdev.Color"};
    PassSimple pass = {"Lookdev.Sphere"};
  };
 
  Sphere spheres_[num_spheres];
  PassSimple display_ps_ = {"Lookdev.Display"};
 
 public:
  LookdevModule(Instance &inst);
  ~LookdevModule();
 
  void init(const rcti *visible_rect);
  void sync();
 
  void draw(View &view);
 
  void display();
 
 private:
  void sync_pass(PassSimple &pass,
                 gpu::Batch *geom,
                 ::Material *mat,
                 ResourceHandleRange res_handle);
  void sync_display();
 
  float calc_viewport_scale();
  SphereLOD calc_level_of_detail(const float viewport_scale);
  blender::gpu::Batch *sphere_get(const SphereLOD level_of_detail);
 
  friend class LookdevView;
};

 
}  // namespace blender::eevee