Skip to content

RenderScene

RenderScene#

(Render Scene)

  • Default object name: render_scene
  • Inherits from: ProjectItem

Go to User page.

Description#

General description of a render scene

Public Attributes#

Type Name Visual Hint Description
long resolution_mode VISUAL_HINT_DEFAULT Render the scene with the selected resolution preset.
string resolution_preset VISUAL_HINT_ENUM Render the scene with the selected resolution preset. Note that it is possible to specify a custom resolution presets file using the Preferences Panel.
long[2] resolution VISUAL_HINT_PIXEL Define the resolution used to render the scene.
double display_aspect_ratio VISUAL_HINT_DEFAULT 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.
bool enable_limited_region VISUAL_HINT_DEFAULT When enabled, only the part set in Limited Region is rendered.
double[4] limited_region VISUAL_HINT_PERCENTAGE 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.
long margin_mode VISUAL_HINT_DEFAULT Choose the mode of the overscan margin.
long[4] margin_pixel VISUAL_HINT_PIXEL Define the overscan in pixels: Left, Top, Right, Bottom.
double[4] margin_ratio VISUAL_HINT_PERCENTAGE Define the overscan in percentage: Left, Top, Right, Bottom.
reference (RendererRaytracer) renderer VISUAL_HINT_DEFAULT Define which renderer is used to render the scene. If nothing is specified, it uses the first renderer found in Input.
reference (Camera) camera VISUAL_HINT_DEFAULT Define the render camera. If nothing is specified, it uses the first camera found in Input.
double pixel_aspect_ratio VISUAL_HINT_DEFAULT Set the render pixel aspect ratio.
double sampling_quality VISUAL_HINT_PERCENTAGE 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.
reference (Group) input VISUAL_HINT_GROUP Specify which input context is defining geometries and lights used during rendering.
reference (Group) visibility VISUAL_HINT_GROUP Override which geometries are seen by the primary (camera) rays. If nothing is specified, it uses what's set in Input.
reference (Group) shadows VISUAL_HINT_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.
reference (Group) raytracing VISUAL_HINT_GROUP Override which geometries are visible during raytracing computations (reflection/transmission rays). If nothing is specified, it uses what's set in Input.
reference (Group) global_illumination VISUAL_HINT_GROUP Override which geometries are visible during global illumination computations. If nothing is specified, it uses what's set in Input.
reference matte_objects VISUAL_HINT_DEFAULT Define which objects are used as matte (holdouts) in the render.
double[3] matte_color VISUAL_HINT_COLOR Define the color of the matte objects.
double matte_alpha VISUAL_HINT_PERCENTAGE Define the alpha value of the matte objects.
reference (Group) lights VISUAL_HINT_GROUP Override the group of lights used during rendering. If nothing is specified, it uses the lights defined in Input.
reference (Material) override_material VISUAL_HINT_DEFAULT Use the specified material for all geometries during rendering.
reference (ShadingLayer) shading_layer VISUAL_HINT_DEFAULT Set a shading layer defining look association.
reference (AovSet) arbitrary_output_variables VISUAL_HINT_DEFAULT Define which AOV Set is used for rendering.
double near_clip VISUAL_HINT_DISTANCE Set the distance of the near clipping plane.
double far_clip VISUAL_HINT_DISTANCE Set the distance of the far clipping plane.
object[] (SubPixelFilter) sub_pixel_filters VISUAL_HINT_DEFAULT Specify which sub pixel filters are used during rendering.

CID#

