This section contains the valid keyfile parameters.
enlarged-view 24, 56 x8
Zoom in to pixel location (24, 56), magnification factor 8x. Can use decimal numbers for location and magnification.
debug-messages on
If debugging messages are off (default) then the debug_vector, _matrix, _transform etc. routines won't print out anything.
frames-per-second 60.0
Set the number of frames per time unit (second). By default this is 25.0.
post-process-command cp %s /frame-store
A command to execute on every frame that is dropped. You must place a '%s' where the frame's name will be placed.
maximum-secondary-rays 5
The maximum depth to trace secondary rays to (e.g. the number of reflections/refractions to recurse). Default is 5, photo realistic typically max 10.
ray-statistics on
Flag to say whether or not to print the number of rays of each type cast; default is off.
show-progress off
Flag to say whether a progress meter should be displayed while raytracing. Default is on.
print-pixel-coords on
If this flag is set, the PixelSampler prints out the coordinates of every pixel that it raytraces prior to casting the ray. This is usually used to debug crashing bugs in the rendering system.
output-filename-template anim%04d.tif
This is the filename to output frames as. You must include a "%d" argument to printf, which is the frame number. The example would print as anim0239.tif etc. This parameter also specifies the output type by its extension (.tif, .ppm etc.) if present.
image-format ppm
This parameter specifies the type of image file to output. It is only used if the output filename template doesn't have a valid image extension.
picture-size 1024, 768
The size in pixels of the image to generate. This is used as the size parameter to any Storage objects in the Cameras unless an overriding size is given.
texturing on
A flag to specify whether or not textures should be applied if present. If not, then all objects just have their base material properties. Default is on.
color-only off
A flag to specify whether or not objects just appear as their base colour (no lighting, no reflection, refraction). Default is off.
memory-statistics off
A flag to specify whether memory allocation information should be output at the conclusion of every frame. Default is off.
antialiasing 2
An int to specify the level of antialiasing. Alternatively it can be specified in the Antialiaser constructor. If it is specified in the constructor and the keyfile, then the constructor level overrides the keyfile level.
run_animation on
A flag to specify whether an animation or a single frame is to be run. If an animation is to be run then the start_frame, end_frame, frame_step and frames_per_second or frame_timestep specify the animation. If a single frame is to be run then the frame_number or frame_worldtime variable specify the time of the animation.
start_frame 5
An int which is the frame number for the first frame in an animation
end_frame 10
An int which is the frame number for the last frame in an animation
frame_step 3
An int which specifies how many of the frames to animate. eg if frame step is three it will animate every third frame. frames 0, 3, 6, 9 ...
frames_per_second 25
A float which specifies how many frames per second.
frame_timestep 0.04
A float which is an alternative way of specifying how many frames per second. Specify timestep between each frame. Equals 1/frames_per_second.
frame_number 6
An int which is the frame number for the frame which you want to produce. (Used if run_animation is off)
frame_worldtime 0.43
A float which is the time at which you want a frame to be produced. An alternative to frame_number above. (Used only if run_animtaion is off)