Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

xtask

Xtask coordinates development tasks across platforms. See building for the tools required by each task, and run cargo xtask --help for all options.

Things it covers

  • standalone evaluation UI: cargo xtask --compile --ui (builds the host executable in target/release)
  • browser viewer: cargo xtask --compile --web (static assets and an embedded HTML evaluation file in target/web)
  • standalone renderer CLI: cargo xtask --compile --cli
  • shader validation: cargo xtask --compile --gpu
  • testing: cargo xtask --test-crates
  • installer: cargo xtask --test-installer builds the OFX installer for this platform, installs it into a scratch folder, loads the installed plugin library and uninstalls it
  • render comparison: cargo xtask preview --head <cli> --base <cli> --out <folder> --image-base-url <url> renders the parity scenes and a focal-plane sweep of the 3D scene with two CLI builds and writes the images, the looping animations and the pull request comment
  • precommit checks cargo xtask --precommit
  • docs publishing
  • docs previewing: cargo xtask --serve-docs