Blender V5.3
blender::wmJobWorkerStatus Struct Reference

#include <WM_types.hh>

Public Attributes

bool do_update
bool stop
float progress
ReportList * reports

Detailed Description

Communication/status data owned by the wmJob, and passed to the worker code when calling startjob callback.

OUTPUT members mean that they are defined by the worker thread, and read/used by the wmJob management code from the main thread. And vice-versa for INPUT members.

Warning
There is currently no thread-safety or synchronization when accessing these values. This is fine as long as:
  • All members are independent of each other, value-wise.
  • Each member is 'simple enough' that accessing it or setting it can be considered as atomic.
  • There is no requirement of immediate synchronization of these values between the main controlling thread (i.e. wmJob management code) and the worker thread.

Definition at line 1076 of file WM_types.hh.

Member Data Documentation

◆ do_update

◆ progress

◆ reports

◆ stop

bool blender::wmJobWorkerStatus::stop

INPUT - Set by the wmJob management code to request a worker to stop/abort its processing.

Note
Some job types (rendering or baking ones e.g.) also use the #Global.is_break flag to cancel their processing.

Definition at line 1089 of file WM_types.hh.

Referenced by blender::ed::object::bake_simulation::bake_geometry_nodes_startjob(), blender::ed::object::bake_startjob(), blender::common_preview_startjob(), blender::compositor_job_start(), blender::dpaint_bake_startjob(), blender::EEVEE_lightbake_job(), blender::io::alembic::export_startjob(), blender::io::usd::export_to_stage(), blender::filelist_readjob_startjob(), blender::fluid_bake_startjob(), blender::fluid_free_startjob(), blender::icon_preview_startjob_all_sizes(), blender::import_startjob(), blender::lineart_bake_startjob(), blender::ed::object::multiresbake_startjob(), blender::ed::object::oceanbake_startjob(), blender::opengl_render_startjob(), blender::pack_islands_startjob(), blender::prefetch_startjob(), blender::ed::vse::preview_startjob(), blender::proxy_startjob(), blender::seq::proxy_startjob(), blender::ptcache_job_startjob(), blender::ed::object::quadriflow_start_job(), blender::render_startjob(), blender::ed::space_node::shader_preview_startjob(), blender::ed::object::bake_simulation::simulate_to_frame_startjob(), blender::solve_camera_startjob(), blender::track_markers_startjob(), blender::wm_job_end(), blender::WM_jobs_customdata_set(), blender::WM_jobs_is_stopped(), blender::wm_jobs_kill_job(), blender::WM_jobs_start(), blender::WM_jobs_stop_all_from_owner(), blender::WM_jobs_stop_type(), and blender::wm_jobs_test_suspend_stop().


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