Blender V5.3
blender::eevee::Film Class Reference

#include <eevee_film.hh>

Classes

struct  DepthState

Public Member Functions

 Film (Instance &inst, FilmData &data)
 ~Film ()
const FilmData & get_data ()
int2 render_extent_get () const
int2 render_extent_original_get () const
bool is_valid_render_extent () const
int2 film_extent_get () const
int2 film_offset_get () const
int2 display_extent_get () const
int render_overscan_get () const
int scaling_factor_get () const
float background_opacity_get () const
int pass_id_get (eViewLayerEEVEEPassType pass_type) const

Static Public Member Functions

static int overscan_pixels_get (float overscan, int2 extent)
static ePassStorageType pass_storage_type (eViewLayerEEVEEPassType pass_type)
static bool pass_is_float3 (eViewLayerEEVEEPassType pass_type)
static const Vector< std::string > pass_to_render_pass_names (eViewLayerEEVEEPassType pass_type, const ViewLayer *view_layer)

Public Attributes

StorageBuffer< AOVsInfoData > aovs_info
struct blender::eevee::Film::DepthState depth

Static Public Attributes

static constexpr bool use_box_filter = false

Film

void init (const int2 &full_extent, const rcti *output_rect)
void sync ()
void end_sync ()
void accumulate (View &view, gpu::Texture *combined_final_tx)
void cryptomatte_sort ()
void display ()
float * read_pass (eViewLayerEEVEEPassType pass_type, int layer_offset)
gpu::Texture * get_pass_texture (eViewLayerEEVEEPassType pass_type, int layer_offset)
void write_viewport_compositor_passes ()
float2 pixel_jitter_get () const
eViewLayerEEVEEPassType enabled_passes_get () const
int cryptomatte_layer_len_get () const
void update_sample_table ()

Arbitrary Output Variables

float * read_aov (ViewLayerAOV *aov)
gpu::Texture * get_aov_texture (ViewLayerAOV *aov)

Detailed Description

Definition at line 56 of file eevee_film.hh.

Constructor & Destructor Documentation

◆ Film()

blender::eevee::Film::Film ( Instance & inst,
FilmData & data )
inline

Definition at line 122 of file eevee_film.hh.

References blender::data.

◆ ~Film()

blender::eevee::Film::~Film ( )
inline

Definition at line 123 of file eevee_film.hh.

Member Function Documentation

◆ accumulate()

◆ background_opacity_get()

float blender::eevee::Film::background_opacity_get ( ) const
inline

Definition at line 208 of file eevee_film.hh.

◆ cryptomatte_layer_len_get()

int Film::cryptomatte_layer_len_get ( ) const

Definition at line 797 of file eevee_film.cc.

References blender::result.

Referenced by init(), and sync().

◆ cryptomatte_sort()

void Film::cryptomatte_sort ( )

Sort and normalize cryptomatte samples.

Definition at line 985 of file eevee_film.cc.

References blender::DRW_manager_get(), and blender::draw::Manager::submit().

Referenced by blender::eevee::Instance::render_frame(), and write_viewport_compositor_passes().

◆ display()

◆ display_extent_get()

int2 blender::eevee::Film::display_extent_get ( ) const
inline

Size of the whole viewport or the render, disregarding the render region.

Definition at line 184 of file eevee_film.hh.

Referenced by blender::eevee::Instance::init().

◆ enabled_passes_get()

eViewLayerEEVEEPassType Film::enabled_passes_get ( ) const

Definition at line 788 of file eevee_film.cc.

References blender::EEVEE_RENDER_PASS_VECTOR.

◆ end_sync()

void Film::end_sync ( )

Definition at line 722 of file eevee_film.cc.

References aovs_info, and update_sample_table().

Referenced by blender::eevee::Instance::end_sync().

◆ film_extent_get()

int2 blender::eevee::Film::film_extent_get ( ) const
inline

Size and offset of the film (taking into account render region).

Definition at line 174 of file eevee_film.hh.

◆ film_offset_get()

int2 blender::eevee::Film::film_offset_get ( ) const
inline

Definition at line 178 of file eevee_film.hh.

◆ get_aov_texture()

◆ get_data()

const FilmData & blender::eevee::Film::get_data ( )
inline

Definition at line 130 of file eevee_film.hh.

Referenced by blender::eevee::Instance::init().

◆ get_pass_texture()

◆ init()

void Film::init ( const int2 & full_extent,
const rcti * output_rect )

Definition at line 301 of file eevee_film.cc.

