about
Displays information about Kray version and modules. If optional modules argument is provided, detailed information about given module is displayed.
wikipage
about[;]
|
<string> moduleName;
|
anim
Animation subsystem commnads
wikipage
anim
|
lockFrameFileMode,
|
<int> mode;
|
|
mtLoader,
|
<int> mode;
|
|
Controls multi threaded loader
|
|
renderFrame[;]
|
<int> frame[;]
|
<bool> singleFrame=1;
|
|
Sets up animation frame and renders it
|
|
renderFrames;
|
|
reset;
|
|
Removes all animated objects from scene
|
|
setFps,
|
<double> fps;
|
|
setFrameRange,
|
<int> firstFrame,
|
<int> lastFrame[;]
|
<int> step;
|
|
setFrameRangeString,
|
<string> ranges[;]
|
<int> step;
|
|
Sets frame ranges string. String can contain list of frame numbers or frame ranges. Example 1,2,6-9 selects frames 1,2,6,7,8,9.
|
|
setupFrame[;]
|
<int> frame[;]
|
<bool> singleFrame=1;
|
|
Sets up scene for given animation frame
|
|
sharedGi,
|
<bool> state;
|
|
sharedGiInterpolatedReset;
|
|
Removes all time interpolated frame data
|
animOb
Modifies attributes of animated object
wikipage
animOb
|
<stringable> s1,
|
addAxesKey,
|
<double> time,
|
<hpb> axes;
|
|
|
addChannelKey,
|
<double> time,
|
<int> channel,
|
<double> value;
|
|
|
|
normalFixedRotate,
|
<xyz> direction;
|
|
|
|
normalRandomRotate;
|
|
|
|
normalRotate;
|
|
|
|
patternAxes;
|
|
|
|
randomSeed,
|
<int> seed;
|
|
|
|
randRotate,
|
<xy> randMinMax,
|
<xyz> rotatePlaneVector;
|
|
|
|
randScale,
|
<xy> randMinMax;
|
|
|
|
randScaleX,
|
<xy> randMinMax;
|
|
|
|
randScaleY,
|
<xy> randMinMax;
|
|
|
|
randScaleZ,
|
<xy> randMinMax;
|
|
|
addKey,
|
<double> time,
|
<coordSys> axes;
|
|
|
addPositionKey,
|
<double> time,
|
<xyz> position;
|
|
|
clearInstanceTransformers;
|
|
|
clearKeys;
|
|
|
invalidateGeometry;
|
|
|
invalidateSurfaces;
|
|
|
remove;
|
|
Removes anim object from anim scene
|
|
|
rename,
|
<string> name;
|
|
|
setActive,
|
<bool> state;
|
|
|
setMeshHandnessAutoFlip,
|
<bool> state;
|
|
|
setParent[;]
|
<stringable> s3;
|
|
|
setStatic,
|
<coordSys> axes;
|
|
|
showInfo;
|
|
|
showKeys;
|
|
|
typeBackground,
|
<shaderNode> s3[;]
|
<int> flags=0;
|
|
|
typeCameraMove;
|
|
|
typeCopy,
|
<stringable> s3;
|
|
|
typeCopyTree,
|
<stringable> s3;
|
|
|
typeInstance,
|
<string> objectNodeName;
|
|
|
typeMesh,
|
<mesh> m3[;]
|
<int> flags;
|
|
|
typeMeshInstance,
|
<mesh> m3[;]
|
<int> flags=32768;
|
|
|
typeNull;
|
|
|
typePhysky,
|
<miscSharedObject> m3[;]
|
<int> sunModel=0[;]
|
<int> shaderFlags=0,
|
<int> animFlags=0[;]
|
<double> sunPowerMultiplier=1,
|
<double> sunDistance=0[;]
|
<double> alphaChannelValue=1;
|
animObLink
Creates animation subsystem object and links it with script symbol.
When animObName is specified, existing anim object can be attached to new script handle
wikipage
animObLink
|
#symbolName#[;]
|
<string> animObName;
|
array
wikipage
axes
wikipage
axes
|
#symbolName#[;]
|
<axes> a2;
|
background
Changes scene background
wikipage
background
|
color[;]
|
<rgba> color;
|
|
directionsMap;
|
|
fishEyeMap,
|
<bitmap> b2[;]
|
<hpb> axes[;]
|
<rgba> colorFilter;
|
|
light,
|
<shaderNode> s2[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0[;]
|
<double> powerMax=0.3[;]
|
<double> dynamicMaxSqr=0.02[;]
|
<int> minGridSize=7;
|
|
shader,
|
<shaderNode> s2;
|
|
sky[;]
|
<xyz> zenithDirection[;]
|
<rgba> horizon,
|
<rgba> zenith,
|
<rgba> nadir[;]
|
<rgba> horizonNadir[;]
|
<double> skyGamma=1,
|
<double> groundGamma=1;
|
|
sphereMap,
|
<bitmap> b2[;]
|
<hpb> axes[;]
|
<rgba> colorFilter;
|
bitmap
Creates bitmap object.
wikipage
bitmap
|
#symbolName#[;]
|
alphaMap,
|
<bitmap> b3[;]
|
<double> alphaRangeStart=0,
|
<double> alphaRangeStop=1;
|
|
Creates view of given bitmap
|
|
|
bitPlane[;]
|
<xy> bmpSize;
|
|
Creates bitmap with bitPlane pixel format
|
|
|
bumpMap,
|
<bitmap> b3[;]
|
<bool> initViewNow=1;
|
|
Creates view of given bitmap
|
|
|
charGray[;]
|
<xy> bmpSize;
|
|
Creates bitmap with charGray pixel format
|
|
|
charRgba[;]
|
<xy> bmpSize;
|
|
Creates bitmap with charRgba pixel format
|
|
|
compress,
|
<bitmap> b3[;]
|
<int> hdr,
|
<int> color,
|
<int> alpha,
|
<int> halfSizeSteps;
|
|
Compresses bitmap pixel format
see:
sett
bitmapPixelCompression
|
|
|
constant,
|
<rgba> value[;]
|
<xy> size;
|
|
Creates virtual bitmap with constant value
|
|
|
copy,
|
<bitmap> b3;
|
|
Creates a copy of given bitmap with the same pixel format
|
|
|
copyView[;]
|
alph;
|
|
|
|
caus;
|
|
|
|
dire;
|
|
|
|
indi;
|
|
|
|
lumi;
|
|
|
|
norm;
|
|
|
|
obid;
|
|
|
|
othr;
|
|
|
|
posi;
|
|
|
|
preview;
|
|
|
|
refl;
|
|
|
|
refr;
|
|
|
|
rgb;
|
|
|
|
rgba;
|
|
|
|
sfid;
|
|
|
|
shdn;
|
|
|
|
txtr;
|
|
|
|
zbuf;
|
|
Creates a copy of last rendered output in current view. Pixel format is adjusted automatically.
|
|
|
displaceBitmap[;]
|
<xy> size;
|
|
Creates image map for use as image + UV geometry displacement mode
|
|
|
floatGray[;]
|
<xy> bmpSize;
|
|
Creates bitmap with floatGray pixel format
|
|
|
floatRgb[;]
|
<xy> bmpSize;
|
|
Creates bitmap with floatRgb pixel format
|
|
|
floatRgba[;]
|
<xy> bmpSize;
|
|
Creates bitmap with floatRgba pixel format
|
|
|
load,
|
<string> filename[;]
|
<double> time[;]
|
<int> flags;
|
|
Loads bitmap from file via bitmap cache. Cached bitmaps can be accessed for read only.
| Unload | 0x1 - Create unloaded bitmap | | LoadOnDemand | 0x2 - Load bitmap on demand | | DontLockFile | 0x10 - Do not lock file (which prevents bitmap file from being modified) | | DontCheckFile | 0x20 - Do not check file existance (no lock, on demand mode only) |
|
|
|
sharpPixelMap,
|
<bitmap> b3;
|
|
Creates view of given bitmap
|
|
|
virtual,
|
bakeNormal,
|
<mesh> m4,
|
<string> imageUv[;]
|
<xy> size[;]
|
<string> pixelUv[;]
|
<bool> reversed=1;
|
|
|
|
bakePosition,
|
<mesh> m4,
|
<string> imageUv[;]
|
<xy> size[;]
|
<string> pixelUv;
|
|
Creates bitmap view of a mesh for texture baking
|
bitmapData
Sets multiple pixels (in line-by-line order) on bitmap.
wikipage
bitmapData
|
<bitmap> b1,
|
<xy> startPoint,
|
{<vector> v3,...};
|
bitmapOp
Various operations on bitmaps
wikipage
bitmapOp
|
<bitmap> b1,
|
blit,
|
<bitmap> source[;]
|
<xy> location[;]
|
<xy> sourceLocation[;]
|
<xy> size;
|
|
Copies part of bitmap to another bitmap
|
|
|
circle,
|
<xy> center,
|
<double> radius,
|
<rgba> v5;
|
|
Draws a circle
|
|
|
clear[;]
|
<rgba> c;
|
|
Clears bitmap
|
|
|
copy,
|
<bitmap> source;
|
|
Creates a copy of a bitmap
|
|
|
copyView[;]
|
alph;
|
|
|
|
caus;
|
|
|
|
dire;
|
|
|
|
indi;
|
|
|
|
lumi;
|
|
|
|
norm;
|
|
|
|
obid;
|
|
|
|
othr;
|
|
|
|
posi;
|
|
|
|
preview;
|
|
|
|
refl;
|
|
|
|
refr;
|
|
|
|
rgb;
|
|
|
|
rgba;
|
|
|
|
sfid;
|
|
|
|
shdn;
|
|
|
|
txtr;
|
|
|
|
zbuf;
|
|
Copies last rendered output in current view to bitmap
|
|
|
fill,
|
<xy> p,
|
<rgba> v4[;]
|
<double> tolerance=0;
|
|
Fills area on bitmap
|
|
|
flush;
|
|
Removes temporary buffers attached to bitmap
|
|
|
line,
|
<xy> p1,
|
<xy> p2,
|
<rgba> v5;
|
|
Draws a line
|
|
|
load,
|
<string> name;
|
|
Loads image directly (not via bitmap cache) to bitmap. Bitmap will be resized, but pixel format will remain unchanged
|
|
|
loadRaw,
|
<string> filename,
|
<int> flags;
|
|
Loads bitmap as raw image in given format. Flag meaning is the same as for saveRaw
|
|
|
plot,
|
<xy> point,
|
<rgba> v4;
|
|
Sets pixel on bitmap
|
|
|
process,
|
<shaderNode> s3;
|
|
Applies postprocessing filter to a bitmap
|
|
|
resize,
|
<xy> newSize;
|
|
Changes dimensions of given bitamp
|
|
|
save,
|
<string> filename[;]
|
bmp[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
exr[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
hdr;
|
|
|
|
|
jpg[;]
|
<double> quality=0.95;
|
|
|
|
|
png[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
tga[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
tif[;]
|
<int> flags=0;
|
|
Saves bitmap to a file.
|
|
Flags: +1 embed alpha channel
|
|
|
saveRaw,
|
<string> filename,
|
<int> flags;
|
|
Saves bitmap as raw image in given format. Flags meaning:
| Binary | 0x2 - File is in binary format (text format if this bit is not set) | | LowByteFirst | 0x4 - File byte ordering is little endian (big endian if not set) | | DoublePrecision | 0x0 - RGBA values are stored as double precision floating point numbers | | FloatPrecision | 0x10 - RGBA values are stored as single precision floating point numbers | | HalfPrecision | 0x80 - RGBA values are stored as half precision floating point numbers | | IntPrecision | 0x20 - RGBA values are stored as 32 bit integers (4 bytes) | | ShortPrecision | 0x30 - RGBA values are stored as 16 bit integers (2 bytes) | | CharPrecision | 0x40 - RGBA values are stored as 8 bit integers (1 byte) | | NibblePrecision | 0x50 - RGBA values are stored as 4 bit nibbles (2 per byte) | | TouplePrecision | 0x60 - RGBA values are stored as 2 bit touples (4 per byte) | | BitPrecision | 0x70 - RGBA values are stored as 1 bit plane (8 per byte) | | BGR | 0x10000 - RGB values are in reverse order (BGR) | | Gray | 0x20000 - Bitmap is monochromatic (single value for all RGB channels) | | HasAlpha | 0x40000 - RGB data is followed by alpha channel information | | AlphaFirst | 0x80000 - Alpha channel information is before RGB data |
|
|
|
saveScript,
|
<string> filename[;]
|
<string> bmpVariableName="bmp";
|
|
Saves bitmap in Kray script file format
|
|
|
show;
|
|
Displays bitmap in current view window
|
|
|
showAlpha[;]
|
<int> mode=1;
|
|
Displays bitmap in current view window with given alpha channel presentation mode
|
|
|
showDirections;
|
|
Displays directions map (normal map, camera directions) in current view window
|
|
|
showHit[;]
|
<int> mode=0;
|
|
Displays hit map (map of ray object intersection positions)
|
|
|
showNormalized;
|
|
Displays bitmap full dynamic range on LDR screen (by normalization)
|
|
|
showZ;
|
|
Displays Z buffer bitmap in current view preview window. Command be used to display any bitmap in logarithmic scale
|
|
|
unload;
|
|
Releases memory used by cached bitmap object. Object will be automatically reloaded from disk when needed
|
blend
wikipage
blend
|
#symbolName#,
|
default;
|
|
|
fromShader,
|
<shaderNode> s3;
|
|
|
none;
|
|
|
partial,
|
<rgb> v3[;]
|
<int> surfaceUsesMapsFlags=0;
|
|
|
superficial,
|
<texture> t3[;]
|
<int> surfaceUsesMapsFlags=0;
|
|
|
total;
|
camera
Controls current view camera
wikipage
camera
|
castMaps,
|
<xy> imageSize,
|
<coordSys> c3,
|
<bitmap> directionsMap[;]
|
<bitmap> positionsMap[;]
|
<bitmap> weightsMap;
|
|
fishEye[;]
|
<xy> imageSize[;]
|
<coordSys> c3;
|
|
lens1,
|
<xy> imageSize,
|
<double> focalDistance,
|
<double> dofDistance,
|
<double> dofStrength[;]
|
<coordSys> c6;
|
|
Perspective camera with depth of field
|
|
mesh,
|
<mesh> m2,
|
<string> bakerUvName[;]
|
<xy> imageSize[;]
|
<coordSys> c5[;]
|
<int> flags=0[;]
|
<double> borderSize=10;
|
|
move,
|
<coordSys> c2;
|
|
Changes camera position and rotation.
|
|
parallel[;]
|
<xy> imageSize[;]
|
<double> planeSize[;]
|
<coordSys> c4[;]
|
<xyz> axisX,
|
<xyz> axisY,
|
<xyz> axisZ;
|
|
perspective[;]
|
<xy> imageSize[;]
|
<double> focalDistance[;]
|
<coordSys> c4;
|
|
Perspective camera
|
|
perspectiveBokehDof,
|
<xy> imageSize,
|
<double> focalDistance,
|
<double> dofDistance,
|
<double> dofStrength,
|
<bitmap> bokehImage[;]
|
<coordSys> c7;
|
|
Perspective camera with depth of field
|
|
perspectiveDof,
|
<xy> imageSize,
|
<double> focalDistance,
|
<double> dofDistance,
|
<double> dofStrength[;]
|
<coordSys> c6;
|
|
Perspective camera with depth of field
|
|
picture[;]
|
<xy> imageSize[;]
|
<double> focalDistance[;]
|
<coordSys> c4;
|
|
Perspective camera
|
|
rotate,
|
<hpb> ori;
|
|
Rotates camera.
|
|
shader,
|
<shaderNode> s2[;]
|
<xy> imageSize[;]
|
<coordSys> c4;
|
|
shift,
|
<xyz> pos;
|
|
Changes camera position.
|
|
sphere[;]
|
<xy> imageSize[;]
|
<coordSys> c3;
|
class
Creates class definition.
wikipage
class
|
#symbolName#
|
(arguments)
|
{code};
|
classObject
Creates a reference to custom class object.
example:
classObject myObject=myClass(parameter);
wikipage
classObject
|
#symbolName#;
|
clear
Clears given object. Exact behaviour depends on object type.
wikipage
color
wikipage
color
|
#symbolName#[;]
|
<vector> v2;
|
commandsProtos
Displays command prototypes on screen or saves to file.
Available modes:
| 0 | plain text |
| 1 | html |
| 2 | C++ prototypes |
Flags bits:
| 0 | list keywords only |
| 1 | extended mode |
commandsProtos[;]
|
<int> mode=0[;]
|
<int> flags=0[;]
|
<string> filename;
|
coordSys
wikipage
coordSys
|
#symbolName#[;]
|
<coordSys> c2;
|
delete
Deletes given script object (variable or symbol).
wikipage
double
wikipage
double
|
#symbolName#[;]
|
<double> d2;
|
echo
Evaluates expression and displays its value
wikipage
end
Ends parsing current script file (also exits interactive mode)
see:
stop
environment
wikipage
environment
|
colorFade,
|
<rgb> exponentialFilter;
|
|
shader,
|
<shaderNode> s2;
|
exit
Ends parsing current script file (also exits interactive mode)
see:
stop
expr
Evaluates expression. Useful when expression variable name is shadowed by build-in function name.
wikipage
fg
Final gathering options
wikipage
fg
|
gradients,
|
<double> gradientMaxDistance,
|
<double> irr_spatial_dens;
|
|
gradients2,
|
<double> gradientMinDistance,
|
<double> irr_brightdens;
|
|
gradients3,
|
<double> irr_min_weight,
|
<double> irr_angle_dens;
|
|
gradients4,
|
<double> gradientBackgroundHitDistance,
|
<double> irr_normal_dist;
|
|
gradientsFlags,
|
<int> d2;
|
|
gradientsNeighbour,
|
<double> d2;
|
|
gradReload,
|
<bool> d2;
|
|
gradSidethreshold,
|
<double> d2;
|
|
irradianceBlur,
|
<double> online[;]
|
<double> offline;
|
|
irradianceBlurGamma,
|
<double> d2;
|
|
irrMissingBlur,
|
<double> d2;
|
|
load,
|
<string> file;
|
|
Loads global illumination data from disk
|
|
pixels,
|
<double> pixel_multiplier,
|
<double> aa_multiplier,
|
<int> aa_multiplies,
|
<double> box_pixels_scale,
|
<double> max_aniso;
|
|
pmShortRay,
|
<double> pmCornerDistance[;]
|
<double> finalGatherCornerRays;
|
|
prerender,
|
<double> d2[;]
|
<int> d3,
|
<double> d4;
|
|
presample[;]
|
<double> powerMax=0.3[;]
|
<double> dynamicMaxSqr=0.02[;]
|
<int> minGridSize=7;
|
|
Sets presampling options for diffuse surfaces
|
|
rays[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
raysNMultiplier,
|
<int> globalRayAvgN;
|
|
raysPresampled[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
Sets number of presampled rays
|
|
render[;]
|
<bool> fgOnly=0;
|
|
Rebuild FG map if needed. If fgOnly is set, data which FG maps are based on (photon maps) will not be initialized even if its empty.
|
|
reset;
|
|
Clears FG cache
|
|
save,
|
<string> file[;]
|
<int> flags=65535;
|
|
Saves global illumination data to disk
|
|
scale[;]
|
<double> scaleFactor;
|
|
scaleRelativeToGlobalPm[;]
|
<double> scaleFactor;
|
|
scaleRelativeToPrecachedPm[;]
|
<double> scaleFactor;
|
|
showCornerSamples,
|
<bool> showFinalGatherCornerSamples[;]
|
<rgb> finalGatherSampleColor;
|
|
showSamples,
|
<bool> showFinalGatherSamples[;]
|
<rgb> finalGatherSampleColor;
|
|
timeGradients,
|
<double> ca0[;]
|
{<vector> cab1,...};
|
fiberPack
wikipage
fiberPackOp
wikipage
fiberPackOp
|
<fiberPack> f1,
|
addFiber,
|
<xy> v3,
|
<double> d4,
|
<double> d5,
|
<xy> v6,
|
<double> d7,
|
<double> d8[;]
|
<xy> v9,
|
<double> d10;
|
|
|
bBoxSize,
|
<double> d3;
|
for
For loop. Classic syntax
example:
for (var a=0; a<10 ; a++) echo 'a='+a;
wikipage
fs
File system operations
wikipage
fs
|
appendString,
|
<string> fileName,
|
<string> text;
|
|
Appends string to file
|
|
cat,
|
<string> fileName;
|
|
Displays text file content on screen
|
|
copy,
|
<string> source,
|
<string> destination;
|
|
Makes a copy of a file
|
|
hexCat,
|
<string> fileName[;]
|
<uint> rowSize;
|
|
Displays binary file content on screen
|
|
list[;]
|
<string> dir="";
|
|
Displays a list of files in given directory
|
|
openUrl,
|
<string> url;
|
|
Opens given URL in webbrowser
|
|
pathAdd,
|
<string> path;
|
|
Adds entry to file search path
|
|
pathRemove,
|
<string> path;
|
|
Removes entry from file search path.
|
|
pathShow;
|
|
pathSkipCurrentDir,
|
<bool> state;
|
|
Sets if current directory should be included in file search path.
|
|
pathSlashCut,
|
<bool> state;
|
function
Defines a function.
example:
function fntest(string text,var num){
echo 'Function args are '+text+' and '+num;
}
fntest('abc',123) // displays 'Function args are abc and 123'
wikipage
function
|
#symbolName#
|
(arguments)
|
{code};
|
gpGpu
General Purpose computing GPU configuration
wikipage
gpGpu
|
addDebug,
|
<stringable> engineId;
|
|
addInternal,
|
<stringable> engineId[;]
|
<int> cpuThreads=-1[;]
|
<int> complementaryThreads=-1;
|
|
Adds internal CPU to compute devices table
|
|
addOpenCl,
|
<stringable> engineId,
|
<int> openClPlatformIndex[;]
|
<int> openClDeviceIndex=0[;]
|
<int> flags=0;
|
|
Adds OpenCL device to table of devices used by Kray
|
|
clear;
|
|
Clears compute devices table
|
|
listAvailable;
|
|
Displays list of available general purpose computing devices
see:
openCl
|
|
listUsed;
|
|
Lists used devices for GPGPU computing
|
|
oct,
|
<stringable> engineId,
|
aniso,
|
<double> maxAniso,
|
<double> anisoBalance;
|
|
|
|
build,
|
<double> separationThreshold,
|
<xyz> dontSplitRatios,
|
<xyz> forceSplitRatios;
|
|
|
|
explorer[;]
|
<vector[4]> v4;
|
|
Starts octree debug tool. (debug version)
|
|
|
|
flags[;]
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
Sets octree flags.
|
|
|
|
invalidate,
|
<vector[4]> v4,
|
<vector[4]> v5;
|
|
Invalidates given volume of scene space (and forces octree rebuild there)
|
|
|
|
limits,
|
<int> recurseMax,
|
<double> minLeafWeight;
|
|
|
|
show[;]
|
<int> flags[;]
|
<int> color_level;
|
|
Draws octree on screen.
|
|
|
|
stats[;]
|
<int> flags;
|
|
Controls octree for given compute engine
|
|
Displays octree statistics.
|
|
remove,
|
<stringable> engineId;
|
|
useGpus;
|
|
Configures compute devices table to use all found GPUs in system
|
|
useInternal;
|
|
Configures compute devices table to use internal CPU only
|
group
Object group operations
wikipage
group
|
add;
|
|
Created new unnamed root group and selects it.
|
|
addInstance[;]
|
<string> subGroupOfNode;
|
|
Created new unnamed instance group and selects it.
|
|
attachSet,
|
function,
|
<string> expression,
|
<coordSys> axes,
|
<double> sx,
|
<double> sy,
|
<int> dx,
|
<int> dy,
|
<surface> s9;
|
|
|
mesh,
|
<mesh> m3[;]
|
<coordSys> axes[;]
|
<int> flags=0;
|
|
Attaches object set to current group.
|
|
Attaches mesh to current object group at given position and orientation. Flags meaning:
| RECTANGLE_LEMS | 0x1000 - Convert quad that are rectangles to rectangle shape instead of triangle pairs if possible | | USE_SURFACE_MAP | 0x2000 - Use surface/blend/clipmap dispatcher (slower rendering, faster material update) | | INSTANCE | 0x8000 - Set if your object will be instanced (adds world to instance filter to texture mappings) | | EXPAND_MB_STATIC | 0x10000 - Use faster but less mem friendly motion blur handling of meshes | | COMPRESS_NORMALS | 0x20000 - Use preprocessed, slower, but more memory friendly normals storage | | NO_MB | 0x40000 - Disable motion blur (even if there are moving polygons in mesh) | | FLIP_NORMALSIDE | 0x80000 - Change polygon facing to opposite | | NO_DISPLACE_FIT | 0x100000 - Do not preprocess displace map polys topology (which assures geometry continuity even for non coplanar displacement sides) | | FIND_COMMON_VERTICES | 0x200000 - Threat vertices with the same location as the have the same vertex index |
|
|
clear;
|
|
Makes current object group empty.
|
|
remove[;]
|
<stringable> s2;
|
|
Removes object group from scene. If instance group has references (instanced objects), group will be only cleared, not removed.
|
|
removeAll;
|
|
Removes all groups from scene.
|
|
removeUnused[;]
|
<int> flags=3;
|
|
Removes unused groups from scene. Flag meaning:
| ModeEmptyGroups | 0x1 - Remove all groups without any geometry | | ModeUnreferencedInstances | 0x2 - Remove instances with reference counter equal zero |
|
|
select[;]
|
<stringable> s2;
|
|
Selects given object group as current. If group does not exist, new root group is created.
|
|
selectInstance,
|
<stringable> s2[;]
|
<stringable> subGroupOfNode;
|
|
Selects given object group as current. If group does not exist, new instance group is created.
|
|
updateMaterials[;]
|
<int> flags=0;
|
|
Updates material of selected group.
|
groupLink
Creates link to object group. Hard linked groups are deleted when group link symbol is deleted.
wikipage
groupLink
|
#symbolName#[;]
|
group[;]
|
<string> name;
|
|
|
groupHard[;]
|
<string> name;
|
|
|
instance[;]
|
<string> name[;]
|
<string> instanceGroupName;
|
|
|
InstanceHard[;]
|
<string> name[;]
|
<string> instanceGroupName;
|
help
wikipage
help[;]
|
about;
|
|
anim;
|
|
animOb;
|
|
animObLink;
|
|
array;
|
|
axes;
|
|
background;
|
|
bitmap;
|
|
bitmapData;
|
|
bitmapOp;
|
|
blend;
|
|
camera;
|
|
class;
|
|
classObject;
|
|
clear;
|
|
color;
|
|
commandsProtos;
|
|
coordSys;
|
|
delete;
|
|
double;
|
|
echo;
|
|
end;
|
|
environment;
|
|
exit;
|
|
expr;
|
|
fg;
|
|
fiberPack;
|
|
fiberPackOp;
|
|
for;
|
|
fs;
|
|
function;
|
|
gpGpu;
|
|
group;
|
|
groupLink;
|
|
help;
|
|
if;
|
|
include;
|
|
instanceAdd;
|
|
instanceLinkAdd;
|
|
interactive;
|
|
k2;
|
|
kray;
|
|
light;
|
|
lightAdd;
|
|
lightOp;
|
|
lopt;
|
|
lw;
|
|
mapping;
|
|
material;
|
|
materialSet;
|
|
mesh;
|
|
meshAddPoly;
|
|
meshesOptions;
|
|
meshOp;
|
|
metaSurface;
|
|
metaTexture;
|
|
metaTextureSet;
|
|
method;
|
|
net;
|
|
objectAdd;
|
|
oct;
|
|
openCl;
|
|
parse;
|
|
parseMode;
|
|
pause;
|
|
platform;
|
|
pm;
|
|
postProcess;
|
|
pv;
|
|
rayCast;
|
|
reference;
|
|
rem;
|
|
render;
|
|
reset;
|
|
return;
|
|
sett;
|
|
shaderNode;
|
|
shadowMap;
|
|
shape;
|
|
shapeSelection;
|
|
shapeSelectionOp;
|
|
shOb;
|
|
shObOp;
|
|
showInfo;
|
|
stop;
|
|
string;
|
|
stringId;
|
|
surface;
|
|
surfaceOp;
|
|
symbolsDelete;
|
|
tds;
|
|
texture;
|
|
threads;
|
|
var;
|
|
variable;
|
|
vector;
|
|
vertex2d;
|
|
vertex3d;
|
|
vertexData;
|
|
vertexMap;
|
|
vertexMapOp;
|
|
view;
|
|
while;
|
if
Executes code if condition is true. Optional else and else if blocks can follow if block.
wikipage
if
|
<bool> condition
|
{code};
|
include
Executes Kray script file given by filename
wikipage
include
|
<string> filename;
|
instanceAdd
Adds object instance to current object group.
wikipage
instanceAdd
|
<stringable> name,
|
<coordSys> axes[;]
|
clipMap,
|
<texture> t4[;]
|
fromVertexMap,
|
<vertexMap> v6[;]
|
<miscSharedObject> m7;
|
|
|
|
|
|
light[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
|
|
|
timeShift,
|
<xy> timeShift[;]
|
fromVertexMap,
|
<vertexMap> v8[;]
|
<miscSharedObject> m9;
|
|
|
|
|
|
|
|
light[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
|
fromVertexMap,
|
<vertexMap> v4[;]
|
<miscSharedObject> m5;
|
|
|
|
light[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
|
timeShift,
|
<xy> timeShift[;]
|
fromVertexMap,
|
<vertexMap> v6[;]
|
<miscSharedObject> m7;
|
|
|
|
|
|
light[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
instanceLinkAdd
Adds object instance specified by group link to current object group.
This is faster version then
instanceAdd. Preferred when lots of instances are added
see:
instanceAdd
instanceLinkAdd
|
<group> name,
|
<coordSys> axes[;]
|
clipMap,
|
<texture> t4[;]
|
fromVertexMap,
|
<vertexMap> v6[;]
|
<miscSharedObject> m7;
|
|
|
|
|
|
light[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
|
|
|
timeShift,
|
<xy> timeShift[;]
|
fromVertexMap,
|
<vertexMap> v8[;]
|
<miscSharedObject> m9;
|
|
|
|
|
|
|
|
light[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
|
fromVertexMap,
|
<vertexMap> v4[;]
|
<miscSharedObject> m5;
|
|
|
|
light[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
|
timeShift,
|
<xy> timeShift[;]
|
fromVertexMap,
|
<vertexMap> v6[;]
|
<miscSharedObject> m7;
|
|
|
|
|
|
light[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
interactive
Starts Kray console interactive mode
wikipage
k2
Executes Kray 2.x script block
wikipage
kray
Executes another instance of Kray with given command line parameters.
| Mode | 0 | restart current instance |
| Mode | 1 | create new instance on the same thread (default) |
| Mode | 2 | create new instance and thread |
| Mode | 3 | parse command line inside current instance |
| Flag | +0x100 | restart platform abstraction layer |
kray[;]
|
<string> parameters[;]
|
<int> mode;
|
light
Creates new light object
wikipage
light
|
#symbolName#,
|
ambient,
|
<rgb> color;
|
|
|
ambientTextured,
|
<texture> lightTexture;
|
|
|
dirPoint,
|
{<vector> position,...},
|
{<vector> orientation,...},
|
<rgb> color;
|
|
Directional point light - infinite small light emitting plane
|
|
|
dirPointTextured,
|
{<vector> position,...},
|
{<vector> orientation,...},
|
<texture> lightTexture;
|
|
Directional point light - infinite small light emitting plane
|
|
|
distantSphere,
|
<shaderNode> s3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0[;]
|
<double> powerMax=0.3[;]
|
<double> dynamicMaxSqr=0.02[;]
|
<int> minGridSize=7;
|
|
Infinite distant sphere light
|
|
|
fade,
|
<light> l3[;]
|
<double> multiplier=1;
|
|
Adds inverse square fallof to given light
|
|
|
fadeDirPoint,
|
{<vector> position,...},
|
{<vector> orientation,...},
|
<rgb> color;
|
|
Directional point light with inverse square falloff
|
|
|
fadeDirPointTextured,
|
{<vector> position,...},
|
{<vector> orientation,...},
|
<texture> lightTexture;
|
|
Directional point light with inverse square falloff
|
|
|
fadePoint,
|
{<vector> position,...},
|
<rgb> color;
|
|
Point light with inverse square falloff (physically correct)
|
|
|
fadePointTextured,
|
{<vector> position,...},
|
<texture> lightTexture;
|
|
Point light with inverse square falloff (physically correct)
|
|
|
fakePhotonEmitter,
|
<light> l3[;]
|
<double> power=1;
|
|
|
far,
|
<light> l3;
|
|
Light filter that optimizes photon casting when light is far from scene geometry
|
|
|
group,
|
{<light> l3,...}[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
groupImportance,
|
{<light> l3,...}[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
groupTree,
|
{<light> l3,...},
|
<double> rejectionThreshold[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
ies,
|
<miscSharedObject> m3,
|
{<coordSys> axes,...}[;]
|
<rgb> colorFilter=(1,1,1)[;]
|
<int> flags=0;
|
|
Photometric IES light. Meaning of flags:
| ClipDimMask | 0x3 - Force light model dimension. (0 - inactive, 1 - 2d area, 2 - 1d line, 3 - 0d point) | | LoopH | 0x4 - Loop horizontal samples | | LoopV | 0x8 - Loop vertical samples |
|
|
|
light,
|
<light> l3;
|
|
Adds already defined light
|
|
|
line,
|
{<vector> position,...},
|
{<vector> direction,...},
|
<rgb> color[;]
|
<int> minRecursionLevel=1[;]
|
<int> maxRecursionLevel=6[;]
|
<double> errorTolerance=0.01;
|
|
Line light - line (segment) that emits light
|
|
|
linear,
|
<xyz> position,
|
<xyz> direction,
|
<texture> lightTexture;
|
|
Line light. Interface compatible with Kray V2, deprecated, use line instead
|
|
|
lineTextured,
|
{<vector> position,...},
|
{<vector> direction,...},
|
<texture> lightTexture[;]
|
<int> minRecursionLevel=1[;]
|
<int> maxRecursionLevel=6[;]
|
<double> errorTolerance=0.01;
|
|
Line light - line (segment) that emits light
|
|
|
parallel,
|
{<vector> direction,...},
|
<rgb> color;
|
|
|
parallelTextured,
|
{<vector> direction,...},
|
<texture> lightTexture;
|
|
|
photonMultiplier,
|
<light> l3,
|
<double> numberMultiplier=1[;]
|
<double> powerMultiplier=1;
|
|
|
point,
|
{<vector> position,...},
|
<rgb> color;
|
|
Point light - infinite small sphere that emits light
|
|
|
pointTextured,
|
{<vector> position,...},
|
<texture> lightTexture;
|
|
Point light - infinite small sphere that emits light
|
|
|
portal,
|
<light> l3,
|
<shapeSelection> s4;
|
|
Adds light with portal
|
|
|
rangeLimiter,
|
<light> l3,
|
<double> rangeMax[;]
|
<double> clip=0;
|
|
|
rectangle,
|
{<coordSys> axes,...},
|
<xy> size,
|
<rgb> color[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
rectangleDS,
|
{<coordSys> axes,...},
|
<xy> size,
|
<rgb> color[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
rectangleSpot,
|
{<coordSys> axes,...},
|
<xy> size,
|
<rgb> color,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd[;]
|
<xyz> spotDirection[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
rectangleSpotDS,
|
{<coordSys> axes,...},
|
<xy> size,
|
<rgb> color,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd[;]
|
<xyz> spotDirection[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
rectangleSpotTextured,
|
{<coordSys> axes,...},
|
<xy> size,
|
<texture> lightTexture,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd[;]
|
<xyz> spotDirection[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
rectangleSpotTexturedDS,
|
{<coordSys> axes,...},
|
<xy> size,
|
<texture> lightTexture,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd[;]
|
<xyz> spotDirection[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
rectangleTextured,
|
{<coordSys> axes,...},
|
<xy> size,
|
<texture> lightTexture[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
rectangleTexturedDS,
|
{<coordSys> axes,...},
|
<xy> size,
|
<texture> lightTexture[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
shadowCache,
|
<light> l3,
|
<int> cacheSize,
|
<double> distanceTolerance;
|
|
Shadow cache for light
|
|
|
shadowMapPoint,
|
<shadowMap> shadowMap,
|
<rgb> color;
|
|
Point light that uses shadow map for visibility checks
|
|
|
shadowMapPointTextured,
|
<shadowMap> shadowMap,
|
<texture> lightTexture;
|
|
Point light that uses shadow map for visibility checks
|
|
|
shape,
|
{<rgb> color,...}[;]
|
<int> flags=0[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
shapeSurfaced,
|
{<surface> s3,...}[;]
|
<int> flags=0[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
shapeTextured,
|
{<texture> t3,...}[;]
|
<int> flags=0[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
sphere,
|
{<vector> position,...},
|
<double> radius,
|
<rgb> color[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
Spherical light
|
|
|
sphereTextured,
|
{<vector> position,...},
|
<double> radius,
|
<texture> lightTexture[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
Spherical light
|
|
|
spot,
|
{<vector> v3,...},
|
{<vector> v4,...},
|
<rgb> color,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd;
|
|
|
spotTextured,
|
{<vector> v3,...},
|
{<vector> v4,...},
|
<texture> lightTexture,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd;
|
lightAdd
Adds light to scene
wikipage
lightAdd
|
ambient,
|
<rgb> color;
|
|
ambientTextured,
|
<texture> lightTexture;
|
|
dirPoint,
|
{<vector> position,...},
|
{<vector> orientation,...},
|
<rgb> color;
|
|
Directional point light - infinite small light emitting plane
|
|
dirPointTextured,
|
{<vector> position,...},
|
{<vector> orientation,...},
|
<texture> lightTexture;
|
|
Directional point light - infinite small light emitting plane
|
|
distantSphere,
|
<shaderNode> s2[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0[;]
|
<double> powerMax=0.3[;]
|
<double> dynamicMaxSqr=0.02[;]
|
<int> minGridSize=7;
|
|
Infinite distant sphere light
|
|
fade,
|
<light> l2[;]
|
<double> multiplier=1;
|
|
Adds inverse square fallof to given light
|
|
fadeDirPoint,
|
{<vector> position,...},
|
{<vector> orientation,...},
|
<rgb> color;
|
|
Directional point light with inverse square falloff
|
|
fadeDirPointTextured,
|
{<vector> position,...},
|
{<vector> orientation,...},
|
<texture> lightTexture;
|
|
Directional point light with inverse square falloff
|
|
fadePoint,
|
{<vector> position,...},
|
<rgb> color;
|
|
Point light with inverse square falloff (physically correct)
|
|
fadePointTextured,
|
{<vector> position,...},
|
<texture> lightTexture;
|
|
Point light with inverse square falloff (physically correct)
|
|
fakePhotonEmitter,
|
<light> l2[;]
|
<double> power=1;
|
|
far,
|
<light> l2;
|
|
Light filter that optimizes photon casting when light is far from scene geometry
|
|
group,
|
{<light> l2,...}[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
groupImportance,
|
{<light> l2,...}[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
groupTree,
|
{<light> l2,...},
|
<double> rejectionThreshold[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
ies,
|
<miscSharedObject> m2,
|
{<coordSys> axes,...}[;]
|
<rgb> colorFilter=(1,1,1)[;]
|
<int> flags=0;
|
|
Photometric IES light. Meaning of flags:
| ClipDimMask | 0x3 - Force light model dimension. (0 - inactive, 1 - 2d area, 2 - 1d line, 3 - 0d point) | | LoopH | 0x4 - Loop horizontal samples | | LoopV | 0x8 - Loop vertical samples |
|
|
light,
|
<light> l2;
|
|
Adds already defined light
|
|
line,
|
{<vector> position,...},
|
{<vector> direction,...},
|
<rgb> color[;]
|
<int> minRecursionLevel=1[;]
|
<int> maxRecursionLevel=6[;]
|
<double> errorTolerance=0.01;
|
|
Line light - line (segment) that emits light
|
|
linear,
|
<xyz> position,
|
<xyz> direction,
|
<texture> lightTexture;
|
|
Line light. Interface compatible with Kray V2, deprecated, use line instead
|
|
lineTextured,
|
{<vector> position,...},
|
{<vector> direction,...},
|
<texture> lightTexture[;]
|
<int> minRecursionLevel=1[;]
|
<int> maxRecursionLevel=6[;]
|
<double> errorTolerance=0.01;
|
|
Line light - line (segment) that emits light
|
|
objectPortal,
|
<light> l2,
|
<shapeSelection> s3;
|
|
Adds light with portal
|
|
parallel,
|
{<vector> direction,...},
|
<rgb> color;
|
|
parallelTextured,
|
{<vector> direction,...},
|
<texture> lightTexture;
|
|
photonMultiplier,
|
<light> l2,
|
<double> numberMultiplier=1[;]
|
<double> powerMultiplier=1;
|
|
point,
|
{<vector> position,...},
|
<rgb> color;
|
|
Point light - infinite small sphere that emits light
|
|
pointTextured,
|
{<vector> position,...},
|
<texture> lightTexture;
|
|
Point light - infinite small sphere that emits light
|
|
portal,
|
<light> l2,
|
<shapeSelection> s3;
|
|
Adds light with portal
|
|
rangeLimiter,
|
<light> l2,
|
<double> rangeMax[;]
|
<double> clip=0;
|
|
rectangle,
|
{<coordSys> axes,...},
|
<xy> size,
|
<rgb> color[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
rectangleDS,
|
{<coordSys> axes,...},
|
<xy> size,
|
<rgb> color[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
rectangleSpot,
|
{<coordSys> axes,...},
|
<xy> size,
|
<rgb> color,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd[;]
|
<xyz> spotDirection[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
rectangleSpotDS,
|
{<coordSys> axes,...},
|
<xy> size,
|
<rgb> color,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd[;]
|
<xyz> spotDirection[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
rectangleSpotTextured,
|
{<coordSys> axes,...},
|
<xy> size,
|
<texture> lightTexture,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd[;]
|
<xyz> spotDirection[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
rectangleSpotTexturedDS,
|
{<coordSys> axes,...},
|
<xy> size,
|
<texture> lightTexture,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd[;]
|
<xyz> spotDirection[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
rectangleTextured,
|
{<coordSys> axes,...},
|
<xy> size,
|
<texture> lightTexture[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
rectangleTexturedDS,
|
{<coordSys> axes,...},
|
<xy> size,
|
<texture> lightTexture[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
shadowCache,
|
<light> l2,
|
<int> cacheSize,
|
<double> distanceTolerance;
|
|
Shadow cache for light
|
|
shadowMapPoint,
|
<shadowMap> shadowMap,
|
<rgb> color;
|
|
Point light that uses shadow map for visibility checks
|
|
shadowMapPointTextured,
|
<shadowMap> shadowMap,
|
<texture> lightTexture;
|
|
Point light that uses shadow map for visibility checks
|
|
shape,
|
{<rgb> color,...}[;]
|
<int> flags=0[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
shapeSurfaced,
|
{<surface> s2,...}[;]
|
<int> flags=0[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
shapeTextured,
|
{<texture> t2,...}[;]
|
<int> flags=0[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
sphere,
|
{<vector> position,...},
|
<double> radius,
|
<rgb> color[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
Spherical light
|
|
sphereTextured,
|
{<vector> position,...},
|
<double> radius,
|
<texture> lightTexture[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
Spherical light
|
|
spot,
|
{<vector> v2,...},
|
{<vector> v3,...},
|
<rgb> color,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd;
|
|
spotTextured,
|
{<vector> v2,...},
|
{<vector> v3,...},
|
<texture> lightTexture,
|
<double> spotAngle[;]
|
<double> spotAngleSoftEnd;
|
lightOp
wikipage
lightOp
|
<light> l1,
|
shadow,
|
<bool> onOff;
|
lopt
Light quality options
wikipage
lopt
|
backgroundPresample[;]
|
<double> powerMax=0.3[;]
|
<double> dynamicMaxSqr=0.02[;]
|
<int> minGridSize=7;
|
|
backgroundQuality[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
lemPresample[;]
|
<double> powerMax=0.3[;]
|
<double> dynamicMaxSqr=0.02[;]
|
<int> minGridSize=7;
|
|
lemQuality[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
lineQuality[;]
|
<int> minRecursionLevel=1[;]
|
<int> maxRecursionLevel=6[;]
|
<double> errorTolerance=0.01;
|
|
rectangleQuality[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4;
|
lw
LightWave importer module commands
wikipage
lw
|
areaLights,
|
<int> showAreaLights,
|
<bool> doubleSided,
|
<bool> computeWithLumi;
|
|
backgroundInputTone[;]
|
<shaderNode> s2;
|
|
bitmapLoad,
|
<bitmap> b2,
|
<string> name[;]
|
<double> time=0[;]
|
<int> bitmapFlags=0;
|
|
camBokeh[;]
|
<bitmap> bokeh;
|
|
camCastMaps[;]
|
<bitmap> positionMap,
|
<bitmap> directionMap;
|
|
camDofTargetObject,
|
<string> dofTarget;
|
|
camMeshAndUv,
|
<string> meshAnimObName,
|
<string> uvName,
|
<int> flags,
|
<int> border[;]
|
<string> uvPixelShiftName[;]
|
<mesh> m7;
|
|
camMode[;]
|
castMaps;
|
|
|
fishEye;
|
|
|
lens1;
|
|
|
mesh;
|
|
|
move;
|
|
|
parallel;
|
|
|
perspective;
|
|
|
perspectiveBokehDof;
|
|
|
perspectiveDof;
|
|
|
picture;
|
|
|
rotate;
|
|
|
shader;
|
|
|
shift;
|
|
|
sphere;
|
|
commRingEvent,
|
<int> dest,
|
<int> value,
|
<double> param=0[;]
|
<string> stringParam;
|
|
Puts a message to LW commring event (Kray plugin only)
|
|
coneToArea,
|
<bool> state;
|
|
controlAmbient,
|
<bool> state;
|
|
controlBackground,
|
<bool> state;
|
|
controlEnvironment,
|
<bool> state;
|
|
directLoader,
|
<bool> d2;
|
|
environmentFlags,
|
<int> flags=0;
|
|
ignoreItemId,
|
<id> id;
|
|
ignoreItemName,
|
<string> name;
|
|
ignoreMeshUpdateMode,
|
<int> mode;
|
|
inputTone[;]
|
<shaderNode> s2;
|
|
Sets light,background and texture tone mapping with single command
|
|
instanceTemplateItem,
|
<id> id1[;]
|
<id> id2=0[;]
|
<int> flags=0;
|
|
Sets up instance template for LW item. Flags are:
| color_filter | 0x2 - Instance uses color filtering | | use_mesh_template | 0x10000 - Instance uses mesh points as a template | | use_vmap_template | 0x20000 - Instance uses vertex map points as a template |
|
|
invalidateScene;
|
|
Invalidates anim scene object list and forces scene reload on next anim scene update
|
|
invalidateType[;]
|
<int> type;
|
|
itemReload,
|
<id> itemId[;]
|
<bool> reset=0;
|
|
lightInputTone[;]
|
<shaderNode> s2;
|
|
lightTreeInstance,
|
<double> rejectionLevel;
|
|
meshesOptions,
|
airPolys,
|
<bool> needAirPolysFlag,
|
<bool> backSidePureTransmission;
|
|
|
baseNormalGrab,
|
<bool> d3;
|
|
|
blurDoubleSide,
|
<bool> d3;
|
|
|
blurPmThreshold,
|
<double> blurPmAproxModeThreshold;
|
|
|
raysLimit,
|
<int> d3,
|
<double> d4;
|
|
|
reflectBlurModel,
|
<int> reflectionBlurModel;
|
|
|
reflectionBlur[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
refractionBlur[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
sssBlur[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
textureSystem,
|
<bool> d3;
|
|
|
unseenByRaysAffectsGi,
|
<bool> unseenByRaysAffectsRadiosity;
|
|
nonPhyLightsCastsPhotons,
|
<bool> state;
|
|
onlySendLastFrameBufferOnLwRender;
|
|
outputTo,
|
<bool> lwOutput;
|
|
Controls passing rendered image to LW
|
|
pathMode,
|
<bool> state;
|
|
physky[;]
|
<miscSharedObject> m2,
|
<id> lightItemId;
|
|
raySamples,
|
<int> samples;
|
|
replaceLight,
|
<uint> d2,
|
<light> l3;
|
|
sceneLoad,
|
<string> filename[;]
|
<int> flags=1;
|
|
Imports LightWave scene. When flags==1, Kray will load scene and Kray embeded script in LWSC file. When flags==0, only LWSC anim item are loaded and embeded script is ignored
|
|
sceneParse,
|
<string> cmd;
|
|
Executes LightWave Layout command
|
|
sceneReLoad[;]
|
<bool> force=0;
|
|
Imports LW scene from Layout
|
|
selfInstance,
|
<int> d2;
|
|
setGlobalHandlers,
|
<int> mask;
|
|
shaderNodeBackground,
|
#symbolName#;
|
|
Creates LW background shader node
|
|
shaderNodeEnvironment,
|
#symbolName#;
|
|
Creates LW environment shader node
|
|
textureInputTone[;]
|
<shaderNode> s2;
|
mapping
wikipage
mapping
|
#symbolName#,
|
rect,
|
<xyz> dx,
|
<xyz> dy,
|
<xyz> pos;
|
|
|
sphere,
|
<coordSys> axes;
|
|
|
triangleUvMap,
|
<vertexMap> v3;
|
|
|
tube,
|
<coordSys> axes,
|
<double> len;
|
material
Creates new material object (which is subclass of shaderNode).
wikipage
material
|
#symbolName#[;]
|
fromMeshTag,
|
<mesh> m3,
|
<uint> polygonTag;
|
|
|
fromMeshTagName,
|
<mesh> m3,
|
<stringable> polygonTagName;
|
materialSet
wikipage
materialSet
|
<material> m1,
|
ambientOcclusionColor,
|
<rgb> t;
|
|
|
ambientOcclusionDistance,
|
<double> value;
|
|
|
backSideFlags,
|
<double> value;
|
|
Polygon back side material behaviour flags, Flags meaning:
| doubleSidedDiffuse | 0x1 - | | doubleSidedTranslucency | 0x2 - | | doubleSidedSpecularity | 0x4 - | | doubleSidedReflection | 0x8 - | | doubleSidedLight | 0x10 - | | doubleSidedFlipNormal | 0x20 - Flip back side normals, so shading is symetrical on front and back side of material. | | doubleSidedTransparencyBlur | 0x40 - Computes transparency/refraction blur on both sides on material. | | doubleSidedSolid | 0x8000 - Back side appears solid when used with camera start distance function (see view command). | | singleSidedGeometry | 0x10000 - Force single sided geometry | | doubleSidedGeometry | 0x20000 - Force double sided geometry. If no single nor double sided flag is set. Sideness is choosen automatically. This flags can be overriden by polygon flags. |
|
|
|
blurRays[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
blurringAproximateSwitchLevel,
|
<double> value;
|
|
|
bumpDepth,
|
<double> value;
|
|
|
clipMapLevel,
|
<double> value;
|
|
|
color,
|
<rgba> t;
|
|
|
diffuse,
|
<double> value;
|
|
Amount of diffuse reflection. By default set to 1 (100%)
|
|
|
diffuseModel,
|
<double> value;
|
|
Diffuse shading model (also global illumination model). Overrides global setting and allows to change diffuse model per material.
see:
meshesOptions
diffuseModel
|
|
|
edgeDetectSlot,
|
<double> value;
|
|
|
flags,
|
<double> value;
|
|
Material flags. Meaning of flags:
| invisible | 0x1 - | | needUv | 0x20000 - | | usesSurfaceIds | 0x80 - | | notCausesCaustics | 0x100 - | | unseenByCam | 0x200 - | | unseenByRays | 0x400 - | | unseenByFg | 0x800 - | | noFgReflections | 0x1000 - | | noFgRefractions | 0x2000 - | | noCastShadow | 0x4000 - | | noSideCheckShadow | 0x8000 - | | unseenByPhotons | 0x40000 - | | diffuseNoColor | 0x80000 - | | translucencyNoColor | 0x100000 - | | lemNoColor | 0x200000 - |
|
|
|
forceColor,
|
<double> value;
|
|
|
fresnel,
|
<double> value;
|
|
|
glossiness,
|
<double> value;
|
|
|
ior,
|
<double> value;
|
|
|
light,
|
<double> value;
|
|
|
lightGroup,
|
<double> value;
|
|
|
lightRays[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
priority,
|
diffuse,
|
<int> pri;
|
|
|
|
reflection,
|
<int> pri;
|
|
|
|
shader,
|
<shaderNode> s4,
|
<int> pri;
|
|
|
|
specularity,
|
<int> pri;
|
|
|
|
sss,
|
<int> pri;
|
|
|
|
translucency,
|
<int> pri;
|
|
|
|
transparency,
|
<int> pri;
|
|
|
reflection,
|
<double> value;
|
|
|
reflectionBlur,
|
<double> value;
|
|
|
reflectionBlurLights,
|
<double> value;
|
|
|
refractionBlur,
|
<double> value;
|
|
|
shader,
|
<shaderNode> s3[;]
|
<double> value=0;
|
|
|
specularity,
|
<double> value;
|
|
|
sss,
|
<double> sss,
|
<rgb> scattering,
|
<rgb> absorbtion;
|
|
|
sssGauss,
|
<double> sss,
|
{<vector> v4,...},
|
{<double> d5,...};
|
|
|
sssRays[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
texture,
|
bump[;]
|
<shaderNode> s4;
|
|
|
|
clipMap[;]
|
<shaderNode> s4;
|
|
|
|
color[;]
|
<shaderNode> s4;
|
|
|
|
diffuse[;]
|
<shaderNode> s4;
|
|
|
|
light[;]
|
<shaderNode> s4;
|
|
|
|
normal[;]
|
<shaderNode> s4;
|
|
|
|
reflection[;]
|
<shaderNode> s4;
|
|
|
|
reflectionBlur[;]
|
<shaderNode> s4;
|
|
|
|
refractionBlur[;]
|
<shaderNode> s4;
|
|
|
|
shader,
|
<shaderNode> s4[;]
|
<shaderNode> s5;
|
|
|
|
specularity[;]
|
<shaderNode> s4;
|
|
|
|
sss[;]
|
<shaderNode> s4;
|
|
|
|
translucency[;]
|
<shaderNode> s4;
|
|
|
|
transparency[;]
|
<shaderNode> s4;
|
|
|
translucency,
|
<double> value;
|
|
|
transparency,
|
<double> value;
|
|
|
transparencyAbsorption,
|
<rgb> t;
|
|
|
transparencyAffects,
|
<int> taFlags;
|
|
Transparency mode flags. When flag is cleared transparency is additive and does not affect diffuse,translucency,specularity and reflection. When flag is set, affected property is scaled down by (1-transparency), so total light reflected from material will not exceed 1 (100%). Flags are:
| diffuse | 0x1 - | | translucency | 0x2 - | | specularity | 0x4 - | | reflection | 0x8 - | | sss | 0x10 - |
|
mesh
Creates a mesh object.
wikipage
mesh
|
#symbolName#[;]
|
fromAnimOb,
|
<stringable> s3[;]
|
<int> flags=0;
|
|
Obtains mesh reference from AnimOb
|
|
|
fromBitmap,
|
<bitmap> b3[;]
|
<xyz> v4,
|
<xyz> v5,
|
<xyz> v6,
|
<xyz> v7,
|
<xyz> v8[;]
|
<xyz> v9[;]
|
<xyz> v10,
|
<xyz> v11;
|
|
Converts height map into a mesh
|
|
|
fromVertexMap,
|
<vertexMap> v3;
|
|
Connects all points from given vertex map into new mesh
|
|
|
import,
|
<string> filename[;]
|
<int> layer[;]
|
<string> meshname;
|
|
Imports mesh from a file. Currently supported formats are VideoScape3d (.geo), LightWave Object (.lwo), 3dStudio (.3ds), WaveFront (.obj/.mtl)
|
|
|
triple,
|
<mesh> m3;
|
|
Creates new mesh by converting all polygons from existing mesh to triangles
|
meshAddPoly
Adds a polygon to a mesh.
Meaning of flags:
| GeometricFlip | 0x1 - Flip geometric normal |
| ShadingFlip | 0x2 - Shading normal is flipped to geometric normal |
| DoubleSided | 0x4 - Polygon is visible on both sides (front and back) |
| Invisible | 0x40 - Polygon is invisible, light emitting is added, but not geometry |
| SingleSided | 0x80 - Polygon is visible on front side only. This flag has priority over DoubleSided flag. When no DoubleSided nor SingleSided flag is set, sidenes depends on material and tags flags. |
example:
meshAddPoly mymesh,5,{0,2,3}; // creates triangle of points 0,2,3 with polygonTag=5
meshAddPoly
|
<mesh> m1,
|
<uint> d2,
|
{<int> polygon,...}[;]
|
<int> groupId=0[;]
|
<int> flags=0;
|
meshesOptions
Mesh to objectSet transformation settings
wikipage
meshesOptions
|
ambientOcclusion,
|
<rgb> ambientOcclusionColor,
|
<double> ambientOcclusionDistance;
|
|
backSideSolid,
|
<int> backSideSolidMode;
|
|
Back side solid surfaces (with clip camera)
|
|
bitFlags,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
bitmapFlags,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
Bitmap load options
|
|
diffuseModel,
|
<int> model;
|
|
Mesh diffuse reflection model. There are following modes and flags available:
Modes:
0 - Raytracing
[+1 caustics photons]
1000 - Ambient occlusion (set AOOptions when used)
[+1 caustics photons]
10000 - Direct filtered photon map [+2 unfiltered]
11000 - Precomputed photon map
[+10 smoothed] [+100 raytrace direct lights [+1 caustics photons]]
12000 - Baked photon map
[+100 raytrace direct lights]
20000 - Photon mapping
[+1 caustics photons] [+1000 cached final gathering] [+2000 use indirect photonmap] [+100 bake photonmap]
30000 - Random path tracing
[+1 caustics photons] [+100 raytrace direct lights [+1 caustics photons]]
40000 - Quasi random path tracing
[+100 raytrace direct lights [+1 caustics photons] [+1000 cached final gathering]]
|
|
overrideColor,
|
<rgb> overrideColor;
|
|
overrideSurface,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
overrideWire,
|
<rgb> wire_color,
|
<double> d3,
|
<double> d4;
|
|
preprocessDuplicatePointTolerance,
|
<double> preprocessDuplicatePointTolerance;
|
|
preprocessFlags,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
| Mesh processing (before adding to scene) optionsAlign | 0x1 - Aligns polygons in mesh (fix geometry normal facing) | | AlignWithRaytrace | 0x2 - Aligns with raytrace check for inside/outside facing | | AlignDoubleSidedOnly | 0x4 - Aligns only double sided polygons | | FindDuplicatePoints | 0x8 - Treats points with the same locations as those having the same index | | RemoveDuplicatePolygons | 0x10 - Removes duplicate polygons |
|
meshOp
Mesh operations
wikipage
meshOp
|
<mesh> m1,
|
addPolyTagName,
|
<stringable> polygonTagName,
|
{<int> polygon,...}[;]
|
<int> groupId=0[;]
|
<int> flags=0;
|
|
Adds a poly with mesh tag given by name. Slower version of meshAddPoly, sometimes convenient
|
|
|
align[;]
|
<bool> checkFacingDirection=1[;]
|
<bool> findSamePointsWithDifferentIndicesFirst=0[;]
|
<bool> doubleSidedOnly=0;
|
|
Aligns polygons facing
|
|
|
autoGroup[;]
|
<bool> edgeMode=0;
|
|
Automatically assigns group number to connected polygons
|
|
|
export,
|
<string> filename,
|
json[;]
|
<int> flags=0;
|
|
Exports a mesh in JavaScript Object Notation format
|
|
|
|
|
sampleMesh,
|
discretize,
|
<double> density[;]
|
<double> time=0.5;
|
|
Converts mesh to points by subdividing each mesh polygon.
|
|
|
|
|
|
planeCast,
|
<double> density[;]
|
<double> time=0.5[;]
|
<hpb> plane;
|
|
Converts mesh to points by casting rays into mesh from given cast plane.
|
|
|
|
|
|
surface,
|
<double> density[;]
|
<double> time=0.5[;]
|
<int> accuracy=1;
|
|
Converts mesh to points cloud and exports them to file
|
|
Convertes mesh to points by randomly sampling mesh surface.
|
|
|
|
|
videoScape;
|
|
Exports mesh to a file
|
|
Exports a mesh to a file in VideoScape ASCII format (.geo).
|
|
|
findQuads;
|
|
Finds triange pairs that makes rectangle and converts each found triangle pair to quad
|
|
|
flip;
|
|
Changes facing of all polygons to opposite
|
|
|
geometricNormalFlip[;]
|
<vertexMap> v3;
|
|
Flips polygons (reverse polygon geometric normal) according to provided per poly normal map or according to normal map attached to mesh
|
|
|
list;
|
|
List mesh data on screen
|
|
|
metaShare,
|
<string> name;
|
|
Sets sharing mode for attached meta VertexMap. In shared multiple meshes share reference to the same VertexMap (this saves memory for meshes with same topology). In non shared mode, each mesh creates a copy of a VertexMap when it is added to scene
|
|
|
pointMeta,
|
<string> name[;]
|
<vertexMap> v4;
|
|
Meta VertexMap contains various data for use with metasurfaces and metatextures (UV maps, vertex colors, vertex weigths etc.)
|
|
|
pointNormals[;]
|
<vertexMap> v3;
|
|
Global normal map for polygon normals interpolation. If not provided, Kray will compute this map based on tags data and polygon group ids.
note:
Normal maps can be defined per meta tag (different for each material)
|
|
|
points[;]
|
<vertexMap> v3;
|
|
Polygon position vertex map. Indices of polygon vertices of a mesh refers to this vertex map
|
|
|
polyMeta,
|
<string> name[;]
|
<vertexMap> v4;
|
|
Meta VertexMap contains various data for use with metasurfaces and metatextures (UV maps, vertex colors, vertex weigths etc.)
|
|
|
polyNormals[;]
|
<vertexMap> v3;
|
|
Global normal map for polygon normals interpolation. If not provided, Kray will compute this map based on tags data and polygon group ids.
note:
Normal maps can be defined per meta tag (different for each material)
|
|
|
removeDuplicatedPoints[;]
|
<double> samePointsToleranceDistance=0;
|
|
Removes duplicated point indices
|
|
|
removeDuplicatedPolygons[;]
|
<double> samePointsTolerance=-1[;]
|
<bool> ignoreBackSide=0[;]
|
<bool> ignoreBackSideUv=0;
|
|
Converts all polygon front/back pairs into single double sided polygon
|
|
|
removeUnusedTags;
|
|
Removes all mesh tags, which are not referred by any polygon
|
|
|
saveScript,
|
<string> filename[;]
|
<string> meshVariableName="msh";
|
|
Saves a mesh in Kray script file
|
|
|
setUvIndexShift,
|
<uint> d3;
|
|
|
shadingNormalFlip;
|
|
Flips shading normal map (reverse vertex normals direction) to match geometric polygon normals
|
|
|
tag,
|
<uint> index,
|
clipMap[;]
|
<metaTexture> m5[;]
|
<double> level=0.5;
|
|
|
|
|
displaceBitmapPointUv,
|
<bitmap> b5,
|
<vertexMap> v6[;]
|
<int> loops=0[;]
|
<int> bitFlags=0;
|
|
|
|
|
displaceBitmapPolyUv,
|
<bitmap> b5,
|
<vertexMap> v6[;]
|
<int> loops=0[;]
|
<int> bitFlags=0;
|
|
|
|
|
displaceDepth,
|
<double> displaceDepth;
|
|
|
|
|
displaceDepthPointUv,
|
<vertexMap> v5;
|
|
|
|
|
displaceDepthPolyUv,
|
<vertexMap> v5;
|
|
|
|
|
displaceInstanceLinkPointUv,
|
<group> g5,
|
<vertexMap> v6[;]
|
<int> loops=0;
|
|
|
|
|
displaceInstanceLinkPolyUv,
|
<group> g5,
|
<vertexMap> v6[;]
|
<int> loops=0;
|
|
|
|
|
displaceInstancePointUv,
|
<stringable> s5,
|
<vertexMap> v6[;]
|
<int> loops=0;
|
|
|
|
|
displaceInstancePolyUv,
|
<stringable> s5,
|
<vertexMap> v6[;]
|
<int> loops=0;
|
|
|
|
|
displaceMap[;]
|
<metaTexture> m5[;]
|
<double> maxDistanceError=0.001,
|
<double> marchMaxStep=1[;]
|
<int> flags=0;
|
|
Flags:
bit 0 sets volume texture mode
|
|
|
|
|
flags,
|
<double> d5;
|
|
|
|
|
material,
|
<shaderNode> s5;
|
|
|
|
|
name,
|
<stringable> s5;
|
|
|
|
|
normalPointMap,
|
<vertexMap> v5;
|
|
|
|
|
normalPolyMap,
|
<vertexMap> v5;
|
|
|
|
|
shader,
|
<shaderNode> s5;
|
|
|
|
|
smoothing,
|
<int> smoothingGroup,
|
<double> maxSmoothingAngle;
|
|
Sets mesh tag information
|
|
|
tagsMap[;]
|
<vertexMap> v3;
|
|
Tags map enables separate material for front and back side of a polygon. Every line of VertexMap describes material for polygon. Column 0 is front side material, column 1 back side material
|
metaSurface
Creates new material object (which is subclass of shaderNode).
wikipage
metaTexture
Declares new metaTexture object (which is subclass of shaderNode).
wikipage
metaTexture
|
#symbolName#;
|
metaTextureSet
Sets properties of metaTexture object.
wikipage
metaTextureSet
|
<metaTexture> m1,
|
bitmap[;]
|
<bitmap> b3;
|
|
Sets bitmap used for texture (requires also mapping to be defined)
|
|
|
bitmapFilename,
|
<string> fileName;
|
|
Sets bitmap used for texture (requires also mapping to be defined)
|
|
|
color,
|
<rgba> v3;
|
|
Sets solid color texture
|
|
|
colorFilter,
|
<rgba> v3;
|
|
Sets map color texture
|
|
|
colorVmap,
|
<string> s3;
|
|
Sets vertex color map as a texture
|
|
|
inputTone[;]
|
<shaderNode> s3;
|
|
Texture input tone mapping
|
|
|
lod,
|
<bool> onOff;
|
|
Level of detail flag
|
|
|
mapping,
|
external,
|
<shaderNode> s4;
|
|
External shaderNode mapping
|
|
|
|
fishEye,
|
<coordSys> axes;
|
|
Fisheye (also called lightmap or probe) mapping of ray hit position
|
|
|
|
fishEyeDirection,
|
<hpb> axes;
|
|
Fisheye (also called lightmap or probe) mapping of ray direction
|
|
|
|
none;
|
|
None (color filter only)
|
|
|
|
projection,
|
<coordSys> ori,
|
<xy> imageSize,
|
<double> focalLength;
|
|
Projection mapping of ray hit position
|
|
|
|
projectionDirection,
|
<hpb> ori,
|
<xy> imageSize,
|
<double> focalLength;
|
|
Projection mapping of ray direction
|
|
|
|
rect,
|
<xyz> dx,
|
<xyz> dy,
|
<xyz> pos;
|
|
|
|
sphere,
|
<coordSys> axes;
|
|
Spherical ray hit position mapping
|
|
|
|
sphereDirection,
|
<hpb> axes;
|
|
Spherical ray direction mapping
|
|
|
|
tube,
|
<coordSys> axes,
|
<double> len;
|
|
|
|
uv,
|
<stringable> s4;
|
|
Sets bitmap mapping type (requires also bitmap image to be defined)
|
|
UV given by name
|
|
|
sharpPixels,
|
<bool> onOff;
|
|
Turns off pixel interpolation
|
|
|
worldCoords,
|
<bool> onOff;
|
|
World or local (objectSet space) coordinates flag
|
|
|
wraping,
|
<int> wrapWidth,
|
<int> wrapHeight;
|
|
Sets texture image wrapping mode
|
method
Defines a class method
wikipage
method
|
#symbolName#
|
(arguments)
|
{code};
|
net
Networking tools
wikipage
net
|
ftp[;]
|
<string> ftpRoot=""[;]
|
<int> port=0[;]
|
<int> flags=0;
|
|
Starts File Transfer Protocol server
|
|
server[;]
|
<string> newInstanceCommandLine=""[;]
|
<int> port=0[;]
|
<int> flags=0;
|
|
Starts server listening mode on given port
Flags:
| GfxOnServer | 0x1 - Show render preview on server | | SuppressOutputToClient | 0x2 - Do not send output to client | | LogOutputOnServer | 0x4 - Show render log on server |
|
objectAdd
Creates shape and adds object to current object group (low level API for geometry handling)
wikipage
objectAdd
|
and2,
|
<shape> s2,
|
<shape> s3[;]
|
<surface> s4[;]
|
<blend> b5;
|
|
circle,
|
<xyz> position,
|
<xyz> direction,
|
<double> radius[;]
|
<surface> s5[;]
|
<blend> b6;
|
|
clipMap,
|
<shape> s2,
|
<texture> t3[;]
|
<surface> s4[;]
|
<blend> b5;
|
|
cone,
|
<coordSys> ori,
|
<double> r1,
|
<double> r2,
|
<double> len[;]
|
<surface> s6[;]
|
<blend> b7;
|
|
displaceTriangleShape,
|
<xyz> v2,
|
<xyz> v3,
|
<xyz> v4,
|
<xyz> v5,
|
<xyz> v6,
|
<xyz> v7,
|
<shape> s8,
|
<xy> v9,
|
<xy> v10,
|
<xy> v11,
|
<uint> bitFlags=0[;]
|
<uint> uvIndex=0[;]
|
<surface> s14[;]
|
<blend> b15;
|
|
Triangle displaced by another shape
|
|
displaceTriangleTexture,
|
<xyz> v2,
|
<xyz> v3,
|
<xyz> v4,
|
<xyz> v5,
|
<xyz> v6,
|
<xyz> v7,
|
<texture> t8,
|
<uint> bitFlags=0[;]
|
<uint> uvIndex=0,
|
<double> maxDistanceError=0.001,
|
<double> marchMaxStep=1[;]
|
<surface> s13[;]
|
<blend> b14;
|
|
Triangle displaced by texture
|
|
distanceField,
|
<string> expression[;]
|
<surface> s3[;]
|
<blend> b4;
|
|
elipCone,
|
<coordSys> ori,
|
<double> rx,
|
<double> ry,
|
<double> rz,
|
<double> l[;]
|
<surface> s7[;]
|
<blend> b8;
|
|
elipParaboloid,
|
<coordSys> ori,
|
<double> rx,
|
<double> ry,
|
<double> rz,
|
<double> l[;]
|
<surface> s7[;]
|
<blend> b8;
|
|
elipTube,
|
<coordSys> ori,
|
<double> rx,
|
<double> ry,
|
<double> rz,
|
<double> l[;]
|
<surface> s7[;]
|
<blend> b8;
|
|
ellipsoid,
|
<coordSys> ori[;]
|
<surface> s3[;]
|
<blend> b4;
|
|
fibers,
|
<fiberPack> f2,
|
<xyz> v3,
|
<xyz> v4,
|
<xyz> v5,
|
<xyz> v6,
|
<xyz> v7,
|
<xyz> v8,
|
<xyz> v9,
|
<xyz> v10[;]
|
<surface> s11[;]
|
<blend> b12;
|
|
instance,
|
<stringable> groupName,
|
<coordSys> axes[;]
|
<surface> s4[;]
|
<blend> b5;
|
|
Instance shape
|
|
instanceOrigin[;]
|
<surface> s2[;]
|
<blend> b3;
|
|
intTriangle,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2,
|
<uint> uvIndex=0,
|
<xyz> normal0,
|
<xyz> normal1,
|
<xyz> normal2[;]
|
<surface> s9[;]
|
<blend> b10;
|
|
Triangle with interpolated normal across corners
|
|
intTriangleSs,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2,
|
<uint> uvIndex=0,
|
<xyz> normal0,
|
<xyz> normal1,
|
<xyz> normal2[;]
|
<surface> s9[;]
|
<blend> b10;
|
|
Single sided triangle with interpolated normal across corners
|
|
isoSurface,
|
<string> expression[;]
|
<surface> s3[;]
|
<blend> b4;
|
|
mandelBulb,
|
<coordSys> axes,
|
<int> iterations=32,
|
<double> escape_radius=100,
|
<double> exponent=2,
|
<int> max_ray_iterations=1000,
|
<double> error=0,
|
<double> maxstep=1,
|
<double> minstep=0.001,
|
<double> steppower=1.4[;]
|
<surface> s11[;]
|
<blend> b12;
|
|
Mandel Bulb fractal
|
|
marchRound,
|
<shape> s2,
|
<double> radius[;]
|
<surface> s4[;]
|
<blend> b5;
|
|
Shape rounding filter (in ray march mode)
|
|
marchSwitch,
|
<shape> s2,
|
<double> maxZError=0.01,
|
<uint> maxMarchSteps=100[;]
|
<surface> s5[;]
|
<blend> b6;
|
|
Shape switch to ray marching form ray tracing with explicit accuracy settings
|
|
or2[;]
|
<surface> s2[;]
|
<blend> b3;
|
|
paraboloid,
|
<coordSys> ori,
|
<double> r1,
|
<double> r2,
|
<double> len[;]
|
<surface> s6[;]
|
<blend> b7;
|
|
polygon,
|
{<vector> v2,...}[;]
|
<surface> s3[;]
|
<blend> b4;
|
|
qJulia,
|
<coordSys> axes,
|
<xyz> axisw=(0,0,0),
|
<int> iterations=32,
|
<double> escape_radius=100,
|
<vector[4]> v6=(-1,0.2,0,0)[;]
|
<surface> s7[;]
|
<blend> b8;
|
|
rectangle,
|
<xyz> cornerPosition,
|
<xyz> deltaX,
|
<xyz> deltaY[;]
|
<uint> uvIndex=0[;]
|
<surface> s6[;]
|
<blend> b7;
|
|
shape,
|
<shape> s2[;]
|
<surface> s3[;]
|
<blend> b4;
|
|
Adds object to current object group from previously created shape
|
|
sphere,
|
<xyz> v2,
|
<double> d3[;]
|
<surface> s4[;]
|
<blend> b5;
|
|
sub2,
|
<shape> s2,
|
<shape> s3[;]
|
<surface> s4[;]
|
<blend> b5;
|
|
testShape[;]
|
<surface> s2[;]
|
<blend> b3;
|
|
Debug/testing new shapes
|
|
triangle,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2[;]
|
<surface> s5[;]
|
<blend> b6;
|
|
triangleSs,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2[;]
|
<surface> s5[;]
|
<blend> b6;
|
|
Single sided triangle
|
|
tube,
|
<coordSys> ori,
|
<double> r,
|
<double> len[;]
|
<surface> s5[;]
|
<blend> b6;
|
|
uvDisplaceMapBox,
|
<uint> bitFlags=0,
|
<bitmap> b3[;]
|
<surface> s4[;]
|
<blend> b5;
|
|
Displacement map shape in UV space. Flags:
+0x1000 normal smoothing
+0x2000 double sided
|
|
uvLoopShape,
|
<shape> s2[;]
|
<int> maxHops=100[;]
|
<xyz> loopBounds=([1 1],[1 1],[1 1])[;]
|
<surface> s5[;]
|
<blend> b6;
|
|
UV space shape looper. Takes a shape in given bounding box between (0,0,0) to loopBounds and loops its instances on XY plane. Maximum ray traverses between looped shape instances is controlled by maxHops.
|
|
uvTriangle,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2[;]
|
<uint> uvIndex=0[;]
|
<surface> s6[;]
|
<blend> b7;
|
|
uvTriangleSs,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2,
|
<uint> uvIndex=0[;]
|
<surface> s6[;]
|
<blend> b7;
|
|
Single sided triangle with UV maps support
|
|
wall,
|
<xyz> v2,
|
<xyz> v3[;]
|
<surface> s4[;]
|
<blend> b5;
|
oct
Controls current object group octree.
wikipage
oct
|
aniso,
|
<double> maxAniso,
|
<double> anisoBalance;
|
|
build,
|
<double> separationThreshold,
|
<xyz> dontSplitRatios,
|
<xyz> forceSplitRatios;
|
|
explorer[;]
|
<vector[4]> v2;
|
|
Starts octree debug tool. (debug version)
|
|
flags[;]
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
Sets octree flags.
|
|
invalidate,
|
<vector[4]> v2,
|
<vector[4]> v3;
|
|
Invalidates given volume of scene space (and forces octree rebuild there)
|
|
limits,
|
<int> recurseMax,
|
<double> minLeafWeight;
|
|
show[;]
|
<int> flags[;]
|
<int> color_level;
|
|
Draws octree on screen.
|
|
stats[;]
|
<int> flags;
|
|
Displays octree statistics.
|
openCl
OpenCL utilities
wikipage
openCl
|
deviceInfo,
|
<int> platformindex,
|
<int> deviceindex;
|
|
devices[;]
|
<int> d2[;]
|
<int> d3[;]
|
<int> d4;
|
|
Displays list of devices of given OpenCL platform
|
|
load[;]
|
<string> libPathAndName;
|
|
Tries to load OpenCL dynamic library from given location if library was not loaded from default location.
|
|
platformInfo,
|
<int> platformindex;
|
|
platforms;
|
|
Displays list of OpenCL platforms.
|
parse
Executes script stored in
commands string
Optional
name is used to identify script section (error reporting)
Flag bits:
| 0 | continue on error |
| 1 | supress text output |
parse
|
<string> commands[;]
|
<string> name[;]
|
<int> flags;
|
parseMode
Sets parsing mode. Available modes:
| 0 | advanced parser (default, supports expressions, functions, classes and variables) |
| 1 | quick parser (literal data only, fast and good for automatically generated scripts) |
wikipage
pause
wikipage
pause[;]
|
<double> seconds=0;
|
platform
Host platform specific operations
wikipage
pm
Photon maps options
wikipage
pm
|
auto,
|
caustics,
|
<int> samples[;]
|
<double> minFilterBound[;]
|
<double> maxFilterBound,
|
<double> relativeStep[;]
|
<double> reSize[;]
|
<double> giveUpSearchIfZeroFound;
|
|
Caustics map autophotons settings
|
|
|
global,
|
<int> samples[;]
|
<double> minFilterBound[;]
|
<double> maxFilterBound,
|
<double> relativeStep[;]
|
<double> reSize;
|
|
Global map autophotons settings
|
|
|
gScaleCaustics,
|
<double> d3[;]
|
<double> causticsFromAutoGlobalScale;
|
|
Sets search caustics filter as multiplier of global photon map filter
|
|
|
gScalePrecached,
|
<double> d3[;]
|
<double> precachedFromAutoGlobalScale;
|
|
Autophotons settings.
|
|
Sets precached map filter size as multiplier of global photon map filter size
|
|
causticsBuild,
|
<double> photons[;]
|
<double> photonSamples;
|
|
Sets caustics photon build options and clears caustic photon map
|
|
causticsFlags,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
Modifies flags for photon map
| RaytracedFiltering | 0x1 - enables raytrace check for filter range (prevents photon leaks) |
|
|
causticsMultiplier,
|
<double> d2;
|
|
Sets caustics map power multiplier
|
|
causticsRrValue,
|
<double> rr;
|
|
causticsSearch,
|
<int> minPhotons[;]
|
<double> minFilterSize[;]
|
<double> maxFilterSize[;]
|
<double> steps[;]
|
<double> giveUpSearchIfZeroFound;
|
|
Controls caustics photons filter
|
|
directLightImportance,
|
<double> lightMapDirectLightImportance;
|
|
Importance of direct light sampling for indirect maps
|
|
globalBuild,
|
<double> photons[;]
|
<double> photonSamples;
|
|
Sets light tracing mode, global photon map build options and clears global photon map
|
|
globalBuildLightMap,
|
<double> photons[;]
|
<double> photonSamples;
|
|
Sets camera tracing mode, global light map build options and clears global photon map
|
|
globalBuildLightMapWithCaustics,
|
<double> photons[;]
|
<double> photonSamples;
|
|
Sets camera tracing mode, global light map build options and clears global photon map
|
|
globalFlags,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
Modifies flags for photon map
| RaytracedFiltering | 0x1 - enables raytrace check for filter range (prevents photon leaks) |
|
|
globalMultiplier,
|
<double> d2;
|
|
Global photon map power multiplier
|
|
globalSearch,
|
<int> minPhotons[;]
|
<double> minFilterSize[;]
|
<double> maxFilterSize[;]
|
<double> steps;
|
|
Controls global photon map search filter
|
|
kdBalance,
|
<uint> kdBalanceMaxPhotons[;]
|
<double> kdBalanceBadSplitTolerance;
|
|
kdOptimize,
|
<bool> d2;
|
|
lmAnim,
|
<bool> d2;
|
|
Light map animation mode
|
|
photonNormal,
|
<double> photonNormalDist;
|
|
Controls normal influence on photon filter range
|
|
precachedBlur,
|
<double> d2;
|
|
Precached map blurring level
|
|
precachedBuild,
|
<int> precacheEvery[;]
|
<double> precacheMinDistToFilterSizeRatio;
|
|
Sets precached map build options and clears precached map
|
|
precachedCorner,
|
<double> d2;
|
|
Avoids picking precached map samples near geometry corners
|
|
precachedFlags,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
Modifies flags for photon map
| RaytracedFiltering | 0x1 - enables raytrace check for filter range (prevents photon leaks) |
|
|
precachedSearch,
|
<double> minFilterSize;
|
|
Controls precached map search filter
|
|
precacheLimitdr,
|
<double> d2;
|
|
Precached map dynamic range limit
|
|
rayWeightAproximateLevel,
|
<double> weightAproximateLimit;
|
|
receivedMinHitRatio,
|
<double> d2;
|
|
Minimal hit ratio for photon build received mode
|
|
removeUnused,
|
<bool> removePhotonMapsUsedForInitOnly;
|
|
Controls if temporary photon maps should be removed after use. Set to one saves rendering time memory, but in some cases requires map rebuild after settings change (for example if global photon map filter is changed and precached map needs to be rebuild)
|
|
render[;]
|
<int> mapsMask=799;
|
|
Rebuilds photon maps if needed
|
|
reset[;]
|
<int> mask=-1;
|
|
Clears photon maps selected with mask:
| caustics | 0x1 | | global | 0x2 | | precached | 0x4 | | baked | 0x8 | | volume | 0x10 |
|
|
showPreview,
|
<bool> showPhotonPreview;
|
|
Sets photon preview on or off.
|
|
smoothPrecacheScale,
|
<double> d2;
|
|
Precached interpolated map smoothness
|
|
stats;
|
|
Displays photon maps statistics
|
|
timePrecached,
|
<double> ca0[;]
|
{<vector> cab1,...};
|
postProcess
Sets render image postprocessing filter
wikipage
postProcess[;]
|
add,
|
<rgb> v2;
|
|
autoExp,
|
<double> blend;
|
|
bitmapOverlay,
|
<int> x,
|
<int> y,
|
<bitmap> b4;
|
|
ca,
|
<double> strength,
|
<double> pixel_aspect,
|
<double> aberationGamma,
|
<int> samples;
|
|
Chromatic aberration blur
|
|
desaturate,
|
<double> value;
|
|
dof,
|
<double> distance,
|
<double> depth,
|
<int> maxsize,
|
<bitmap> irisImage;
|
|
erode,
|
<int> strength;
|
|
erodeAlpha,
|
<double> level,
|
<int> steps;
|
|
filter,
|
{<double> mask,...};
|
|
Convolution filter. Mask size depends on number of weights provided (1-1x1 4-2x2 9-3x3 16-4x4 25-5x5)
|
|
gBlur,
|
<double> size[;]
|
<double> blend=1[;]
|
<double> cutOff=5;
|
|
glow,
|
<double> strength,
|
<double> size,
|
<bitmap> b4;
|
|
histogramFix,
|
<double> low,
|
<double> high;
|
|
mult,
|
<rgb> filter;
|
|
openImageDenoise[;]
|
<double> blend=1;
|
|
saveImage,
|
<string> filename[;]
|
bmp[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
exr[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
hdr;
|
|
|
|
jpg[;]
|
<double> quality=0.95;
|
|
|
|
png[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
tga[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
tif[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
saveNormal,
|
<string> filename;
|
|
saveZ,
|
<string> filename;
|
|
setDirectionsMapFormat,
|
<bool> compress[;]
|
<bool> d3;
|
|
Changes directions (normal) map output format
|
|
shader,
|
<shaderNode> s2;
|
|
stereogram,
|
<bitmap> b2,
|
<int> patternPositon[;]
|
<int> randomSeed=0;
|
|
toneMap,
|
<shaderNode> s2;
|
|
trimAlpha,
|
<int> steps;
|
pv
Controls previewer behaviour
wikipage
pv
|
flayer[;]
|
<double> flySpeed=0[;]
|
<double> mouseSensitivity=0[;]
|
<int> flags=0;
|
|
Starts scene fly mode in current view.
|
|
iterativeWaitLevel,
|
<int> level[;]
|
<double> seconds=0;
|
|
Starts previewer on main thread and waits until it reaches given accuracy or time limit
|
|
none;
|
|
Turns off previewer for current view
|
|
on;
|
|
Sets default preview mode for current view, starts previewer and turns on autorestart
|
|
orbiter[;]
|
<double> flySpeed=0[;]
|
<double> mouseSensitivity=0[;]
|
<int> flags=0;
|
|
Starts scene fly mode in current view.
|
|
pause;
|
|
Sends pause signal and waits until all previewer threads are paused.
see:
pv
pauseSignal
|
|
pauseSignal;
|
|
Sends pause signal to previewing threads, but does not wait until they are paused. If your code has something sensible to do between signaling previewer pause and modifing scene, use this command to improve previewing responsiveness and saving computing power.
|
|
rasterize[;]
|
<int> flags;
|
|
Sets previewer type for current view to rasterize and starts previewer
|
|
raycast[;]
|
<int> flags;
|
|
Sets previewer type for current view to raycast and starts previewer
|
|
raytrace[;]
|
<int> flags,
|
<int> maxPixelSize;
|
|
Sets previewer type for current view to raytrace and starts previewer
|
|
render;
|
|
Starts rendering on previewer thread.
|
|
restart;
|
|
(Re)starts previewer if auto restart flag is set. This action is taken by default after each command call in interactive mode.
|
|
setAnimMode,
|
<bool> state;
|
|
Sets anim mode on/off. In anim mode, previewer updates anim scene on each restart
|
|
setAutoRestart,
|
<bool> state;
|
|
Controls autorestart flag (if previewer should be restarted when main thread is idle)
|
|
setDelay,
|
<double> delay;
|
|
Sets preview refresh delay in seconds.
|
|
setWeight,
|
<double> weight;
|
|
Sets current view previewer weight. Heavy views takes more CPU power and renders faster then low weight view.
Default weight is 1
|
|
start;
|
|
(Re)starts previewer that was stopped or paused (what happends automatically when scene is modified).
Before previewer can start, its type must be determined.
|
|
stop;
|
|
Stops (turns off) previewer thread(s)
|
|
waitLevel,
|
<int> level[;]
|
<double> seconds=0;
|
|
Waits until previewer reaches given level of preview accuracy or given time limit
|
rayCast
Low level raytracing
see:
render
rayCast
|
camera,
|
<xy> dofPosition,
|
<bitmap> directionMap[;]
|
<bitmap> positionMap[;]
|
<bitmap> weightMap;
|
|
Renders camera directions, positions and pixel weights to given bitmaps
|
|
cameraHit[;]
|
<bitmap> zBufferResult[;]
|
<xy> v3;
|
|
Renders camera object hit positions (hit buffer)
|
|
cameraZ[;]
|
<bitmap> zBufferResult[;]
|
<xy> v3;
|
|
Renders distance to pixels from camera (z buffer)
|
|
hitToNormalQuick,
|
<bitmap> normalMapResult,
|
<bitmap> hitMap;
|
|
Computes normal map aproximation (based only on object hit positions)
|
|
init;
|
|
Initializes ray cache for scene. This in done automatically when needed, but command can be useful for performance testing to separate preprocessing time from rendering time.
|
|
z,
|
<bitmap> zBufferResult,
|
<bitmap> directionMap,
|
<bitmap> positionMap;
|
|
Renders distance to pixels for given directions and positions maps (z buffer)
|
|
zToHit,
|
<bitmap> hitMapResult,
|
<bitmap> zBuffer,
|
<bitmap> directionMap,
|
<bitmap> positionMap;
|
|
Computes ray-object intersection (hit) positions from Z buffer, camera position and direction maps
|
reference
Creates reference to symbol
wikipage
reference
|
#symbolName#,
|
<symbol> s2;
|
rem
Adds a comment to script. You can also use C++ style (// sometext) and C style (/* sometext */) comments inside scripts
wikipage
render
Renders current scene
wikipage
reset
Resets scene, symbols and settings
wikipage
return
Ends function/method execution and retuns function value.
wikipage
sett
Various, global scene settings
wikipage
sett
|
bitmapPixelCompression,
|
<int> hdr,
|
<int> color,
|
<int> alpha,
|
<int> halfSizeSteps;
|
|
Sets bitmap format compression settings for bitmap loader.
Hdr, color and alpha modes:
| 1 | compress when lossless | | 2 | compress always | | 3 | decompress always |
Bitmap can be also downscaled with 2^halfSizeSteps factor
|
|
buffersMask,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
Sets mask of needed render buffers. Meaning of mask bits:
| RGB | 0x0 - RGB | | ALPH | 0x1 - Alpha | | TXTR | 0x2 - Texture | | ZBUF | 0x3 - Zbuffer | | DIRE | 0x4 - Direct light | | SHDN | 0x5 - Shadow density | | INDI | 0x6 - Indirect light | | CAUS | 0x8 - Caustics | | REFL | 0xA - Reflection | | REFR | 0xC - Refraction | | LUMI | 0xE - Luminosity | | OTHR | 0x10 - Other | | SFID | 0x12 - Surface ID | | OBID | 0x14 - Object ID | | NORM | 0x16 - Normal |
example:
sett buffersMask (2^0)|(2^2)|(2^4) // requests RGB(2^0) TXTR(2^2) and DIRE(2^4)
|
|
debug,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
debugExecute,
|
<int> d2[;]
|
<string> s3[;]
|
<double> d4[;]
|
<string> s5[;]
|
<double> d6;
|
|
Debuging utility
|
|
debugTestValue,
|
<int> index,
|
<double> value;
|
|
Debuging utility
|
|
dither,
|
floydSteinberg;
|
|
|
qRandom;
|
|
|
random;
|
|
|
simple;
|
|
Sets rendered image dithering (antibanding) mode
|
|
ditherAmplitude,
|
<double> d2;
|
|
edgeDetector,
|
<double> absolutePixel[;]
|
<double> relativePixel[;]
|
<double> normal[;]
|
<double> zBuffer[;]
|
<int> enhancedAA[;]
|
<double> maxPixelBrightness[;]
|
<int> upsample;
|
|
edgeDetectorGlobals,
|
<int> enhancedAA,
|
<int> upsample;
|
|
edgeDetectorSlot,
|
<int> index,
|
<double> absolutePixel,
|
<double> relativePixel,
|
<double> normal,
|
<double> zBuffer,
|
<double> maxPixelBrightness;
|
|
energetic,
|
<int> nrgIterations;
|
|
Sets number of radiosity matrix resolve iterations
|
|
failBitmap[;]
|
<bitmap> b2;
|
|
Sets replacement bitmap that will be loaded when bitmap cache failes to load a bitmap from file.
Without this command, bitmap loading failrue causes an error.
|
|
imageSampler,
|
adaptive[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
none;
|
|
|
qmcAdaptive[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
rotUniform,
|
<double> minSamples;
|
|
|
totalMbRandom,
|
<double> minSamples,
|
<double> maxSamples;
|
|
|
totalQmc,
|
<double> minSamples;
|
|
|
totalQmcAdaptive[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
totalRandom,
|
<double> minSamples;
|
|
|
totalRotUniform,
|
<double> minSamples;
|
|
|
totalUniform,
|
<double> minSamples;
|
|
|
uniform,
|
<double> minSamples;
|
|
imageSamplerMultiPass,
|
<bool> d2;
|
|
Sets on or off multipass antialiasing (supported by some antialiasing modes)
|
|
importanceGamma,
|
<double> gamma[;]
|
<double> subSampleGamma;
|
|
Changes importance sampling gamma parametr, which controls noise (and number of samples) balance in bright and dark regions. Default value is 0.5. Lower values gives better quality (more samples) in dark areas.
|
|
instanceOctreeWeight,
|
<double> d2;
|
|
instanceRecurse,
|
<int> d2;
|
|
lightRaysShadowCheck,
|
<bool> d2;
|
|
logFile,
|
<string> logFile[;]
|
<bool> logTime=1[;]
|
<bool> logAppend=1;
|
|
maxRayColor,
|
<rgba> rayMaxRecurseColor;
|
|
Sets color of ray that exceeds maximum recurtion depth
|
|
mipMap,
|
<double> mipMapLevelShift,
|
<int> maxSamples;
|
|
miscBufOrder,
|
<int> d2;
|
|
outputFormat,
|
bmp[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
exr[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
hdr;
|
|
|
jpg[;]
|
<double> quality=0.95;
|
|
|
png[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
tga[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
tif[;]
|
<int> flags=0;
|
|
Sets render output format
|
|
Flags: +1 embed alpha channel
|
|
outputTo[;]
|
<string> s2[;]
|
bmp[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
exr[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
hdr;
|
|
|
|
jpg[;]
|
<double> quality=0.95;
|
|
|
|
png[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
tga[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
tif[;]
|
<int> flags=0;
|
|
Sets render output filename
|
|
Flags: +1 embed alpha channel
|
|
pixelBufOrder,
|
<int> d2;
|
|
pixelFilter,
|
box,
|
<double> d3;
|
|
|
catmull;
|
|
|
cone,
|
<double> d3;
|
|
|
cubic,
|
<double> d3;
|
|
|
lanczos,
|
<double> d3;
|
|
|
mitchell;
|
|
|
quadric,
|
<double> d3;
|
|
|
spline;
|
|
pixelFilterLoopMap[;]
|
<bitmap> b2;
|
|
Sets pixel filter looping map. For each pixel map defines rectangular looping area where R=x0 G=x1 B=y0 A=y1.
|
|
pixelFilterMap[;]
|
<bitmap> b2[;]
|
<double> tolerance=0.5;
|
|
Sets pixel filter map, which splits screen into pixel filter groups. Pixels are filtered only inside group, never across groups. Tolerance means difference between bitmap values, that is enough for two points to belong to separate groups.
|
|
pixelOrder,
|
flood,
|
<bitmap> b3[;]
|
<int> flags[;]
|
<double> jitter;
|
|
|
frost;
|
|
|
progressive;
|
|
|
random[;]
|
<double> randomRange;
|
|
|
ripples[;]
|
<xy> position;
|
|
|
scanColumn;
|
|
|
scanLine;
|
|
|
worm;
|
|
Sets rendering pixel order
|
|
pixelScreenSplit,
|
auto,
|
flood,
|
<int> splitsPerThread;
|
|
|
|
frost,
|
<int> splitsPerThread;
|
|
|
|
progressive,
|
<int> splitsPerThread;
|
|
|
|
random,
|
<int> splitsPerThread;
|
|
|
|
ripples,
|
<int> splitsPerThread;
|
|
|
|
scanColumn,
|
<int> splitsPerThread;
|
|
|
|
scanLine,
|
<int> splitsPerThread;
|
|
|
|
worm,
|
<int> splitsPerThread;
|
|
|
betterAuto;
|
|
|
none;
|
|
|
parts,
|
flood,
|
<xy> size;
|
|
|
|
frost,
|
<xy> size;
|
|
|
|
progressive,
|
<xy> size;
|
|
|
|
random,
|
<xy> size;
|
|
|
|
ripples,
|
<xy> size;
|
|
|
|
scanColumn,
|
<xy> size;
|
|
|
|
scanLine,
|
<xy> size;
|
|
|
|
worm,
|
<xy> size;
|
|
|
size,
|
flood,
|
<xy> size;
|
|
|
|
frost,
|
<xy> size;
|
|
|
|
progressive,
|
<xy> size;
|
|
|
|
random,
|
<xy> size;
|
|
|
|
ripples,
|
<xy> size;
|
|
|
|
scanColumn,
|
<xy> size;
|
|
|
|
scanLine,
|
<xy> size;
|
|
|
|
worm,
|
<xy> size;
|
|
previewSize,
|
<xy> maxSize;
|
|
Defines maximum size of preview window. If set to (0,0), preview will be disabled.
|
|
rayMarch,
|
<double> maxZError=0.01,
|
<uint> maxMarchSteps=100;
|
|
Ray marching global settings
|
|
rayWeightStochasticLimit,
|
<double> weightStochasticLimit;
|
|
recurse,
|
<int> d2;
|
|
Sets maximum ray recursion depth
|
|
renderInfo,
|
<string> s2;
|
|
Sets information to be added on rendered image bottom bar
|
|
renderInfoSize,
|
<double> renderInfoPercent,
|
<int> renderInfoBorder;
|
|
renderMode,
|
mlt[;]
|
<uint> d3[;]
|
<int> d4;
|
|
|
raytrace;
|
|
Selects rendering mode
|
|
semaphoreFileTryDelete,
|
<bool> d2;
|
|
sssDipole,
|
<xy> v2;
|
|
sssOct,
|
<int> sssSamplesPerLeaf,
|
<int> sssMaxRecurseLevel;
|
|
sssTolerance,
|
<double> d2[;]
|
<double> d3;
|
|
subframeRecomputeFlags,
|
<int> bitFlags[;]
|
<int> mask=-1;
|
|
Sets which resources should be recomputed for each AA subframe (AA multipass mode)
| ReleaseCaustics | 0x1 - Caustics photon map | | ReleaseGlobal | 0x2 - Global photon map | | ReleaseFG | 0x4 - Final Gathering samples | | ReleaseVolume | 0x8 - Volumetric photon map | | ReleaseSSS | 0x10 - SSS samples |
|
|
threadMinSplit,
|
<int> d2;
|
|
toneMapping,
|
edge[;]
|
<shaderNode> s3;
|
|
Sets edge tone mapper used for edge detection
|
|
|
ray[;]
|
<shaderNode> s3;
|
|
Sets ray tone mapper. Ray tone mapper is applied before image sampling filters (antialiasing).
|
|
|
z,
|
inverse,
|
<double> nearClip,
|
<double> farClip,
|
<double> nearValue,
|
<double> farValue;
|
|
|
|
linear,
|
<double> nearClip,
|
<double> farClip,
|
<double> nearValue,
|
<double> farValue;
|
|
|
|
log,
|
<double> nearClip,
|
<double> farClip,
|
<double> nearValue,
|
<double> farValue;
|
|
Sets up global tone mapping
|
|
Sets z buffer tone mapper
|
|
underSample[;]
|
<int> underSampleLevel,
|
<double> threshold,
|
<bool> edge;
|
|
undersamplePrerender,
|
<bool> d2;
|
|
vrPrerender,
|
<int> d2;
|
shaderNode
Creates new shader node object.
wikipage
shaderNode
|
#symbolName#,
|
background,
|
color[;]
|
<rgba> color;
|
|
|
|
directionsMap;
|
|
|
|
fishEyeMap,
|
<bitmap> b4[;]
|
<hpb> axes[;]
|
<rgba> colorFilter;
|
|
|
|
light,
|
<shaderNode> s4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0[;]
|
<double> powerMax=0.3[;]
|
<double> dynamicMaxSqr=0.02[;]
|
<int> minGridSize=7;
|
|
|
|
shader,
|
<shaderNode> s4;
|
|
|
|
sky[;]
|
<xyz> zenithDirection[;]
|
<rgba> horizon,
|
<rgba> zenith,
|
<rgba> nadir[;]
|
<rgba> horizonNadir[;]
|
<double> skyGamma=1,
|
<double> groundGamma=1;
|
|
|
|
sphereMap,
|
<bitmap> b4[;]
|
<hpb> axes[;]
|
<rgba> colorFilter;
|
|
|
camera,
|
fromView;
|
|
|
chain,
|
|
Chain of shaders applied one after another
|
|
|
colorFilter,
|
<shaderNode> s3,
|
<rgb> color[;]
|
<rgba> baseColor=(0,0,0);
|
|
Color filter node
|
|
|
dummy;
|
|
Dummy shader node. It does nothing
|
|
|
environment,
|
colorFade,
|
<rgb> exponentialFilter;
|
|
|
|
shader,
|
<shaderNode> s4;
|
|
|
extractAlpha,
|
<shaderNode> node[;]
|
<double> rangeStart=0,
|
<double> rangeStop=1[;]
|
<double> alphaDefault=1;
|
|
|
|
fromMeshTag,
|
<mesh> m,
|
<uint> polygonTag;
|
|
|
fromMeshTagName,
|
<mesh> m,
|
<stringable> polygonTagName;
|
|
|
giDesaturate,
|
<shaderNode> s3,
|
<double> desaturate[;]
|
<double> multiplier=1[;]
|
<double> dynamicRangeLimit=0;
|
|
Color bleeding limiter
|
|
|
lowLevel,
|
<symbol> s3[;]
|
<symbol> s4;
|
|
Creates link to low level shading object
|
|
|
mix,
|
{<vector> v3,...};
|
|
Creates weighted mix (blend) of shaders
|
|
|
portal,
|
<shaderNode> s3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
postProcess,
|
add,
|
<rgb> v4;
|
|
|
|
autoExp,
|
<double> blend;
|
|
|
|
bitmapOverlay,
|
<int> x,
|
<int> y,
|
<bitmap> b6;
|
|
|
|
ca,
|
<double> strength,
|
<double> pixel_aspect,
|
<double> aberationGamma,
|
<int> samples;
|
|
Chromatic aberration blur
|
|
|
|
desaturate,
|
<double> value;
|
|
|
|
dof,
|
<double> distance,
|
<double> depth,
|
<int> maxsize,
|
<bitmap> irisImage;
|
|
|
|
erode,
|
<int> strength;
|
|
|
|
erodeAlpha,
|
<double> level,
|
<int> steps;
|
|
|
|
filter,
|
{<double> mask,...};
|
|
Convolution filter. Mask size depends on number of weights provided (1-1x1 4-2x2 9-3x3 16-4x4 25-5x5)
|
|
|
|
gBlur,
|
<double> size[;]
|
<double> blend=1[;]
|
<double> cutOff=5;
|
|
|
|
glow,
|
<double> strength,
|
<double> size,
|
<bitmap> b6;
|
|
|
|
histogramFix,
|
<double> low,
|
<double> high;
|
|
|
|
mult,
|
<rgb> filter;
|
|
|
|
openImageDenoise[;]
|
<double> blend=1;
|
|
|
|
saveImage,
|
<string> filename[;]
|
bmp[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
|
exr[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
|
hdr;
|
|
|
|
|
|
jpg[;]
|
<double> quality=0.95;
|
|
|
|
|
|
png[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
|
tga[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
|
tif[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
saveNormal,
|
<string> filename;
|
|
|
|
saveZ,
|
<string> filename;
|
|
|
|
setDirectionsMapFormat,
|
<bool> compress[;]
|
<bool> d5;
|
|
Changes directions (normal) map output format
|
|
|
|
shader,
|
<shaderNode> s4;
|
|
|
|
stereogram,
|
<bitmap> b4,
|
<int> patternPositon[;]
|
<int> randomSeed=0;
|
|
|
|
toneMap,
|
<shaderNode> s4;
|
|
|
|
trimAlpha,
|
<int> steps;
|
|
Creates image post processing shader node
|
|
|
shapeClipFilter,
|
<shaderNode> s3,
|
<shaderNode> s4;
|
|
|
textureFilter,
|
<shaderNode> s3,
|
<shaderNode> s4;
|
|
|
toneMap,
|
desaturate,
|
<double> d4;
|
|
Color saturation reduction (or amplification if negative) tone mapper
|
|
|
|
exponential,
|
<double> parameter[;]
|
<double> exposure=1;
|
|
|
|
fnArctanh,
|
<double> startRange,
|
<double> stopRange[;]
|
<double> exposure;
|
|
|
|
fnGamma,
|
<double> gamma,
|
<double> startRange,
|
<double> stopRange[;]
|
<double> exposure;
|
|
|
|
fnSin,
|
<double> startRange,
|
<double> stopRange[;]
|
<double> exposure;
|
|
|
|
fnTanh,
|
<double> startRange,
|
<double> stopRange[;]
|
<double> exposure;
|
|
|
|
fnVArctanh,
|
<double> startRange,
|
<double> stopRange[;]
|
<double> exposure;
|
|
|
|
fnVGamma,
|
<double> gamma,
|
<double> startRange,
|
<double> stopRange[;]
|
<double> exposure;
|
|
|
|
fnVSin,
|
<double> startRange,
|
<double> stopRange[;]
|
<double> exposure;
|
|
|
|
fnVTanh,
|
<double> startRange,
|
<double> stopRange[;]
|
<double> exposure;
|
|
|
|
gamma,
|
<double> parameter[;]
|
<double> exposure=1;
|
|
|
|
limitDr,
|
<double> limit;
|
|
|
|
linear;
|
|
|
|
reverse,
|
<shaderNode> s4;
|
|
Creates reverse tone mapper to given one if possible
|
|
|
|
vExponential,
|
<double> parameter[;]
|
<double> exposure=1;
|
|
|
|
vGamma,
|
<double> parameter[;]
|
<double> exposure=1;
|
|
|
|
vLimitDr,
|
<double> limit;
|
|
Creates new tone mapper object
|
|
|
toneMapFilter,
|
<shaderNode> node,
|
<shaderNode> filter;
|
|
Tone maps given shader node
|
|
|
twoSided,
|
<shaderNode> front,
|
<shaderNode> back;
|
|
|
visibilityFlags,
|
<shaderNode> s3,
|
<int> flags;
|
|
Filter which allows to hide/show object depending following flags:
| UnseenByRays | 0x1 | | UnseenByCamera | 0x2 | | UnseenByGi | 0x4 | | UnseenByPhotons | 0x8 | | NoFg | 0x100 | | NoCastShadow | 0x200 | | LightBackWardCaustics | 0x400 |
|
|
|
wire;
|
|
Wireframe shader
|
shadowMap
wikipage
shadowMap
|
#symbolName#,
|
<xyz> v2,
|
<xy> size;
|
shape
wikipage
shape
|
#symbolName#,
|
and2,
|
<shape> s3,
|
<shape> s4;
|
|
|
circle,
|
<xyz> position,
|
<xyz> direction,
|
<double> radius;
|
|
|
clipMap,
|
<shape> s3,
|
<texture> t4;
|
|
|
cone,
|
<coordSys> ori,
|
<double> r1,
|
<double> r2,
|
<double> len;
|
|
|
displaceTriangleShape,
|
<xyz> v3,
|
<xyz> v4,
|
<xyz> v5,
|
<xyz> v6,
|
<xyz> v7,
|
<xyz> v8,
|
<shape> s9,
|
<xy> v10,
|
<xy> v11,
|
<xy> v12,
|
<uint> bitFlags=0[;]
|
<uint> uvIndex=0;
|
|
Triangle displaced by another shape
|
|
|
displaceTriangleTexture,
|
<xyz> v3,
|
<xyz> v4,
|
<xyz> v5,
|
<xyz> v6,
|
<xyz> v7,
|
<xyz> v8,
|
<texture> t9,
|
<uint> bitFlags=0[;]
|
<uint> uvIndex=0,
|
<double> maxDistanceError=0.001,
|
<double> marchMaxStep=1;
|
|
Triangle displaced by texture
|
|
|
distanceField,
|
<string> expression;
|
|
|
elipCone,
|
<coordSys> ori,
|
<double> rx,
|
<double> ry,
|
<double> rz,
|
<double> l;
|
|
|
elipParaboloid,
|
<coordSys> ori,
|
<double> rx,
|
<double> ry,
|
<double> rz,
|
<double> l;
|
|
|
elipTube,
|
<coordSys> ori,
|
<double> rx,
|
<double> ry,
|
<double> rz,
|
<double> l;
|
|
|
ellipsoid,
|
<coordSys> ori;
|
|
|
fibers,
|
<fiberPack> f3,
|
<xyz> v4,
|
<xyz> v5,
|
<xyz> v6,
|
<xyz> v7,
|
<xyz> v8,
|
<xyz> v9,
|
<xyz> v10,
|
<xyz> v11;
|
|
|
instance,
|
<stringable> groupName,
|
<coordSys> axes;
|
|
Instance shape
|
|
|
instanceOrigin;
|
|
|
intTriangle,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2,
|
<uint> uvIndex=0,
|
<xyz> normal0,
|
<xyz> normal1,
|
<xyz> normal2;
|
|
Triangle with interpolated normal across corners
|
|
|
intTriangleSs,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2,
|
<uint> uvIndex=0,
|
<xyz> normal0,
|
<xyz> normal1,
|
<xyz> normal2;
|
|
Single sided triangle with interpolated normal across corners
|
|
|
isoSurface,
|
<string> expression;
|
|
|
mandelBulb,
|
<coordSys> axes,
|
<int> iterations=32,
|
<double> escape_radius=100,
|
<double> exponent=2,
|
<int> max_ray_iterations=1000,
|
<double> error=0,
|
<double> maxstep=1,
|
<double> minstep=0.001,
|
<double> steppower=1.4;
|
|
Mandel Bulb fractal
|
|
|
marchRound,
|
<shape> s3,
|
<double> radius;
|
|
Shape rounding filter (in ray march mode)
|
|
|
marchSwitch,
|
<shape> s3,
|
<double> maxZError=0.01,
|
<uint> maxMarchSteps=100;
|
|
Shape switch to ray marching form ray tracing with explicit accuracy settings
|
|
|
or2;
|
|
|
paraboloid,
|
<coordSys> ori,
|
<double> r1,
|
<double> r2,
|
<double> len;
|
|
|
polygon,
|
{<vector> v3,...};
|
|
|
qJulia,
|
<coordSys> axes,
|
<xyz> axisw=(0,0,0),
|
<int> iterations=32,
|
<double> escape_radius=100,
|
<vector[4]> v7=(-1,0.2,0,0);
|
|
|
rectangle,
|
<xyz> cornerPosition,
|
<xyz> deltaX,
|
<xyz> deltaY[;]
|
<uint> uvIndex=0;
|
|
|
shape,
|
<shape> s3;
|
|
Adds object to current object group from previously created shape
|
|
|
sphere,
|
<xyz> v3,
|
<double> d4;
|
|
|
sub2,
|
<shape> s3,
|
<shape> s4;
|
|
|
testShape;
|
|
Debug/testing new shapes
|
|
|
triangle,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2;
|
|
|
triangleSs,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2;
|
|
Single sided triangle
|
|
|
tube,
|
<coordSys> ori,
|
<double> r,
|
<double> len;
|
|
|
uvDisplaceMapBox,
|
<uint> bitFlags=0,
|
<bitmap> b4;
|
|
Displacement map shape in UV space. Flags:
+0x1000 normal smoothing
+0x2000 double sided
|
|
|
uvLoopShape,
|
<shape> s3[;]
|
<int> maxHops=100[;]
|
<xyz> loopBounds=([1 1],[1 1],[1 1]);
|
|
UV space shape looper. Takes a shape in given bounding box between (0,0,0) to loopBounds and loops its instances on XY plane. Maximum ray traverses between looped shape instances is controlled by maxHops.
|
|
|
uvTriangle,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2[;]
|
<uint> uvIndex=0;
|
|
|
uvTriangleSs,
|
<xyz> vertex0,
|
<xyz> vertex1,
|
<xyz> vertex2,
|
<uint> uvIndex=0;
|
|
Single sided triangle with UV maps support
|
|
|
wall,
|
<xyz> v3,
|
<xyz> v4;
|
shapeSelection
Creates new shape selection object
wikipage
shapeSelection
|
#symbolName#;
|
shapeSelectionOp
Shape selection operations
wikipage
shapeSelectionOp
|
<shapeSelection> s1,
|
add,
|
<shape> s3;
|
|
Adds shape to shape selection
|
shOb
Creates misc shared not-so-frequently used objects.
wikipage
shOb
|
#symbolName#,
|
ies,
|
<string> iesFileName;
|
|
IES light object
|
|
|
instanceTransformation;
|
|
|
physky[;]
|
<xyz> sunDirection=([0 0],[1 1],[-1 -1])[;]
|
<double> turbidity=2[;]
|
<double> exposure=1[;]
|
<hpb> orientation;
|
|
|
physky0[;]
|
<xyz> sunDirection=([0 0],[1 1],[-1 -1])[;]
|
<rgb> sunColor=(1,1,1)[;]
|
<hpb> orientation;
|
|
|
physky2[;]
|
<xyz> sunDirection=([0 0],[1 1],[-1 -1])[;]
|
<double> turbidity=2[;]
|
<double> exposure=1[;]
|
<hpb> orientation[;]
|
<rgb> groundAlbedo=(0.8,0.8,0.8)[;]
|
<double> sunDawnDuskAboveAngle=0,
|
<double> sunDawnDuskUnderAngle=0;
|
|
|
water,
|
<xy> size;
|
|
Simple water simulation
|
shObOp
Operations on misc shared objects
wikipage
shObOp
|
<miscSharedObject> m1,
|
addInstanceTransformer,
|
normalFixedRotate,
|
<xyz> direction;
|
|
|
|
normalRandomRotate;
|
|
|
|
normalRotate;
|
|
|
|
patternAxes;
|
|
|
|
randomSeed,
|
<int> seed;
|
|
|
|
randRotate,
|
<xy> randMinMax,
|
<xyz> rotatePlaneVector;
|
|
|
|
randScale,
|
<xy> randMinMax;
|
|
|
|
randScaleX,
|
<xy> randMinMax;
|
|
|
|
randScaleY,
|
<xy> randMinMax;
|
|
|
|
randScaleZ,
|
<xy> randMinMax;
|
|
Adds instance transformer to instance transformation
|
|
|
addToScene;
|
|
Add sun light to current holder and sets up background physical sky
|
|
|
flags,
|
<int> objectFlags;
|
|
|
phySkyAddToScene;
|
|
Add sun light to current holder and sets up background physical sky
|
|
|
phySkySkyShader,
|
<shaderNode> s3;
|
|
Sets external background for physky
|
|
|
phySkySunModel,
|
none[;]
|
<double> sunIntensityMultiplier=1[;]
|
<double> sunSolidAngleMultiplier=1[;]
|
<double> sunDistance=0;
|
|
|
|
parallel[;]
|
<double> sunIntensityMultiplier=1[;]
|
<double> sunSolidAngleMultiplier=1[;]
|
<double> sunDistance=0;
|
|
|
|
point[;]
|
<double> sunIntensityMultiplier=1[;]
|
<double> sunSolidAngleMultiplier=1[;]
|
<double> sunDistance=0;
|
|
|
|
rectangle[;]
|
<double> sunIntensityMultiplier=1[;]
|
<double> sunSolidAngleMultiplier=1[;]
|
<double> sunDistance=0[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
|
rectangleTextured[;]
|
<double> sunIntensityMultiplier=1[;]
|
<double> sunSolidAngleMultiplier=1[;]
|
<double> sunDistance=0[;]
|
<int> minRecursionLevel=0[;]
|
<int> maxRecursionLevel=4,
|
<double> errorTolerance=0.01[;]
|
<int> borderTestRecursionLevel=4[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
phySkySunToneMapper,
|
<shaderNode> s3;
|
|
|
phySkyToneMapper,
|
<shaderNode> s3;
|
|
|
setValue,
|
<int> i,
|
<double> value;
|
|
Sets object dependent parameter
|
|
|
waterDisturb,
|
<bitmap> b3[;]
|
<double> multiplier=1;
|
|
|
waterIterate,
|
<bitmap> b3[;]
|
<double> iterateStepFraction=1[;]
|
<double> attentuation=0;
|
|
|
waterSetBounds[;]
|
<bitmap> b3;
|
showInfo
wikipage
showInfo[;]
|
all;
|
|
anim;
|
|
bitmaps;
|
|
bitmapsExt;
|
|
fg;
|
|
fiberPacks;
|
|
pm;
|
|
pmExt;
|
|
scene;
|
|
shared;
|
|
symbol,
|
<symbol> s2[;]
|
<int> mode=0[;]
|
<uint> param;
|
|
Displays information about an object. Exact behaviour depends on object type.
|
|
symbols;
|
|
vertexMaps;
|
|
views;
|
stop
Interrupts parsing of script. If used in included file, it will also stop caller script (opposite to
exit command)
see:
exit
include
string
Creates a string variable
wikipage
string
|
#symbolName#[;]
|
<string> s2;
|
stringId
Creates a string variable with unique value
wikipage
surface
wikipage
surface
|
#symbolName#[;]
|
ambientOcclusion,
|
<texture> t3,
|
<rgb> occlusionColor,
|
<double> maxDistance[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
black;
|
|
|
blur2,
|
<surface> s3,
|
<double> d4,
|
<bool> accurateReflection[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
btHybrid,
|
<texture> t3,
|
<surface> s4,
|
<surface> s5;
|
|
|
bump,
|
<surface> s3,
|
<texture> t4,
|
<double> d5;
|
|
|
cell,
|
<rgb> upc,
|
<double> upt,
|
<rgb> midc,
|
<double> lowt,
|
<rgb> lowc,
|
<rgb> shadc,
|
<double> shadt,
|
<rgb> bordc,
|
<double> bordt,
|
<double> hight;
|
|
|
color;
|
|
|
cShaded[;]
|
<texture> t3;
|
|
|
default;
|
|
|
diffuse[;]
|
<texture> t3[;]
|
<int> d4;
|
|
|
dispGlass2,
|
<double> d3,
|
<double> d4,
|
<int> d5;
|
|
|
dReflect,
|
<double> exponent;
|
|
|
dSide,
|
<surface> s3;
|
|
|
energetic,
|
<texture> t3,
|
<texture> t4,
|
<double> d5;
|
|
|
envMap,
|
<hpb> ori,
|
<bitmap> b4;
|
|
|
fHybrid,
|
<double> ior,
|
{<double> d4,...};
|
|
|
filter,
|
<surface> s3,
|
<texture> t4[;]
|
<bool> alpha=0;
|
|
|
filterMetalic,
|
<texture> t3;
|
|
|
fresnel;
|
|
|
fromShader,
|
<shaderNode> s3;
|
|
|
glass2,
|
<double> d3;
|
|
|
glassTransparent2,
|
<double> d3,
|
<rgba> v4;
|
|
|
glassTransparentText2,
|
<double> n,
|
<double> f,
|
<texture> t5,
|
<double> spd;
|
|
|
gStat,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
hybrid,
|
{<double> d3,...};
|
|
|
ids,
|
<surface> s3,
|
<rgb> surface_id,
|
<rgb> object_id,
|
<int> buffers_flags,
|
<int> edge_flags,
|
<int> alpha_mode,
|
<double> alpha_value;
|
|
|
light,
|
<texture> t3[;]
|
<bool> doubleSided=0;
|
|
|
metalic;
|
|
|
mltHybrid,
|
<int> d3;
|
|
|
noCC,
|
<surface> s3;
|
|
|
normal;
|
|
|
nrgShaded,
|
<texture> t3,
|
<double> divisionSize;
|
|
|
nrgTest,
|
<double> size[;]
|
<int> flags=0[;]
|
<double> value=0;
|
|
|
occlusionMap,
|
<double> maxDistance[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
pmBaked[;]
|
<texture> t3;
|
|
|
pmbcShaded,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
pmbShaded,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
pmcmcShaded,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
pmcShaded,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
pmDirect[;]
|
<texture> t3;
|
|
|
pmLight[;]
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
pmmcShaded,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
pmPrecached[;]
|
<texture> t3;
|
|
|
pmShaded,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
pmUnfiltered[;]
|
<texture> t3[;]
|
<double> scale=1;
|
|
|
qStat,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
qStatD,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
qStatDReflect,
|
<double> exponent[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
qStatReflect,
|
<double> exponent[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
reflect,
|
<double> d3;
|
|
|
reflectMap,
|
<texture> t3,
|
<bitmap> b4;
|
|
|
shaded[;]
|
<texture> t3;
|
|
|
shadeMap,
|
<texture> t3,
|
<bitmap> b4;
|
|
|
shSdEnergetic,
|
<texture> t3,
|
<texture> t4,
|
<double> d5;
|
|
|
shSdSmoothEnergetic,
|
<texture> t3,
|
<texture> t4,
|
<double> d5;
|
|
|
sss,
|
<rgb> s,
|
<rgb> a,
|
<double> n,
|
<texture> t6,
|
<surface> s7[;]
|
<double> mfpRange=50[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
sssCached,
|
<rgb> s,
|
<rgb> a,
|
<double> n,
|
<texture> t6,
|
<surface> s7[;]
|
<double> mfpRange=50[;]
|
<double> cacheTraversError=0;
|
|
|
sst,
|
<rgb> s,
|
<rgb> a,
|
<double> n,
|
<int> smp,
|
<int> pht,
|
<double> pmr,
|
<texture> t9;
|
|
|
stat,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
statd,
|
<texture> t3[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
statReflect,
|
<double> exponent[;]
|
<double> minSamples=100[;]
|
<double> maxSamples=100[;]
|
<double> stdDeviation=0;
|
|
|
sTransparent,
|
<texture> t3;
|
|
|
testSurface;
|
|
|
uvColors;
|
|
|
wireNormal;
|
|
|
zeroTransparent2;
|
surfaceOp
Surface operations
wikipage
surfaceOp
|
<surface> s1,
|
clearFlag,
|
<int> flag;
|
|
|
setBlend,
|
<blend> b3;
|
|
|
setFlag,
|
<int> flag;
|
symbolsDelete
Deletes all script symbols
wikipage
tds
3d studio object import
wikipage
tds
|
sceneLoad,
|
<string> filename;
|
texture
wikipage
texture
|
#symbolName#,
|
bitmap,
|
<mapping> m3,
|
<bitmap> b4;
|
|
|
color,
|
<rgba> color;
|
|
|
fromShader,
|
<shaderNode> s3;
|
|
|
lightPortal,
|
<light> l3;
|
|
|
lodBitmap,
|
<mapping> m3,
|
<bitmap> b4;
|
|
|
octaveFractaler,
|
<texture> t3,
|
{<vector> v4,...}[;]
|
{<vector> v5,...}[;]
|
{<vector> v6,...};
|
|
|
surface,
|
<surface> s3;
|
|
|
toneMap,
|
<texture> t3,
|
<shaderNode> s4;
|
|
|
voxelMap,
|
<vector[3]> v3;
|
|
|
wire,
|
<double> wireThickness,
|
<rgba> wire,
|
<double> alpha,
|
<rgba> inside;
|
threads
Sets number of threads used for rendering.
If threadsCount==0, Kray will set number of threads equal to system CPUs count
WARNING !!! This command clears current scene
wikipage
threads[;]
|
<int> threadsCount=0;
|
var
wikipage
var
|
#symbolName#[;]
|
<double> d2;
|
variable
wikipage
variable
|
#symbolName#[;]
|
<double> d2;
|
vector
wikipage
vector
|
#symbolName#[;]
|
<vector> v2;
|
vertex2d
Changes data of 2-dimensional vertexMap
wikipage
vertex2d
|
<vertexMap> v1,
|
<uint> index,
|
<xy> data;
|
vertex3d
Changes data of 3-dimensional vertexMap. Supports animated 3d vertex maps.
wikipage
vertex3d
|
<vertexMap> v1,
|
<uint> index,
|
{<vector> data,...};
|
vertexData
Changes vertexMap data. This command can change multiple vertices starting from index when there is more data then for a single vertex.
wikipage
vertexData
|
<vertexMap> v1,
|
<uint> index,
|
{<double> data,...}[;]
|
<int> rowOffset=0;
|
vertexMap
Creates vertexMap object.
wikipage
vertexMap
|
#symbolName#,
|
<int> dim[;]
|
fixedSize,
|
<uint> stop[;]
|
<int> animSamples;
|
|
|
|
fromMesh,
|
<mesh> m4[;]
|
atlas[;]
|
<double> gap=0.05[;]
|
<int> flags=0;
|
|
|
|
sampleMesh,
|
<mesh> m4,
|
discretize,
|
<double> density[;]
|
<double> time=0.5;
|
|
Converts mesh to points by subdividing each mesh polygon.
|
|
|
|
|
|
planeCast,
|
<double> density[;]
|
<double> time=0.5[;]
|
<hpb> plane;
|
|
Converts mesh to points by casting rays into mesh from given cast plane.
|
|
|
|
|
|
surface,
|
<double> density[;]
|
<double> time=0.5[;]
|
<int> accuracy=1;
|
|
Convertes mesh to points by randomly sampling mesh surface.
|
vertexMapOp
Vertex map operations
wikipage
vertexMapOp
|
<vertexMap> v1,
|
flush;
|
|
Removes temporary buffers attached to vertex map
|
|
|
list;
|
|
Lists vertex map content
|
|
|
resize,
|
<uint> size;
|
|
Changes size of a vertex map
|
|
|
saveScript,
|
<string> filename[;]
|
<string> vertexMapVariableName="vtx";
|
|
Saves vertexmap in Kray script file
|
|
|
setOffsetMeta,
|
HPBOrientation[;]
|
<int> offset;
|
|
|
|
instanceID[;]
|
<int> offset;
|
|
|
|
normal[;]
|
<int> offset;
|
|
|
|
position[;]
|
<int> offset;
|
|
|
|
rbgColor[;]
|
<int> offset;
|
|
|
|
rgbaColor[;]
|
<int> offset;
|
|
|
|
scaling[;]
|
<int> offset;
|
|
|
|
weight[;]
|
<int> offset;
|
|
|
|
XYZScaling[;]
|
<int> offset;
|
|
Attaches and modifies meta infomation about vertex map columns (their offset from column 0) content
|
|
|
show[;]
|
<double> time[;]
|
<rgba> defaultColor=(1,1,1);
|
|
Visualizes vertex map on screen
|
view
Render view controls
wikipage
view
|
camAspect,
|
<double> aspect;
|
|
Sets standard camera pixel aspect ratio for current view.
|
|
camClip,
|
<double> distance[;]
|
<int> clipType=1;
|
|
Sets standard camera scene clipping mode.
Clip type can be:
| Distance | 0x1 - rayDistance | | Plane | 0x2 - plane |
|
|
close;
|
|
Closes current preview window.
|
|
flags,
|
<int> flags;
|
|
Sets view flags. Flags bits:
| alpha | 0x1 - Alpha channel on preview |
|
|
freeRenderedImage;
|
|
Frees rendered image buffer
|
|
offset[;]
|
<xy> offset;
|
|
Sets upper left corner pixel offset
|
|
postProcess,
|
add,
|
<rgb> v3;
|
|
|
autoExp,
|
<double> blend;
|
|
|
bitmapOverlay,
|
<int> x,
|
<int> y,
|
<bitmap> b5;
|
|
|
ca,
|
<double> strength,
|
<double> pixel_aspect,
|
<double> aberationGamma,
|
<int> samples;
|
|
Chromatic aberration blur
|
|
|
desaturate,
|
<double> value;
|
|
|
dof,
|
<double> distance,
|
<double> depth,
|
<int> maxsize,
|
<bitmap> irisImage;
|
|
|
erode,
|
<int> strength;
|
|
|
erodeAlpha,
|
<double> level,
|
<int> steps;
|
|
|
filter,
|
{<double> mask,...};
|
|
Convolution filter. Mask size depends on number of weights provided (1-1x1 4-2x2 9-3x3 16-4x4 25-5x5)
|
|
|
gBlur,
|
<double> size[;]
|
<double> blend=1[;]
|
<double> cutOff=5;
|
|
|
glow,
|
<double> strength,
|
<double> size,
|
<bitmap> b5;
|
|
|
histogramFix,
|
<double> low,
|
<double> high;
|
|
|
mult,
|
<rgb> filter;
|
|
|
openImageDenoise[;]
|
<double> blend=1;
|
|
|
saveImage,
|
<string> filename[;]
|
bmp[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
exr[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
hdr;
|
|
|
|
|
jpg[;]
|
<double> quality=0.95;
|
|
|
|
|
png[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
tga[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
|
tif[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
saveNormal,
|
<string> filename;
|
|
|
saveZ,
|
<string> filename;
|
|
|
setDirectionsMapFormat,
|
<bool> compress[;]
|
<bool> d4;
|
|
Changes directions (normal) map output format
|
|
|
shader,
|
<shaderNode> s3;
|
|
|
stereogram,
|
<bitmap> b3,
|
<int> patternPositon[;]
|
<int> randomSeed=0;
|
|
|
toneMap,
|
<shaderNode> s3;
|
|
|
trimAlpha,
|
<int> steps;
|
|
Applies postprocessing filter to image rendered in current view
|
|
rayDiff,
|
<bool> rdf;
|
|
Enables or disables ray differentials tracking (which are used for texture filtering)
|
|
remove[;]
|
<string> name;
|
|
Removes view from scene.
|
|
removeAll;
|
|
Removes all views except default view.
|
|
render;
|
|
Renders scene in currently selected view. Opposite to render command which renders scene active view.
|
|
save,
|
<string> filename[;]
|
bmp[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
exr[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
hdr;
|
|
|
|
jpg[;]
|
<double> quality=0.95;
|
|
|
|
png[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
tga[;]
|
<int> flags=0;
|
|
Flags: +1 embed alpha channel
|
|
|
|
tif[;]
|
<int> flags=0;
|
|
Saves last rendered image from current view to a file
|
|
Flags: +1 embed alpha channel
|
|
select[;]
|
<stringable> s2;
|
|
Changes currently selected view for editing. Creates new view if view name was not used before.
|
|
selectActive[;]
|
<stringable> s2;
|
|
Selects scene active view for editing. Optional parameter can be used for selecting and activating view in single command.
|
|
setActive[;]
|
<stringable> s2;
|
|
Sets view as active for rendering. Note that selected view may be different from active view. Selected view ( view select command) is used for scene editing, while scene active view ( view setActive command) is an active view for rendering ( render command)
see:
view
select
view
render
view
selectActive
render
|
|
size,
|
<xy> size;
|
|
Sets up rendered image size
|
|
stereo[;]
|
<xyz> stereoEyeSeparation[;]
|
<int> stereoStripes[;]
|
<double> stereoFocalLength[;]
|
<xyz> stereoRigGroundPlane;
|
|
Sets standard camera stereoscopic render mode
|
|
toneMapping[;]
|
<shaderNode> s2;
|
|
Sets preview tone mapper
|
|
update[;]
|
<bool> forceOpenPreview=0;
|
|
Updates last rendered image view (with postprocessing and tone mapping changes applied).
|
|
window[;]
|
<xy> leftUp,
|
<xy> rightBottom[;]
|
<bool> border=1;
|
|
Sets up rendering window (rectangular region of interest in rendered image)
|
while
Executes code as long as condition is true
wikipage
while
|
<bool> condition
|
{code};
|