eevee_lightprobe_volume.hh

Go to the documentation of this file.

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

 
#pragma once
 
#include "DNA_lightprobe_types.h"
 
#include "BLI_math_quaternion_types.hh"
 
#include "eevee_lightprobe.hh"
 
namespace blender::eevee {
 
using blender::math::AxisSigned;
using blender::math::CartesianBasis;
 
class Instance;
class CapturePipeline;
class ShadowModule;
class Camera;
class SphereProbeModule;
 
using CaptureInfoBuf = draw::StorageBuffer<CaptureInfoData>;
using IrradianceBrickBuf = draw::StorageVectorBuffer<IrradianceBrickPacked, 16>;
using SurfelBuf = draw::StorageArrayBuffer<Surfel, 64>;
using SurfelListInfoBuf = draw::StorageBuffer<SurfelListInfoData>;
using VolumeProbeDataBuf = draw::UniformArrayBuffer<VolumeProbeData, IRRADIANCE_GRID_MAX>;

class IrradianceBake {
  friend CapturePipeline;
  friend ShadowModule;
  friend Camera;
 
 private:
  Instance &inst_;

  LightCache *light_cache_ = nullptr;
  SurfelBuf surfels_buf_;
  CaptureInfoBuf capture_info_buf_;
  Framebuffer empty_raster_fb_ = {"empty_raster_fb_"};
  PassSimple surfel_light_eval_ps_ = {"LightEval"};
  PassSimple surfel_ray_build_ps_ = {"RayBuild"};
  PassSimple surfel_cluster_build_ps_ = {"RayBuild"};
  PassSimple surfel_light_propagate_ps_ = {"LightPropagate"};
  PassSimple irradiance_capture_ps_ = {"IrradianceCapture"};
  PassSimple irradiance_offset_ps_ = {"IrradianceOffset"};
  PassSimple irradiance_bounds_ps_ = {"IrradianceBounds"};
  int radiance_src_ = 0, radiance_dst_ = 1;

  CartesianBasis basis_x_ = {AxisSigned::Z_POS, AxisSigned::Y_POS, AxisSigned::X_NEG};
  CartesianBasis basis_y_ = {AxisSigned::X_POS, AxisSigned::Z_POS, AxisSigned::Y_NEG};
  CartesianBasis basis_z_ = {AxisSigned::Y_POS, AxisSigned::X_POS, AxisSigned::Z_NEG};
  View view_x_ = {"BakingViewX"};
  View view_y_ = {"BakingViewY"};
  View view_z_ = {"BakingViewZ"};
  int3 grid_pixel_extent_ = int3(0);
  SurfelListInfoBuf list_info_buf_ = {"list_info_buf_"};
  StorageArrayBuffer<int, 16, true> list_start_buf_ = {"list_start_buf_"};
  StorageArrayBuffer<int, 16, true> list_counter_buf_ = {"list_counter_buf_"};
  StorageArrayBuffer<int, 16, true> list_range_buf_ = {"list_range_buf_"};
  StorageArrayBuffer<float, 16, true> list_item_distance_buf_ = {"list_item_distance_buf_"};
  StorageArrayBuffer<int, 16, true> list_item_surfel_id_buf_ = {"list_item_surfel_id_buf_"};
  StorageArrayBuffer<int, 16, true> sorted_surfel_id_buf_ = {"sorted_surfel_id_buf_"};
 
  /* Dispatch size for per surfel workload. */
  int3 dispatch_per_surfel_ = int3(1);
  /* Dispatch size for per surfel list workload. */
  int3 dispatch_per_list_ = int3(1);
  /* Dispatch size for per grid sample workload. */
  int3 dispatch_per_grid_sample_ = int3(1);

  View ray_view_ = {"RayProjectionView"};