References blender::RenderData::alphamode, blender::View3DShading::aov_name, aovs_info, blender::assign_if_different(), blender::BKE_render_preview_pixel_size(), blender::BLI_rcti_init(), blender::BLI_rcti_is_empty(), blender::BLI_rcti_size_x(), blender::BLI_rcti_size_y(), ceilf, blender::clamp_f(), cryptomatte_layer_len_get(), depth, divide_ceil(), blender::divide_ceil_u(), blender::DRW_STATE_DEPTH_GREATER_EQUAL, blender::EEVEE_RENDER_PASS_AO, blender::EEVEE_RENDER_PASS_COMBINED, blender::EEVEE_RENDER_PASS_CRYPTOMATTE_ASSET, blender::EEVEE_RENDER_PASS_CRYPTOMATTE_MATERIAL, blender::EEVEE_RENDER_PASS_CRYPTOMATTE_OBJECT, blender::EEVEE_RENDER_PASS_DENOISING_DEPTH, blender::EEVEE_RENDER_PASS_DENOISING_DIFFUSE_ALBEDO, blender::EEVEE_RENDER_PASS_DENOISING_NORMAL, blender::EEVEE_RENDER_PASS_DENOISING_ROUGHNESS, blender::EEVEE_RENDER_PASS_DENOISING_SPECULAR_ALBEDO, blender::EEVEE_RENDER_PASS_DEPTH, blender::EEVEE_RENDER_PASS_DIFFUSE_COLOR, blender::EEVEE_RENDER_PASS_DIFFUSE_LIGHT, blender::EEVEE_RENDER_PASS_EMIT, blender::EEVEE_RENDER_PASS_ENVIRONMENT, blender::EEVEE_RENDER_PASS_MIST, blender::EEVEE_RENDER_PASS_NORMAL, blender::EEVEE_RENDER_PASS_POSITION, blender::EEVEE_RENDER_PASS_SHADOW, blender::EEVEE_RENDER_PASS_SPECULAR_COLOR, blender::EEVEE_RENDER_PASS_SPECULAR_LIGHT, blender::EEVEE_RENDER_PASS_TRANSPARENT, blender::EEVEE_RENDER_PASS_UNUSED_14, blender::EEVEE_RENDER_PASS_UNUSED_8, blender::EEVEE_RENDER_PASS_VECTOR, blender::EEVEE_RENDER_PASS_VOLUME_LIGHT, blender::eevee::enabled_passes(), blender::ColorManagedViewSettings::exposure, blender::RenderData::gauss, blender::bke::compositor::get_used_passes(), blender::eevee::get_viewport_compositor_enabled_passes(), blender::GPU_max_texture_size(), blender::math::max(), blender::max_ii(), blender::RenderData::mode, overscan_pixels_get(), blender::eevee::PASS_CATEGORY_COLOR_1, blender::eevee::PASS_CATEGORY_COLOR_2, blender::eevee::PASS_CATEGORY_COLOR_3, blender::eevee::PASS_CATEGORY_CRYPTOMATTE, blender::eevee::PASS_CATEGORY_DATA, blender::eevee::PASS_CATEGORY_DENOISE, blender::eevee::PASS_STORAGE_COLOR, blender::eevee::PASS_STORAGE_CRYPTOMATTE, blender::eevee::PASS_STORAGE_DENOISING_DEPTH, pass_storage_type(), blender::eevee::PASS_STORAGE_VALUE, blender::pow2f(), blender::bke::compositor::Preview, blender::Scene::r, blender::R_ALPHAPREMUL, blender::R_MBLUR, blender::View3DShading::render_pass, reset(), blender::eevee::Sampling::sample_count(), sqrtf, blender::Scene::view_settings, blender::eevee::with_light_pass_color_dependencies(), blender::rcti::xmin, and blender::rcti::ymin.

Referenced by blender::eevee::Instance::init(), and blender::eevee::Instance::init_light_bake().

◆ is_valid_render_extent()

bool blender::eevee::Film::is_valid_render_extent ( ) const
inline

Definition at line 168 of file eevee_film.hh.

Referenced by blender::eevee::Instance::init().

◆ overscan_pixels_get()

int blender::eevee::Film::overscan_pixels_get ( float overscan,
int2 extent )
inlinestatic

Returns number of overscan pixels for the given parameters.

Definition at line 196 of file eevee_film.hh.

References blender::math::ceil(), blender::max_ff(), and blender::math::reduce_max().

Referenced by init(), and blender::eevee::Camera::sync().

◆ pass_id_get()

◆ pass_is_float3()

bool blender::eevee::Film::pass_is_float3 ( eViewLayerEEVEEPassType pass_type)
inlinestatic

◆ pass_storage_type()

◆ pass_to_render_pass_names()

const Vector< std::string > blender::eevee::Film::pass_to_render_pass_names ( eViewLayerEEVEEPassType pass_type,
const ViewLayer * view_layer )
inlinestatic

Definition at line 301 of file eevee_film.hh.

