You are viewing RenderMan 22 documentation which is not the current release. You may view the current documentation by visiting the home page.

Page tree

Contents

The PrmanGlobalStatements node is a RenderMan-specific node containing attributes to configure RenderMan's global Options.

There is generally a one-to-one mapping between a PrmanGlobalStatements attribute and its corresponding RenderMan option. In addition there are a number of RfK-specific plugin control options detailed below.


Common

Name
Type
Default
Description
hider:adaptallint0Enable adaptive sampling of all AOVs. When 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. Value range: true/false.
hider:darkfallofffloat0.025De-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. Value range: 0 to 1.
hider:extrememotiondofint0Enable 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. Value range: true/false.
hider:incrementalint0Enables the progressive display of results (rather than bucketed results). Value range: true/false.
hider:maxsamplesint0An 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. Value range: 0 or more.
hider:minextrasamplesint-1This 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.
hider:minsamplesint-1Specifies the minimum number of samples for adaptive sampling. The default value is the square root of maxsamples.
hider:pixelfiltermodestringweightedSpecifies 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. Supported values: weighted, importance.
hider:samplemotionint1This 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. Value range: true/false.
hider:sampleoffsetint0This 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 samples.
hider:typestringraytraceRender mode. Supported values: raytrace, bake.
Ri:Frameint0Frame number.
Ri:PixelVariancefloat0.001Controls adaptive sampling. This sets the upper bound on the acceptable estimated variance of the pixel values from the true pixel values. Value range: 0 to 1.
Ri:Shutterfloat[2]0 0Scene motion shutter.
Shutter:offsetfloat0Offset shutter open/close.

Shading

Name
Type
Default
Description
lighting:selectionlearningschemeint1Employs a machine learning algorithm to more accurately importance sample lights, taking into account occlusion and light filters. Value range: true/false.
trace:bvhcompressionfloat0Provides a hint to the system to favor memory utilization versus speed when constructing the ray accelerator. Valid values are in the range [0, 1], where the higher the values the more compact the memory representation. The control behaves almost linearly with some discontinuities in the compression rate as different strategies are activated. The result obtained is likely to be scene dependent. As a rule of thumb, leave this control to 0 unless you need to reduce memory utilization in order to render a given scene or sequence. When tuning, set the control to 1 at first to see how much memory can be saved through compression and what time overhead is generated, then dial the number back to a lower value (if possible) and reach the desired balance between speed and memory usage. Value range: 0 to 1.
trace:worldoffsetfloat[3]0 0 0Used as the origin when the worldorigin option is set to "worldoffset".
trace:worldoriginstringcameraSet a new world origin to give better floating point precision. Supported values: world, worldoffset, camera.

Dicing

Name
Type
Default
Description
curve:minwidthfloat0Minimum curve width in raster coordinates. Value range: 0 or more.
dice:offscreenmultiplierfloat1Dicing rate multiplier for objects outside the viewing frustum. Value range: 0 or more.

Display

Name
Type
Default
Description
bucket:orderstringhorizontalRender bucket order. Supported values: horizontal, vertical, zigzag-x, zigzag-y, spacefill, random, spiral, circle.
bucket:orderoriginint[2]-1 -1First bucket for "spiral" and "circle" order. Image center is [-1 -1].
checkpoint:asfinalint0When 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 later. Value range: true/false.
checkpoint:commandstringemptySystem 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 %%.
checkpoint:exitatstringemptyHow 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 disable.
checkpoint:intervalstringemptyWrite 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 checkpoints.
checkpoint:keepfilesint0If 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' option. Value range: true/false.
Ri:CropWindowfloat[4]0 1 0 1Crop window [left right top bottom] in NDC space.
Ri:FormatPixelAspectRatiofloat1Output image pixel aspect ratio. Value range: 0 to 1.
Ri:FormatResolutionint[2]640 480Output image resolution.
Ri:FrameAspectRatiofloat-1Output image aspect ratio.
Ri:ScreenWindowfloat[4]0 0 0 0Screen window [left right top bottom] in screen space.

Statistics

