C/C++ SDK / C++ layer · Jobs / kroys::TaskJob

kroys::TaskJob

A running editor task (worker thread).

Kindclass

Headerkroys/plugin.hpp

Members4

DECLARATION

Declaration

Declared in kroys/plugin.hpp.

plugin.hpp

class TaskJob

REFERENCE

Members

Constructors

#explicit TaskJob(const KroysTaskJob* job);

Wraps the host's job.

constructor

Methods

#[[nodiscard]] bool Cancelled() const;

Thread-safe; call from Run.

methodwraps KroysTaskJob::IsCancelled

#void Report(float fraction, const std::string& stage = {}) const;

Thread-safe: progress 0..1 and a stage text for the Tasks panel.

methodwraps KroysTaskJob::Report

#Result Fail(const std::string& message) const;

Thread-safe: fails the task with a message (Run then returns an error).

methodwraps KroysTaskJob::Fail

Signatures

explicit TaskJob(const KroysTaskJob* job);
[[nodiscard]] bool Cancelled() const;
void Report(float fraction, const std::string& stage = {}) const;
Result Fail(const std::string& message) const;

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.