eevee_film.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2021 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <string>
 
#include "BLI_math_vector.hh"
#include "BLI_set.hh"
 
#include "DRW_render.hh"
 
#include "eevee_shader_shared.hh"
 
#include <sstream>
 
namespace blender::eevee {
 
class Instance;
 
/* -------------------------------------------------------------------- */
class Film {
 public:
  AOVsInfoDataBuf aovs_info;
  static constexpr bool use_box_filter = false;
 
 private:
  Instance &inst_;
 
  GPUTexture *combined_final_tx_ = nullptr;
 
  bool use_compute_;
 
  Texture color_accum_tx_;
  Texture value_accum_tx_;
  Texture depth_tx_;
  Texture cryptomatte_tx_;
  SwapChain<Texture, 2> combined_tx_;
  SwapChain<Texture, 2> weight_tx_;
 
  PassSimple accumulate_ps_ = {"Film.Accumulate"};
  PassSimple copy_ps_ = {"Film.Copy"};
  PassSimple cryptomatte_post_ps_ = {"Film.Cryptomatte.Post"};
 
  FilmData &data_;
  int2 display_extent;
 
  eViewLayerEEVEEPassType enabled_passes_ = eViewLayerEEVEEPassType(0);
  /* Store the pass types needed by the viewport compositor separately, because some passes might
   * be enabled but not used by the viewport compositor, so they needn't be written. */
  eViewLayerEEVEEPassType viewport_compositor_enabled_passes_ = eViewLayerEEVEEPassType(0);
  PassCategory enabled_categories_ = PassCategory(0);
  bool use_reprojection_ = false;
 
 public:
  Film(Instance &inst, FilmData &data) : inst_(inst), data_(data){};
  ~Film(){};
 
  void init(const int2 &full_extent, const rcti *output_rect);
 
  void sync();
  void end_sync();
 
  const FilmData &get_data()
  {
    return data_;
  }
 
  void accumulate(View &view, GPUTexture *combined_final_tx);
 
  void cryptomatte_sort();
 
  void display();
 
  float *read_pass(eViewLayerEEVEEPassType pass_type, int layer_offset);
  float *read_aov(ViewLayerAOV *aov);
 
  GPUTexture *get_pass_texture(eViewLayerEEVEEPassType pass_type, int layer_offset);
  GPUTexture *get_aov_texture(ViewLayerAOV *aov);
 
  void write_viewport_compositor_passes();
 
  bool is_viewport_compositor_enabled() const;
 
  int2 render_extent_get() const
  {
    return data_.render_extent;
  }
 
  int2 film_extent_get() const
  {
    return data_.extent;
  }
  int2 film_offset_get() const
  {
    return data_.offset;
  }
 
  int2 display_extent_get() const
  {
    return display_extent;
  }
 
  int render_overscan_get() const
  {
    return data_.overscan;
  }
 
  static int overscan_pixels_get(float overscan, int2 extent)
  {
    return math::ceil(max_ff(0.0f, overscan) * math::reduce_max(extent));
  }
 
  int scaling_factor_get() const
  {
    return data_.scaling_factor;
  }
 
  float2 pixel_jitter_get() const;
 
  float background_opacity_get() const
  {
    return data_.background_opacity;
  }
 
  eViewLayerEEVEEPassType enabled_passes_get() const;
  int cryptomatte_layer_max_get() const;
  int cryptomatte_layer_len_get() const;
 
  static ePassStorageType pass_storage_type(eViewLayerEEVEEPassType pass_type)
  {
    switch (pass_type) {
      case EEVEE_RENDER_PASS_Z:
      case EEVEE_RENDER_PASS_MIST:
        return PASS_STORAGE_VALUE;
      case EEVEE_RENDER_PASS_CRYPTOMATTE_OBJECT:
      case EEVEE_RENDER_PASS_CRYPTOMATTE_ASSET:
      case EEVEE_RENDER_PASS_CRYPTOMATTE_MATERIAL:
        return PASS_STORAGE_CRYPTOMATTE;
      default:
        return PASS_STORAGE_COLOR;
    }
  }
 
  static bool pass_is_float3(eViewLayerEEVEEPassType pass_type)
  {
    return pass_storage_type(pass_type) == PASS_STORAGE_COLOR &&
           !ELEM(pass_type,
                 EEVEE_RENDER_PASS_COMBINED,
                 EEVEE_RENDER_PASS_VECTOR,
                 EEVEE_RENDER_PASS_TRANSPARENT);
  }
 
