Skip to content

RendererRaytracer

RendererRaytracer#

(Raytracer)

Go to User page.

Description#

Raytracing rendering engine.

Public Attributes#

Type Name Visual Hint Description
string integration_model VISUAL_HINT_DEFAULT
long anti_aliasing_sample_count VISUAL_HINT_SAMPLE_PER_PIXEL Set the number of samples to use for the antialiasing.
long refinement_maximum_sample_count VISUAL_HINT_SAMPLE_PER_PIXEL Set the maximum number of samples to use to refine a pixel.
double refinement_variance_threshold VISUAL_HINT_DEFAULT Set the color variance over which a pixel is considered noisy and needs more samples.
long anti_aliasing_sampling_mode VISUAL_HINT_DEFAULT Set the sampling algorithm used by the antialiasing.
long anti_aliasing_filter VISUAL_HINT_DEFAULT Algorithm used to filter the antialiasing samples.
long anti_aliasing_filter_mode VISUAL_HINT_DEFAULT Set the algorithm used to integrate antialiasing samples. The Splatting mode generates samples inside the current pixel and accumulates them in current and neighbour pixels using the antialiasing filter. The Importance Sampling mode samples the antialiasing filter and accumulates only in the current pixel.
double[2] anti_aliasing_filter_size VISUAL_HINT_SUBPIXEL Diameter in pixels of the kernel used for the filter.
double subsample_quality VISUAL_HINT_PERCENTAGE Set the size of ray differentials for antialiasing samples. A value of 0% corresponds to ray differentials with a size of a pixel whereas a value of 100% corresponds to the size of a sub pixel.
double shading_oversampling VISUAL_HINT_PERCENTAGE Set the sampling demultiplication factor between antialiasing and shading samples. The higher the value, the more shading samples are computed per antialiasing samples and the slower it gets.
bool lock_sampling_noise VISUAL_HINT_DEFAULT Lock the samples through time.
long sampling_seed VISUAL_HINT_DEFAULT Control the seed of the sampling used for the shading and the antialiasing.
long refinement_variance_mode VISUAL_HINT_DEFAULT Set the mode used to compute the variance within a pixel. In Contrast mode, the variance corresponds to the maximum difference between new accumulated samples and the new beauty. In Standard Deviation mode, the variance corresponds to the standard deviation of the beauty for each accumulated samples.
long refinement_variance_filter VISUAL_HINT_DEFAULT A pixel is refined when its variance or the one of its neighbours is over the variance threshold. This filter is applied on neighbour variances before comparing them against the threshold. When disabled, neighbours are not tested at all. In other cases, the filter has the same size of the anti aliasing filter when splatting samples and a size of 3x3 when using importance sampling (see Anti Aliasing Filter Mode).
string refinement_variance_LUT VISUAL_HINT_ENUM Set the LUT to use to compute the color variance of a pixel.
long motion_blur_mode VISUAL_HINT_DEFAULT Set whether motion blur and motion vectors must be computed.
long motion_blur_sampling_mode VISUAL_HINT_DEFAULT Set the sampling algorithm used by the motion blur.
long motion_blur_settings VISUAL_HINT_DEFAULT Set whether the motion blur should use settings defined in project preferences or custom settings.
long motion_blur_sample_count VISUAL_HINT_DEFAULT Set the number of samples to use for the motion blur.
long motion_blur_direction VISUAL_HINT_DEFAULT Set the direction of the motion blur.
double motion_blur_length VISUAL_HINT_PERCENTAGE Set the length of the motion blur. Setting it to 100% corresponds to the duration of the current frame.
double motion_blur_shutter_begin VISUAL_HINT_DEFAULT Control the lower bound of the range in which motion samples must be taken.
double motion_blur_shutter_end VISUAL_HINT_DEFAULT Control the higher bound of the range in which motion samples must be taken.
curve motion_blur_shutter_curve VISUAL_HINT_DEFAULT Control inbetween frame shutter opening and sample weight.
bool enable_tone_mapping VISUAL_HINT_DEFAULT
bool affect_color_aovs VISUAL_HINT_DEFAULT Defines if the tone mapping affects the color aovs
curve[3] tone_mapping_curve VISUAL_HINT_DEFAULT Curves to remap subsample color prior pixel filtering. Use this curve is you want to control low and high values on each subsamples.
bool export_aovs VISUAL_HINT_DEFAULT Defines if the raytracer writes aovs to the image
long matte_object_AOV_mode VISUAL_HINT_DEFAULT Choose wether the matte alpha of objects should affect all AOVs or only the beauty ones.

CID#

