A running instance of the engine. More...

#include <eevee_instance.hh>

Public Member Functions
	Instance ()
	~Instance ()
template<typename... Args>
void	info_append (const char *msg, Args &&...args)
template<typename... Args>
void	info_append_i18n (const char *msg, Args &&...args)
const char *	info_get ()
bool	is_viewport () const
bool	is_image_render () const
bool	is_viewport_image_render () const
bool	is_baking () const
bool	overlays_enabled () const
bool	gpencil_engine_enabled () const
bool	is_playback () const
bool	is_transforming () const
bool	is_navigating () const
bool	is_painting () const
bool	use_scene_lights () const
bool	use_studio_light () const
bool	use_lookdev_overlay () const
int	get_recalc_flags (const ObjectRef &ob_ref)
int	get_recalc_flags (const ::World &world)

Public Attributes
ShaderModule &	shaders
SyncModule	sync
UniformDataModule	uniform_data
MaterialModule	materials
SubsurfaceModule	subsurface
PipelineModule	pipelines
ShadowModule	shadows
LightModule	lights
AmbientOcclusion	ambient_occlusion
RayTraceModule	raytracing
VelocityModule	velocity
MotionBlurModule	motion_blur
DepthOfField	depth_of_field
Cryptomatte	cryptomatte
GBuffer	gbuffer
HiZBuffer	hiz_buffer
Sampling	sampling
Camera	camera
Film	film
RenderBuffers	render_buffers
MainView	main_view
CaptureView	capture_view
World	world
LookdevView	lookdev_view
LookdevModule	lookdev
SphereProbeModule	sphere_probes
PlanarProbeModule	planar_probes
VolumeProbeModule	volume_probes
LightProbeModule	light_probes
VolumeModule	volume
Depsgraph *	depsgraph
Manager *	manager
Scene *	scene
ViewLayer *	view_layer
Object *	camera_eval_object
Object *	camera_orig_object
const RenderLayer *	render_layer
RenderEngine *	render
const DRWView *	drw_view
const View3D *	v3d
const RegionView3D *	rv3d
bool	is_light_bake = false
bool	use_surfaces = true
bool	use_curves = true
bool	use_volumes = true
eDebugMode	debug_mode = eDebugMode::DEBUG_NONE

Initialization
Initialization functions need to be called once at the start of a frame. Active camera, render extent and enabled render passes are immutable until next init. This takes care of resizing output buffers and view in case a parameter changed. IMPORTANT: xxx.init() functions are NOT meant to acquire and allocate DRW resources. Any attempt to do so will likely produce use after free situations.
void	init (const int2 &output_res, const rcti output_rect, const rcti visible_rect, RenderEngine render, Depsgraph depsgraph, Object camera_object=nullptr, const RenderLayer render_layer=nullptr, const DRWView drw_view=nullptr, const View3D v3d=nullptr, const RegionView3D *rv3d=nullptr)
void	view_update ()
void	init_light_bake (Depsgraph depsgraph, draw::Manager manager)

Sync
Sync will gather data from the scene that can change over a time step (i.e: motion steps). IMPORTANT: xxx.sync() functions area responsible for creating DRW resources (i.e: DRWView) as well as querying temp texture pool. All DRWPasses should be ready by the end end_sync().
void	begin_sync ()
void	object_sync (Object *ob)
void	end_sync ()
bool	do_lightprobe_sphere_sync () const
bool	do_planar_probe_sync () const
bool	needs_lightprobe_sphere_passes () const
bool	needs_planar_probe_passes () const
void	render_sync ()

Interface
void	render_frame (RenderEngine engine, RenderLayer render_layer, const char *view_name)
void	store_metadata (RenderResult *render_result)
void	draw_viewport ()
void	draw_viewport_image_render ()
void	light_bake_irradiance (Object &probe, FunctionRef< void()> context_enable, FunctionRef< void()> context_disable, FunctionRef< bool()> stop, FunctionRef< void(LightProbeGridCacheFrame *, float progress)> result_update)
static void	update_passes (RenderEngine engine, Scene scene, ViewLayer *view_layer)

Detailed Description

A running instance of the engine.

Definition at line 68 of file eevee_instance.hh.

Constructor & Destructor Documentation

◆ Instance()

blender::eevee::Instance::Instance ( )

