This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Clouds

This section contains settings for clouds.

Clouds Settings

Common#

Enable Clouds The value indicating if rendering of clouds is enabled. enabled by default.
Console access: render_clouds_enabled (API control)
Ground Shadows The value indicating if rendering of shadows from the clouds on the ground is enabled. enabled by default.
Console access: render_clouds_ground_shadows (API control)
Accurate Layers Sorting The value indicating if correct sorting of intersecting cloud layers is enabled.
Notice
Enabling this feature may reduce raymarching quality as samples shall be distributed among all layers.
disabled by default.
Console access: render_clouds_accurate_layers_sorting (API control)
Cutout By Far Clipping The value indicating if far-plane clipping is used for clouds visibility.

Controlling clouds visibility by increasing the far-plane distance significantly affects performance in many aspects (dynamic Environment Probes, etc.). You can disable this option when necessary as an optimization.

enabled by default.
Console access: render_clouds_far_clipping (API control)
Transparent Order The rendering order for clouds relative to transparent objects (except water).
  • Render Before Transparent — render clouds before all transparent objects (except water).
  • Render After Transparent — render clouds after all transparent objects (except water).
  • Sort Transparent — enable rough sorting for transparent objects relative to clouds (below the lowest cloud layer base -> inside the clouds -> above the highest cloud layer top).
Option #1 is selected by default (see above).
Console access: render_clouds_transparent_order (API control)
Detail Distortion The value indicating which texture type is used for clouds distortion at the moment. This parameter has a significant impact on performance:
  • 2D Texture — more performance-friendly, but may cause an excessive vertical extrusion of clouds.
  • 3D Texture — ensures homogeneous detail distortion and better image quality, but at a higher performance cost.
Option #1 is selected by default (see above).
Console access: render_clouds_distortion_texture (API control)
Soft Intersection The soft intersection distance for clouds, in meters.
Range of values: [0.0f, 100000.0f]. The default value is 100.0f.
Console access: render_clouds_soft_intersection (API control)

Quality#

Clouds quality rendering settings

Preset The index of the clouds quality preset used at the moment. One of the following values:
  • Low (by default)
  • Medium
  • High + Interleaved
  • High
  • Ultra + Interleaved
  • Ultra
  • Extreme + Interleaved
  • Extreme
  • Custom

Console access: render_clouds_quality_preset (API control)
Notice
Presets override user-defined custom settings. When any preset other than Custom is active, modification of the parameters via API has no effect. The parameter value set via the last API call shall be used only when the Custom preset is active. When checking the current parameter value via API, you'll get the corresponding setting stored in the active preset (default or custom one).

Customizable Settings#

The following settings are available when the Custom preset is selected.

Clouds quality custom settings

Clouds Quality Settings
Sampling Quality The sampling quality for clouds. This parameter sets the number of noise samples that affects the cloud shape processing quality. The higher the value, the less are visual artifacts. The following modes are available:
  • Low — 1 sample, low quality (higher cloud density)
  • Medium — 3 samples, medium quality
  • High — 5 samples, high quality
  • Ultra — 6 samples, ultra quality (lower density, the clouds are softer)
Notice
Visual difference between low and ultra quality is not significant. Therefore, it is recommended to use low settings, when possible, to gain performance.
Option #2 is selected by default (see above).
Console access: render_clouds_sampling_quality (API control)
Lighting Quality The lighting quality for clouds. This parameter determines the number of samples used to calculate lighting for clouds. The following values are available:
  • Low — 1 sample, low quality
  • Medium — 3 samples, medium quality
  • High — 5 samples, high quality
  • Ultra — 6 samples, ultra quality
Notice
This parameter has a significant impact on performance. Therefore, it is recommended to use low settings, when possible.
Option #2 is selected by default (see above).
Console access: render_clouds_lighting_quality (API control)
Samples Count The number of samples used for clouds rendering. The higher the value, the less noise in clouds rendering. The following values are available:
  • Low — 1 sample, low quality
  • Medium — 3 samples, medium quality
  • High — 5 samples, high quality
  • Ultra — 6 samples, ultra quality
Option #3 is selected by default (see above).
Console access: render_clouds_samples_count (API control)
Step Accuracy The accuracy of ray marching steps. This parameter enables you to improve the visual look of clouds when viewed from inside a cloud layer. It reduces the noise of lighting and clouds shape for long ray marching distances, adds some noise-based blur to a sharp border at the bottom sphere of the cloud layer (rounded) and removes popping effect when leaving a rounded cloud layer. Higher values provide more accurate form and less noise, while lower ones gain more performance.
Range of values: [0.0f, 1.0f]. The default value is 0.5f.
Console access: render_clouds_step_accuracy (API control)
Downsampling Rendering The downsampling rendering mode for clouds. This parameter determines clouds resolution based on current screen resolution.
Notice
This parameter has a significant impact on performance.
One of the following values:
  • Quarter - quarter resolution
  • Half - half resolution (by default)
  • Full - full resolution