class "RenderScene" "ProjectItem" {
    #license {
        flavor "advanced"
    }
    #version 0.91
    icon "../icons/object_icons/render_scene.iconrc"
    doc "General description of a render scene"
    attribute_group "canvas" {
        long "resolution_mode" {
            doc "Render the scene with the selected resolution preset."
            preset "Use Project Preferences" "0"
            preset "User-defined" "1"
            value 0
        }
        enum "resolution_preset" {
            doc "Render the scene with the selected resolution preset. Note that it is possible to specify a custom resolution presets file using the Preferences Panel."
            filter "resolution_preset"
            read_only yes
            value "__invalid_enum_label__"
        }
        pixel[2] "resolution" {
            doc "Define the resolution used to render the scene."
            output "image"
            animatable yes
            numeric_range yes 20 16384
            ui_range yes 20 16384
            read_only yes
            value 1280 720
        }
        double "display_aspect_ratio" {
            doc "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."
            numeric_range yes 0.1 10
            ui_range yes 0.5 2
            dg_active no
            value 1
        }
    }
    attribute_group "region" {
        collapsed yes
        bool "enable_limited_region" {
            doc "When enabled, only the part set in Limited Region is rendered."
            output "image"
            animatable yes
            value no
        }
        percentage[4] "limited_region" {
            doc "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."
            output "image"
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            read_only yes
            value 0.0 0.0 1 1
        }
    }
    attribute_group "overscan" {
        collapsed yes
        long "margin_mode" {
            doc "Choose the mode of the overscan margin."
            preset "Pixel" "0"
            preset "Ratio" "1"
            value 0
        }
        pixel[4] "margin_pixel" {
            doc "Define the overscan in pixels: Left, Top, Right, Bottom."
            numeric_range yes 0.0 10000
            ui_range yes 0.0 10000
            value 0 0 0 0
        }
        percentage[4] "margin_ratio" {
            doc "Define the overscan in percentage: Left, Top, Right, Bottom."
            numeric_range yes 0.0 10
            ui_range yes 0.0 10
            read_only yes
            value 0.0 0.0 0.0 0.0
        }
    }
    attribute_group "rendering" {
        reference "renderer" {
            doc "Define which renderer is used to render the scene. If nothing is specified, it uses the first renderer found in Input."
            filter "RendererRaytracer"
            null_label "Use input"
            value ""
        }
        reference "camera" {
            doc "Define the render camera. If nothing is specified, it uses the first camera found in Input."
            filter "Camera"
            null_label "Use input"
            value ""
        }
        double "pixel_aspect_ratio" {
            doc "Set the render pixel aspect ratio."
            numeric_range yes 0.0001 1.79769313486232e+308
            ui_range yes 0.1 10
            value 1
        }
        percentage "sampling_quality" {
            doc "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."
            output "shading"
            numeric_range yes 0.0 10
            ui_range yes 0.0 1
            value 1
        }
    }
    attribute_group "rendering>visibility" {
        doc "For each category, set which objects are visible (used) to render the scene."
        group "input" {
            doc "Specify which input context is defining geometries and lights used during rendering."
            filter "Context" "SceneItem"
            input "shading" "motion" "parenting" "geometry"
            dirtiness_pass_through yes
            value ""
        }
        reference "__input__" {
            filter "Group"
            input "shading" "motion" "parenting" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        group "visibility" {
            doc "Override which geometries are seen by the primary (camera) rays. If nothing is specified, it uses what\'s set in Input."
            filter "Context" "SceneObject"
            null_label "Use input"
            input "shading" "motion" "parenting" "geometry"
            dirtiness_pass_through yes
            value ""
        }
        reference "__visibility__" {
            filter "Group"
            input "shading" "motion" "parenting" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        group "shadows" {
            doc "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."
            filter "Context" "SceneObject"
            null_label "Use input"
            input "shading" "motion" "parenting" "geometry"
            dirtiness_pass_through yes
            value ""
        }
        reference "__shadows__" {
            filter "Group"
            input "shading" "motion" "parenting" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        group "raytracing" {
            doc "Override which geometries are visible during raytracing computations (reflection/transmission rays). If nothing is specified, it uses what\'s set in Input."
            filter "Context" "SceneObject"
            null_label "Use input"
            input "shading" "motion" "parenting" "geometry"
            dirtiness_pass_through yes
            value ""
        }
        reference "__raytracing__" {
            filter "Group"
            input "shading" "motion" "parenting" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        group "global_illumination" {
            doc "Override which geometries are visible during global illumination computations. If nothing is specified, it uses what\'s set in Input."
            filter "Context" "SceneObject"
            null_label "Use input"
            input "shading" "motion" "parenting" "geometry"
            dirtiness_pass_through yes
            value ""
        }
        reference "__global_illumination__" {
            filter "Group"
            input "shading" "motion" "parenting" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        reference "matte_objects" {
            doc "Define which objects are used as matte (holdouts) in the render."
            filter "Context" "SceneObject" "Group"
            input "motion" "parenting" "geometry"
            dirtiness_pass_through yes
            value ""
        }
        reference "__matte_objects__" {
            filter "Group"
            input "motion" "parenting" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        color "matte_color" {
            doc "Define the color of the matte objects."
            output "shading"
            texturable yes
            animatable yes
            shading_variable yes
            value 0.0 0.0 0.0
        }
        percentage "matte_alpha" {
            doc "Define the alpha value of the matte objects."
            output "shading"
            texturable yes
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            shading_variable yes
            value 0.0
        }
    }
    attribute_group "rendering>lighting" {
        group "lights" {
            doc "Override the group of lights used during rendering. If nothing is specified, it uses the lights defined in Input."
            filter "Context" "Light"
            null_label "Use input"
            input "shading_light"
            dirtiness_pass_through yes
            value ""
        }
        reference "__lights__" {
            filter "Group"
            input "shading_light"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
    }
    attribute_group "rendering>materials" {
        doc "Select the channels that will be computed during the shading process."
        reference "override_material" {
            doc "Use the specified material for all geometries during rendering."
            filter "Material"
            output "shading_material"
            value ""
        }
        reference "shading_layer" {
            doc "Set a shading layer defining look association."
            filter "ShadingLayer"
            output "shading_material" "shading_group"
            value ""
        }
        list<reference> "arbitrary_output_variables" {
            doc "Define which AOV Set is used for rendering."
            filter "AovSet" "Group"
            output "image"
            value <empty>
        }
    }
    attribute_group "rendering>clipping" {
        doc "Defines the near and far clipping planes. Objects between the camera and the near clipping plane or beyond the far clipping plane will be ignored."
        collapsed yes
        distance "near_clip" {
            doc "Set the distance of the near clipping plane."
            animatable yes
            numeric_range yes 0.0 1.79769313486232e+308
            ui_range yes 0.0 1.79769313486232e+308
            value 0.0
        }
        distance "far_clip" {
            doc "Set the distance of the far clipping plane."
            null_label "Infinity"
            null_value "-1.0"
            animatable yes
            numeric_range yes 0.0 1.79769313486232e+308
            ui_range yes 0.0 1.79769313486232e+308
            value -1
        }
    }
    attribute_group "rendering>sub_pixel_filters" {
        collapsed yes
        object[] "sub_pixel_filters" {
            doc "Specify which sub pixel filters are used during rendering."
            filter "SubPixelFilter"
            value <empty>
        }
    }
}