#include <path_trace_work.h>

Inherited by PathTraceWorkCPU, and PathTraceWorkGPU.

Classes
struct	RenderStatistics

Public Member Functions
virtual	~PathTraceWork ()

RenderBuffers *	get_render_buffers ()

void	set_effective_buffer_params (const BufferParams &effective_full_params, const BufferParams &effective_big_tile_params, const BufferParams &effective_buffer_params)

bool	has_multiple_works () const

virtual void	alloc_work_memory ()

virtual void	init_execution ()=0

virtual void	render_samples (RenderStatistics &statistics, int start_sample, int samples_num, int sample_offset)=0

virtual void	copy_to_display (PathTraceDisplay *display, PassMode pass_mode, int num_samples)=0

virtual void	destroy_gpu_resources (PathTraceDisplay *display)=0

void	copy_to_render_buffers (RenderBuffers *render_buffers)

void	copy_from_render_buffers (const RenderBuffers *render_buffers)

void	copy_from_denoised_render_buffers (const RenderBuffers *render_buffers)

virtual bool	copy_render_buffers_from_device ()=0

virtual bool	copy_render_buffers_to_device ()=0

virtual bool	zero_render_buffers ()=0

bool	get_render_tile_pixels (const PassAccessor &pass_accessor, const PassAccessor::Destination &destination)

bool	set_render_tile_pixels (PassAccessor &pass_accessor, const PassAccessor::Source &source)

virtual int	adaptive_sampling_converge_filter_count_active (float threshold, bool reset)=0

virtual void	cryptomatte_postproces ()=0

bool	is_cancel_requested () const

Device *	get_device () const

Static Public Member Functions
static unique_ptr< PathTraceWork >	create (Device device, Film film, DeviceScene device_scene, bool cancel_requested_flag)

Protected Member Functions
	PathTraceWork (Device device, Film film, DeviceScene device_scene, bool cancel_requested_flag)

PassAccessor::PassAccessInfo	get_display_pass_access_info (PassMode pass_mode) const

PassAccessor::Destination	get_display_destination_template (const PathTraceDisplay *display) const

Protected Attributes
Device *	device_

Film *	film_

DeviceScene *	device_scene_

unique_ptr< RenderBuffers >	buffers_

BufferParams	effective_full_params_

BufferParams	effective_big_tile_params_

BufferParams	effective_buffer_params_

bool *	cancel_requested_flag_ = nullptr

Detailed Description

Definition at line 22 of file path_trace_work.h.

Constructor & Destructor Documentation

◆ ~PathTraceWork()

PathTraceWork::~PathTraceWork ( )

virtual

Definition at line 48 of file path_trace_work.cpp.

◆ PathTraceWork()

PathTraceWork::PathTraceWork	(	Device *	device,
		Film *	film,
		DeviceScene *	device_scene,
		bool *	cancel_requested_flag )

protected

Definition at line 35 of file path_trace_work.cpp.

Member Function Documentation

◆ adaptive_sampling_converge_filter_count_active()

virtual int PathTraceWork::adaptive_sampling_converge_filter_count_active	(	float	threshold,
		bool	reset )

pure virtual

Implemented in PathTraceWorkCPU, and PathTraceWorkGPU.

◆ alloc_work_memory()

virtual void PathTraceWork::alloc_work_memory ( )

inlinevirtual

Reimplemented in PathTraceWorkGPU.

Definition at line 55 of file path_trace_work.h.

◆ copy_from_denoised_render_buffers()

void PathTraceWork::copy_from_denoised_render_buffers ( const RenderBuffers * render_buffers )

Definition at line 112 of file path_trace_work.cpp.

References buffers_, copy_render_buffers_to_device(), effective_big_tile_params_, effective_buffer_params_, BufferParams::full_y, render_buffers_host_copy_denoised(), and BufferParams::width.

◆ copy_from_render_buffers()

void PathTraceWork::copy_from_render_buffers ( const RenderBuffers * render_buffers )

Definition at line 93 of file path_trace_work.cpp.

References RenderBuffers::buffer, buffers_, copy_render_buffers_to_device(), device_vector< T >::data(), effective_big_tile_params_, effective_buffer_params_, float, BufferParams::full_y, BufferParams::height, BufferParams::pass_stride, and BufferParams::width.

◆ copy_render_buffers_from_device()

virtual bool PathTraceWork::copy_render_buffers_from_device ( )

pure virtual

Implemented in PathTraceWorkCPU, and PathTraceWorkGPU.

Referenced by copy_to_render_buffers().

◆ copy_render_buffers_to_device()

virtual bool PathTraceWork::copy_render_buffers_to_device ( )

pure virtual

Implemented in PathTraceWorkCPU, and PathTraceWorkGPU.

Referenced by copy_from_denoised_render_buffers(), and copy_from_render_buffers().

◆ copy_to_display()

virtual void PathTraceWork::copy_to_display	(	PathTraceDisplay *	display,
		PassMode	pass_mode,
		int	num_samples )

pure virtual

Implemented in PathTraceWorkCPU, and PathTraceWorkGPU.