inline

Definition at line 145 of file eevee_instance.hh.

References ambient_occlusion, camera, capture_view, blender::math::clamp(), cryptomatte, data, depth_of_field, film, hiz_buffer, light_probes, lights, lookdev, lookdev_view, main_view, materials, motion_blur, pipelines, planar_probes, raytracing, render_buffers, sampling, shaders, shadows, sphere_probes, subsurface, sync, uniform_data, velocity, volume, volume_probes, and world.

◆ ~Instance()

blender::eevee::Instance::~Instance ( )

inline

Definition at line 174 of file eevee_instance.hh.

Member Function Documentation

◆ begin_sync()

void blender::eevee::Instance::begin_sync ( )

Definition at line 191 of file eevee_instance.cc.

References ambient_occlusion, cryptomatte, depth_of_field, film, hiz_buffer, is_light_bake, is_viewport(), light_probes, lights, lookdev, main_view, materials, motion_blur, pipelines, raytracing, sampling, SCE_LAY_SOLID, SCE_LAY_STRAND, SCE_LAY_VOLUMES, shadows, sphere_probes, use_curves, use_surfaces, use_volumes, velocity, view_layer, volume, volume_probes, and world.

Referenced by blender::eevee::DeferredPipeline::begin_sync(), and render_sync().

◆ do_lightprobe_sphere_sync()

bool blender::eevee::Instance::do_lightprobe_sphere_sync ( ) const

Return true when probe pipeline is used during this sample.

Definition at line 376 of file eevee_instance.cc.

References materials, and needs_lightprobe_sphere_passes().

◆ do_planar_probe_sync()

bool blender::eevee::Instance::do_planar_probe_sync ( ) const

Definition at line 386 of file eevee_instance.cc.

References materials, and needs_planar_probe_passes().

◆ draw_viewport()

void blender::eevee::Instance::draw_viewport ( )

Definition at line 558 of file eevee_instance.cc.

References DefaultFramebufferList::default_fb, DRW_state_is_playback(), DRW_viewport_framebuffer_list_get(), DRW_viewport_request_redraw(), film, GPU_BACKEND_OPENGL, GPU_DEVICE_ANY, GPU_DRIVER_ANY, GPU_framebuffer_clear_color_depth(), GPU_OS_ANY, GPU_type_matches_ex(), GPU_use_parallel_compilation(), info_append_i18n(), materials, sampling, and velocity.

Referenced by eevee_draw_scene().

◆ draw_viewport_image_render()

void blender::eevee::Instance::draw_viewport_image_render ( )

Definition at line 599 of file eevee_instance.cc.

References film, sampling, and velocity.

Referenced by eevee_draw_scene().

◆ end_sync()

void blender::eevee::Instance::end_sync ( )

Definition at line 316 of file eevee_instance.cc.

References cryptomatte, DEG_get_update_count(), depsgraph, film, light_probes, lights, pipelines, planar_probes, sampling, shadows, sphere_probes, subsurface, uniform_data, velocity, and volume.

Referenced by render_sync().

◆ get_recalc_flags() [1/2]

int blender::eevee::Instance::get_recalc_flags ( const ::World & world )

inline

Definition at line 351 of file eevee_instance.hh.

References ID_RECALC_SHADING, int, and world.

◆ get_recalc_flags() [2/2]

int blender::eevee::Instance::get_recalc_flags ( const ObjectRef & ob_ref )

inline

Definition at line 330 of file eevee_instance.hh.

References blender::draw::ObjectRef::dupli_parent, ID_RECALC_GEOMETRY, ID_RECALC_SHADING, ID_RECALC_TRANSFORM, blender::draw::ObjectRef::object, Object::runtime, and SET_FLAG_FROM_TEST.

◆ gpencil_engine_enabled()

bool blender::eevee::Instance::gpencil_engine_enabled ( ) const

inline

True if the grease pencil engine might be running.

Definition at line 280 of file eevee_instance.hh.

References DEG_id_type_any_exists(), depsgraph, and ID_GP.

◆ info_append()

template<typename... Args>

void blender::eevee::Instance::info_append	(	const char *	msg,
		Args &&...	args )

inline

Definition at line 232 of file eevee_instance.hh.

Referenced by blender::eevee::DeferredPipeline::debug_draw().

