Blender: Progress Class Reference

Blender V4.3

#include <progress.h>

Public Member Functions
	Progress ()

	Progress (Progress &progress)

Progress &	operator= (Progress &progress)

void	reset ()

void	set_cancel (const string &cancel_message_)

bool	get_cancel () const

string	get_cancel_message () const

void	set_cancel_callback (function< void()> function)

void	set_error (const string &error_message_)

bool	get_error () const

string	get_error_message () const

void	set_start_time ()

void	set_render_start_time ()

void	set_time_limit (double time_limit_)

void	add_skip_time (const scoped_timer &start_timer, bool only_render)

void	get_time (double &total_time_, double &render_time_) const

void	set_end_time ()

void	reset_sample ()

void	set_total_pixel_samples (uint64_t total_pixel_samples_)

double	get_progress () const

void	add_samples (uint64_t pixel_samples_, int tile_sample)

void	add_samples_update (uint64_t pixel_samples_, int tile_sample)

void	add_finished_tile (bool denoised)

int	get_current_sample () const

int	get_rendered_tiles () const

int	get_denoised_tiles () const

void	set_status (const string &status_, const string &substatus_="")

void	set_substatus (const string &substatus_)

void	set_sync_status (const string &status_, const string &substatus_="")

void	set_sync_substatus (const string &substatus_)

void	get_status (string &status_, string &substatus_) const

void	set_update ()

void	set_update_callback (function< void()> function)

Protected Attributes
thread_mutex	progress_mutex

thread_mutex	update_mutex

function< void()>	update_cb

function< void()>	cancel_cb

uint64_t	pixel_samples

uint64_t	total_pixel_samples

int	current_tile_sample

int	rendered_tiles

int	denoised_tiles

double	start_time

double	render_start_time

double	time_limit

double	end_time

string	status

string	substatus

string	sync_status

string	sync_substatus

volatile bool	cancel

string	cancel_message

volatile bool	error

string	error_message

Detailed Description

Definition at line 21 of file progress.h.

Constructor & Destructor Documentation

◆ Progress() [1/2]

Progress::Progress ( )

inline

Definition at line 23 of file progress.h.

References cancel, cancel_cb, cancel_message, current_tile_sample, denoised_tiles, end_time, error, error_message, function_null, pixel_samples, render_start_time, rendered_tiles, start_time, status, substatus, sync_status, sync_substatus, time_dt(), time_limit, total_pixel_samples, and update_cb.

◆ Progress() [2/2]

Progress::Progress ( Progress & progress )

inline

Definition at line 46 of file progress.h.

Member Function Documentation

◆ add_finished_tile()

void Progress::add_finished_tile ( bool denoised )

inline

Definition at line 229 of file progress.h.

References denoised_tiles, lock, progress_mutex, and rendered_tiles.

Referenced by Session::run_update_for_next_iteration().

◆ add_samples()

void Progress::add_samples	(	uint64_t	pixel_samples_,
		int	tile_sample )

inline

Definition at line 215 of file progress.h.

References current_tile_sample, lock, pixel_samples, and progress_mutex.

Referenced by add_samples_update(), and PathTrace::progress_update_if_needed().

◆ add_samples_update()

void Progress::add_samples_update	(	uint64_t	pixel_samples_,
		int	tile_sample )

inline

Definition at line 223 of file progress.h.

References add_samples(), and set_update().

◆ add_skip_time()

void Progress::add_skip_time	(	const scoped_timer &	start_timer,
		bool	only_render )

inline

Definition at line 158 of file progress.h.

References scoped_timer::get_start(), render_start_time, start_time, and time_dt().

Referenced by Session::run_update_for_next_iteration(), and Session::run_wait_for_work().

◆ get_cancel()

bool Progress::get_cancel ( ) const

inline

Definition at line 93 of file progress.h.

References cancel, and cancel_cb.

