Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Below are the current options and their defaults.

Name and parameters
bucket:orderstring[“horizontal”]horizontalRender bucket order. Supported values are: “horizontal”horizontal, “vertical”vertical, “zigzagzigzag-x”x, “zigzagzigzag-y”y, “spacefill”spacefill, “random”random, “spiral”spiral, or “circle”circle.
bucket:orderorigininteger[2][-1 -1]First bucket for “spiral” and “circle” "spiral" and "circle" order. Image center is [-1 -1].
checkpoint:asfinalinteger[0]When enabled, this keeps the extra channels and the checkpoint tag when writing the final image for the render. The final image will be identical to any other checkpoint, rather than a slimmed down image. This means that once your image has reached the quality you've set and it completes, it can always be restarted by the user laterWrite checkpoint as final image or remove display channels.
checkpoint:commandstring[]emptySystem command to be called after checkpoint. If system calls are enabled, then after a checkpoint has been written, the specified command will be called. This is synchronous; the rendering threads are quiescent while this runs and will not resume again until the process returns, avoiding possible race conditions if the command takes a token %i will be replaced with the current increment, zero-padded to 5 digits. The token %e will be replaced with the elapsed time in seconds, zero-padded to 6 digits. The token %r will be replaced with the reason for this update to the checkpoint files (either completely `finished`, `exiting` early due to exitat option, or a normal `checkpoint`). Literal % characters may be inserted with %%Command to run at each checkpoint.
checkpoint:exitatstring[]emptyHow long render should run before writing a final checkpoint and terminating. Value can also be a string such as "10m" or "0.5h". Set to 0 or empty to disableTime to checkpoint and abort render, e.g. “1h30m” for 1 hour 30 min.
checkpoint:intervalstring[]emptyWrite framebuffers to disk every N progressive steps. If value is positive the units will be interpreted as seconds. If value is negative its units will be interpreted as increments. Value can also be a string such as "10m" or "0.5h". Setting option to 0 or empty will disable checkpointsTime between checkpoints, e.g. “1h30m” for 1 hour 30 min.
checkpoint:keepfilesinteger[0]If set to true then prman will write to a new, numbered image for each checkpoint. Note: This will disable the final write of a checkpoint file which means the render cannot be recovered using the 'recover' optionIndividually name and preserve checkpoint renders.
curve:minwidthfloat[0]Minimum curve width in raster coordinates. Curves smaller than minwidth
deep:flagvolumesinteger[1]Off [0], auto (off for dtex, on otherwise) [1], or on [2]
dice:offscreenmultiplierfloat[1]Dicing rate multiplier for objects outside the viewing frustum. See dice:micropolygonlength.
dice:trianglestring[“trim”]trimThe method used for dicing “triangles”"triangles". The default method “trim” "trim" renders triangles by trimming a quad. The “blp” "blp" method renders a quad with two points being coincident.
hider:adaptallinteger[0]Enable adaptive sampling of all AOVs. Otherwise adaptive sampling is driven by “Ci,a”, i.e. rgba, the Beauty renderWhen enabled, all channels (beauty pass + AOVs) are considered when deciding if a pixel is converging. The default (off) will ignore the AOVs and only the beauty pass is considered for pixel convergence. So turning off "adaptall" may speed up your render if some of your AOVs never reach the specified variance threshold.
hider:darkfallofffloat[0.025]De-prioritize low luminance samples in the adaptive sampler. Use this parameter to avoid oversampling dark areas while maintaining overall image quality. Higher values cull more samples, speeding up render time while increasing noise in darker areas.This prevents oversampling in dark areas of an image. Higher values may erode sampling in brighter areas
hider:extrememotiondofinteger[0]0Enable improved sampling accuracy. In some cases where a large amount of motion blur is used with depth of field, sampling artifacts could cause an undesirable result. This flag causes a slower but more accurate sampling method to be used to alleviate the artifacts. Due to the performance degradations of this sampling method, this flag should only be used when necessary.
hider:incrementalinteger[0]Enables the progressive display of results (rather than bucketed results).Incremental rendering renders passes of samples instead of bucket/tile-based. Some integrators (PxrVCM) enforce incremental
hider:maxsamplesinteger[0]The upper limit of samples per pixelAn explicit limit for the number of samples. If maxsamples is equal to its default then the maximum number of samples will be set equal to 64. Note that minsamples defaults to the square root of the maxsamples setting.
hider:minextrasamplesinteger[-1]This is the minimum number of extra samples that a pixel should continue shooting with after a sample fails to meet its convergence test with the adaptive sampler. Defaults to matching minsamples.Takes additional samples when recovering from a checkpoint to determine variance and then continues to sample
hider:minsamplesinteger[-1]The Specifies the minimum samples per pixel. 0 is a special case where minsamples is number of samples for adaptive sampling. The default value is the square root of the maxsamples.
hider:pixelfiltermodestring[“weighted”]weightedSpecifies how pixel filtering of camera samples is performed. "Weighted" is the standard method and blends together samples from neighboring pixels. "Importance" warps the samples in screen space around the pixel center and does not share samples between pixels. It may be noisier, but is needed by some postprocessing algorithms. It is also needed to produce variance AOVs.Weighted pixel filtering may appear to converge more quickly but Importance is required for all denoising applications as well the improved adaptive sampler (enforced)
hider:samplemotioninteger[1]This option toggles the sampling of motion blurred micropolygon in the hider, and is thus only meaningful if motion blur is being used in your scene. By default, this hider option is enabled (set to 1), meaning that micropolygons will be blurred and sampled in the hider. When disabled (set to 0), micropolygons will no longer be blurred before sampling; however, the dPdtime variable will still be computed for all objects. This variable can be output into a separate image using an arbitrary output variable (aov) and used to perform motion blur as a postprocess.Take more motion samples to improve the shape of curved paths. While this is a global control, it's more efficient to set on shape that require it
hider:sampleoffsetinteger[0]This allows several images to be rendered in parallel (with different sampleoffset values) and then combined. With non-adaptive sampling: Let's say you render four images with 256 samples each, with sampleoffsets 0, 256, 512, and 768. If you combine those four images, you'll get exactly the same image as if you had rendered a single image with 1024 samples. With adaptive sampling: Let's say you again render four images, each with "maxsamples" 256, with sampleoffsets 0, 256, 512, and 768. Let's say that due to adaptive sampling, some given pixel only gets 64 pixel samples in each of the four images. Then the combined image has been rendered with sample numbers 0-63, 256-319, 512-575, and 768-831. Due to the stratification of the samples, this is not quite as good as if you had rendered a single image with 256 consecutive samples. However, it is still better than rendering a single image with only 64 samplesOffset RNG sample sequence.
hider:typestring[“raytrace”]raytraceRender mode “raytrace” or “bake”. Supported values are: raytrace, bake.
lighting:selectionlearningschemeinteger0Employs a machine learning algorithm to more accurately importance sample lights, taking into account occlusion and light filters.
limits:brickmemoryinteger[2097152]Brickmap cache size in kB (2048 MB).
limits:bucketsizeinteger[2][16 16]Size of render buckets Sets the bucket size in pixels.
limits:deepshadowerrorfloat[0.01]Control lossy compression scheme to reduce file size of deep output. Setting to a high value will result in lower numbers of samples stored for each pixel.Useful for rendering deep images where samples can be merged
limits:geocachememoryinteger[2097152]Geometry cache size in kB (2048 MB).
limits:gridsizeinteger[289]Description (17 x 17 = 289)
limits:matrixcachememoryinteger[0]Matrix cache in kB.
limits:nurbcurvaturedicefactorinteger[3]NURBs max curvature multiplier.
limits:octreememoryinteger[20480]None cache size in kB (20 MB).
limits:opacitycachememoryinteger[1048576]Opacity cache in kB (1024 MB).
limits:othresholdfloat[3][0.99609375 0.99609375 0.99609375]Opacity Culling: When rendering scenes with a large number of semi-transparent layered objects (e.g. hair), the opacity culling threshold (255/256)can be set for a significant time and memory savings. Essentially, a stack of visible points whose accumulated opacity is greater (in each channel) than the specified limit will be considered fully opaque by the hider, and objects behind the stack will be culled.
limits:pointmemoryinteger[20480]Point cache size in kB (20 MB).
limits:proceduralbakingclumpsizeinteger[0]Description. Only used for `prman -capture`
limits:ptexturememoryinteger[32768]PTex cache size in kB (32 MB).
limits:rendermemoryfloat[0]Memory limit as percentage of machine memory.
limits:rendertimeinteger[0]Maximum render time in minutes.
limits:shadesizeinteger[289]The maximum number of vertices, not grid (17 x 17 = 289).
limits:texturememoryinteger[2097152]Texture cache size in kB (2048 MB).
limits:threadsinteger[0]Number Set the number of render threads .
lpe:customLPE:<name>string<lpe>Name custom LPE
lpe:diffuse1string[]D1 diffuse lobe name for light path expressions.
lpe:specular1string[]S1 specular lobe name for light path expressions.
lpe:user1string[]U1 user lobe name for light path expressionsthat the renderer uses. If a value of 0 is specified then all CPUs will be utilized for rendering. If a negative value '-N' is specified then prman will use all but N CPUs for rendering.
procedural:splitmodeinteger[0]Split on demand [0], up front [1], or hybrid [2].
Ri:CropWindowfloat[4][0 1 0 1]Crop window [left right top bottom] in NDC space.
Ri:FormatPixelAspectRatiofloat[1]Device pixel aspect ratio.
Ri:FormatResolutioninteger[2][640 480]Device Output image resolution.
Ri:Frameinteger[0]Frame number.
Ri:FrameAspectRatiofloat[-1]Output image aspect ratio.
Ri:PixelVariancefloat[0.001]The main control for frame quality, lowers numbers improve quality at the cost of computation, 0.001 is extremely high qualityControls adaptive sampling. This sets the upper bound on the acceptable estimated variance of the pixel values from the true pixel values.
Ri:ScreenWindowfloat[4][0 0 0 0]Screen window [left right top bottom] in screen space.
Ri:Shutterfloat[2][0 0]Scene motion shutter, open and close.
ribparse:varsubststring[]emptyRIB parse only.
scenedump:filenamestring[]emptyPath to dump RIB scene for rendermode “catrib”"catrib".
searchpath:archivestring[]emptySearch path for Rib archives and DelayedReadArchive.
searchpath:dirmapstring[]emptySearch path remapping.
searchpath:displaystring[]emptySearch path for display plug-ins.
searchpath:proceduralstring[]emptySearch path for DynamicLoad procedural plug-ins.
searchpath:rifilterstring[]emptySearch path for Rif plug-ins.
searchpath:rixpluginstring[]emptySearch path for shading plug-ins.
searchpath:shaderstring[]emptySearch path for OSL pattern plug-ins.
searchpath:texturestring[]emptySearch path for texture files.
shade:debuginteger[0]Shading debug level.
shade:frequencyframetimefloat[-inf]Shading time for frequency “frame”"frame".
Shutter:offsetfloat[0]Offset shutter open/close.
statistics:displace_ratiosfloat[2][0.1 1]Suppress reporting of displacements that, when divided by the max displacement, fall in the specified range.
statistics:filenamestring[]emptyFile name for summary statistics reported in plain text.
statistics:levelinteger[0]Enable statistics reporting.The verbosity of stats output
statistics:maxdispwarningsinteger[100]100Modify the maximum reported displacement issues. If the value is set to 0, then all displacements issues are reported.
statistics:stylesheetstring[]emptyStylesheet for XML detailed statistics.
statistics:xmlfilenamestring[]emptyThe name of the xml stats file to writeFile name for detailed statistics reported as XML.
stitch:refwarninginteger[1]Enable stitch warnings.
trace:depthmodestring[“separate”]separateIntegrators track diffuse/specular depth “separate” or “combined”"separate" or "combined".
trace:maxdepthinteger[25]Maximum ray depth.
trace:worldoffsetfloat[3][0 0 0]World Used as the origin offset value when trace:the worldorigin option is set to “worldoffset”"worldoffset".
trace:worldoriginstring[“camera”]Compute world origin offset value as “camera”, “world”, or “worldoffset”.
user:<name><type><value>Arbitrary global user data.
cameraSet a new world origin to give better floating point precision. Supported values are: world, worldoffset, cameravolume:aggregateprecisionfloat[1]Aggregate volume precision, effecting memory usage.