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 963 of file WM_types.hh.

Member Data Documentation

do_update

bool wmJobWorkerStatus::do_update

OUTPUT - Set to true by the worker to request update processing from the main thread (as part of the wmJob 'event loop', see wm_jobs_timer).

Definition at line 968 of file WM_types.hh.

Referenced by blender::ed::object::bake_simulation::bake_geometry_nodes_startjob(), blender::ed::object::bake_startjob(), common_preview_startjob(), blender::ed::space_node::compo_startjob(), dpaint_bake_startjob(), EEVEE_NEXT_lightbake_job(), blender::io::alembic::export_startjob(), blender::io::usd::export_startjob(), blender::io::usd::export_to_stage(), filelist_readjob_startjob(), fluid_bake_startjob(), fluid_free_startjob(), fsmenu_bookmark_validate_job_startjob(), blender::io::usd::import_startjob(), import_startjob(), lineart_bake_startjob(), blender::ed::object::multiresbake_startjob(), blender::ed::object::oceanbake_startjob(), pack_islands_startjob(), prefetch_startjob(), preview_startjob(), proxy_startjob(), ptcache_job_startjob(), blender::ed::object::quadriflow_start_job(), render_startjob(), SEQ_proxy_rebuild(), blender::ed::space_node::shader_preview_startjob(), blender::ed::object::bake_simulation::simulate_to_frame_startjob(), solve_camera_startjob(), track_markers_startjob(), and wm_jobs_timer().

progress

float wmJobWorkerStatus::progress

OUTPUT - Progress as reported by the worker, from 0.0f to 1.0f.

Definition at line 979 of file WM_types.hh.

Referenced by blender::ed::object::bake_simulation::bake_geometry_nodes_startjob(), blender::ed::object::bake_startjob(), blender::ed::space_node::compo_startjob(), dpaint_bake_startjob(), EEVEE_NEXT_lightbake_job(), blender::io::alembic::export_startjob(), blender::io::usd::export_startjob(), blender::io::usd::export_to_stage(), filelist_readjob_startjob(), fluid_bake_startjob(), fluid_free_startjob(), blender::io::usd::import_startjob(), import_startjob(), lineart_bake_startjob(), blender::ed::object::multiresbake_startjob(), blender::ed::object::oceanbake_startjob(), pack_islands_startjob(), prefetch_startjob(), preview_startjob(), proxy_startjob(), ptcache_job_startjob(), blender::ed::object::quadriflow_start_job(), render_startjob(), SEQ_proxy_rebuild(), blender::ed::object::bake_simulation::simulate_to_frame_startjob(), solve_camera_startjob(), track_markers_startjob(), WM_jobs_progress(), and WM_jobs_start().

reports

ReportList* wmJobWorkerStatus::reports

OUTPUT - Storage of reports generated during this job's run. Contains its own locking for thread-safety.

Definition at line 985 of file WM_types.hh.

Referenced by blender::io::usd::export_startjob(), blender::io::usd::export_texture(), blender::io::usd::export_texture(), blender::io::usd::import_startjob(), blender::io::hydra::USDSceneDelegate::populate(), blender::io::usd::USDAbstractWriter::reports(), blender::io::usd::USDMaterialReader::reports(), blender::io::usd::USDPrimReader::reports(), blender::io::usd::USDStageReader::reports(), blender::io::usd::USD_export(), blender::io::usd::USD_import(), wm_job_free(), WM_jobs_get(), and wm_jobs_reports_update().

stop

bool 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 976 of file WM_types.hh.

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

---

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

• WM_types.hh