Render Scene#
(RenderScene)
- Default object name:
render_scene
Description#
General description of a render scene
Attributes#
| Name | Type | Description |
|---|---|---|
| Resolution Mode | long |
Render the scene with the selected resolution preset. |
| Resolution Preset | string |
Render the scene with the selected resolution preset. Note that it is possible to specify a custom resolution presets file using the Preferences Panel. |
| Resolution | long[2] |
Define the resolution used to render the scene. |
| Display Aspect Ratio | double |
Set the pixel aspect ratio of the image when displayed in the Image View. Please note that this is only a display setting. This doesn't modify the rendered pixel aspect ratio. |
| Enable Limited Region | bool |
When enabled, only the part set in Limited Region is rendered. |
| Limited Region | double[4] |
Define the top left corner and the size of the render region in percentage of the image canvas. Only works if Enable Limited Region is on. |
| Margin Mode | long |
Choose the mode of the overscan margin. |
| Margin Pixel | long[4] |
Define the overscan in pixels: Left, Top, Right, Bottom. |
| Margin Ratio | double[4] |
Define the overscan in percentage: Left, Top, Right, Bottom. |
| Renderer | reference (RendererRaytracer) |
Define which renderer is used to render the scene. If nothing is specified, it uses the first renderer found in Input. |
| Camera | reference (Camera) |
Define the render camera. If nothing is specified, it uses the first camera found in Input. |
| Pixel Aspect Ratio | double |
Set the render pixel aspect ratio. |
| Sampling Quality | double |
Control the global sampling of the scene. This attribute is a sampling multiplier that globally increases or decreases the number of samples in the scene. This value doesn't change the actual values of the scene, it multiplies the actual sample values on the fly during rendering. |
| Input | reference (Group) |
Specify which input context is defining geometries and lights used during rendering. |
| Visibility | reference (Group) |
Override which geometries are seen by the primary (camera) rays. If nothing is specified, it uses what's set in Input. |
| Shadows | reference (Group) |
Override which geometries are seen by the lights when performing shadow computations (shadow rays). If nothing is specified, it uses what's set in Input. |
| Raytracing | reference (Group) |
Override which geometries are visible during raytracing computations (reflection/transmission rays). If nothing is specified, it uses what's set in Input. |
| Global Illumination | reference (Group) |
Override which geometries are visible during global illumination computations. If nothing is specified, it uses what's set in Input. |
| Matte Objects | reference |
Define which objects are used as matte (holdouts) in the render. |
| Matte Color | double[3] |
Define the color of the matte objects. |
| Matte Alpha | double |
Define the alpha value of the matte objects. |
| Lights | reference (Group) |
Override the group of lights used during rendering. If nothing is specified, it uses the lights defined in Input. |
| Override Material | reference (Material) |
Use the specified material for all geometries during rendering. |
| Shading Layer | reference (ShadingLayer) |
Set a shading layer defining look association. |
| Arbitrary Output Variables | reference (AovSet) |
Define which AOV Set is used for rendering. |
| Near Clip | double |
Set the distance of the near clipping plane. |
| Far Clip | double |
Set the distance of the far clipping plane. |
| Sub Pixel Filters | object[] (SubPixelFilter) |
Specify which sub pixel filters are used during rendering. |