render:set-control-variable
List of: Scheme Extensions
Subjects: Rendering Control
Contents: Rendering Base

Action: Sets the value of a rendering control variable.

Filename: rbase/rnd_scm/avh_scm.cxx

APIs: api_rh_set_control_variable

Syntax: (render:set-control-variable name value)

Arg Types: name string

value real | integer

Returns: unspecified


name specifies the name of the control variable.


value specifies the new value associated with the named control variable.


Valid names and value ranges follow:


pixel threshold controls anti-aliasing. It determines when to adaptively super-sample the image. The image is sampled until adjacent color samples differ in the largest of their red, green and blue components by an amount not exceeding the pixel threshold. Range is 0.0 to 1.0. The default is 0.1.


min pixel contrib is used for determining whether the contribution made by a secondary ray can be ignored. A combination of this control variable and the level variable define the recursive ray tracing termination criteria. The range is 0.0 to 1.0. The default is 0.05.


raytrace level is the maximum level of recursion that is enforced when tracing secondary rays. The default is 16.


octtree occupancy is the maximum occupancy of a leaf cell of the octtree data structure constructed for ray tracing. The occupancy corresponds to the number of facets contained in an octtree leaf cell. An octtree is constructed when rendering using ray tracing, either in a ray tracing mode, or when ray tracing is required by a shader in the preview or full rendering modes. The default is 8.


octtree depth is the maximum depth of the octtree data structure constructed during ray tracing. An octtree is constructed when rendering using ray tracing, either in a ray tracing mode, or when ray tracing is required by a shader in preview or full rendering modes. The default is 8.

Example: ; render:set-control-variable

; Get a valid list of rendering control variables.

(render:control-variables)

;; ("pixel threshold" "min pixel contrib"

;; "raytrace level" "octtree occupancy"

;; "octtree depth")

; Set the value of a rendering control variable.

(render:set-control-variable "raytrace level" 1.0)

;; ()
PDF/RBASE/03SCM.PDF
HTM/DATA/RBASE/RBASE/03SCM/0044.HTM