Rayshade Quick Reference
-------------------------------------------------------------------------------
Key:
[thing] Optional item Production
Thing Number or String (thing) Default value(s)
thing Keyword
-------------------------------------------------------------------------------
Reals and integers may be written in exponential notation, with or without a
decimal point. Reals are truncated to integers when need be. Numbers may also
be written as expressions surrounded by a matched pair of parentheses.
Subexpressions may be parenthesized to control order of evaluation. Variables
may be defined and used in parenthesized expressions. Predefined variables
include time (current time) and frame (current frame number, 0 - frames-1), pi,
dtor (pi/180), rotd (180/pi). Available operators are '+' (addition),
'-' (subtraction and negation), '*' (multiplication), '/' (division),
'%' (remainder), '^' (exponentiation). Functions include sin, cos, tan, asin,
acos, atan, sqrt, hypot.
Strings are written as non-quoted strings that may include include the
special characters '/' ("slash"), '-' ("dash"), '_' ("underscore), and '.'
("period"), in addition to upper and lowercase letters and non-leading digits.
-------------------------------------------------------------------------------
Command-line options (override options set in input file):
-A frame First frame to render
-a Toggle alpha channel -C cutoff Adaptive tree cutoff
-c Continued rendering -D depth Maximum ray tree depth.
-E eye_sep Eye separation -e Exponential RLE output
-F freq Report frequency -f Flip triangle normals
-G gamma Gamma exponent -g Use gaussian filter
-h Help -j Toggle jittered sampling
-l Render left eye view -m Produce sample map
-N frames Total frames to render -n No shadows
-O outfile Output file name -o Toggle opaque shadows
-P cpp-args Arguments for cpp -p Preview-quality
-q Run quietly -R xres yres Resolution
-r Right eye view -S samples Use Samples^2 samples
-s Toggle shadow caching -T r g b Contrast threshold
-u Toggle use of cpp -V filename Verbose file output
-v Verbose output -W lx hx ly hy Render subwindow
-X l r b t Crop window
-------------------------------------------------------------------------------
File: /* Input file consists of...*/
[ ... ]
Item:
ObjItem: /* Items used in object definition blocks */
Viewing:
eyep Xpos Ypos Zpos /* Eye position (0 -10 0) */
lookp Xpos Ypos Zpos /* Look position (0 0 0) */
up Xup Yup Zup /* "up" vector (0 0 1) */
fov Hfov [Vfov] /* Field of view in degrees (horiontal=45) */
aperture Width /* Aperture width (0) */
focaldist Distance /* focal distance (|eyep - lookp|) */
shutter Speed /* Shutter speed (0 --> no blur) */
framelength Length /* Length of a singelf frame (1) */
screen Xsize Ysize /* Screen size */
window Xmin Xmax Ymin Ymax /* Window (0 xsize-1 0 ysize-1) */
crop left right bot top /* Crop window (0 1 0 1) */
eyesep Separation /* eye separation (0) */
SurfDef: /* Give a name to a set of surface attributes. */
surface Name [ ...]
Surface: /* Surface specification */
/* Use gven attributes */
Surfname [ ...] /* Use named surface w/ optional mods. */
cursurf [ ...] /* Use cur. surface w/mods - see ApplySurf */
SurfSpec: /* Surface attribute specification */
ambient R G B /* Ambient contribution */
diffuse R G B /* Diffuse color */
specular R G B /* Specular color */
specpow Exponent /* Phong exponent */
body R G B /* Body color */
extinct Coef /* Extinction coefficient */
transp Ktr /* Transparency */
reflect Kr /* Reflectivity */
index N /* Index of refraction */
translu Ktl R G B Stpow /* Translucency, transmit diffuse, spec exp */
noshadow /* No shadows cast on this surface */
Effect: /* Atmospheric Effects */
mist R G B Rtrans Gtrans Btrans Zero Scale
fog R G B Rtrans Gtrans Btrans
Atmosphere: /* Global atmosphere */
atmosphere [Index] [...] /* Global index, effects */
ApplySurf:
applysurf /* apply surf to all following objs w/o surface */
Instance: /* Instance of an object */
