Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
renderdl file.nsi 

Command Line Options


There are the supported options of the renderdl command:

Option                              Description

-t n

Specifies the number of threads to use for the rendering. "n" can take any of the following values: 

n > 0 : Use "n" threads.
n = 0 : Use as many threads as there are available cores.
n < 0 :  Use all but "n" threads.

By default, renderdl use as many threads as there are available cores.

-stats

Embed statistics in rendered images. This is supported for EXR and TIFF files only. Statistics are explained in more detail in Detailed Statistics.

-progressPrints a progress status after each rendered bucket.
-cat

Print NSI commands instead of sending them into the renderer. An example usage is converting a binary (or compressed) NSI into an human readable ASCII version:

Code Block
renderdl -cat binary.nsi.gz > ascii.nsi


-cat -binary

Outputs the NSI commands in binary format. For example:

Code Block
renderdl -cat -binary ascii.nsi > binary.nsi


-cat -gzip

Outputs the NSI file in compressed form. For example:

Code Block
renderdl -cat -gzip ascii.nsi > ascii.nsi.gz


-vPrints the current version of the renderer.
-h

Prints the following help:

Expand
titleExpand to view


Code Block
Usage: renderdl [options] [file1 ... fileN]
  -v         : output version to console
  -h         : output this help
  -q         : don't print the name of files rendered
  -d         : add a framebuffer display
  -lua       : input file is a NSI scene in LUA
  -id        : add an i-display interactive framebuffer
  -stats     : save statistics in rendered images
  -progress  : print rendering progress at each bucket
  -test      : render a test image
  -t n       : launch the render using 'n' threads
  -cat       : output NSI to stdout
  -binary    : encode NSI stream in binary format
  -gzip      : compress NSI stream using gzip format



No File Name Specified

If no file name is specified, renderdl reads scene description commands from the standard in. This feature enables piping commands directly in renderdl. For example, to enter scene description commands interactively (which is not really practical), do the following:

Code Block
renderdl
Reading (stdin)
<enter commands here>

If you wish to pipe the content of file.nsi in renderdl, type: 

Code Block
cat file.nsi | renderdl

Shell Return values

The renderdl executable will return one of the following values:

Return ValueDescription
0No error.
1Bad combination of parameters. An error message will explain why.
199Option "licensing" "waitforlicense" 0 was used and no license was available.
255The NSI file specified on the command line could not be read.