Skip to main content

indicatrix_render_jobs/
lib.rs

1//! Render jobs for Indicatrix.
2//!
3//! A render job is a frozen description of one still picture or one tilt video: the
4//! fully resolved scene (material, facet planes, lighting, camera), the export
5//! settings and the place the result goes. It is a plain JSON file (`*.job.json`).
6//!
7//! This crate holds everything about jobs that does not need a window, a database or a
8//! renderer:
9//!
10//! - [`job`]: the job file types and their validation;
11//! - [`codec`]: job file text to and from [`RenderJobFile`], with a format-version check;
12//! - [`state`]: the job state machine and what each row command does;
13//! - [`order`]: queue ordering and the next job to run;
14//! - [`paths`]: collision-free output names, job file names and the frame folder marker;
15//! - [`script`]: the `.sh` and `.ps1` script writer and its quoting rules;
16//! - [`run`]: the progress and outcome types, and the progress line formatting.
17//!
18//! It is used by the desktop render queue (`indicatrix-cut`) and by the command-line
19//! renderer (`indicatrix-cli render` and `indicatrix-cli tilt-video`). It stays pure
20//! (no Slint, no vault, no I/O) so its tests run in seconds and both consumers can
21//! share one definition of the job file, the state rules and the script text.
22
23pub mod codec;
24pub mod job;
25pub mod order;
26pub mod paths;
27pub mod run;
28pub mod script;
29pub mod state;
30
31pub use codec::{JobFileError, from_text, to_text};
32pub use job::{
33    ComputeChoice, JobColorSpace, JobKind, LocalEngines, RenderJobFile, StillJob, TiltVideoJob,
34    TransferChoice, format_for_engine,
35};
36pub use run::{FailureKind, JobOutcome, JobProgress, JobSink};
37pub use state::JobState;