class "RendererRaytracer" "Renderer" {
    #version 1.4
    icon "../icons/object_icons/raytracer.iconrc"
    doc "Raytracing rendering engine."
    aliases "RendererPathTracer"
    attribute_group "integrator" {
        collapsed yes
        string "integration_model" {
            value ""
        }
        reference "integrator" {
            doc "Specify the light integrator used during the shading."
            filter "Integrator"
            hidden yes
            promote_attribute yes
            value ""
        }
        object[] "integrators" {
            doc "Store all internal integrators."
            filter "Integrator"
            hidden yes
            value <empty>
        }
        pixel "bucket_width" {
            doc "Set the render bucket width."
            hidden yes
            numeric_range yes 1 16384
            ui_range yes 1 16384
            value 32
        }
        pixel "bucket_height" {
            doc "Set the render bucket height."
            hidden yes
            numeric_range yes 1 16384
            ui_range yes 1 16384
            value 32
        }
        long "packet_width" {
            doc "Set the packet tracing width."
            hidden yes
            numeric_range yes 1 16384
            ui_range yes 1 16384
            value 8
        }
        long "packet_height" {
            doc "Set the packet tracing height."
            hidden yes
            numeric_range yes 1 16384
            ui_range yes 1 16384
            value 8
        }
        bool "previz_mode" {
            doc "If checked, set the renderer in Previz mode: the renderer uses a simplified light set to simplify lighting still providing the real shading."
            hidden yes
            value no
        }
    }
    attribute_group "sampling" {
        sample_per_pixel "anti_aliasing_sample_count" {
            doc "Set the number of samples to use for the antialiasing."
            texturable yes
            numeric_range yes 1 65536
            ui_range yes 1 256
            value 9
        }
        sample_per_pixel "refinement_sample_count" {
            doc "Set the number of samples to use to refine a pixel when they are considered as noisy."
            hidden yes
            numeric_range yes 1 65536
            ui_range yes 1 256
            read_only yes
            value 8
        }
        sample_per_pixel "refinement_maximum_sample_count" {
            doc "Set the maximum number of samples to use to refine a pixel."
            null_label "Refinement Sampling Disabled"
            null_value "0"
            numeric_range yes 0.0 65536
            ui_range yes 0.0 256
            value 0
        }
        double "refinement_variance_threshold" {
            doc "Set the color variance over which a pixel is considered noisy and needs more samples."
            animatable yes
            numeric_range yes 0.0 1.79769313486232e+308
            ui_range yes 0.0 1
            read_only yes
            value 0.005
        }
    }
    attribute_group "sampling>advanced_anti_aliasing" {
        collapsed yes
        ui_weight 1000
        long "anti_aliasing_sampling_mode" {
            doc "Set the sampling algorithm used by the antialiasing."
            preset "Stratified" "0"
            preset "Random" "1"
            preset "Stratified Jitter" "2"
            preset "Blue Noise" "3"
            value 3
        }
        long "anti_aliasing_filter" {
            doc "Algorithm used to filter the antialiasing samples."
            preset "Box" "0"
            preset "Triangle" "1"
            preset "Gaussian" "2"
            preset "Blackman-Harris" "3"
            preset "Mitchell" "4"
            preset "Lanczos" "5"
            value 2
        }
        long "anti_aliasing_filter_mode" {
            doc "Set the algorithm used to integrate antialiasing samples. The Splatting mode generates samples inside the current pixel and accumulates them in current and neighbour pixels using the antialiasing filter. The Importance Sampling mode samples the antialiasing filter and accumulates only in the current pixel."
            preset "Splatting" "0"
            preset "Importance Sampling" "1"
            value 1
        }
        subpixel[2] "anti_aliasing_filter_size" {
            doc "Diameter in pixels of the kernel used for the filter."
            numeric_range yes 1 128
            ui_range yes 1 32
            value 2 2
        }
        percentage "subsample_quality" {
            doc "Set the size of ray differentials for antialiasing samples. A value of 0% corresponds to ray differentials with a size of a pixel whereas a value of 100% corresponds to the size of a sub pixel."
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.0
        }
        percentage "shading_oversampling" {
            doc "Set the sampling demultiplication factor between antialiasing and shading samples. The higher the value, the more shading samples are computed per antialiasing samples and the slower it gets."
            numeric_range yes 0.0 10
            ui_range yes 0.0 1
            value 0.0
        }
        bool "lock_sampling_noise" {
            doc "Lock the samples through time."
            animatable yes
            dg_active no
            value no
        }
        long "sampling_seed" {
            doc "Control the seed of the sampling used for the shading and the antialiasing."
            animatable yes
            numeric_range yes 0.0 10000000
            ui_range yes 0.0 10000000
            value 0
        }
        long "refinement_variance_mode" {
            doc "Set the mode used to compute the variance within a pixel. In Contrast mode, the variance corresponds to the maximum difference between new accumulated samples and the new beauty. In Standard Deviation mode, the variance corresponds to the standard deviation of the beauty for each accumulated samples."
            read_only yes
            preset "Contrast" "0"
            preset "Standard Deviation" "1"
            value 0
        }
        long "refinement_variance_filter" {
            doc "A pixel is refined when its variance or the one of its neighbours is over the variance threshold. This filter is applied on neighbour variances before comparing them against the threshold. When disabled, neighbours are not tested at all. In other cases, the filter has the same size of the anti aliasing filter when splatting samples and a size of 3x3 when using importance sampling (see Anti Aliasing Filter Mode)."
            read_only yes
            preset "Disabled" "-2"
            preset "Use Anti-Aliasing Filter" "-1"
            preset "Box" "0"
            preset "Triangle" "1"
            preset "Gaussian" "2"
            preset "Blackman-Harris" "3"
            preset "Mitchell" "4"
            preset "Lanczos" "5"
            value -1
        }
        enum "refinement_variance_LUT" {
            doc "Set the LUT to use to compute the color variance of a pixel."
            filter "color_space"
            read_only yes
            value "__invalid_enum_label__"
        }
    }
    attribute_group "sampling>motion_blur" {
        collapsed yes
        long "motion_blur_mode" {
            doc "Set whether motion blur and motion vectors must be computed."
            preset "Disabled" "0"
            preset "Motion Vectors" "1"
            preset "3D Motion Blur" "2"
            preset "3D Motion Blur + Motion Vectors" "3"
            value 0
        }
        long "motion_blur_sampling_mode" {
            doc "Set the sampling algorithm used by the motion blur."
            read_only yes
            preset "Stratified" "0"
            preset "Random" "1"
            preset "Stratified Jitter" "2"
            preset "Blue Noise" "3"
            value 3
        }
        long "motion_blur_settings" {
            doc "Set whether the motion blur should use settings defined in project preferences or custom settings."
            read_only yes
            preset "Use Project Preferences" "0"
            preset "Custom" "1"
            value 0
        }
        long "motion_blur_sample_count" {
            doc "Set the number of samples to use for the motion blur."
            animatable yes
            numeric_range yes 2 1024
            ui_range yes 2 32
            read_only yes
            value 3
        }
        long "motion_blur_direction" {
            doc "Set the direction of the motion blur."
            read_only yes
            preset "Backward" "-1"
            preset "Centered" "0"
            preset "Forward" "1"
            value 0
        }
        percentage "motion_blur_length" {
            doc "Set the length of the motion blur. Setting it to 100% corresponds to the duration of the current frame."
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            read_only yes
            value 0.5
        }
        double "motion_blur_shutter_begin" {
            doc "Control the lower bound of the range in which motion samples must be taken."
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            read_only yes
            value 0.0
        }
        double "motion_blur_shutter_end" {
            doc "Control the higher bound of the range in which motion samples must be taken."
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            read_only yes
            value 1
        }
        curve "motion_blur_shutter_curve" {
            doc "Control inbetween frame shutter opening and sample weight."
            read_only yes
            value[] {
                key 0 0.0 1 0.0 0.0 0.0 -0.16665 0.0 0.16665 0.0 yes yes no no
                key 0 0.5 1 0.0 0.0 0.0 -0.16665 0.0 0.16665 0.0 yes yes no no
                key 0 1 1 0.0 0.0 0.0 -0.16665 0.0 0.16665 0.0 yes yes no no
            }
        }
    }
    attribute_group "tone_mapping" {
        collapsed yes
        bool "enable_tone_mapping" {
            animatable yes
            value no
        }
        bool "affect_color_aovs" {
            doc "Defines if the tone mapping affects the color aovs"
            value yes
        }
        curve[3] "tone_mapping_curve" {
            doc "Curves to remap subsample color prior pixel filtering. Use this curve is you want to control low and high values on each subsamples."
            read_only yes
            value[] {
                key 0 0.0 0.0 0.0 0.0 0.0 -0.3333 0.0 0.3333 0.0 yes yes no yes
                key 0 1 1 0.0 0.0 0.0 -0.3333 0.0 0.3333 0.0 yes yes no yes
            }
            value[1] {
                key 0 0.0 0.0 0.0 0.0 0.0 -0.3333 0.0 0.3333 0.0 yes yes no yes
                key 0 1 1 0.0 0.0 0.0 -0.3333 0.0 0.3333 0.0 yes yes no yes
            }
            value[2] {
                key 0 0.0 0.0 0.0 0.0 0.0 -0.3333 0.0 0.3333 0.0 yes yes no yes
                key 0 1 1 0.0 0.0 0.0 -0.3333 0.0 0.3333 0.0 yes yes no yes
            }
        }
    }
    attribute_group "AOV" {
        collapsed yes
        bool "export_aovs" {
            doc "Defines if the raytracer writes aovs to the image"
            value yes
        }
        long "matte_object_AOV_mode" {
            doc "Choose wether the matte alpha of objects should affect all AOVs or only the beauty ones."
            preset "Affect All AOVs" "0"
            preset "Affect Beauty AOVs" "1"
            value 0
        }
    }
    attribute_group "debug" {
        bool "verbose" {
            hidden yes
            value no
        }
    }
}