  Texture irradiance_L0_tx_ = {"irradiance_L0_tx_"};
  Texture irradiance_L1_a_tx_ = {"irradiance_L1_a_tx_"};
  Texture irradiance_L1_b_tx_ = {"irradiance_L1_b_tx_"};
  Texture irradiance_L1_c_tx_ = {"irradiance_L1_c_tx_"};
  Texture virtual_offset_tx_ = {"virtual_offset_tx_"};
  Texture cluster_list_tx_ = {"cluster_list_tx_"};
  Texture validity_tx_ = {"validity_tx_"};
 
  /* Bounding sphere of the scene being baked. In world space. */
  float4 scene_bound_sphere_;
  /* Surfel per unit distance in world space. */
  float surfel_density_ = 1.0f;
  float min_distance_to_surface_ = 0.05f;
  float max_virtual_offset_ = 0.1f;
  float clip_distance_;

  bool capture_world_ = false;
  bool capture_indirect_ = false;
  bool capture_emission_ = false;

  bool do_break_ = false;
 
 public:
  IrradianceBake(Instance &inst) : inst_(inst) {};
 
  void init(const Object &probe_object);
  void sync();

  bool should_break()
  {
    return do_break_;
  }

  void surfel_raster_views_sync(const float3 &scene_min,
                                const float3 &scene_max,
                                const float4x4 &probe_to_world);
  void surfels_create(const Object &probe_object);
  void surfels_lights_eval();
  void clusters_build();
  void raylists_build();
  void propagate_light();
  void irradiance_offset();
  void irradiance_capture();

  LightProbeGridCacheFrame *read_result_unpacked();
  LightProbeGridCacheFrame *read_result_packed();
 
 private:
  void read_surfels(LightProbeGridCacheFrame *cache_frame);
  void read_virtual_offset(LightProbeGridCacheFrame *cache_frame);
};

class VolumeProbeModule {
 public:
  IrradianceBake bake;
 
 private:
  Instance &inst_;

  Texture irradiance_atlas_tx_ = {"irradiance_atlas_tx_"};
  int world_brick_index_ = 0;
  VolumeProbeDataBuf grids_infos_buf_ = {"grids_infos_buf_"};
  IrradianceBrickBuf bricks_infos_buf_ = {"bricks_infos_buf_"};
  Vector<IrradianceBrickPacked> brick_pool_;
  PassSimple grid_upload_ps_ = {"VolumeProbeModule.Upload"};
  bool do_full_update_ = true;
  uint irradiance_pool_size_ = 0;
  uint irradiance_pool_size_alloc_ = 0;

  PassSimple debug_ps_ = {"VolumeProbeModule.Debug"};
  draw::StorageArrayBuffer<Surfel> debug_surfels_buf_;

  bool display_grids_enabled_ = false;
  PassSimple display_grids_ps_ = {"VolumeProbeModule.Display Grids"};

  bool do_update_world_ = true;
 
 public:
  VolumeProbeModule(Instance &inst) : bake(inst), inst_(inst) {};
  ~VolumeProbeModule() {};
 
  void init();
  void sync();
 
  /* Tag all grids for reupload in set_view and composite them with the world irradiance. */
  void update_world_irradiance()
  {
    do_update_world_ = true;
  }
 
  void set_view(View &view);
  void viewport_draw(View &view, gpu::FrameBuffer *view_fb);
 
  Vector<IrradianceBrickPacked> bricks_alloc(int brick_len);
  void bricks_free(Vector<IrradianceBrickPacked> &bricks);
 
  template<typename PassType> void bind_resources(PassType &pass)
  {
    pass.bind_ubo(IRRADIANCE_GRID_BUF_SLOT, &grids_infos_buf_);
    pass.bind_ssbo(IRRADIANCE_BRICK_BUF_SLOT, &bricks_infos_buf_);
    pass.bind_texture(VOLUME_PROBE_TEX_SLOT, &irradiance_atlas_tx_);
  }
 
 private:
  void debug_pass_draw(View &view, gpu::FrameBuffer *view_fb);
  void display_pass_draw(View &view, gpu::FrameBuffer *view_fb);
 
  friend class SphereProbeModule;
};
 
}  // namespace blender::eevee