◆ info_append_i18n()

template<typename... Args>

void blender::eevee::Instance::info_append_i18n	(	const char *	msg,
		Args &&...	args )

inline

Definition at line 240 of file eevee_instance.hh.

References BLI_str_endswith(), and RPT_.

Referenced by draw_viewport().

◆ info_get()

const char * blender::eevee::Instance::info_get ( )

inline

Definition at line 249 of file eevee_instance.hh.

Referenced by eevee_draw_scene().

◆ init()

void blender::eevee::Instance::init	(	const int2 &	output_res,
		const rcti *	output_rect,
		const rcti *	visible_rect,
		RenderEngine *	render,
		Depsgraph *	depsgraph,
		Object *	camera_object = nullptr,
		const RenderLayer *	render_layer = nullptr,
		const DRWView *	drw_view = nullptr,
		const View3D *	v3d = nullptr,
		const RegionView3D *	rv3d = nullptr )

Definition at line 47 of file eevee_instance.cc.

References ambient_occlusion, blender::assign_if_different(), BLI_rcti_size_x(), BLI_rcti_size_y(), camera, camera_orig_object, debug_mode, depsgraph, depth_of_field, DRW_manager_get(), drw_view, film, G, is_image_render(), is_navigating(), is_painting(), light_probes, lookdev, main_view, manager, motion_blur, planar_probes, raytracing, render, render_buffers, render_layer, rv3d, sampling, SCE_EEVEE_SHADOW_JITTERED_VIEWPORT, scene, shaders, shadows, sphere_probes, v3d, V3D_HIDE_OVERLAYS, velocity, volume, volume_probes, rcti::xmin, and rcti::ymin.

Referenced by eevee_engine_init().

◆ init_light_bake()

void blender::eevee::Instance::init_light_bake	(	Depsgraph *	depsgraph,
		draw::Manager *	manager )

Definition at line 123 of file eevee_instance.cc.

References camera, camera_orig_object, debug_mode, depsgraph, depth_of_field, drw_view, film, G, is_light_bake, light_probes, lookdev, main_view, manager, planar_probes, render, render_buffers, render_layer, rv3d, sampling, scene, shaders, shadows, sphere_probes, v3d, velocity, volume, and volume_probes.

◆ is_baking()

bool blender::eevee::Instance::is_baking ( ) const

inline

Definition at line 269 of file eevee_instance.hh.

References is_light_bake.

Referenced by is_viewport(), and light_bake_irradiance().

◆ is_image_render()

bool blender::eevee::Instance::is_image_render ( ) const

inline

Definition at line 259 of file eevee_instance.hh.

References DRW_state_is_image_render().

Referenced by init(), and is_transforming().

◆ is_navigating()

bool blender::eevee::Instance::is_navigating ( ) const

inline

Definition at line 296 of file eevee_instance.hh.

References DRW_state_is_navigating().

Referenced by init().

◆ is_painting()

bool blender::eevee::Instance::is_painting ( ) const

inline

Definition at line 301 of file eevee_instance.hh.

References DRW_state_is_painting().

Referenced by init().

◆ is_playback()

bool blender::eevee::Instance::is_playback ( ) const

inline

Definition at line 285 of file eevee_instance.hh.

References DRW_state_is_playback().

◆ is_transforming()

bool blender::eevee::Instance::is_transforming ( ) const

inline

Definition at line 290 of file eevee_instance.hh.

References BLI_assert_msg, G, G_TRANSFORM_EDIT, G_TRANSFORM_OBJ, and is_image_render().

◆ is_viewport()

bool blender::eevee::Instance::is_viewport ( ) const

inline

Definition at line 254 of file eevee_instance.hh.

References is_baking(), and render.

Referenced by begin_sync().

◆ is_viewport_image_render()

bool blender::eevee::Instance::is_viewport_image_render ( ) const

inline

Definition at line 264 of file eevee_instance.hh.

References DRW_state_is_viewport_image_render().

◆ light_bake_irradiance()

void blender::eevee::Instance::light_bake_irradiance	(	Object &	probe,
		FunctionRef< void()>	context_enable,
		FunctionRef< void()>	context_disable,
		FunctionRef< bool()>	stop,
		FunctionRef< void(LightProbeGridCacheFrame *, float progress)>	result_update )