entelechy renderGenerated

Generated from the source

Data comes from entelechy help render --json.

Brief

Step a scene for a number of frames and write each frame and the sound.

Synopsis

render <scene.esn> --frames <n>

Description

Step the scene for n frames at the rate (60 by default) and write each frame’s picture as <dir>/0000.png, 0001.png,… and the sound output, block after block, as <dir>/sound.wav at the sound rate (48000 by default, what Kernels read as rate()); a scene without a picture or a sound writes none of it. The blocks are joined as they come, whatever their length: a block of rate() / fps samples keeps the sound in time with the frames. The clock is the frame count over the rate, so a render is the same every time; async nodes are waited for after every frame. ffmpeg makes a video of the directory. –save writes a node’s output after the last frame, as run’s does: how a state trained or settled over many frames is kept. –profile times every node alone, waiting for the device after each, over the frames after the first (which compiles and allocates), and prints each node’s milliseconds a frame, the busiest first; and each Kernel’s preparing, its compiling and its building, as run’s does.

Flags

flag	Value	Repeats	Description
--frames	<n>	no	How many frames to step.
--rate	<fps>	no	Frames a second (60 by default).
--sound-rate	<hz>	no	Sound frames a second (48000 by default).
--out	<dir|file.wav>	no	Where the frames go: a directory for each picture and the sound (frames by default), or a .wav file for the sound alone.
--window	<w>x<h>[@<scale>]	no	The window a scene sized by window() fills, in pixels, with its scale factor.
--save	<node.port>=<file.field|.png|.ppm|.pgm|.wav|.mid|.csv|.json>	yes	Writes a node’s output to a file, in the format its extension names.
--profile	``	no	Prints each node’s time a frame over the frames after the first.
--library	<dir|file>	no	Kernels the scene uses beside its own.
--input	<name>=<path>	yes	Reads the scene’s input from the path given, a file or a directory as the input reads; an external the scene leaves to its caller bound to a picture file.
--output	<name>=<path>	yes	Writes the scene’s output to the path given, a file or a directory as the output writes.
--param	<name>=<literal>	yes	Sets a graph parameter.
--backend	cpu|gpu|jit	no	The backend the scene runs on.
--no-fusion	``	no	Runs pointwise producers apart from their consumers.
--allow	file.read|file.write|file.delete=<dir>|clipboard.read|clipboard.write	yes	Lets the scene read files from, write its outputs into, or remove and rename files in, a directory; or read and write the system’s clipboard.
--grant	<capability,...>	no	The only capabilities a Kernel may be given.
--memory	<MB>	no	Mebibytes of Fields the Host may hold at once (2048 by default).
--work	<M>	no	Million loop iterations one run of a Kernel may take (4000 by default).
--small	<operations>	no	Operations a run may take, by its elements and its Kernel’s typical work, and go to the processor rather than the device (400000 by default; 0 keeps every run on the device).