Console access: render_clouds_downsampling_rendering (API control)
Interleaved Rendering The interleaved rendering mode for clouds. In cases when clouds are viewed from the ground, or from above (at significant distance) and viewer's velocities are less than 200 units per second, this parameter can be used to provide a significant gain in performance. One of the following values:
  • Disabled (by default)
  • 2×2
  • 4×4
  • 8×8

Console access: render_clouds_interleaved_rendering (API control)
Depth Based Reconstruction The value indicating if clouds ray-marched depth is used for upsampling the downsampled clouds without obscuring the geometry and reprojection depending on the cloud depth. Recommended for flying through clouds.
Notice
Works only with the clouds downsampling rendering mode set to half and/or the clouds interleaved rendering mode set to 2x2.
disabled by default.
Console access: render_clouds_depth_based_reconstruction (API control)
Interleaved Rendering Temporal The value indicating if temporal accumulation of noises for interleaved sampling for clouds is enabled.
Notice
Works only when the clouds interleaved rendering mode is set to 2x2.
enabled by default.
Console access: render_clouds_interleaved_rendering_temporal (API control)
Depth Based Reconstruction Threshold The depth threshold value for clouds depth-based reconstruction mode. This value defines the depth difference starting from which pixels are considered to be related to different surfaces.
Range of values: [0.0f, inf]. The default value is 100.0f.
Console access: render_clouds_depth_based_reconstruction_threshold (API control)
Noise Step The value of the noise step parameter for clouds. This parameter determines the amount of jitter in the areas within clouds, that is used to reduce banding effect due to insufficient number of steps.
Range of values: [0.0f, 1.0f]. The default value is 0.3f.
Console access: render_clouds_noise_step (API control)
Noise Iterations The value of the noise iterations parameter for clouds. This parameter determines the amount of jitter in the areas within clouds, that is used to reduce banding effect due to insufficient number of steps.
Range of values: [0.0f, 1.0f]. The default value is 0.1f.
Console access: render_clouds_noise_iterations (API control)
Noise Lighting The value of the noise lighting parameter for the clouds. This parameter determines the amount of jitter for tracing steps of lighting calculation, that is used to reduce banding effect due to insufficient number of steps.
Range of values: [0.0f, 1.0f]. The default value is 0.3f.
Console access: render_clouds_noise_lighting (API control)
Noise Step Skip The value of the noise step skip parameter for clouds. This parameter determines the amount of jitter in the areas between clouds, that is used to reduce banding effect due to insufficient number of steps.
Range of values: [0.0f, 1.0f]. The default value is 0.3f.
Console access: render_clouds_noise_step_skip (API control)

Lighting#

Lighting Trace Length The lighting trace length for clouds. This parameter determines the maximum length of a sun ray inside a cloud.
Range of values: [1.0f, 2048.0f]. The default value is 230.0f.
Console access: render_clouds_lighting_tracelength (API control)
Lighting Cone Radius The lighting cone sampling radius for clouds lighting.
Notice
Low values may result in unnatural behavior as the position of the sun changes.

Range of values: [0.0f, 1.0f]. The default value is 0.3f.
Console access: render_clouds_lighting_cone_radius (API control)
Lighting Samples Distribution The value that controls distribution of samples for clouds lighting. Can be used to keep small details for long shadows when the lighting trace length value is high.
Range of values: [0.001f, 5.0f]. The default value is 1.0f.
Console access: render_clouds_lighting_samples_distribution (API control)

Rounded#

Enable Rounded The value indicating if cloud layers are to be curved to make them look more natural imitating planet's curvature. enabled by default.
Console access: render_clouds_rounded (API control)

Planet Radius The radius of the planet to be used for clouds curving. Visual curving can be used to make clouds look more natural imitating planet's curvature.
Range of values: [100.0f, inf]. The default value is 200000.0f.
Console access: render_clouds_rounded_planet_radius (API control)

Dynamic Coverage#

Dynamic Coverage Resolution The the value defining the size of the square dynamic coverage resolution texture for clouds, in pixels. This parameter determines the quality of dynamic coverage texture for FieldWeather objects. Higher values make it possible to preserve texture details at high distances.
Notice
Increased resolution significantly affects performance.

Range of values: [16, 8192]. The default value is 256.
Console access: render_clouds_dynamic_coverage_resolution (API control)

The following values are available:

  • 128 x 128
  • 256 x 256
  • 512 x 512
  • 1024 x 1024
  • 2048 x 2048
Dynamic Coverage Area The dynamic coverage area for clouds, in units. This parameter determines visibility distance for coverage of FieldWeather objects.
Notice
Increasing dynamic coverage area leads to reduction of quality of FieldWeather coverage texture and loss of details. This effect can be mitigated by increasing dynamic coverage resolution using the corresponding command.

Range of values: [10.0f, 400000.0f]. The default value is 10000.0f.
Console access: render_clouds_dynamic_coverage_area (API control)
Last update: 2023-06-23
Build: ()