Referenced by BVHBuild::add_references(), ObjectManager::apply_static_transforms(), BlenderSession::bake(), BVH2::build(), LightTree::build(), BVHBuild::build_node(), Geometry::compute_bvh(), GeometryManager::device_update(), Scene::device_update(), GeometryManager::device_update_attributes(), LightManager::device_update_background(), GeometryManager::device_update_bvh(), LightManager::device_update_distribution(), GeometryManager::device_update_mesh(), ParticleSystemManager::device_update_particles(), SVMShaderManager::device_update_shader(), LightManager::device_update_tree(), ShaderEval::eval_cpu(), ShaderEval::eval_gpu(), PathTrace::is_cancel_requested(), LightTree::LightTree(), BVH2::refit(), BlenderSession::render(), BVHBuild::run(), Session::run_main_render_loop(), Session::run_update_for_next_iteration(), Session::run_wait_for_work(), BVHBuild::thread_build_node(), BVHBuild::thread_build_spatial_split_node(), and Session::thread_render().

◆ get_cancel_message()

string Progress::get_cancel_message ( ) const

inline

Definition at line 101 of file progress.h.

References cancel_message, lock, and progress_mutex.

Referenced by Session::thread_render().

◆ get_current_sample()

int Progress::get_current_sample ( ) const

inline

Definition at line 241 of file progress.h.

References current_tile_sample, lock, and progress_mutex.

Referenced by operator=(), and Session::update_status_time().

◆ get_denoised_tiles()

int Progress::get_denoised_tiles ( ) const

inline

Definition at line 255 of file progress.h.

References denoised_tiles, lock, and progress_mutex.

◆ get_error()

bool Progress::get_error ( ) const

inline

Definition at line 123 of file progress.h.

References error.

Referenced by BlenderSession::check_and_report_session_error().

◆ get_error_message()

string Progress::get_error_message ( ) const

inline

Definition at line 128 of file progress.h.

References error_message, lock, and progress_mutex.

Referenced by BlenderSession::check_and_report_session_error().

◆ get_progress()

double Progress::get_progress ( ) const

inline

Definition at line 200 of file progress.h.

References double(), lock, max, min, pixel_samples, progress_mutex, render_start_time, time_dt(), time_limit, and total_pixel_samples.

Referenced by Session::get_estimated_remaining_time(), BlenderSession::get_progress(), HdCyclesDelegate::GetRenderStats(), session_print_status(), and BlenderSession::update_bake_progress().

◆ get_rendered_tiles()

int Progress::get_rendered_tiles ( ) const

inline

Definition at line 249 of file progress.h.

References lock, progress_mutex, and rendered_tiles.

Referenced by Session::update_status_time().

◆ get_status()

void Progress::get_status	(	string &	status_,
		string &	substatus_ ) const

inline

Definition at line 305 of file progress.h.

References lock, progress_mutex, status, substatus, sync_status, and sync_substatus.

Referenced by BlenderSession::get_status(), HdCyclesDelegate::GetRenderStats(), operator=(), and session_print_status().

◆ get_time()

void Progress::get_time	(	double &	total_time_,
		double &	render_time_ ) const

inline

Definition at line 168 of file progress.h.

References end_time, lock, progress_mutex, render_start_time, start_time, and time_dt().

Referenced by Session::get_estimated_remaining_time(), BlenderSession::get_progress(), HdCyclesDelegate::GetRenderStats(), BlenderSession::render(), Session::run_main_render_loop(), and BlenderSession::stamp_view_layer_metadata().

◆ operator=()

Progress & Progress::operator= ( Progress & progress )

inline

Definition at line 51 of file progress.h.

References current_tile_sample, get_current_sample(), get_status(), lock, pixel_samples, progress_mutex, status, substatus, and total_pixel_samples.

◆ reset()

void Progress::reset ( )

inline

Definition at line 64 of file progress.h.

References cancel, cancel_message, current_tile_sample, denoised_tiles, end_time, error, error_message, pixel_samples, render_start_time, rendered_tiles, start_time, status, substatus, sync_status, sync_substatus, time_dt(), time_limit, and total_pixel_samples.

Referenced by HdCyclesRenderPass::HdCyclesRenderPass(), and BlenderSession::reset_session().

◆ reset_sample()

void Progress::reset_sample ( )

inline

Definition at line 183 of file progress.h.

