HDWater

Enumerations

HDWaterResolution
Values:

  • Low = 0 - Low FFT resolution for water waves. Best performance, least detail.

  • Medium = 1 - Medium FFT resolution for water waves. Balanced detail and performance.

  • High = 2 - High FFT resolution for water waves. Most detailed waves, highest simulation and rendering cost.

Classes

HDWater : NativeComponent

This component enables and provides control over water in HD Renderer.

Water is represented by a world-wide plane at a specified altitude with configurable waves and underwater rendering below its surface.

To use this component, add the following line to your project file:

require engine.core_components.hd_water // or require engine.core

Usage example:

let renderSettings = create_render_settings()
add_component(renderSettings, new HDWater())
get_component(renderSettings) $(var water : HDWater?) {
    water.level = 1.0
    water.wavesStrength = 0.8
}
Properties:

HDWater.active: bool
HDWater.active =(value: bool)

Active flag. Allows for toggling water on and off without removing the component.

Arguments:

  • value : bool

HDWater.resolution: HDWaterResolution
HDWater.resolution =(value: HDWaterResolution)

Detail level of water waves and ripples. Higher values increase simulation and rendering cost.

Arguments:
HDWater.level: float
HDWater.level =(value: float)

Level of the water surface.

Arguments:

  • value : float

HDWater.wavesStrength: float
HDWater.wavesStrength =(value: float)

Strength of the waves.

Arguments:

  • value : float

HDWater.wavesDirection: float
HDWater.wavesDirection =(value: float)

Direction of the waves in degrees.

Arguments:

  • value : float

HDWater.color: float3
HDWater.color =(value: float3)

Color of underwater fog.

Arguments:

  • value : float3

HDWater.density: float
HDWater.density =(value: float)

Density of underwater fog.

Arguments:

  • value : float

HDWater.cameraDroplets: bool
HDWater.cameraDroplets =(value: bool)

Enables a water droplet effect on the camera when it emerges from underwater.

Arguments:

  • value : bool

HDWater.underwaterVignette: float
HDWater.underwaterVignette =(value: float)

Vignette strength while underwater.

Arguments:

  • value : float

HDWater.underwaterAberrations: float
HDWater.underwaterAberrations =(value: float)

Chromatic aberration strength while underwater.

Arguments:

  • value : float