Module vrRenderSettings

[frames] | no frames]

Module vrRenderSettings

Functions

addPreset(name)
Add preset to Render Queue.

applyPreset(name)
Apply preset in Render Queue .

clearRenderVariantSetGroups()
Removes all variant set groups.

disableRaytracingOverrides()
Disables the raytracing override settings in all materials.

generateRayFile(filename, numPhotons, maxDepth)
Generates a rayfile in ASCII format.

int

getBrdfMode()
Returns the currently active BRDF mode.

bool

getDenoiseAlpha()
Returns whether to denoise the alpha channel or not.

unsigned int

getDenoiseFilter()
Returns the denoise filter used.

double

getDenoiseFilterThreshold()
Deprecated

unsigned int

getDenoiserModel()
Returns the denoiser model used.

int

getDenoiserType()
Returns the denoiser type used.

bool

getEnableDenoiseFilter()
Deprecated, use getDenoiseFilter instead: Returns whether the CPU denoise filter for raytracing is enabled or not.

int

getIlluminant()
Returns the illuminant id used.

bool

getNURBSRaytracing()
Returns whether NURBS raytracing is on or off.

unsigned int

getOptimizationMode()
Returns the optimization strategy used in GPU raytracing.

float

getRaytracingAAImageFilterHeight()
Returns the height of the pixel filter in use.

int

getRaytracingAAImageFilterType()
Returns the pixel filter type in use.

float

getRaytracingAAImageFilterWidth()
Returns the width of the pixel filterin use.

int

getRaytracingAAThresholdQuality()
Returns the adaptive antialiasing quality level.

float

getRaytracingClampValue()
Returns the clamping value.

bool

getRaytracingClampingEnable()
Returns whether clamping is enabled or disabled.

int

getRaytracingCores()
Returns the number of cores to be used during raytracing.

float

getRaytracingFinalGatherRadius()
Returns the final gather lookup radius.

int

getRaytracingImageSamples()
Returns the number of anti-aliasing samples.

int

getRaytracingInteractiveFinalGatherQuality()
Returns the interactive final gather quality level.

int

getRaytracingInteractiveIBLQuality()
Returns the interacitve ibl quality level in use.

int

getRaytracingInteractivePhotonCount()
Returns the interactive photon count.

int

getRaytracingInteractiveQuality()
Returns the interactive quality level in use.

int

getRaytracingInteractiveQualityMode()
Returns the interactive quality mode in use.

float

getRaytracingInteractiveTextureSharpness()
Returns the sharpness scale factor for texture sampling during interacitve mode.

int

getRaytracingInteractiveTraceDepth()
Returns the interactive trace depth in use.

float

getRaytracingLightEvaluationThreshold()
Returns the threshold used for culling lights.

int

getRaytracingMode()
Returns the raytracing mode.

int

getRaytracingPhotonLookupCount()
Returns the photon lookup count.

int

getRaytracingPhotonMapFreezeMode()
Gets the freeze mode for updating photon map.

int

getRaytracingPhotonMapRefreshMode()
Returns final gathering refresh mode.

int

getRaytracingPhotonMode()
Returns the photon mode.

float

getRaytracingPhotonRadius()
Returns the photon lookup radius.

bool

getRaytracingPhotonUseAutomaticRadius()
Returns the enable state of the automatic photon radius calculation.

int

getRaytracingSampleOffset()
Returns the sample offset to start the rendering.

int

getRaytracingSamplesThreshold()
Returns the samples threshold.

int

getRaytracingStillFrameFinalGatherQuality()
Returns the stillframe final gather quality level.

int

getRaytracingStillFrameIBLQuality()
Returns the stillframe ibl quality level in use.

int

getRaytracingStillFramePhotonCount()
Returns the stillframe photon count.

int

getRaytracingStillFrameQuality()
Returns the still frame reflection/refraction quality level in use.

int

getRaytracingStillFrameQualityMode()
Returns the stillframe quality mode in use.

int

getRaytracingStillFrameSupersampling()
Returns the stillframe supersampling factor.

float

getRaytracingStillFrameTextureSharpness()
Returns the sharpness scale factor for texture sampling during stillframe mode.

int

getRaytracingStillFrameTraceDepth()
Returns the stillframe trace depth in use.

bool

getRaytracingUseFinalGatherForGlossy()
Returns whether the final gather map should be used for glossy reflections.

bool

getRaytracingUseHighQualityTextureFiltering()
Returns whether anisotropic texture filtering is allowed or not.

bool

getRenderAlpha()
Returns whether an alpha should be exported.

bool

getRenderAnimation()
Returns whether animation export is turned on or off.

string

getRenderAnimationClip()
Returns the name of the clip to render.

vector<string>

getRenderAnimationClips()
Returns the names of the available clips in a scene.

0=Images, 1=Movie

getRenderAnimationFormat()
Returns the output format.

int

getRenderAnimationType()
Returns the type of the animation to render.

Vec3f

getRenderBackgroundColor()
Returns the background color.

string

getRenderFilename()
Returns the current image filename.

int

getRenderFps()
Returns the frames per second for rendering and animation.

int

getRenderFrameStep()
Returns the frame step for rendering and animation.

int

getRenderICCProfile()
Returns the ICC Profile Id.

int

getRenderMetaDataFlags()
Returns the meta data flags bitmask.

vector<string>

getRenderOutputFilenames()
Returns all filenames that will be created when rendering is started, i.e.

unsigned int

getRenderPNGQuality()
Returns the current quality for writing PNG files.

vector<string>

getRenderPasses()
Returns the names of the current active renderpasses.

float

getRenderPixelHeight()
Returns height of the image in pixels.

float

getRenderPixelPerInch()
Returns the number of pixels per inch.

float

getRenderPixelWidth()
Returns width of the image in pixels.

bool

getRenderPremultiply()
Returns whether premultiplied alpha should be used.

float

getRenderPrintHeight()
Returns height of the image in centimeter.

float

