Blender  V2.93
Public Member Functions | Protected Attributes | List of all members
Progress Class Reference

#include <util_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 ()
 
string get_cancel_message ()
 
void set_cancel_callback (function< void()> function)
 
void set_error (const string &error_message_)
 
bool get_error ()
 
string get_error_message ()
 
void set_start_time ()
 
void set_render_start_time ()
 
void add_skip_time (const scoped_timer &start_timer, bool only_render)
 
void get_time (double &total_time_, double &render_time_)
 
void set_end_time ()
 
void reset_sample ()
 
void set_total_pixel_samples (uint64_t total_pixel_samples_)
 
float get_progress ()
 
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 ()
 
int get_rendered_tiles ()
 
int get_denoised_tiles ()
 
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_)
 
void set_kernel_status (const string &kernel_status_)
 
void get_kernel_status (string &kernel_status_)
 
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 end_time
 
string status
 
string substatus
 
string sync_status
 
string sync_substatus
 
string kernel_status
 
volatile bool cancel
 
string cancel_message
 
volatile bool error
 
string error_message
 

Detailed Description

Definition at line 33 of file util_progress.h.

Constructor & Destructor Documentation

◆ Progress() [1/2]

Progress::Progress ( )
inline

Definition at line 35 of file util_progress.h.

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

◆ Progress() [2/2]

Progress::Progress ( Progress &  progress)
inline

Definition at line 58 of file util_progress.h.

Member Function Documentation

◆ add_finished_tile()

void Progress::add_finished_tile ( bool  denoised)
inline

Definition at line 229 of file util_progress.h.

References denoised_tiles, progress_mutex, and rendered_tiles.

Referenced by Session::release_tile().

◆ add_samples()

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

Definition at line 215 of file util_progress.h.

References current_tile_sample, pixel_samples, and progress_mutex.

Referenced by add_samples_update(), and Session::render().

◆ add_samples_update()

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

Definition at line 223 of file util_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 163 of file util_progress.h.

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

Referenced by Session::run_cpu(), and Session::run_gpu().

◆ get_cancel()

bool Progress::get_cancel ( )
inline

Definition at line 105 of file util_progress.h.

References cancel, and cancel_cb.

Referenced by Session::acquire_tile(), BVHBuild::add_references(), ObjectManager::apply_static_transforms(), BlenderSession::bake(), BVH2::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(), GeometryManager::displace(), BVH2::refit(), BlenderSession::render(), Session::render(), BVHBuild::run(), Session::run(), Session::run_cpu(), Session::run_gpu(), shade_background_pixels(), BVHBuild::thread_build_node(), and BVHBuild::thread_build_spatial_split_node().

◆ get_cancel_message()

string Progress::get_cancel_message ( )
inline

Definition at line 113 of file util_progress.h.

References cancel_message, and progress_mutex.

Referenced by Session::run().

◆ get_current_sample()

int Progress::get_current_sample ( )
inline

Definition at line 241 of file util_progress.h.

References current_tile_sample, and progress_mutex.

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

◆ get_denoised_tiles()

int Progress::get_denoised_tiles ( )
inline

Definition at line 255 of file util_progress.h.

References denoised_tiles, and progress_mutex.

Referenced by Session::update_status_time().

◆ get_error()

bool Progress::get_error ( )
inline

Definition at line 135 of file util_progress.h.

References error.

Referenced by BlenderSession::update_status_progress().

◆ get_error_message()

string Progress::get_error_message ( )
inline

Definition at line 140 of file util_progress.h.

References error_message, and progress_mutex.

Referenced by BlenderSession::update_status_progress().

◆ get_kernel_status()

void Progress::get_kernel_status ( string &  kernel_status_)
inline

Definition at line 331 of file util_progress.h.

References kernel_status, and progress_mutex.

Referenced by BlenderSession::get_kernel_status().

◆ get_progress()

float Progress::get_progress ( )
inline

Definition at line 205 of file util_progress.h.

References pixel_samples, progress_mutex, and total_pixel_samples.

Referenced by BlenderSession::get_progress(), session_print_status(), and BlenderSession::update_bake_progress().

◆ get_rendered_tiles()

int Progress::get_rendered_tiles ( )
inline

Definition at line 249 of file util_progress.h.

References progress_mutex, and rendered_tiles.

Referenced by Session::update_status_time().

◆ get_status()

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

Definition at line 305 of file util_progress.h.

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

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

◆ get_time()

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

Definition at line 173 of file util_progress.h.

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

Referenced by BlenderSession::get_progress(), BlenderSession::render(), and BlenderSession::stamp_view_layer_metadata().

◆ operator=()

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

Definition at line 63 of file util_progress.h.

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

◆ reset()

void Progress::reset ( )
inline

Definition at line 76 of file util_progress.h.

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

Referenced by BlenderSession::reset_session().

◆ reset_sample()

void Progress::reset_sample ( )
inline

Definition at line 188 of file util_progress.h.

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

Referenced by Session::reset_(), and Session::run().

