Skip to main content

Crate indicatrix_render_jobs

Crate indicatrix_render_jobs 

Source
Expand description

Render jobs for Indicatrix.

A render job is a frozen description of one still picture or one tilt video: the fully resolved scene (material, facet planes, lighting, camera), the export settings and the place the result goes. It is a plain JSON file (*.job.json).

This crate holds everything about jobs that does not need a window, a database or a renderer:

  • job: the job file types and their validation;
  • codec: job file text to and from RenderJobFile, with a format-version check;
  • state: the job state machine and what each row command does;
  • order: queue ordering and the next job to run;
  • paths: collision-free output names, job file names and the frame folder marker;
  • script: the .sh and .ps1 script writer and its quoting rules;
  • run: the progress and outcome types, and the progress line formatting.

It is used by the desktop render queue (indicatrix-cut) and by the command-line renderer (indicatrix-cli render and indicatrix-cli tilt-video). It stays pure (no Slint, no vault, no I/O) so its tests run in seconds and both consumers can share one definition of the job file, the state rules and the script text.

Re-exports§

pub use codec::JobFileError;
pub use codec::from_text;
pub use codec::to_text;
pub use job::ComputeChoice;
pub use job::JobColorSpace;
pub use job::JobKind;
pub use job::LocalEngines;
pub use job::RenderJobFile;
pub use job::StillJob;
pub use job::TiltVideoJob;
pub use job::TransferChoice;
pub use job::format_for_engine;
pub use run::FailureKind;
pub use run::JobOutcome;
pub use run::JobProgress;
pub use run::JobSink;
pub use state::JobState;

Modules§

codec
Job file text: reading and writing *.job.json.
job
The render job file: what a job freezes, and the rules a job must satisfy.
order
Queue ordering: which job runs next, and how rows move.
paths
Collision-free names for job output, job file names, and the frame folder marker.
run
What a running job reports and how a run ends: the types the desktop executor and the command-line renderer share, and the progress line text.
script
The script writer: run-render-jobs.sh and run-render-jobs.ps1, which run each job with indicatrix-cli, and the quoting that keeps every value literal.
state
The job state machine: what each row command does, and what a finished run leaves behind. Pure functions, so the rules are tested without a window or a database.