getRenderPrintWidth()
Returns width of the image in centimeter.

int

getRenderRegionEndX()
Returns the right x-coordinate of the render region.

int

getRenderRegionEndY()
Returns the top y-coordinate of the render region.

int

getRenderRegionStartX()
Returns the left x-coordinate of the render region.

int

getRenderRegionStartY()
Returns the lower y-coordinate of the render region.

int

getRenderStartFrame()
Returns the startframe for rendering an animation.

int

getRenderStopFrame()
Returns the stop frame for rendering an animation.

int

getRenderSupersampling()
Gets the image supersampling setting.

int

getRenderTimeInSeconds()
Returns the maximum render time in seconds.

bool

getRenderTonemapHDR()
Returns whether the image should be tonemapped when rendering to a HDR image format.

bool

getRenderUseClipRange()
Returns whether the clip range should be used.

vector<string>

getRenderVariantSetGroups()
Returns the names of all variant set groups used in the render settings.

vector<string>

getRenderVariantSets()
Returns the names of the variant sets used in this group.

string

getRenderView()
Returns the name of the active view.

unsigned int

getRenderingColorspace()
Returns the rendering colorspace used.

bool

getSpectralRaytracing()
Returns whether spectral raytracing is on or off.

bool

getUseInfiniteRenderInViewport()
Returns whether infinite rendering in renderview is on or off.

bool

getUseRenderPasses()
Returns whether the render passes export is active or not.

bool

getUseRenderRegion()
Returns whether the render region is active or not.

bool

getUseRenderTimeLimit()
If true, the render time limit is used.

bool

getUseRenderVariantSets()
Returns whether variant sets are used when rendering images.

bool

getUseRenderViewFromVariantSets()
Returns whether views can be changed by selecting variant sets.

removeRenderVariantSetGroup(groupName)
Removes a variant set group.

setActiveGPUMask(mask)
Sets the bitmask for gpus to use for gpu raytracing.

setBrdfMode(mode)
Sets the BRDF mode.

setDenoiseAlpha(denoiseAlpha)
Sets whether to denoise the alpha channel or not.

setDenoiseFilter(filterType)
Sets the denoise filter to use for raytracing.

setDenoiseFilterThreshold(value)
Deprecated

setDenoiserInput(type)
Enables the use of the albedo buffer when the deep learning denoiser is enabled.

setDenoiserModel(model)
Sets the denoiser model to use.

setDenoiserType(denoiserType)
Sets the denoiser type to use.

setEnableDenoiseFilter(on)
Deprecated, use setDenoiseFilter instead: Sets the CPU denoise filter for raytracing to on or off.

setIlluminant(illuminant)
Sets illuminant to be used as white for spectral raytracing.

setMaxClusterTileSize(tilesize)
Sets the maximum size of a tile for gpu clustering.

setNURBSRaytracing(on)
Sets NURBS raytracing on or off.

setOptimizationMode(mode)
Sets the optimization strategy to use for GPU raytracing.

setRaytracingAAAdaptiveSamples()
This function is deprecated.

setRaytracingAAImageFilter(id, width, height)
Sets the pixel filter to use during stillframe antialiasing.

setRaytracingAAInitialSamples()
This function is deprecated.

setRaytracingAAThreshold()
This function is deprecated.

setRaytracingAAThresholdQuality(threshold)
Sets the adaptive antialiasing quality level.

setRaytracingCausticPhotonRadius(radius)
Deprecated! Used to set the caustic photon lookup radius but it is no longer used.

setRaytracingClampValue(value)
Sets the reflection clamping for raytracing.

setRaytracingClampingEnable(state)
Enables output value clamping.

setRaytracingCores(numCores)
Sets the number of cores to use for raytracing.

setRaytracingDOFEnable()
Deprecated, Depth of Field is always on on a global level.

setRaytracingFinalGatherRadius(radius)
Sets the final gather radius.

setRaytracingFinalGathering(quality)
Sets the interactive and still frame final gathering quality to use.

setRaytracingImageSamples(samples)
Sets the number of anti-aliasing samples.

setRaytracingIndirectPhotonRadius(radius)
Deprecated! Sets the indirect photon lookup radius.

setRaytracingInteractiveFinalGatherQuality(quality)
Sets the interactive final gathering quality to use.

setRaytracingInteractiveIBLQuality(quality)
Sets the interactive ibl sampling quality level for raytracing.

setRaytracingInteractivePhotonCount(count)
Sets the number of photons emitted during interactive rendering.

setRaytracingInteractiveQuality(quality)
Sets the interactive quality level for raytracing.

setRaytracingInteractiveQualityMode(mode)
Sets the interactive quality mode for raytracing.

setRaytracingInteractiveTextureSharpness(sharpness)
Sets the sharpness factor for texture sampling in interactive mode (advanced feature).

setRaytracingInteractiveTraceDepth(depth)
Sets the interactive trace depth for raytracing.

setRaytracingLightEvaluationThreshold(threshold)
Sets the threshold used for culling lights in [0.0,1.0] range.

setRaytracingMode(mode)
Sets raytracing mode.

setRaytracingMotionBlurEnable()
Deprecated, Motion Blur is always on on a global level.

setRaytracingNURBSEpsilon(epsilon)
Sets the self-intersection tolerance for NURBS raytracing.

setRaytracingNURBSMaxDepthCurve(depth)
Sets the maximum subdivision depth of the trimming curves.

setRaytracingNURBSMaxDepthSurface(depth)
Sets the maximum subdivision depth of the acceleration data structure for the NURBS raytracing.

setRaytracingNURBSMinDepthCurve(depth)
Sets the minimum subdivision depth of the trimming curves.

setRaytracingNURBSMinDepthSurface(depth)
Sets the minimum subdivision depth of the acceleration data structure for the NURBS raytracing.

setRaytracingNURBSNewtonEpsilon(epsilon)
Sets the newton iteration tolerance for NURBS raytracing.

