vrdTextureBakeSettings

class vrdTextureBakeSettings

(Inherits vrdData)

Settings for texture baking with vrBakeService.bakeToTexture(geometryNodes, illuminationSettings, textureSettings, replaceTextureBake).

Functions

vrdTextureBakeSettings.getDenoiserType()
Returns:The used denoiserType.
Return type:vrBakeTypes.DenoiserType
vrdTextureBakeSettings.getEdgeDilation()
Returns:The edge dilation in pixels.
Return type:integer
vrdTextureBakeSettings.getExternalReferenceLocation()
Returns:The external reference location path.
Return type:string
vrdTextureBakeSettings.getHideTransparentObjects()
Returns:True if transparent objects should be hidden, False otherwise.
Return type:bool
vrdTextureBakeSettings.getMaximumResolution()
Returns:The maximum resolution in pixels.
Return type:integer
vrdTextureBakeSettings.getMinimumResolution()
Returns:The minimum resolution in pixels.
Return type:integer
vrdTextureBakeSettings.getRenderer()
Returns:The used raytracing renderer.
Return type:vrBakeTypes.Renderer
vrdTextureBakeSettings.getSamples()
Returns:The number of samples.
Return type:integer
vrdTextureBakeSettings.getShareLightmapsForClones()
Returns:True if lightmaps should be shared, False otherwise
Return type:bool
vrdTextureBakeSettings.getTexelDensity()
Returns:The texel density.
Return type:float
vrdTextureBakeSettings.getUseDenoising()
Returns:True if denoising is used, False otherwise.
Return type:bool
vrdTextureBakeSettings.getUseExistingResolution()
Returns:True if an existing resolution should be used, False otherwise.
Return type:bool
vrdTextureBakeSettings.setDenoiserType(denoiserType)

Sets which denoiser type is used to denoise the lightmaps.

Parameters:denoiserType (vrBakeTypes.DenoiserType) – The used denoiserType.
vrdTextureBakeSettings.setEdgeDilation(value)

Sets the edge dilation in pixels.

Sets the number of pixels the valid bake areas will be extended by. This is necessary to prevent the rendering of black seams at UV island borders.

Parameters:value (integer) – Number of pixels.
vrdTextureBakeSettings.setExternalReferenceLocation(value)

Sets an external reference location.

The external reference location is a path to a folder were the lightmap texture will be stored after the baking is done. In that case the lightmap texture is externally referenced. If no external reference location is set, the lightmap texture will exist only within the project file.

Parameters:value (string) – A path where the lightmap will be stored.
vrdTextureBakeSettings.setHideTransparentObjects(value)

Sets if transparent objects should be hidden.

This option controls if objects with transparent materials will be hidden during the lightmap calculation process. When hidden, they do not have any effect on the light and shadow calculation.

Parameters:value (bool) – True for hiding transparent objects, False otherwise.
vrdTextureBakeSettings.setMaximumResolution(value)

Sets the maximum resolution for the lightmap.

- Equal values for minimum and maximum resolution will
enforce a fixed resolution.
- Otherwise a resolution between minimum and maximum is
automatically calculated.
Parameters:value (integer) – Number of pixels.
vrdTextureBakeSettings.setMinimumResolution(value)

Sets the minimum resolution for the lightmap.

- Equal values for minimum and maximum resolution will
enforce a fixed resolution.
- Otherwise a resolution between minimum and maximum is
automatically calculated.
Parameters:value (integer) – Number of pixels.
vrdTextureBakeSettings.setRenderer(renderer)

Sets which raytracing renderer is used to generate the lightmaps.

Parameters:renderer (vrBakeTypes.Renderer) – The used raytracing renderer.
vrdTextureBakeSettings.setSamples(value)

Sets the number of samples.

The number of samples per pixel defines the quality of the lightmap. The higher the number, the better the quality but the longer the calculation.

Parameters:value (integer) – The number of samples.
vrdTextureBakeSettings.setShareLightmapsForClones(shareLightmaps)

Sets if given clones will share the same lightmap or if separate lightmaps will be created for each clone.

Parameters:shareLightmaps (bool) – True for sharing lightmaps, False otherwise
vrdTextureBakeSettings.setTexelDensity(value)

Sets the texel density in pixels per meter.

The texel density is used for the automatic lightmap resolution calculation. The lightmap resolution will be calculated using this value and the object’s size as well as the covered UV space, clamped by the minimum and maximum resolution.

Parameters:value (float) – The texel density.
vrdTextureBakeSettings.setUseDenoising(value)

Sets if denoising should be used or not.

Denoising is a post-process of the final lightmap texture and tries to reduce noise based on AI algorithms.

Parameters:value (bool) – True for use of denoising, False otherwise.
vrdTextureBakeSettings.setUseExistingResolution(value)

Sets if an existing lightmap resolution should be kept.

If the geometry already has a valid lightmap, its resolution is used for the new bake process.

Parameters:value (bool) – True for using an existing resolution, False otherwise.
vrdTextureBakeSettings.vrdTextureBakeSettings()

Default constructor.