References current_tile_sample, denoised_tiles, lock, pixel_samples, progress_mutex, and rendered_tiles.

Referenced by Session::do_delayed_reset(), and Session::thread_render().

◆ set_cancel()

void Progress::set_cancel ( const string & cancel_message_ )

inline

Definition at line 86 of file progress.h.

References cancel, cancel_message, lock, and progress_mutex.

Referenced by Session::cancel(), PathTrace::process_full_buffer_from_disk(), and BlenderSession::test_cancel().

◆ set_cancel_callback()

void Progress::set_cancel_callback ( function< void()> function )

inline

Definition at line 107 of file progress.h.

References cancel_cb.

Referenced by BlenderSession::create_session().

◆ set_end_time()

void Progress::set_end_time ( )

inline

Definition at line 178 of file progress.h.

References end_time, and time_dt().

Referenced by Session::update_status_time().

◆ set_error()

void Progress::set_error ( const string & error_message_ )

inline

Definition at line 113 of file progress.h.

References cancel, cancel_message, error, error_message, lock, and progress_mutex.

Referenced by LightManager::device_update_distribution(), Scene::load_kernels(), PathTrace::process_full_buffer_from_disk(), Session::run_main_render_loop(), and Session::Session().

◆ set_render_start_time()

void Progress::set_render_start_time ( )

inline

Definition at line 144 of file progress.h.

References lock, progress_mutex, render_start_time, and time_dt().

Referenced by Session::do_delayed_reset().

◆ set_start_time()

void Progress::set_start_time ( )

inline

Definition at line 136 of file progress.h.

References end_time, lock, progress_mutex, start_time, and time_dt().

Referenced by Session::do_delayed_reset().

◆ set_status()

void Progress::set_status	(	const string &	status_,
		const string &	substatus_ = "" )

inline

Definition at line 263 of file progress.h.

References lock, progress_mutex, set_update(), status, and substatus.

Referenced by Geometry::compute_bvh(), GeometryManager::create_volume_mesh(), Scene::device_update(), GeometryManager::device_update_attributes(), LightManager::device_update_background(), GeometryManager::device_update_bvh(), GeometryManager::device_update_displacement_images(), LightManager::device_update_distribution(), GeometryManager::device_update_mesh(), LightManager::device_update_tree(), GeometryManager::device_update_volume_images(), GeometryManager::displace(), Denoiser::load_kernels(), Scene::load_kernels(), PathTrace::progress_set_status(), Session::run_main_render_loop(), Session::run_update_for_next_iteration(), Session::thread_render(), ProceduralManager::update(), Scene::update(), Hair::update_shadow_transparency(), and Session::update_status_time().

◆ set_substatus()

void Progress::set_substatus ( const string & substatus_ )

inline

Definition at line 274 of file progress.h.

References lock, progress_mutex, set_update(), and substatus.

Referenced by BVH2::build(), BVHBuild::progress_update(), and BVH2::refit().

◆ set_sync_status()

void Progress::set_sync_status	(	const string &	status_,
		const string &	substatus_ = "" )

inline

Definition at line 284 of file progress.h.

References lock, progress_mutex, set_update(), sync_status, and sync_substatus.

◆ set_sync_substatus()

void Progress::set_sync_substatus ( const string & substatus_ )

inline

Definition at line 295 of file progress.h.

References lock, progress_mutex, set_update(), and sync_substatus.

◆ set_time_limit()

void Progress::set_time_limit ( double time_limit_ )

inline

Definition at line 151 of file progress.h.

References lock, progress_mutex, and time_limit.

Referenced by Session::do_delayed_reset().

◆ set_total_pixel_samples()

void Progress::set_total_pixel_samples ( uint64_t total_pixel_samples_ )

inline

Definition at line 193 of file progress.h.

References lock, progress_mutex, and total_pixel_samples.

Referenced by Session::do_delayed_reset().

◆ set_update()

void Progress::set_update ( )

inline

Definition at line 321 of file progress.h.

References lock, update_cb, and update_mutex.

Referenced by add_samples_update(), Scene::load_kernels(), Session::run_main_render_loop(), Session::run_wait_for_work(), set_status(), set_substatus(), set_sync_status(), set_sync_substatus(), and Session::thread_render().