setRaytracingNURBSThresholdCurve(threshold)
Sets the curvature threshold for trimming curves.

setRaytracingNURBSThresholdSurface(threshold)
Sets the surface curvature threshold for NURBS raytracing.

setRaytracingNURBSUsePreclassification(enable)
Deprecated: Enables trimming curve pre-classification.

setRaytracingPhotonLookupCount(count)
Sets the minimum number of photons that need to be collected during a photon lookup.

setRaytracingPhotonMapFreezeMode(mode)
Sets the freeze mode for updating photon map.

setRaytracingPhotonMapRefreshMode(mode)
Sets the final gathering refresh mode.

setRaytracingPhotonMode(mode)
Sets the photon mapping mode to use.

setRaytracingPhotonRadius(radius)
Sets the photon lookup radius.

setRaytracingPhotonUseAutomaticRadius(on)
Sets whether the photon radius should be estimated automatically or not.

setRaytracingRenderRegion(xBegin, yBegin, xEnd, yEnd)
Sets the active render region in pixel coordinates.

setRaytracingRenderer()
Internal function.

setRaytracingSampleOffset(samplingOffset)
Sets the offset for the pixel sampling id (advanced feature).

setRaytracingSamplesThreshold(samples)
Sets samples threshold.

setRaytracingStillFrameFinalGatherQuality(quality)
Sets the still frame gathering quality to use.

setRaytracingStillFrameIBLQuality(quality)
Sets the still frame ibl sampling quality level for raytracing.

setRaytracingStillFramePhotonCount(count)
Sets the number of photons emitted during still frame antialiasing.

setRaytracingStillFrameQuality(quality)
Sets the still frame reflection/refraction quality level for raytracing.

setRaytracingStillFrameQualityMode(mode)
Sets the still frame quality mode for raytracing.

setRaytracingStillFrameSupersampling(factor)
Enables supersampling for stillframe rendering.

setRaytracingStillFrameTextureSharpness(sharpness)
Sets the sharpness factor for texture sampling (advanced feature).

setRaytracingStillFrameTraceDepth(depth)
Sets the still frame trace depth for raytracing.

setRaytracingUseFinalGatherForGlossy(enable)
Turns use of final gather map for glossy reflections on or off

setRaytracingUseHighQualityTextureFiltering(enable)
Enables high quality anisotropic texture filtering.

setRenderAlpha(state)
Enables export of images with an alpha channel.

setRenderAnimation(enable)
Enables rendering of an animation sequence.

setRenderAnimationClip(clipname)
Sets the name of the clip to render.

setRenderAnimationFormat(format)
Sets the output format.

setRenderAnimationType(type)
Sets the type of the animation to render.

setRenderBackgroundColor(r, g, b)
Sets the background color.

setRenderCurrentView()
Sets the view to use the current position.

setRenderFilename(filename)
Sets the filename to render to.

setRenderFps(fps)
Sets the frames per second for rendering and animation.

setRenderFrameStep(frame)
Sets the frame step for rendering and animation.

setRenderICCProfile(state)
Sets the ICC Profile to use when writing to a file.

setRenderMetaDataFlags(flags)
Sets the type of meta data to be embedded in a file.

setRenderPNGQuality(quality)
Sets the compression level for PNG images.

setRenderPasses(state)
Sets the active renderpasses by passing a list of pass names.

setRenderPixelResolution(pixelWidth, pixelHeight, pixelsPerInch)
Sets the print resolution.

setRenderPremultiply(state)
Enables premultiplied alpha.

setRenderPrintResolution(printWidth, printHeight, pixelsPerInch)
Sets the print resolution.

setRenderRegionEndX(state)
Sets right x-coordinate of the render region.

setRenderRegionEndY(state)
Sets top y-coordinate of the render region.

setRenderRegionStartX(state)
Sets left x-coordinate of the render region.

setRenderRegionStartY(state)
Sets the upper y-coordinate of the render region.

setRenderStartFrame(frame)
Sets the start frame for rendering and animation.

setRenderStopFrame(frame)
Sets the stop frame for rendering and animation.

setRenderSupersampling(state)
Enables antialiasing.

setRenderTimeInSeconds(timeInSeconds)
Sets the maximum render time in seconds.

setRenderTonemapHDR(state)
Enables tonemapping when rendering to a HDR image format.

setRenderUseClipRange(enable)
Uses the range of the chosen clip instead the start and stop frame range.

setRenderVariantSets(groupName, variantSetNames)
Sets the variant sets that should be used for the group.

setRenderView(viewName)
Sets the view with the given name.

setRenderingColorspace(renderingColorspace)
Sets the rendering colorspace to use.

setSpectralRaytracing(on)
Sets spectral raytracing on or off.

setUseInfiniteRenderInViewport(state)
Enables infinite rendering in the renderview.

setUseRaySplitting(on)
Enables raysplitting for glass and carpaint materials.

setUseRenderPasses(state)
Enables export of render passes when rendering to a file.

setUseRenderRegion(state)
Enables region rendering.

setUseRenderTimeLimit(state)
Enables rendering up to the maximum render time.

setUseRenderVariantSets(enable)
Enables rendering of variant sets.

setUseRenderViewFromVariantSets(enable)
Enables using of views in variant sets, i.e.

setUseTwoSampleImportanceSampling(on)
Enables use of two samples for multiple importance sampling.

startRenderToFile(alwaysOverride)
Starts rendering to file using the current render settings.

Function Details

addPreset(name)

Add preset to Render Queue.

Parameters:

name (string) - The name of the preset

applyPreset(name)

Apply preset in Render Queue .

Parameters:

name (string) - The name of the preset

generateRayFile(filename, numPhotons, maxDepth)

Generates a rayfile in ASCII format. Usage: Apply a diffuse black material to every object that is not supposed to reflect any light. Rays are stored on each diffuse hit at the moment.

Parameters:

filename (const char*) - The output filename for the generated rayfile.
numPhotons (unsigned int) - The number of photons to trace.
maxDepth (unsigned int) - The maximum number of bounces a photon can take.