References blender::BLI_assert(), blender::ViewLayer::cryptomatte_levels, blender::EEVEE_RENDER_PASS_AO, blender::EEVEE_RENDER_PASS_COMBINED, blender::EEVEE_RENDER_PASS_CRYPTOMATTE_ASSET, blender::EEVEE_RENDER_PASS_CRYPTOMATTE_MATERIAL, blender::EEVEE_RENDER_PASS_CRYPTOMATTE_OBJECT, blender::EEVEE_RENDER_PASS_DENOISING_DEPTH, blender::EEVEE_RENDER_PASS_DENOISING_DIFFUSE_ALBEDO, blender::EEVEE_RENDER_PASS_DENOISING_NORMAL, blender::EEVEE_RENDER_PASS_DENOISING_ROUGHNESS, blender::EEVEE_RENDER_PASS_DENOISING_SPECULAR_ALBEDO, blender::EEVEE_RENDER_PASS_DEPTH, blender::EEVEE_RENDER_PASS_DIFFUSE_COLOR, blender::EEVEE_RENDER_PASS_DIFFUSE_LIGHT, blender::EEVEE_RENDER_PASS_EMIT, blender::EEVEE_RENDER_PASS_ENVIRONMENT, blender::EEVEE_RENDER_PASS_MIST, blender::EEVEE_RENDER_PASS_NORMAL, blender::EEVEE_RENDER_PASS_POSITION, blender::EEVEE_RENDER_PASS_SHADOW, blender::EEVEE_RENDER_PASS_SPECULAR_COLOR, blender::EEVEE_RENDER_PASS_SPECULAR_LIGHT, blender::EEVEE_RENDER_PASS_TRANSPARENT, blender::EEVEE_RENDER_PASS_VECTOR, blender::EEVEE_RENDER_PASS_VOLUME_LIGHT, RE_PASSNAME_AO, RE_PASSNAME_COMBINED, RE_PASSNAME_CRYPTOMATTE_ASSET, RE_PASSNAME_CRYPTOMATTE_MATERIAL, RE_PASSNAME_CRYPTOMATTE_OBJECT, RE_PASSNAME_DENOISING_DEPTH, RE_PASSNAME_DENOISING_DIFFUSE_ALBEDO, RE_PASSNAME_DENOISING_NORMAL, RE_PASSNAME_DENOISING_ROUGHNESS, RE_PASSNAME_DENOISING_SPECULAR_ALBEDO, RE_PASSNAME_DEPTH, RE_PASSNAME_DIFFUSE_COLOR, RE_PASSNAME_DIFFUSE_DIRECT, RE_PASSNAME_EMIT, RE_PASSNAME_ENVIRONMENT, RE_PASSNAME_GLOSSY_COLOR, RE_PASSNAME_GLOSSY_DIRECT, RE_PASSNAME_MIST, RE_PASSNAME_NORMAL, RE_PASSNAME_POSITION, RE_PASSNAME_SHADOW, RE_PASSNAME_TRANSPARENT, RE_PASSNAME_VECTOR, RE_PASSNAME_VOLUME_LIGHT, and blender::result.

Referenced by blender::eevee::get_viewport_compositor_enabled_passes(), blender::eevee::Instance::update_passes(), and write_viewport_compositor_passes().

◆ pixel_jitter_get()

◆ read_aov()

◆ read_pass()

◆ render_extent_get()

int2 blender::eevee::Film::render_extent_get ( ) const
inline

Returns the extent rendered by one shading view, including overscan: a square cubemap face for panoramic cameras and the rectangular render extent for all other cameras.

Definition at line 156 of file eevee_film.hh.

◆ render_extent_original_get()

int2 blender::eevee::Film::render_extent_original_get ( ) const
inline

Returns the film's resolution. Includes overscan pixels.

Definition at line 164 of file eevee_film.hh.

◆ render_overscan_get()

int blender::eevee::Film::render_overscan_get ( ) const
inline

Number of padding pixels around the render target. Included inside render_extent_get.

Definition at line 190 of file eevee_film.hh.

◆ scaling_factor_get()

int blender::eevee::Film::scaling_factor_get ( ) const
inline

Definition at line 201 of file eevee_film.hh.

◆ sync()

◆ update_sample_table()

◆ write_viewport_compositor_passes()

Member Data Documentation

◆ aovs_info

StorageBuffer<AOVsInfoData> blender::eevee::Film::aovs_info

Stores indirection table of AOVs based on their name hash and their type.

Definition at line 59 of file eevee_film.hh.

Referenced by end_sync(), get_aov_texture(), and init().

◆ depth

struct blender::eevee::Film::DepthState blender::eevee::Film::depth

Referenced by init().

◆ use_box_filter

bool blender::eevee::Film::use_box_filter = false
staticconstexpr

For debugging purpose but could be a user option in the future.

Definition at line 61 of file eevee_film.hh.

Referenced by pixel_jitter_get(), and update_sample_table().


The documentation for this class was generated from the following files: