Blender V5.3
eevee_film.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2021 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
28
29#pragma once
30
31#include <string>
32
33#include "BLI_math_vector.hh"
34#include "BLI_set.hh"
35
36#include "DNA_scene_types.h"
37#include "DRW_render.hh"
38
39#include "draw_pass.hh"
40
41#include "eevee_film_shared.hh"
43
44#include <sstream>
45
46namespace blender::eevee {
47
48using namespace draw;
49
50class Instance;
51
52/* -------------------------------------------------------------------- */
55
56class Film {
57 public:
61 static constexpr bool use_box_filter = false;
62
72
73 private:
74 Instance &inst_;
75
77 gpu::Texture *combined_final_tx_ = nullptr;
78
80 bool use_compute_ = false;
81
84 std::string ui_aov_name_;
85
90 Texture color_accum_tx_;
91 Texture value_accum_tx_;
93 Texture depth_tx_;
95 Texture cryptomatte_tx_;
97 SwapChain<Texture, 2> combined_tx_;
99 SwapChain<Texture, 2> weight_tx_;
101 Texture denoising_depth_tx_;
102
103 PassSimple accumulate_ps_ = {"Film.Accumulate"};
104 PassSimple copy_ps_ = {"Film.Copy"};
105 PassSimple cryptomatte_post_ps_ = {"Film.Cryptomatte.Post"};
106
107 FilmData &data_;
108 bool32_t display_only_;
109 int2 display_extent = int2(-1);
110
112 /* Store the pass types needed by the viewport compositor separately, because some passes might
113 * be enabled but not used by the viewport compositor, so they needn't be written. */
114 eViewLayerEEVEEPassType viewport_compositor_enabled_passes_ = eViewLayerEEVEEPassType(0);
115 PassCategory enabled_categories_ = PassCategory(0);
116 bool use_reprojection_ = false;
117 bool is_valid_render_extent_ = true;
119 int2 render_extent_shading_view_ = int2(-1);
120
121 public:
122 Film(Instance &inst, FilmData &data) : inst_(inst), data_(data) {};
123 ~Film() {};
124
125 void init(const int2 &full_extent, const rcti *output_rect);
126
127 void sync();
128 void end_sync();
129
131 {
132 return data_;
133 }
134
136 void accumulate(View &view, gpu::Texture *combined_final_tx);
137
139 void cryptomatte_sort();
140
142 void display();
143
144 float *read_pass(eViewLayerEEVEEPassType pass_type, int layer_offset);
145 float *read_aov(ViewLayerAOV *aov);
146
147 gpu::Texture *get_pass_texture(eViewLayerEEVEEPassType pass_type, int layer_offset);
149
151
157 {
158 return render_extent_shading_view_;
159 }
160
165 {
166 return data_.render_extent;
167 }
169 {
170 return is_valid_render_extent_;
171 }
172
175 {
176 return data_.extent;
177 }
179 {
180 return data_.offset;
181 }
182
185 {
186 return display_extent;
187 }
188
191 {
192 return data_.overscan;
193 }
194
196 static int overscan_pixels_get(float overscan, int2 extent)
197 {
198 return math::ceil(max_ff(0.0f, overscan) * math::reduce_max(extent));
199 }
200
202 {
203 return data_.scaling_factor;
204 }
205
206 float2 pixel_jitter_get() const;
207
209 {
210 return data_.background_opacity;
211 }
212
214 int cryptomatte_layer_len_get() const;
215
234
243
244 /* Returns layer offset in the accumulation texture. -1 if the pass is not enabled. */
246 {
247 switch (pass_type) {
249 return data_.combined_id;
251 return data_.depth_id;
253 return data_.mist_id;
255 return data_.normal_id;
257 return data_.position_id;
259 return data_.vector_id;
261 return data_.diffuse_light_id;
263 return data_.diffuse_color_id;
265 return data_.specular_light_id;
267 return data_.specular_color_id;
269 return data_.volume_light_id;
271 return data_.emission_id;
273 return data_.environment_id;
275 return data_.shadow_id;
277 return data_.ambient_occlusion_id;
279 return data_.transparent_id;
281 return data_.cryptomatte_object_id;
283 return data_.cryptomatte_asset_id;
285 return data_.cryptomatte_material_id;
287 return data_.denoising_depth_id;
289 return data_.denoising_normal_id;
291 return data_.denoising_roughness_id;
293 return data_.denoising_diffuse_albedo_id;
295 return data_.denoising_specular_albedo_id;
296 default:
297 return -1;
298 }
299 }
300
302 const ViewLayer *view_layer)
303 {
305
306 auto build_cryptomatte_passes = [&](const char *pass_name) {
307 const int num_cryptomatte_passes = (view_layer->cryptomatte_levels + 1) / 2;
308 for (int pass = 0; pass < num_cryptomatte_passes; pass++) {
309 std::stringstream ss;
310 ss.fill('0');
311 ss << pass_name;
312 ss.width(2);
313 ss << pass;
314 result.append(ss.str());
315 }
316 };
317
318 switch (pass_type) {
321 break;
324 break;
326 result.append(RE_PASSNAME_MIST);
327 break;
330 break;
333 break;
336 break;
339 break;
342 break;
345 break;
348 break;
351 break;
353 result.append(RE_PASSNAME_EMIT);
354 break;
357 break;
360 break;
362 result.append(RE_PASSNAME_AO);
363 break;
366 break;
368 build_cryptomatte_passes(RE_PASSNAME_CRYPTOMATTE_OBJECT);
369 break;
371 build_cryptomatte_passes(RE_PASSNAME_CRYPTOMATTE_ASSET);
372 break;
374 build_cryptomatte_passes(RE_PASSNAME_CRYPTOMATTE_MATERIAL);
375 break;
378 break;
381 break;
384 break;
387 break;
390 break;
391 default:
392 BLI_assert(0);
393 break;
394 }
395 return result;
396 }
397
401 void update_sample_table();
402
403 private:
404 void init_aovs(const Set<std::string> &passes_used_by_viewport_compositor);
405 void sync_mist();
406
407 void init_pass(PassSimple &pass, gpu::Shader *sh);
408};
409
411
412} // namespace blender::eevee
#define RE_PASSNAME_COMBINED
#define RE_PASSNAME_DENOISING_ROUGHNESS
#define RE_PASSNAME_CRYPTOMATTE_MATERIAL
#define RE_PASSNAME_NORMAL
#define RE_PASSNAME_CRYPTOMATTE_ASSET
#define RE_PASSNAME_VECTOR
#define RE_PASSNAME_EMIT
#define RE_PASSNAME_GLOSSY_COLOR
#define RE_PASSNAME_DEPTH
#define RE_PASSNAME_GLOSSY_DIRECT
#define RE_PASSNAME_SHADOW
#define RE_PASSNAME_DENOISING_NORMAL
#define RE_PASSNAME_MIST
#define RE_PASSNAME_ENVIRONMENT
#define RE_PASSNAME_POSITION
#define RE_PASSNAME_DIFFUSE_COLOR
#define RE_PASSNAME_DENOISING_DIFFUSE_ALBEDO
#define RE_PASSNAME_AO
#define RE_PASSNAME_DENOISING_DEPTH
#define RE_PASSNAME_VOLUME_LIGHT
#define RE_PASSNAME_DENOISING_SPECULAR_ALBEDO
#define RE_PASSNAME_CRYPTOMATTE_OBJECT
#define RE_PASSNAME_TRANSPARENT
#define RE_PASSNAME_DIFFUSE_DIRECT
int32_t bool32_t
#define ELEM(...)
float2 pixel_jitter_get() const
int2 film_offset_get() const
int2 display_extent_get() const
int render_overscan_get() const
int pass_id_get(eViewLayerEEVEEPassType pass_type) const
int2 render_extent_original_get() const
static bool pass_is_float3(eViewLayerEEVEEPassType pass_type)
gpu::Texture * get_pass_texture(eViewLayerEEVEEPassType pass_type, int layer_offset)
struct blender::eevee::Film::DepthState depth
int scaling_factor_get() const
static const Vector< std::string > pass_to_render_pass_names(eViewLayerEEVEEPassType pass_type, const ViewLayer *view_layer)
int cryptomatte_layer_len_get() const
static ePassStorageType pass_storage_type(eViewLayerEEVEEPassType pass_type)
float * read_pass(eViewLayerEEVEEPassType pass_type, int layer_offset)
bool is_valid_render_extent() const
int2 film_extent_get() const
void write_viewport_compositor_passes()
static int overscan_pixels_get(float overscan, int2 extent)
const FilmData & get_data()
int2 render_extent_get() const
void accumulate(View &view, gpu::Texture *combined_final_tx)
float * read_aov(ViewLayerAOV *aov)
StorageBuffer< AOVsInfoData > aovs_info
Definition eevee_film.hh:59
eViewLayerEEVEEPassType enabled_passes_get() const
Film(Instance &inst, FilmData &data)
float background_opacity_get() const
static constexpr bool use_box_filter
Definition eevee_film.hh:61
gpu::Texture * get_aov_texture(ViewLayerAOV *aov)
A running instance of the engine.
detail::Pass< command::DrawCommandBuf > PassSimple
T reduce_max(const VecBase< T, Size > &a)
T ceil(const T &a)
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
VecBase< int32_t, 2 > int2
VecBase< float, 2 > float2
BMesh const char void * data
@ DRW_STATE_DEPTH_LESS_EQUAL
Definition draw_state.hh:40
@ EEVEE_RENDER_PASS_CRYPTOMATTE_ASSET
@ EEVEE_RENDER_PASS_MIST
@ EEVEE_RENDER_PASS_SPECULAR_LIGHT
@ EEVEE_RENDER_PASS_DIFFUSE_COLOR
@ EEVEE_RENDER_PASS_DENOISING_NORMAL
@ EEVEE_RENDER_PASS_CRYPTOMATTE_MATERIAL
@ EEVEE_RENDER_PASS_ENVIRONMENT
@ EEVEE_RENDER_PASS_VECTOR
@ EEVEE_RENDER_PASS_EMIT
@ EEVEE_RENDER_PASS_AO
@ EEVEE_RENDER_PASS_DENOISING_ROUGHNESS
@ EEVEE_RENDER_PASS_DENOISING_DIFFUSE_ALBEDO
@ EEVEE_RENDER_PASS_DEPTH
@ EEVEE_RENDER_PASS_CRYPTOMATTE_OBJECT
@ EEVEE_RENDER_PASS_COMBINED
@ EEVEE_RENDER_PASS_VOLUME_LIGHT
@ EEVEE_RENDER_PASS_DENOISING_SPECULAR_ALBEDO
@ EEVEE_RENDER_PASS_TRANSPARENT
@ EEVEE_RENDER_PASS_NORMAL
@ EEVEE_RENDER_PASS_POSITION
@ EEVEE_RENDER_PASS_DIFFUSE_LIGHT
@ EEVEE_RENDER_PASS_SPECULAR_COLOR
@ EEVEE_RENDER_PASS_SHADOW
@ EEVEE_RENDER_PASS_DENOISING_DEPTH
MINLINE float max_ff(float a, float b)