getBrdfMode()

Returns the currently active BRDF mode.

Returns: int: 0 = Ver. 6.0x and below, 1 = Ver. 2014 and above, 2 = Energy Preserving GGX.

getDenoiseAlpha()

Returns whether to denoise the alpha channel or not.

Returns: bool: denoise the alpha channel.

getDenoiseFilter()

Returns the denoise filter used.

Returns: unsigned int: filtertype.

getDenoiseFilterThreshold()

Deprecated

Returns: double: The threshold value.

getDenoiserModel()

Returns the denoiser model used.

Returns: unsigned int: model.

getDenoiserType()

Returns the denoiser type used.

Returns: int: denoiser type.

getEnableDenoiseFilter()

Deprecated, use getDenoiseFilter instead: Returns whether the CPU denoise filter for raytracing is enabled or not.

Returns: bool: on/off.

getIlluminant()

Returns the illuminant id used.

Returns: int: illuminant id.

getNURBSRaytracing()

Returns whether NURBS raytracing is on or off.

Returns: bool: on/off.

getOptimizationMode()

Returns the optimization strategy used in GPU raytracing.

Returns: unsigned int: optimization mode.

getRaytracingAAImageFilterHeight()

Returns the height of the pixel filter in use.

Returns: float: pixel filter height.

getRaytracingAAImageFilterType()

Returns the pixel filter type in use.

Returns: int: pixel filter type id.

getRaytracingAAImageFilterWidth()

Returns the width of the pixel filterin use.

Returns: float: pixel filter width.

getRaytracingAAThresholdQuality()

Returns the adaptive antialiasing quality level.

Returns: int: threshold quality level.

getRaytracingClampValue()

Returns the clamping value.

Returns: float: clamping value.

getRaytracingClampingEnable()

Returns whether clamping is enabled or disabled.

Returns: bool: on/off.

getRaytracingCores()

Returns the number of cores to be used during raytracing.

Returns: int: The number of cores to be used during raytracing.

getRaytracingFinalGatherRadius()

Returns the final gather lookup radius.

Returns: float: lookup radius.

getRaytracingImageSamples()

Returns the number of anti-aliasing samples.

Returns: int: The number of image samples.

getRaytracingInteractiveFinalGatherQuality()

Returns the interactive final gather quality level.

Returns: int: quality level.

getRaytracingInteractiveIBLQuality()

Returns the interacitve ibl quality level in use.

Returns: int: quality level.

getRaytracingInteractivePhotonCount()

Returns the interactive photon count.

Returns: int: photon count.

getRaytracingInteractiveQuality()

Returns the interactive quality level in use.

Returns: int: quality level.

getRaytracingInteractiveQualityMode()

Returns the interactive quality mode in use.

Returns: int: quality mode.

getRaytracingInteractiveTextureSharpness()

Returns the sharpness scale factor for texture sampling during interacitve mode.

Returns: float: sharpness.

getRaytracingInteractiveTraceDepth()

Returns the interactive trace depth in use.

Returns: int: trace depth.

getRaytracingLightEvaluationThreshold()

Returns the threshold used for culling lights.

Returns: float: sharpness.

getRaytracingMode()

Returns the raytracing mode.

Returns: int: mode.

getRaytracingPhotonLookupCount()

Returns the photon lookup count.

Returns: int: photon count.

getRaytracingPhotonMapFreezeMode()

Gets the freeze mode for updating photon map.

Returns: int: The freeze mode: 0 = update photon map as normal, 1 = freeze the updating of photon map.

getRaytracingPhotonMapRefreshMode()

Returns final gathering refresh mode.

Returns: int: refresh mode.

getRaytracingPhotonMode()

Returns the photon mode.

Returns: int: photon mode.

getRaytracingPhotonRadius()

Returns the photon lookup radius.

Returns: float: lookup radius.

getRaytracingPhotonUseAutomaticRadius()

Returns the enable state of the automatic photon radius calculation.

Returns: bool: automatic photon radius calculation state.

getRaytracingSampleOffset()

Returns the sample offset to start the rendering. Usually this will be 0 unless you want to continue at a certain sample id.

Returns: int: sample offset.

getRaytracingSamplesThreshold()

Returns the samples threshold.

Returns: int: sample number.

getRaytracingStillFrameFinalGatherQuality()

Returns the stillframe final gather quality level.

Returns: int: quality level.

getRaytracingStillFrameIBLQuality()

Returns the stillframe ibl quality level in use.

Returns: int: quality level.

getRaytracingStillFramePhotonCount()

Returns the stillframe photon count.

Returns: int: photon count.

getRaytracingStillFrameQuality()

Returns the still frame reflection/refraction quality level in use.

Returns: int: quality level.

getRaytracingStillFrameQualityMode()

Returns the stillframe quality mode in use.

Returns: int: quality mode.

getRaytracingStillFrameSupersampling()

Returns the stillframe supersampling factor.

Returns: int: supersampling factor.

getRaytracingStillFrameTextureSharpness()

Returns the sharpness scale factor for texture sampling during stillframe mode.

Returns: float: sharpness.

getRaytracingStillFrameTraceDepth()

Returns the stillframe trace depth in use.

Returns: int: trace depth.

getRaytracingUseFinalGatherForGlossy()

Returns whether the final gather map should be used for glossy reflections.

Returns: bool: on/off.

getRaytracingUseHighQualityTextureFiltering()

Returns whether anisotropic texture filtering is allowed or not.

Returns: bool: on/off.

getRenderAlpha()

Returns whether an alpha should be exported.

Returns: bool: on/off.

getRenderAnimation()

Returns whether animation export is turned on or off.

Returns: bool: true/false.

getRenderAnimationClip()

Returns the name of the clip to render.

Returns: string: clipname.

getRenderAnimationClips()

Returns the names of the available clips in a scene.

Returns: vector<string>: clip names.

getRenderAnimationFormat()