Name
Type
Default
Description
shade:debugint0Shading debug level. Value range: true/false.
statistics:displace_ratiosfloat[2]0.1 1Suppress reporting of displacements that, when divided by the max displacement, fall in the specified range.
statistics:filenamestringemptyFile name for summary statistics reported in plain text.
statistics:iotracefilenamestringempty
statistics:levelint0Enable statistics reporting. Value range: true/false.
statistics:maxdispwarningsint100Modify the maximum reported displacement issues. If the value is set to 0, then all displacements issues are reported. Value range: 0 or more.
statistics:shaderprofilestringempty
statistics:stylesheetstringemptyStylesheet for XML detailed statistics.
statistics:texturestatslevelint0Enable texture statistics reporting. Value range: true/false.
statistics:trackassetobjectsint0
statistics:xmlfilenamestringemptyFile name for detailed statistics reported as XML.

Configuration

Name
Type
Default
Description
limits:brickmemoryint2097152Brickmap cache size in kB. Value range: 0 or more.
limits:bucketsizeint[2]16 16Size of render buckets in pixels.
limits:deepshadowerrorfloat0.01Control 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. Value range: 0 to 1.
limits:geocachememoryint2097152Geometry cache size in kB. Value range: 0 or more.
limits:gridsizeint289Value range: 1 or more.
limits:matrixcachememoryint0Matrix cache in kB. Value range: 0 or more.
limits:nurbcurvaturedicefactorint3NURBs max curvature multiplier. Value range: 0 or more.
limits:opacitycachememoryint1048576Opacity cache in kB. Value range: 0 or more.
limits:othresholdfloat[3]0.99609375 0.99609375 0.99609375Opacity Culling: When rendering scenes with a large number of semi-transparent layered objects (e.g. hair), the opacity culling threshold 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:proceduralbakingclumpsizeint0Value range: 0 or more.
limits:ptexturemaxfilesint128Value range: 1 or more.
limits:ptexturememoryint32768PTex cache size in kB. Value range: 0 or more.
limits:rendermemoryfloat0Memory limit as percentage of machine memory. Value range: 0 to 1.
limits:rendertimeint0Maximum render time in minutes. Value range: 0 or more.
limits:shadesizeint289The maximum number of vertices, not grid. Value range: 1 or more.
limits:texturememoryint2097152Texture cache size in kB. Value range: 0 or more.
limits:textureperthreadmemoryratiofloat0.5
limits:threadsint0Set the number of threads that 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.
searchpath:archivestringemptySearch path for Rib archives and DelayedReadArchive.
searchpath:dirmapstringemptySearch path remapping.
searchpath:displaystringemptySearch path for display plug-ins.
searchpath:proceduralstringemptySearch path for DynamicLoad procedural plug-ins.
searchpath:rifilterstringemptySearch path for Rif plug-ins.
searchpath:rixpluginstringemptySearch path for shading plug-ins.
searchpath:shaderstringemptySearch path for OSL pattern plug-ins.
searchpath:texturestringemptySearch path for texture files.

RIB

Name
Type
Default
Description
ribparse:varsubststringemptyRIB parse only.
scenedump:filenamestringemptyPath to dump RIB scene for rendermode "catrib".

User

NameTypeDefaultDescription
osl:batchedint1Allows batched execution of OSL patterns to improve performance, this in on by default, see more in the OSL page
osl:verboseint4The verbosity level of OSL output, see more in the OSL page
osl:statisticslevelint0The statistics level of detail, see more in the OSL page



Plugin

Name

Type

Default

Description

traversalMethodintParallel

Option to serialize traversal of Katana scenegraph when converting to Rix scenegraph. By default this traversal runs in parallel.

maxTraversalThreadsint4

The maximum number of threads that RfK will use when traversing the Katana scenegraph to build the Rix scenegraph. A value of '0' means 'automatic'

sleepAtStartupint0

Tell plugin to sleep for N seconds after render starts but before any initialization happens. Useful for attaching a debugger or profiler to renderboot. Default is '0' (disable sleep at startup). NOTE: Currently this is a Linux-only feature.

flattenInstanceSourcesint1

By default, RenderMan flattens an instance source into separate object masters for each geometry in the group. Setting this option to 'false' will keep each instance source location as a single object master. This can have large performance improvements for scenes with a large number of instances.

deferInstanceSourcesint0

Setting this to 'true' tells the plugin to only traverse and build instance source locations that are used by an instance. Enabling the option can speed up traversal if the scene has heavy instance sources that aren't used. The setting will be ignored during live rendering.

honorInheritedMeshLightMaterialint0Setting this to 1 or "yes" will cause mesh light objects to inherit the set BxDF material as opposed to replacing it with a PxrBlack material, which is the default material.