This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
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

Water

This section contains settings related to water rendering.

Common Settings#

Common Settings

Common Settings
Enabled The value indicating if rendering of water is enabled. Enabled by default.
Console access: render_water_enabled (API control)
SSR Enabled The value indicating if the SSR (Screen Space Reflections) effect is enabled for water. Enabled by default.
Console access: render_water_ssr (API control)

SSR Quality The resolution of water SSR (Screen Space Reflections). One of the following values:
  • Low - low quality
  • Medium - medium quality (by default)
  • High - high quality
  • Ultra - ultra quality

Console access: render_water_ssr_quality (API control)

SSR Increased Accuracy The value indicating if increased accuracy for the water SSR (Screen Space Reflections). This option reduces visual artifacts by increasing accuracy of the last step. Enabled by default.
Console access: render_water_ssr_increased_accuracy (API control)

Refraction Quality The quality of water refraction. One of the following values:
  • Low - low quality
  • Medium - medium quality
  • High - high quality (by default)
  • Ultra - ultra quality

Console access: render_water_refraction_quality (API control)
Anisotropy Quality The water texture anisotropy level. The following values are available:
  • 1x — anisotropy level 1
  • 2x — anisotropy level 2
  • 4x — anisotropy level 4
  • 8x — anisotropy level 8
  • 16x — anisotropy level 16
Option #2 is selected by default (see above).
Console access: render_water_anisotropy (API control)
Shoreline Wetness The value indicating if the wetness effect for objects near the shoreline is enabled. Enabled by default.
Console access: render_water_shoreline_wetness (API control)

Waterline Accuracy The quality of underwater and waterline determination. Use high quality only if you need to submerge underwater (to see the waterline) and at medium and high Beaufort values. One of the following values:
  • Low - low quality (by default)
  • Medium - medium quality
  • High - high quality
  • Ultra - ultra quality

Console access: render_water_waterline_accuracy (API control)
Render Underwater Shafts The value indicating if rendering of underwater shafts is enabled. Enabled by default.
Console access: render_water_shafts (API control)
Render Environment Probes The value indicating if rendering of environment probes on the water surface is enabled. Enabled by default.
Console access: render_water_environment_probes (API control)

Render Voxel Probes The value indicating if voxel probes are enabled for water rendering. Enabled by default.
Console access: render_water_voxel_probes (API control)
Render Lights The value indicating if rendering of lights on the water surface is enabled.
Notice
The option doesn't affect the World Light source.
Enabled by default.
Console access: render_water_lights (API control)

Opacity Depth The value indicating if depth data for water is written to the opacity buffer. Enabled by default.
Console access: render_water_opacity_depth (API control)
Field Height Resolution The resolution of the texture into which all textures set for all FieldHeight objects are rendered.
Notice
Increased resolution significantly affects performance.
One of the following values:
  • 128 x 128
  • 256 x 256
  • 512 x 512 (by default)
  • 1024 x 1024
  • 2048 x 2048
  • 4096 x 4096
  • 8192 x 8192

Console access: render_field_height_resolution (API control)
Field Precision 32 bits The value indicating the precision of textures used for field objects. Either of the following:
  • 16-bit precision R16 texture
  • 32-bit precision R32F texture
Option #1 is selected by default (see above).
Console access: render_field_precision (API control)
Field Shoreline Resolution The resolution of the texture into which all textures set for all FieldShoreline objects are rendered.
Notice
Increased resolution significantly affects performance.
One of the following values:
  • 128x128 (by default)
  • 256x256
  • 512x512
  • 1024x1024
  • 2048x2048
  • 4096x4096
  • 8192x8192

Console access: render_field_shoreline_resolution (API control)

Geometry Settings#

Geometry Settings

Geometry Settings
Preset The index of the Global Water geometry preset used at the moment. To customize the Global Water geometry preset options at run time you should activate the Custom preset: One of the following values:
  • Low (by default)
  • Medium
  • High
  • Ultra
  • Extreme
  • Custom

Console access: render_water_geometry_preset (API control)

Customizable Settings#

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

Geometry Progression The progression of Global Water geometry tessellation.
Range of values: [0.0f, 50.0f]. The default value is 1.5f.
Console access: render_water_geometry_progression (API control)
Geometry Fade Lods The intensity of fading between levels of Global Water geometry tessellation. This value can be increased to remove sharp edges between areas with different geometry density.
Range of values: [0.0f, 1.0f]. The default value is 0.5f.
Console access: render_water_geometry_fade_lods (API control)
Geometry Subpixel Reduction The minimum ratio of a polygon size (in screen space) to the size of an area seen in the viewport. If the ratio calculated for the polygon is less than this value, such polygon will be removed.
Range of values: [0.0f, 50.0f]. The default value is 6.0f.
Console access: render_water_geometry_subpixel_reduction (API control)
Geometry Polygon Size The size of Global Water polygons. The value defines the maximum allowed density of Global Water geometry. If the polygon size is large, small waves will be lost. It is better to set this parameter to about 1/3 or 1/4 of the smallest wavelength.
Range of values: [0.0f, 1000.0f]. The default value is 0.01f.
Console access: render_water_geometry_polygon_size (API control)
Visibility Distance The maximum visibility distance for the Global Water. The water is visible, as long as the distance between the camera and the water object does not exceed this value.
Range of values: [0.0f, inf]. The default value is 30000.0f.
Console access: render_water_visible_distance (API control)

Culling Settings#

Culling Settings

Culling Settings
Culling Aggressive The value indicating if frustum culling optimization is enabled for the Global Water. When enabled, the number of culled polygons increases thereby increasing performance. In case of any issues with polygons rendering, try disabling this option (however, note that performance may drop). Enabled by default.
Console access: render_water_culling_aggressive (API control)
Culling Frustum Padding The value, by which the borders of the current frustum are increased. Frustum culling is performed for the frustum of the increased size. By the maximum value of 1, the frustum borders will be increased by the size of the current frustum.
Range of values: [0.0f, 1.0f]. The default value is 0.1f.
Console access: render_water_culling_frustum_padding (API control)
Culling Oblique Frustum The multiplier for the size of viewing frustum used for culling polygons of Global Water object beyond the oblique frustum plane. The higher the value, the more patches will be culled.
Range of values: [0.0f, 1.0f]. The default value is 0.9f.
Console access: render_water_culling_oblique_frustum (API control)
Last update: 2022-06-20
Build: ()