The aqsis executable is a command-line renderer which accepts RenderMan(tm) scene descriptions in the form of sequences of requests, known as the RenderMan (tm) Interface. These requests are passed to the aqsis executable as a character stream known as the RenderMan Interface Bytestream (RIB). When launched, aqsis processes the requests in the passed RIB stream, which in turn can force processing of other external assets such as compiled shaders and texture maps, to produce a final rendered image. The output image data is presented via the [[doc:dev:display|standard Dspy interface]] to the chosen [[doc:display|display device]].
RIB streams can be in plain ASCII or using a custom binary encoding described as part of the RenderMan(tm) standard. Either format can be zipped for further compression. See [[doc:miqser]] for more information about producing binary encoded RIB files.
By default aqsis will take the RIB file to be processed as the final argument on the command line, such as
Additionally, aqsis can be passed a RIB stream via ‘‘stdin’’, for example by piping in the output from another application:
mygenerator.exe | aqsis
Most other options to aqsis, such as the output file name and its format, are normally specified in the input file. The RenderMan Interface covers both a 3D scene description format, a rich set of configurable settings for the renderer and some command-like constructs to create supporting files like textures and shadow maps.
More introductory information on using aqsis itself can be found in the [[guide:first_steps|first steps tutorial]].
A short help text listing all options can be displayed using the ‘‘aqsis -help’’ option. All options can either begin with a single dash or two dashes and can appear anywhere on the command line.
Usage: aqsis [options] [RIB file...] -h, -help Print this help and exit -version Print version information and exit -pause Wait for a keypress on completion -progress Print progress information -Progress Print PRMan-compatible progress information (ignores -progressformat) -progressformat=string printf-style format string for -progress -endofframe=integer Equivalent to "endofframe" RIB option -nostandard Do not declare standard RenderMan parameters -v, -verbose=integer Set log output level 0 = errors 1 = warnings (default) 2 = information 3 = debug -echoapi Echo all RI API calls to the log output (experimental) -z, -priority=integer Control the priority class of aqsis. 0 = idle 1 = normal(default) 2 = high 3 = RT -type=string Specify a display device type to use -addtype=string Specify a display device type to add -mode=string Specify a display device mode to use -d, -fb Same as --type="framebuffer" --mode="rgb" -crop x1 x2 y1 y2 Specify a crop window, values are in screen space. -frames f1 f2 Specify a starting/ending frame to render (inclusive). -frameslist=string Specify a range of frames to render, ',' separated with '-' to indicate ranges. -nc, -nocolor Disable colored output -beep Beep on completion of all ribs -res x y Specify the resolution of the render. -option=string A valid RIB Option string, can be specified multiple times. -shaders=string Override the default shader searchpath(s) -archives=string Override the default archive searchpath(s) -textures=string Override the default texture searchpath(s) -displays=string Override the default display searchpath(s) -procedurals=string Override the default procedural searchpath(s)
"Frame (%f) %p%% complete [ %s secs / %S left ]". Valid format characters are listed in Table 1:
Option "statistics" "endofframe" [integer]The command line option takes precedence over the value in RIB stream.
tools/mpdump). Warning: Only use this option in conjunction with an appropriate crop window to select the region of interest, otherwise the dump file might be huge and impossible to handle by the analyse tool.
Option "searchpath" "shader" [string].
Option "searchpath" "archive" [string].
Option "searchpath" "texture" [string].
Option "searchpath" "display" [string].
Option "searchpath" "procedural" [string].
|%h||Rendering time in hours|
|%H||Estimated number of hours left|
|%m||Rendering time in minutes|
|%M||Estimated number of minutes left|
|%s||Rendering time in seconds|
|%S||Estimated number of seconds left|
|%t||Rendering time in hours:mins:secs|
|%T||Estimated time left in hours:mins:secs|
|%%||A single % sign|
|0||Only display errors|
|1||Display warnings (default)|
|2||Display informational messages|
|3||Display debug information|
Information regarding the usage of configuration files and environment variables can be found [[doc:install#environment|here]].
Aqsis is configured entirely though the [[doc:options|options]] mechanism, everything that controls the behaviour of Aqsis can be set by setting options in a RIB file. There three ways to control the operation of Aqsis, in order of decreasing priority, the command line, user and local configuration files, and the RIB stream itself.
The command line options described above provide various ways of setting some common options. For instance the searchpath options directly modify the [[doc:options#searchpath_options|”searchpath”]] options. Also, the –option command line flag allows more flexible control over all of the available options (see [[doc:options#options|options]] for more information about the available options).
Aqsis will look for a file named “.aqsisrc” or “_aqsisrc” ((_aqsisrc supported by version 1.6 and above)) first in the users home directory as defined by the “HOME” envrionment variable, and then in the current folder from which aqsis was launched. This file contains any valid RIB requests, but is generally only used to set options.
Finally, options can be set as normal in the RIB stream that aqsis is processing.
Aqsis processes the various configuration options in the following manner.
Each lower processing step will override settings already set further up the list.