Returns the output format.

Returns: 0=Images, 1=Movie: format.

getRenderAnimationType()

Returns the type of the animation to render.

Returns: int: format.

getRenderBackgroundColor()

Returns the background color.

Returns: Vec3f: A vector with r, g and b values.

getRenderFilename()

Returns the current image filename.

Returns: string: The filename of the image to render to.

getRenderFps()

Returns the frames per second for rendering and animation.

Returns: int: fps.

getRenderFrameStep()

Returns the frame step for rendering and animation.

Returns: int: step.

getRenderICCProfile()

Returns the ICC Profile Id.

Returns: int: id.

getRenderMetaDataFlags()

Returns the meta data flags bitmask.

Returns: int: flags.

getRenderOutputFilenames()

Returns all filenames that will be created when rendering is started, i.e. when using multiple viewpoints, animation frames or variant sets.

Returns: vector<string>: All names of files to be created.

getRenderPasses()

Returns the names of the current active renderpasses.

Returns: vector<string>: renderpasses.

getRenderPixelHeight()

Returns height of the image in pixels. Note that these are floating point values due to the print width used.

Returns: float: The height of the image in pixel.

getRenderPixelPerInch()

Returns the number of pixels per inch.

Returns: float: pixels per inch.

getRenderPixelWidth()

Returns width of the image in pixels. Note that these are floating point values due to the print width used.

Returns: float: The width of the image in pixel.

getRenderPremultiply()

Returns whether premultiplied alpha should be used.

Returns: bool: on/off.

getRenderPrintHeight()

Returns height of the image in centimeter.

Returns: float: The height of the image.

getRenderPrintWidth()

Returns width of the image in centimeter.

Returns: float: The width of the image.

getRenderRegionEndX()

Returns the right x-coordinate of the render region.

Returns: int: xEnd.

getRenderRegionEndY()

Returns the top y-coordinate of the render region.

Returns: int: yEnd.

getRenderRegionStartX()

Returns the left x-coordinate of the render region.

Returns: int: xStart.

getRenderRegionStartY()

Returns the lower y-coordinate of the render region.

Returns: int: xStart.

getRenderStartFrame()

Returns the startframe for rendering an animation.

Returns: int: frame.

getRenderStopFrame()

Returns the stop frame for rendering an animation.

Returns: int: frame.

getRenderSupersampling()

Gets the image supersampling setting.

Returns: int: on/off.

getRenderTimeInSeconds()

Returns the maximum render time in seconds.

Returns: int: time in seconds.

getRenderTonemapHDR()

Returns whether the image should be tonemapped when rendering to a HDR image format.

Returns: bool: on/off.

getRenderUseClipRange()

Returns whether the clip range should be used.

Returns: bool: true/false.

getRenderVariantSetGroups()

Returns the names of all variant set groups used in the render settings.

Returns: vector<string>: List of group names.

getRenderVariantSets()

Returns the names of the variant sets used in this group.

Returns: vector<string>: List of variant set names.

getRenderView()

Returns the name of the active view.

Returns: string: Name of the view.

getRenderingColorspace()

Returns the rendering colorspace used.

Returns: unsigned int: renderingColorspace.

getSpectralRaytracing()

Returns whether spectral raytracing is on or off.

Returns: bool: on/off.

getUseInfiniteRenderInViewport()

Returns whether infinite rendering in renderview is on or off.

Returns: bool: on/off.

getUseRenderPasses()

Returns whether the render passes export is active or not.

Returns: bool: on/off.

getUseRenderRegion()

Returns whether the render region is active or not.

Returns: bool: on/off.

getUseRenderTimeLimit()

If true, the render time limit is used. Otherwise the number of image samples is used.

Returns: bool: on/off.

getUseRenderVariantSets()

Returns whether variant sets are used when rendering images.

Returns: bool: true/false.

getUseRenderViewFromVariantSets()

Returns whether views can be changed by selecting variant sets.

Returns: bool: true/false.

removeRenderVariantSetGroup(groupName)

Removes a variant set group.

Parameters:

groupName (string) - Name of variant set group to be removed.

setActiveGPUMask(mask)

Sets the bitmask for gpus to use for gpu raytracing. This must be set before gpu raytracing is activated.

Parameters:

mask (unsigned int) - bitmask for the active gpus.

setBrdfMode(mode)

Sets the BRDF mode. 0 = Ver. 6.0x and below, 1 = Ver. 2014 and above, 2 = Energy Preserving GGX.

Parameters:

mode (int) - brdf mode id.

setDenoiseAlpha(denoiseAlpha)

Sets whether to denoise the alpha channel or not.

Parameters:

denoiseAlpha (bool) - true: denoise the alpha channel, false: just copy the alpha channel.

setDenoiseFilter(filterType)

Sets the denoise filter to use for raytracing.

Parameters:

filterType (unsigned int) - 0 = Off, 2 = AI Denoiser stillframe only, 3 = AI Denoiser Always.

setDenoiseFilterThreshold(value)

Deprecated

Parameters:

value (double) - The threshold value.

setDenoiserInput(type)

Enables the use of the albedo buffer when the deep learning denoiser is enabled.

Parameters:

type (int) - 0=color only, 1 = color and albedo, 2 = color, albedo and normal.

setDenoiserModel(model)

Sets the denoiser model to use.

Parameters:

model (unsigned int) - 0 = Default model, 1 = Lightmap model if available, 2 = AOV model if available.

setDenoiserType(denoiserType)

Sets the denoiser type to use.

Parameters:

denoiserType (int) - 0 = GPU/Auto, 1 = CPUs.

setEnableDenoiseFilter(on)

Deprecated, use setDenoiseFilter instead: Sets the CPU denoise filter for raytracing to on or off.

Parameters:

on (bool) - On/Off switch.

setIlluminant(illuminant)

Sets illuminant to be used as white for spectral raytracing. The XYZ-Illuminant does not convert the rendered image to RGB but outputs the XYZ values instead.

