Builtin Library
README.md
procgen.preview
Evaluates one target (an output or a node) of a .procGraph graph and renders
what it makes, for any output type (Geometry, points, Field heatmap, Material
ball, Texture, Bundle). The picture comes back in the result as image, beside
the visualizer's stats as metrics; path also writes the PNG there. It is the
look step of the build, preview, change loop, and leaves nothing in the scene.
An output made of drawn points (a particle effect, a part of one) that an
io.output of the graph shows is drawn by the generator that presents it, so its
preview is the picture of that generator at the moment the graph names for a still
(g:still; else half way through its timeline), framed to fit over the studio
backdrop. metrics then states output_type = "Generator" with the graph time and
frame pictured and the elements each output drew.
Drawn points the graph returns without showing them (a set of pieces handed on to
another graph, a node's answer) are pictured the way an io.output of them would
stand them: shown through the io.output node's own show, framed to fit, and taken
down again. metrics then states shown = "io.output" and the elements that stood.
An output made of drawn points (a particle effect, a part of one) that an
io.output of the graph shows is drawn by the generator that presents it, so
its preview is the picture of that generator at the moment the graph names for
a still (g:still; else half way through its timeline), framed to fit over the
studio backdrop. metrics then states output_type = "Generator" with the
graph time and frame pictured and the elements each output drew.
Drawn points the graph returns without showing them (a set of pieces handed on
to another graph, a node's answer) are pictured the way an io.output of them
would stand them: shown through the io.output node's own show, framed to fit,
and taken down again. metrics then states shown = "io.output" and the
elements that stood.
tools.use("procgen", "preview", { graph = "/source/scratch/Box.procGraph", target = "output:mesh" })
Part of procgen.toolbox, called as tools.use("procgen", "preview", ...)
(zero procgen preview in the engine shell). Returns { image, metrics }.