◆ copy_to_render_buffers()

void PathTraceWork::copy_to_render_buffers ( RenderBuffers * render_buffers )

Definition at line 74 of file path_trace_work.cpp.

References RenderBuffers::buffer, buffers_, copy_render_buffers_from_device(), device_vector< T >::data(), effective_big_tile_params_, effective_buffer_params_, float, BufferParams::full_y, BufferParams::height, BufferParams::pass_stride, and BufferParams::width.

◆ create()

CCL_NAMESPACE_BEGIN unique_ptr< PathTraceWork > PathTraceWork::create	(	Device *	device,
		Film *	film,
		DeviceScene *	device_scene,
		bool *	cancel_requested_flag )

static

Definition at line 19 of file path_trace_work.cpp.

References DEVICE_CPU, DEVICE_DUMMY, Device::info, and DeviceInfo::type.

Referenced by PathTrace::denoise(), and PathTrace::PathTrace().

◆ cryptomatte_postproces()

virtual void PathTraceWork::cryptomatte_postproces ( )

pure virtual

Implemented in PathTraceWorkCPU, and PathTraceWorkGPU.

◆ destroy_gpu_resources()

virtual void PathTraceWork::destroy_gpu_resources ( PathTraceDisplay * display )

pure virtual

Implemented in PathTraceWorkCPU, and PathTraceWorkGPU.

◆ get_device()

Device * PathTraceWork::get_device ( ) const

inline

Definition at line 139 of file path_trace_work.h.

References device_.

Referenced by PathTrace::path_trace().

◆ get_display_destination_template()

PassAccessor::Destination PathTraceWork::get_display_destination_template ( const PathTraceDisplay * display ) const

protected

Definition at line 186 of file path_trace_work.cpp.

References effective_big_tile_params_, effective_buffer_params_, film_, BufferParams::full_x, BufferParams::full_y, BufferParams::window_x, BufferParams::window_y, and int2::x.

Referenced by PathTraceWorkCPU::copy_to_display(), and PathTraceWorkGPU::copy_to_display_interop().

◆ get_display_pass_access_info()

PassAccessor::PassAccessInfo PathTraceWork::get_display_pass_access_info ( PassMode pass_mode ) const

protected

Definition at line 149 of file path_trace_work.cpp.

References buffers_, DeviceScene::data, DENOISED, device_scene_, film_, PassAccessor::PassAccessInfo::mode, NOISY, PassAccessor::PassAccessInfo::offset, params, PASS_UNUSED, PassAccessor::PassAccessInfo::show_active_pixels, BufferPass::type, PassAccessor::PassAccessInfo::type, PassAccessor::PassAccessInfo::use_approximate_shadow_catcher, and PassAccessor::PassAccessInfo::use_approximate_shadow_catcher_background.

Referenced by PathTraceWorkCPU::copy_to_display(), and PathTraceWorkGPU::get_render_tile_film_pixels().

◆ get_render_buffers()

RenderBuffers * PathTraceWork::get_render_buffers ( )

Definition at line 50 of file path_trace_work.cpp.

References buffers_.

Referenced by PathTrace::update_allocated_work_buffer_params().

◆ get_render_tile_pixels()

bool PathTraceWork::get_render_tile_pixels	(	const PassAccessor &	pass_accessor,
		const PassAccessor::Destination &	destination )

Definition at line 124 of file path_trace_work.cpp.

References buffers_, effective_big_tile_params_, effective_buffer_params_, BufferParams::full_y, PassAccessor::get_render_tile_pixels(), PassAccessor::Destination::offset, BufferParams::width, and BufferParams::window_y.

◆ has_multiple_works()

bool PathTraceWork::has_multiple_works ( ) const

Definition at line 64 of file path_trace_work.cpp.

References effective_big_tile_params_, effective_buffer_params_, BufferParams::full_x, BufferParams::full_y, BufferParams::height, and BufferParams::width.

Referenced by PathTraceWorkGPU::should_use_graphics_interop().

◆ init_execution()

virtual void PathTraceWork::init_execution ( )

pure virtual

Implemented in PathTraceWorkCPU, and PathTraceWorkGPU.

◆ is_cancel_requested()

bool PathTraceWork::is_cancel_requested ( ) const

inline

Definition at line 131 of file path_trace_work.h.

References cancel_requested_flag_.

Referenced by PathTraceWorkGPU::enqueue_work_tiles(), PathTraceWorkCPU::render_samples(), PathTraceWorkGPU::render_samples(), and PathTraceWorkCPU::render_samples_full_pipeline().

◆ render_samples()

virtual void PathTraceWork::render_samples	(	RenderStatistics &	statistics,
		int	start_sample,
		int	samples_num,
		int	sample_offset )

pure virtual

Implemented in PathTraceWorkCPU, and PathTraceWorkGPU.

Referenced by PathTrace::path_trace().

◆ set_effective_buffer_params()

void PathTraceWork::set_effective_buffer_params	(	const BufferParams &	effective_full_params,
		const BufferParams &	effective_big_tile_params,
		const BufferParams &	effective_buffer_params )