Parameters:

illuminant (int) - 0 = Equal Energy, 1 = D65, 2 = XYZ.

setMaxClusterTileSize(tilesize)

Sets the maximum size of a tile for gpu clustering.

Parameters:

tilesize (int) - tilesize, must be between 32 and 256.

setNURBSRaytracing(on)

Sets NURBS raytracing on or off. If off, the tessellated meshes will be used during raytracing. If on, the NURBS surfaces will be traced directly.

Parameters:

on (bool) - On/Off switch.

setOptimizationMode(mode)

Sets the optimization strategy to use for GPU raytracing.

Parameters:

mode (unsigned int) - 0 = prefer performance, 1 = optimize memory usage.

setRaytracingAAImageFilter(id, width, height)

Sets the pixel filter to use during stillframe antialiasing.

Parameters:

id (int) - The filter id in [0,9]: (Box, Triangle, Gaussian, Mitchell, Lanczos, BSpline, Catmull-Rom, Sharp Triangle, Sharp Gaussian, Sharp BSpline).
width (float) - The filter width in [0.5,5.0].
height (float) - The filter height in [0.5,5.0].

setRaytracingAAThresholdQuality(threshold)

Sets the adaptive antialiasing quality level.

Parameters:

threshold (int) - The threshold quality level in [0,5].

setRaytracingCausticPhotonRadius(radius)

Deprecated! Used to set the caustic photon lookup radius but it is no longer used. Use setRaytracingPhotonRadius instead.

Parameters:

radius (float) - The caustic photon lookup radius.

setRaytracingClampValue(value)

Sets the reflection clamping for raytracing.

Parameters:

value (float) - The clamping value.

setRaytracingClampingEnable(state)

Enables output value clamping.

Parameters:

state (bool) - Clamping: On/Off.

setRaytracingCores(numCores)

Sets the number of cores to use for raytracing.

Parameters:

numCores (int) - The number of cores in [0, 1024].

setRaytracingFinalGatherRadius(radius)

Sets the final gather radius.

Parameters:

radius (float) - The final gather radius.

setRaytracingFinalGathering(quality)

Sets the interactive and still frame final gathering quality to use. This function should be considered obsolete, use setRaytracingInteractiveFinalGatherQuality and setRaytracingStillFrameFinalGatherQuality instead.

Parameters:

quality (int) - The final gather quality: 0 = off, 1 = 1, 2 = 4, 3 = 8, 4 = 16 Final Gather rays per sample.

setRaytracingImageSamples(samples)

Sets the number of anti-aliasing samples.

Parameters:

samples (int) - The total number of image samples.

setRaytracingIndirectPhotonRadius(radius)

Deprecated! Sets the indirect photon lookup radius.

Parameters:

radius (float) - The indirect photon lookup radius.

setRaytracingInteractiveFinalGatherQuality(quality)

Sets the interactive final gathering quality to use.

Parameters:

quality (int) - The final gather quality: 0 = off, 1 = 1, 2 = 4, 3 = 8, 4 = 16 Final Gather rays per sample.

setRaytracingInteractiveIBLQuality(quality)

Sets the interactive ibl sampling quality level for raytracing.

Parameters:

quality (int) - The quality level in [0,4].

setRaytracingInteractivePhotonCount(count)

Sets the number of photons emitted during interactive rendering.

Parameters:

count (int) - The number of photons.

setRaytracingInteractiveQuality(quality)

Sets the interactive quality level for raytracing.

Parameters:

quality (int) - The quality level in [0,4].

setRaytracingInteractiveQualityMode(mode)

Sets the interactive quality mode for raytracing. Valid values are : Precomputed = -1 Precomputed + Reflections = 0 Precomputed + Shadows = 1 Precomputed + IBL = 2 Full Global Illumination = 3

Parameters:

mode (int) - The quality mode in [-1,3].

setRaytracingInteractiveTextureSharpness(sharpness)

Sets the sharpness factor for texture sampling in interactive mode (advanced feature). WARNING: Changing this settings may lead to rendering artifacts!

Parameters:

sharpness (float) - The sharpness factor.

setRaytracingInteractiveTraceDepth(depth)

Sets the interactive trace depth for raytracing.

Parameters:

depth (int) - The maximum trace depth.

setRaytracingLightEvaluationThreshold(threshold)

Sets the threshold used for culling lights in [0.0,1.0] range. Lower values are more accurate, higher values increase performance.

Parameters:

threshold (float) - The threshold value.

setRaytracingMode(mode)

Sets raytracing mode.

Parameters:

mode (int) - 0 = CPU, 1 = GPU.

setRaytracingNURBSEpsilon(epsilon)

Sets the self-intersection tolerance for NURBS raytracing.

Parameters:

epsilon (float) - The tolerance value.

setRaytracingNURBSMaxDepthCurve(depth)

Sets the maximum subdivision depth of the trimming curves.

Parameters:

depth (int) - The maximum depth.

setRaytracingNURBSMaxDepthSurface(depth)

Sets the maximum subdivision depth of the acceleration data structure for the NURBS raytracing.

Parameters:

depth (int) - The maximum depth.

setRaytracingNURBSMinDepthCurve(depth)

Sets the minimum subdivision depth of the trimming curves.

Parameters:

depth (int) - The minimum depth.

setRaytracingNURBSMinDepthSurface(depth)

Sets the minimum subdivision depth of the acceleration data structure for the NURBS raytracing.

Parameters:

depth (int) - The minimum depth.

setRaytracingNURBSNewtonEpsilon(epsilon)

Sets the newton iteration tolerance for NURBS raytracing.

Parameters:

epsilon (float) - The tolerance value.

setRaytracingNURBSThresholdCurve(threshold)

Sets the curvature threshold for trimming curves.

Parameters:

threshold (float) - The threshold.

setRaytracingNURBSThresholdSurface(threshold)

Sets the surface curvature threshold for NURBS raytracing.

Parameters:

