3Delight 12.0 User's Manual: 2.4 Environment Variables

Short Contents

2.4 Environment Variables

3Delight needs only two environment variables to run properly and both should be correctly set by the installer.

DELIGHT: This variable must point to the root of your 3Delight installation.
PATH: `$DELIGHT/bin' must be part of this environment variable.

The following environment variables are not necessary for the proper running of 3Delight but they can be used to enable some special features.

RISERVER (2)

If defined, and set to a valid filename, this variable forces 3Delight to output all Ri commands to a RIB file. More on RIB output in RIB Output.

RIFORMAT

Specifies the format of the RIB output, can be either `ascii' or `binary'.

DL_RIB_ARCHIVEPROCEDURALS

Enables the "rib" "archiveprocedurals" option. The main purpose is debugging C API applications.

DL_OUTPUT_DIR

If this variable contains a valid directory, all output file names are post concatenated with it. For example, setting $DL_OUTPUT_DIR to `/tmp', transforms Display "test.rif" "file" "rgb" into Display "/tmp/test.rif" "file" "rgb". This also applies to files generated by RiMakeTexture, RiMakeShadow, RiMakeCubeFaceEnvironment and RiMakeLatLongEnvironment.

DL_DUMP_DEFAULTS

Forces 3Delight to dump the contents of the configuration file(s) it reads. More on this subject in Configuration file (`rendermn.ini').

DL_SHADERS_PATH

DL_TEXTURES_PATH

DL_DISPLAYS_PATH

DL_ARCHIVES_PATH

DL_PROCEDURALS_PATH

DL_RESOURCES_PATH

These variables specify default search paths for different 3Delight resources. They can be extracted using the `@' symbol when specifying search paths through RiOption. Note that default search paths can also be specified through the configuration file (see section Configuration file (`rendermn.ini')) but setting them through environment variables overrides configuration file defaults.

RIBDIR

This environment variable is set by 3Delight in each RiReadArchive call to the path of the current RIB. This lets the user load RIB archives that have a path relative to the parent RIB without using absolute paths. For example, if the master RIB is `/scene/master.rib' and the archive to be loaded is `/scene/models/car.rib', one can write the following in `master.rib' to load the archive:

ReadArchive "$RIBDIR/models/car.rib"

The advantage of using such relative paths is of importance: entire RIB directory structures can be moved elsewhere and still have correct archive paths.

DL_SEARCHPATH_DEBUG

When this variable is set to an integer value, 3Delight prints a trace of how it uses the search paths. A value of 1 or higher displays the files found. A value of 2 or higher displays every location in which a file is searched for. A value of 3 or higher shows how the dirmap option (see section Search Paths Options) is applied.

DL_DUMP_CORE

When this variable is set, 3Delight will not install its own signal handlers. This means crashes will result in core dumps instead of a stack trace, among other things. This is only useful for debugging.

[ < ]

[ > ]

[ << ]

[ Up ]

[ >> ]