-
Notifications
You must be signed in to change notification settings - Fork 0
PearRayCLI
Ömercan Yazici edited this page Nov 21, 2016
·
4 revisions
The PearRay Command Line Interface (pearray binary) is a gui-less interface to the pearray raytracer.
| Short | Long | Input | Description | Example |
|---|---|---|---|---|
| -h | --help | Pearray shows the help message and exits. | pearray -h |
|
| -q | --quiet | Pearray does not print messages into the console. | pearray -q scene.prc |
|
| -v | --verbose | Pearray shows additional information. | pearray -v scene.prc |
|
| -p | --progress | SECONDS | Progress information will be produced in a specific interval. Default is every single second. | pearray -p scene.prc |
| -i | --input | FILE | The used scene description file. Is also always the first positional argument. | pearray scene.prc |
| -o | --output | PATH | A directory where the output is produced. If not specified, ./scene will be used. Is the second positional argument. See Output for directory structure and content. |
pearray scene.prc ./test |
| -C | --config | FILE | A additional configuration file. | pearray scene.prc ./test -C config.ini |
| --display |
image, net
|
The used display driver. Default is image. net is still experimental. |
pearray scene.prc ./test -C config.ini --display=image |
| Short | Long | Input | Description | Example |
|---|---|---|---|---|
| --img-update | SECONDS | Update interval of the image while progressing. | pearray scene.prc --img-update=1.5 |
| Short | Long | Input | Description | Example |
|---|---|---|---|---|
| --net-ip | STRING | IP address to be used by network display driver. | pearray scene.prc --net-ip=0.0.0.1 |
|
| --net-port | INT | Port to be used by network display driver. | pearray scene.prc --net-ip=0.0.0.1 --net-port=4242 |
Every option group ending with an [*] can be set by the configuration file. The command line arguments override the arguments specified in the configuration file.
See the configuration file page to get more information.