◆ set_cancel()

void Progress::set_cancel ( const string &  cancel_message_)
inline

Definition at line 98 of file util_progress.h.

References cancel, cancel_message, and progress_mutex.

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

◆ set_cancel_callback()

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

Definition at line 119 of file util_progress.h.

References cancel_cb.

Referenced by BlenderSession::create_session().

◆ set_end_time()

void Progress::set_end_time ( )
inline

Definition at line 183 of file util_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 125 of file util_progress.h.

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

Referenced by Scene::load_kernels(), Session::run_cpu(), Session::run_gpu(), Session::Session(), and Session::set_denoising().

◆ set_kernel_status()

void Progress::set_kernel_status ( const string &  kernel_status_)
inline

Definition at line 321 of file util_progress.h.

References kernel_status, progress_mutex, and set_update().

Referenced by Scene::update().

◆ set_render_start_time()

void Progress::set_render_start_time ( )
inline

Definition at line 156 of file util_progress.h.

References progress_mutex, render_start_time, and time_dt().

Referenced by Session::reset_(), and Session::run_gpu().

◆ set_start_time()

void Progress::set_start_time ( )
inline

Definition at line 148 of file util_progress.h.

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

Referenced by Session::reset_().

◆ set_status()

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

Definition at line 263 of file util_progress.h.

References 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(), GeometryManager::device_update_volume_images(), GeometryManager::displace(), Scene::load_kernels(), Session::run(), Session::run_cpu(), Session::run_gpu(), Scene::update(), ProceduralManager::update(), and Session::update_status_time().

◆ set_substatus()

void Progress::set_substatus ( const string &  substatus_)
inline

Definition at line 274 of file util_progress.h.

References 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 util_progress.h.

References 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 util_progress.h.

References progress_mutex, set_update(), and sync_substatus.

◆ set_total_pixel_samples()

void Progress::set_total_pixel_samples ( uint64_t  total_pixel_samples_)
inline

Definition at line 198 of file util_progress.h.

References progress_mutex, and total_pixel_samples.

Referenced by Session::reset_().

◆ set_update()

void Progress::set_update ( )
inline

Definition at line 339 of file util_progress.h.

References update_cb, and update_mutex.

Referenced by add_samples_update(), Scene::load_kernels(), Session::run(), Session::run_cpu(), Session::run_gpu(), set_kernel_status(), set_status(), set_substatus(), set_sync_status(), and set_sync_substatus().

◆ set_update_callback()

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

Definition at line 347 of file util_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 383 of file util_progress.h.

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

◆ cancel_cb

function<void()> Progress::cancel_cb
protected

Definition at line 356 of file util_progress.h.

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

◆ cancel_message

string Progress::cancel_message
protected

Definition at line 384 of file util_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 365 of file util_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 369 of file util_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 373 of file util_progress.h.

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

◆ error

volatile bool Progress::error
protected

Definition at line 386 of file util_progress.h.

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

◆ error_message

string Progress::error_message
protected

Definition at line 387 of file util_progress.h.

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

◆ kernel_status

string Progress::kernel_status
protected

Definition at line 381 of file util_progress.h.

Referenced by get_kernel_status(), Progress(), reset(), and set_kernel_status().

◆ pixel_samples

uint64_t Progress::pixel_samples
protected

Definition at line 362 of file util_progress.h.

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

◆ progress_mutex

thread_mutex Progress::progress_mutex
protected

Definition at line 353 of file util_progress.h.

Referenced by add_finished_tile(), add_samples(), get_cancel_message(), get_current_sample(), get_denoised_tiles(), get_error_message(), get_kernel_status(), get_progress(), get_rendered_tiles(), get_status(), get_time(), operator=(), reset_sample(), set_cancel(), set_error(), set_kernel_status(), set_render_start_time(), set_start_time(), set_status(), set_substatus(), set_sync_status(), set_sync_substatus(), and set_total_pixel_samples().

◆ render_start_time

double Progress::render_start_time
protected

Definition at line 371 of file util_progress.h.

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

◆ rendered_tiles

int Progress::rendered_tiles
protected

Definition at line 369 of file util_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 371 of file util_progress.h.

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

◆ status

string Progress::status
protected

Definition at line 375 of file util_progress.h.

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

◆ substatus

string Progress::substatus
protected

Definition at line 376 of file util_progress.h.

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

◆ sync_status

string Progress::sync_status
protected

Definition at line 378 of file util_progress.h.

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

◆ sync_substatus

string Progress::sync_substatus
protected

Definition at line 379 of file util_progress.h.

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

◆ total_pixel_samples

uint64_t Progress::total_pixel_samples
protected

Definition at line 362 of file util_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 355 of file util_progress.h.

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

◆ update_mutex

thread_mutex Progress::update_mutex
protected

Definition at line 354 of file util_progress.h.

Referenced by set_update().

The documentation for this class was generated from the following file:
Generated on Tue Jan 31 2023 14:37:24 for Blender by  doxygen 1.9.1