◆ set_update_callback()

void Progress::set_update_callback ( function< void()> function )

inline

Definition at line 329 of file progress.h.

References update_cb.

Referenced by BlenderSession::bake(), BlenderSession::create_session(), and session_init().

Member Data Documentation

◆ cancel

volatile bool Progress::cancel

protected

Definition at line 363 of file progress.h.

Referenced by get_cancel(), Progress(), reset(), set_cancel(), and set_error().

◆ cancel_cb

function<void()> Progress::cancel_cb

protected

Definition at line 338 of file progress.h.

Referenced by get_cancel(), Progress(), and set_cancel_callback().

◆ cancel_message

string Progress::cancel_message

protected

Definition at line 364 of file progress.h.

Referenced by get_cancel_message(), Progress(), reset(), set_cancel(), and set_error().

◆ current_tile_sample

int Progress::current_tile_sample

protected

Definition at line 347 of file progress.h.

Referenced by add_samples(), get_current_sample(), operator=(), Progress(), reset(), and reset_sample().

◆ denoised_tiles

int Progress::denoised_tiles

protected

Definition at line 351 of file progress.h.

Referenced by add_finished_tile(), get_denoised_tiles(), Progress(), reset(), and reset_sample().

◆ end_time

double Progress::end_time

protected

Definition at line 355 of file progress.h.

Referenced by get_time(), Progress(), reset(), set_end_time(), and set_start_time().

◆ error

volatile bool Progress::error

protected

Definition at line 366 of file progress.h.

Referenced by get_error(), Progress(), reset(), and set_error().

◆ error_message

string Progress::error_message

protected

Definition at line 367 of file progress.h.

Referenced by get_error_message(), Progress(), reset(), and set_error().

◆ pixel_samples

uint64_t Progress::pixel_samples

protected

Definition at line 344 of file progress.h.

Referenced by add_samples(), get_progress(), operator=(), Progress(), reset(), and reset_sample().

◆ progress_mutex

thread_mutex Progress::progress_mutex

mutableprotected

◆ render_start_time

double Progress::render_start_time

protected

Definition at line 353 of file progress.h.

Referenced by add_skip_time(), get_progress(), get_time(), Progress(), reset(), and set_render_start_time().

◆ rendered_tiles

int Progress::rendered_tiles

protected

Definition at line 351 of file progress.h.

Referenced by add_finished_tile(), get_rendered_tiles(), Progress(), reset(), and reset_sample().

◆ start_time

double Progress::start_time

protected

Definition at line 353 of file progress.h.

Referenced by add_skip_time(), get_time(), Progress(), reset(), and set_start_time().

◆ status

string Progress::status

protected

Definition at line 357 of file progress.h.

Referenced by get_status(), operator=(), Progress(), reset(), and set_status().

◆ substatus

string Progress::substatus

protected

Definition at line 358 of file progress.h.

Referenced by get_status(), operator=(), Progress(), reset(), set_status(), and set_substatus().

◆ sync_status

string Progress::sync_status

protected

Definition at line 360 of file progress.h.

Referenced by get_status(), Progress(), reset(), and set_sync_status().

◆ sync_substatus

string Progress::sync_substatus

protected

Definition at line 361 of file progress.h.

Referenced by get_status(), Progress(), reset(), set_sync_status(), and set_sync_substatus().

◆ time_limit

double Progress::time_limit

protected

Definition at line 353 of file progress.h.

Referenced by get_progress(), Progress(), reset(), and set_time_limit().

◆ total_pixel_samples

uint64_t Progress::total_pixel_samples

protected

Definition at line 344 of file progress.h.

Referenced by get_progress(), operator=(), Progress(), reset(), and set_total_pixel_samples().

◆ update_cb

function<void()> Progress::update_cb

protected

Definition at line 337 of file progress.h.

Referenced by Progress(), set_update(), and set_update_callback().

◆ update_mutex

thread_mutex Progress::update_mutex

mutableprotected

Definition at line 336 of file progress.h.

Referenced by set_update().

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

progress.h