threshold (float) - The threshold.

setRaytracingNURBSUsePreclassification(enable)

Deprecated: Enables trimming curve pre-classification.

Parameters:

enable (bool) - Pre-classification: On/Off.

setRaytracingPhotonLookupCount(count)

Sets the minimum number of photons that need to be collected during a photon lookup. It less photons are collected, the lookup radius is increased.

Parameters:

count (int) - The number of photons to be collected. Default is 16.

setRaytracingPhotonMapFreezeMode(mode)

Sets the freeze mode for updating photon map.

Parameters:

mode (int) - The freeze mode: 0 = update photon map as normal, 1 = freeze the updating of photon map.

setRaytracingPhotonMapRefreshMode(mode)

Sets the final gathering refresh mode.

Parameters:

mode (int) - The refresh mode: 0 = refresh photon map on each image sample, 1 = refresh the photon map only when necessary.

setRaytracingPhotonMode(mode)

Sets the photon mapping mode to use.

Parameters:

mode (int) - The photon mapping mode: 0 = off, 1 = indirect only, 2 = indirect + caustics.

setRaytracingPhotonRadius(radius)

Sets the photon lookup radius.

Parameters:

radius (float) - The indirect photon lookup radius.

setRaytracingPhotonUseAutomaticRadius(on)

Sets whether the photon radius should be estimated automatically or not.

Parameters:

on (bool) - The state of the automatic photon radius calculation.

setRaytracingRenderRegion(xBegin, yBegin, xEnd, yEnd)

Sets the active render region in pixel coordinates.

Parameters:

xBegin (float) - The relative x start coordinate in [0.0,1.0].
yBegin (float) - The relative y start coordinate in [0.0,1.0].
xEnd (float) - The relative x end coordinate in [0.0,1.0].
yEnd (float) - The relative y end coordinate in [0.0,1.0].

setRaytracingSampleOffset(samplingOffset)

Sets the offset for the pixel sampling id (advanced feature). This allows to use some sort of manual image refinement be offsetting the starting sample of the computation and merging the final image with a previous render.

Parameters:

samplingOffset (int) - The offset.

setRaytracingSamplesThreshold(samples)

Sets samples threshold. With this sample number the rendering gets updated.

Parameters:

samples (int) - sample number.

setRaytracingStillFrameFinalGatherQuality(quality)

Sets the still frame gathering quality to use.

Parameters:

quality (int) - The final gather quality: 0 = off, 1 = 1, 2 = 4, 3 = 8, 4 = 16 Final Gather rays per sample.

setRaytracingStillFrameIBLQuality(quality)

Sets the still frame ibl sampling quality level for raytracing.

Parameters:

quality (int) - The quality level in [0,4].

setRaytracingStillFramePhotonCount(count)

Sets the number of photons emitted during still frame antialiasing.

Parameters:

count (int) - The number of photons.

setRaytracingStillFrameQuality(quality)

Sets the still frame reflection/refraction quality level for raytracing.

Parameters:

quality (int) - The quality level in [0,4].

setRaytracingStillFrameQualityMode(mode)

Sets the still frame quality mode for raytracing. Valid values are: Precompute = -1 Precomputed + Reflections = 0 Precomputed + Shadows = 1 Precomputed + IBL = 2 Full Global Illumination = 3

Parameters:

mode (int) - The quality mode in [-1,3].

setRaytracingStillFrameSupersampling(factor)

Enables supersampling for stillframe rendering. This is usefull for reducing jagged edges but requires factor * factor times more memory for the framebuffer so it should only be used when really needed.

Parameters:

factor (int) - set still frame supersampling factor. 1 is off.

setRaytracingStillFrameTextureSharpness(sharpness)

Sets the sharpness factor for texture sampling (advanced feature). WARNING: Changing this settings may lead to rendering artifacts!

Parameters:

sharpness (float) - The sharpness factor.

setRaytracingStillFrameTraceDepth(depth)

Sets the still frame trace depth for raytracing.

Parameters:

depth (int) - The maximum trace depth.

setRaytracingUseFinalGatherForGlossy(enable)

Turns use of final gather map for glossy reflections on or off

Parameters:

enable (bool) - final gather glossy lookup: On/Off.

setRaytracingUseHighQualityTextureFiltering(enable)

Enables high quality anisotropic texture filtering. This can slow down rendering performance quite a bit..

Parameters:

enable (bool) - high quality anisotropic texture filtering: On/Off.

setRenderAlpha(state)

Enables export of images with an alpha channel.

Parameters:

state (bool) - On/Off.

setRenderAnimation(enable)

Enables rendering of an animation sequence.

Parameters:

enable (bool) - on/off.

setRenderAnimationClip(clipname)

Sets the name of the clip to render.

Parameters:

clipname (string) - name of the clip.

setRenderAnimationFormat(format)

Sets the output format. 0=Images, 1 = Movie.

Parameters:

format (int) - on/off.

setRenderAnimationType(type)

Sets the type of the animation to render. 0=Clip, 1=Timeline.

Parameters:

type (int) - 0=Clip, 1=Timeline.

setRenderBackgroundColor(r, g, b)

Sets the background color.

Parameters:

r (float) - The red background color.
g (float) - The green background color.
b (float) - The blue background color.

setRenderFilename(filename)

Sets the filename to render to.

Parameters:

filename (string) - filename .

setRenderFps(fps)

Sets the frames per second for rendering and animation.

Parameters:

fps (int) - frames per second.

setRenderFrameStep(frame)

Sets the frame step for rendering and animation.

Parameters:

frame (int) - step.

setRenderICCProfile(state)

Sets the ICC Profile to use when writing to a file. 0 = current scene settings, 1 = sRGB, 2 = AdobeRGB, 3 = Specified Monitor ICC Profile, 4 = Specified Image ICC Profile.

Parameters:

state (int) - icc profile id.

setRenderMetaDataFlags(flags)