Definition at line 55 of file path_trace_work.cpp.

References effective_big_tile_params_, effective_buffer_params_, and effective_full_params_.

Referenced by PathTrace::update_effective_work_buffer_params().

◆ set_render_tile_pixels()

bool PathTraceWork::set_render_tile_pixels	(	PassAccessor &	pass_accessor,
		const PassAccessor::Source &	source )

Definition at line 137 of file path_trace_work.cpp.

References buffers_, effective_big_tile_params_, effective_buffer_params_, BufferParams::full_y, PassAccessor::Source::offset, PassAccessor::set_render_tile_pixels(), and BufferParams::width.

◆ zero_render_buffers()

virtual bool PathTraceWork::zero_render_buffers ( )

pure virtual

Implemented in PathTraceWorkCPU, and PathTraceWorkGPU.

Member Data Documentation

◆ buffers_

unique_ptr<RenderBuffers> PathTraceWork::buffers_

protected

Definition at line 176 of file path_trace_work.h.

◆ cancel_requested_flag_

bool* PathTraceWork::cancel_requested_flag_ = nullptr

protected

Definition at line 185 of file path_trace_work.h.

Referenced by is_cancel_requested().

◆ device_

Device* PathTraceWork::device_

protected

Definition at line 164 of file path_trace_work.h.

Referenced by PathTraceWorkCPU::adaptive_sampling_converge_filter_count_active(), PathTraceWorkGPU::adaptive_sampling_convergence_check_count_active(), PathTraceWorkCPU::copy_to_display(), PathTraceWorkGPU::copy_to_display(), PathTraceWorkCPU::cryptomatte_postproces(), get_device(), PathTraceWorkCPU::init_execution(), PathTraceWorkGPU::init_execution(), PathTraceWorkCPU::render_samples(), and PathTraceWorkGPU::render_samples().

◆ device_scene_

DeviceScene* PathTraceWork::device_scene_

protected

Definition at line 171 of file path_trace_work.h.

◆ effective_big_tile_params_

BufferParams PathTraceWork::effective_big_tile_params_

protected

Definition at line 182 of file path_trace_work.h.

Referenced by copy_from_denoised_render_buffers(), copy_from_render_buffers(), PathTraceWorkGPU::copy_to_display_naive(), copy_to_render_buffers(), get_display_destination_template(), get_render_tile_pixels(), has_multiple_works(), set_effective_buffer_params(), and set_render_tile_pixels().

◆ effective_buffer_params_

BufferParams PathTraceWork::effective_buffer_params_

protected

Definition at line 183 of file path_trace_work.h.

Referenced by PathTraceWorkCPU::adaptive_sampling_converge_filter_count_active(), PathTraceWorkGPU::adaptive_sampling_convergence_check_count_active(), copy_from_denoised_render_buffers(), copy_from_render_buffers(), PathTraceWorkCPU::copy_to_display(), PathTraceWorkGPU::copy_to_display_naive(), copy_to_render_buffers(), PathTraceWorkCPU::cryptomatte_postproces(), PathTraceWorkGPU::cryptomatte_postproces(), PathTraceWorkGPU::enqueue_adaptive_sampling_filter_x(), PathTraceWorkGPU::enqueue_adaptive_sampling_filter_y(), get_display_destination_template(), PathTraceWorkGPU::get_render_tile_film_pixels(), get_render_tile_pixels(), has_multiple_works(), PathTraceWorkCPU::render_samples(), PathTraceWorkGPU::render_samples(), set_effective_buffer_params(), and set_render_tile_pixels().

◆ effective_full_params_

BufferParams PathTraceWork::effective_full_params_

protected

Definition at line 181 of file path_trace_work.h.

Referenced by set_effective_buffer_params().

◆ film_

Film* PathTraceWork::film_

protected

Definition at line 168 of file path_trace_work.h.

Referenced by PathTraceWorkGPU::copy_to_display_naive(), get_display_destination_template(), and get_display_pass_access_info().

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~PathTraceWork()

◆ PathTraceWork()

Member Function Documentation

◆ adaptive_sampling_converge_filter_count_active()

◆ alloc_work_memory()

◆ copy_from_denoised_render_buffers()

◆ copy_from_render_buffers()

◆ copy_render_buffers_from_device()

◆ copy_render_buffers_to_device()

◆ copy_to_display()

◆ copy_to_render_buffers()

◆ create()

◆ cryptomatte_postproces()

◆ destroy_gpu_resources()

◆ get_device()

◆ get_display_destination_template()

◆ get_display_pass_access_info()

◆ get_render_buffers()

◆ get_render_tile_pixels()

◆ has_multiple_works()

◆ init_execution()

◆ is_cancel_requested()

◆ render_samples()

◆ set_effective_buffer_params()

◆ set_render_tile_pixels()

◆ zero_render_buffers()

Member Data Documentation

◆ buffers_

◆ cancel_requested_flag_

◆ device_

◆ device_scene_

◆ effective_big_tile_params_

◆ effective_buffer_params_

◆ effective_full_params_

◆ film_