  /* Returns layer offset in the accumulation texture. -1 if the pass is not enabled. */
  int pass_id_get(eViewLayerEEVEEPassType pass_type) const
  {
    switch (pass_type) {
      case EEVEE_RENDER_PASS_COMBINED:
        return data_.combined_id;
      case EEVEE_RENDER_PASS_Z:
        return data_.depth_id;
      case EEVEE_RENDER_PASS_MIST:
        return data_.mist_id;
      case EEVEE_RENDER_PASS_NORMAL:
        return data_.normal_id;
      case EEVEE_RENDER_PASS_POSITION:
        return data_.position_id;
      case EEVEE_RENDER_PASS_VECTOR:
        return data_.vector_id;
      case EEVEE_RENDER_PASS_DIFFUSE_LIGHT:
        return data_.diffuse_light_id;
      case EEVEE_RENDER_PASS_DIFFUSE_COLOR:
        return data_.diffuse_color_id;
      case EEVEE_RENDER_PASS_SPECULAR_LIGHT:
        return data_.specular_light_id;
      case EEVEE_RENDER_PASS_SPECULAR_COLOR:
        return data_.specular_color_id;
      case EEVEE_RENDER_PASS_VOLUME_LIGHT:
        return data_.volume_light_id;
      case EEVEE_RENDER_PASS_EMIT:
        return data_.emission_id;
      case EEVEE_RENDER_PASS_ENVIRONMENT:
        return data_.environment_id;
      case EEVEE_RENDER_PASS_SHADOW:
        return data_.shadow_id;
      case EEVEE_RENDER_PASS_AO:
        return data_.ambient_occlusion_id;
      case EEVEE_RENDER_PASS_TRANSPARENT:
        return data_.transparent_id;
      case EEVEE_RENDER_PASS_CRYPTOMATTE_OBJECT:
        return data_.cryptomatte_object_id;
      case EEVEE_RENDER_PASS_CRYPTOMATTE_ASSET:
        return data_.cryptomatte_asset_id;
      case EEVEE_RENDER_PASS_CRYPTOMATTE_MATERIAL:
        return data_.cryptomatte_material_id;
      default:
        return -1;
    }
  }
 
  static const Vector<std::string> pass_to_render_pass_names(eViewLayerEEVEEPassType pass_type,
                                                             const ViewLayer *view_layer)
  {
    Vector<std::string> result;
 
    auto build_cryptomatte_passes = [&](const char *pass_name) {
      const int num_cryptomatte_passes = (view_layer->cryptomatte_levels + 1) / 2;
      for (int pass = 0; pass < num_cryptomatte_passes; pass++) {
        std::stringstream ss;
        ss.fill('0');
        ss << pass_name;
        ss.width(2);
        ss << pass;
        result.append(ss.str());
      }
    };
 
    switch (pass_type) {
      case EEVEE_RENDER_PASS_COMBINED:
        result.append(RE_PASSNAME_COMBINED);
        break;
      case EEVEE_RENDER_PASS_Z:
        result.append(RE_PASSNAME_Z);
        break;
      case EEVEE_RENDER_PASS_MIST:
        result.append(RE_PASSNAME_MIST);
        break;
      case EEVEE_RENDER_PASS_NORMAL:
        result.append(RE_PASSNAME_NORMAL);
        break;
      case EEVEE_RENDER_PASS_POSITION:
        result.append(RE_PASSNAME_POSITION);
        break;
      case EEVEE_RENDER_PASS_VECTOR:
        result.append(RE_PASSNAME_VECTOR);
        break;
      case EEVEE_RENDER_PASS_DIFFUSE_LIGHT:
        result.append(RE_PASSNAME_DIFFUSE_DIRECT);
        break;
      case EEVEE_RENDER_PASS_DIFFUSE_COLOR:
        result.append(RE_PASSNAME_DIFFUSE_COLOR);
        break;
      case EEVEE_RENDER_PASS_SPECULAR_LIGHT:
        result.append(RE_PASSNAME_GLOSSY_DIRECT);
        break;
      case EEVEE_RENDER_PASS_SPECULAR_COLOR:
        result.append(RE_PASSNAME_GLOSSY_COLOR);
        break;
      case EEVEE_RENDER_PASS_VOLUME_LIGHT:
        result.append(RE_PASSNAME_VOLUME_LIGHT);
        break;
      case EEVEE_RENDER_PASS_EMIT:
        result.append(RE_PASSNAME_EMIT);
        break;
      case EEVEE_RENDER_PASS_ENVIRONMENT:
        result.append(RE_PASSNAME_ENVIRONMENT);
        break;
      case EEVEE_RENDER_PASS_SHADOW:
        result.append(RE_PASSNAME_SHADOW);
        break;
      case EEVEE_RENDER_PASS_AO:
        result.append(RE_PASSNAME_AO);
        break;
      case EEVEE_RENDER_PASS_TRANSPARENT:
        result.append(RE_PASSNAME_TRANSPARENT);
        break;
      case EEVEE_RENDER_PASS_CRYPTOMATTE_OBJECT:
        build_cryptomatte_passes(RE_PASSNAME_CRYPTOMATTE_OBJECT);
        break;
      case EEVEE_RENDER_PASS_CRYPTOMATTE_ASSET:
        build_cryptomatte_passes(RE_PASSNAME_CRYPTOMATTE_ASSET);
        break;
      case EEVEE_RENDER_PASS_CRYPTOMATTE_MATERIAL:
        build_cryptomatte_passes(RE_PASSNAME_CRYPTOMATTE_MATERIAL);
        break;
      default:
        BLI_assert(0);
        break;
    }
    return result;
  }
 
 private:
  void init_aovs(const Set<std::string> &passes_used_by_viewport_compositor);
  void sync_mist();
 
  void update_sample_table();
 
  void init_pass(PassSimple &pass, GPUShader *sh);
};
 
}  // namespace blender::eevee