Sets the type of meta data to be embedded in a file. Image formats supporting meta data are png, jpg, tif and exr. The types are set by a bitmask with the following bit values: CAMERA_DATA = 1 SCENEGRAPH_VISIBILITY_STATE = 1 << 1 SCENEGRAPH_SWITCH_CHOICE_STATE = 1 << 2 FILEOUTPUT_IMAGE_SETTINGS = 1 << 3 FILEOUTPUT_ANIMATION_SETTINGS = 1 << 4 FILEOUTPUT_RENDERPASSES_SETTINGS = 1 << 5 RAYTRACING_SETTINGS = 1 << 6 SWITCH_MATERIAL_CHOICE_STATE = 1 << 7 FILEOUTPUT_IMAGE_SETTINGS | FILEOUTPUT_ANIMATION_SETTINGS | FILEOUTPUT_RENDERPASSES_SETTINGS | RAYTRACING_SETTINGS

Parameters:

flags (int) - Bitmask for the metadata to embedded.

setRenderPNGQuality(quality)

Sets the compression level for PNG images. Valid values range from 0 to 9. Default is 1.

Parameters:

quality (int) - pixel coordinate.

setRenderPasses(state)

Sets the active renderpasses by passing a list of pass names. This modifies the current scene settings and is used when calling startRenderToFile command. Valid passes are: beauty, diffuse_ibl, diffuse_light, glossy_ibl, glossy_light, specular_reflection, translucency, incandescence, diffuse_indirect, glossy_indirect, diffuse_color, glossy_color, specular_color, translucency_color, transparency_color, background_color, diffuse_ibl_illumination, glossy_ibl_illumination, translucency_ibl_illumination, diffuse_light_illumination, glossy_light_illumination, translucency_light_illumination, diffuse_indirect_illumination, glossy_indirect_illumination, specular_indirect_illumination, translucency_indirect_illumination, volume_color, fog, lens_flare, occlusion, albedo, normal, camera_normal, depth, materialID, mask, position, view, cryptoObjectMatte, cryptoMaterialMatte, frontplates, backplates.

Parameters:

state (vector<string>) - passes.

setRenderPixelResolution(pixelWidth, pixelHeight, pixelsPerInch)

Sets the print resolution.

Parameters:

pixelWidth (float) - The width of the image in pixel.
pixelHeight (float) - The height of the image in pixel.
pixelsPerInch (float) - The number of pixels per inch.

setRenderPremultiply(state)

Enables premultiplied alpha.

Parameters:

state (bool) - On/Off.

setRenderPrintResolution(printWidth, printHeight, pixelsPerInch)

Sets the print resolution.

Parameters:

printWidth (float) - The width of the image in centimeter.
printHeight (float) - The height of the image in centimeter.
pixelsPerInch (float) - The number of pixels per inch.

setRenderRegionEndX(state)

Sets right x-coordinate of the render region.

Parameters:

state (int) - pixel coordinate.

setRenderRegionEndY(state)

Sets top y-coordinate of the render region.

Parameters:

state (int) - pixel coordinate.

setRenderRegionStartX(state)

Sets left x-coordinate of the render region.

Parameters:

state (int) - pixel coordinate.

setRenderRegionStartY(state)

Sets the upper y-coordinate of the render region.

Parameters:

state (int) - pixel coordinate.

setRenderStartFrame(frame)

Sets the start frame for rendering and animation.

Parameters:

frame (int) - startframe.

setRenderStopFrame(frame)

Sets the stop frame for rendering and animation.

Parameters:

frame (int) - stopframe.

setRenderSupersampling(state)

Enables antialiasing.

Parameters:

state (int) - 0=Off, Else=On.

setRenderTimeInSeconds(timeInSeconds)

Sets the maximum render time in seconds.

Parameters:

timeInSeconds (int) - time in seconds.

setRenderTonemapHDR(state)

Enables tonemapping when rendering to a HDR image format.

Parameters:

state (bool) - On/Off.

setRenderUseClipRange(enable)

Uses the range of the chosen clip instead the start and stop frame range.

Parameters:

enable (bool) - on/off.

setRenderVariantSets(groupName, variantSetNames)

Sets the variant sets that should be used for the group.

Parameters:

groupName (string) - Name of variant set group.
variantSetNames (vector<string>) - List of variant set names.

setRenderView(viewName)

Sets the view with the given name.

Parameters:

viewName (string) - Name of the view to be used.

setRenderingColorspace(renderingColorspace)

Sets the rendering colorspace to use.

Parameters:

renderingColorspace (unsigned int) - 0 = scene-linear Rec.709, 1 = ACEScg, 2 = DCI P3-D65 3 = scene-linear Rec.2020.

setSpectralRaytracing(on)

Sets spectral raytracing on or off.

Parameters:

on (bool) - On/Off switch.

setUseInfiniteRenderInViewport(state)

Enables infinite rendering in the renderview.

Parameters:

state (bool) - On/Off.

setUseRaySplitting(on)

Enables raysplitting for glass and carpaint materials.

Parameters:

on (bool) - true of false.

setUseRenderPasses(state)

Enables export of render passes when rendering to a file.

Parameters:

state (bool) - On/Off.

setUseRenderRegion(state)

Enables region rendering.

Parameters:

state (bool) - On/Off.

setUseRenderTimeLimit(state)

Enables rendering up to the maximum render time.

Parameters:

state (bool) - On/Off.

setUseRenderVariantSets(enable)

Enables rendering of variant sets.

Parameters:

enable (bool) - on/off.

setUseRenderViewFromVariantSets(enable)

Enables using of views in variant sets, i.e. applying a variant set may also change the view

Parameters:

enable (bool) - on/off.

setUseTwoSampleImportanceSampling(on)

Enables use of two samples for multiple importance sampling.

Parameters:

on (bool) - true of false.

startRenderToFile(alwaysOverride)

Starts rendering to file using the current render settings. (This command is only available in VRED Professional.)

Parameters:

alwaysOverride (bool) - If true, files will be overwritten without warning.