.. _stdlib_hd_water_component:

=======
HDWater
=======

.. das:module:: hd_water_component




++++++++++++
Enumerations
++++++++++++

.. _enum-public_components-HDWaterResolution:

.. das:attribute:: 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
+++++++

.. _struct-hd_water_component-HDWater:

.. das:attribute:: HDWater : NativeComponent

This component enables and provides control over water in :ref:`HD Renderer <stdlib_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:

.. _function-hd_water_component__dot__rq_active_HDWater:

.. das:operator:: HDWater.active() : bool




.. _function-hd_water_component__dot__rq_active_rq_clone_HDWater_bool:

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

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


:Arguments: * **value** : bool

.. _function-hd_water_component__dot__rq_resolution_HDWater:

.. das:operator:: HDWater.resolution() : HDWaterResolution




.. _function-hd_water_component__dot__rq_resolution_rq_clone_HDWater_HDWaterResolution:

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

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


:Arguments: * **value** :  :ref:`HDWaterResolution <enum-public_components-HDWaterResolution>`

.. _function-hd_water_component__dot__rq_level_HDWater:

.. das:operator:: HDWater.level() : float




.. _function-hd_water_component__dot__rq_level_rq_clone_HDWater_float:

.. das:operator:: HDWater.level =(value: float)

Level of the water surface.


:Arguments: * **value** : float

.. _function-hd_water_component__dot__rq_wavesStrength_HDWater:

.. das:operator:: HDWater.wavesStrength() : float




.. _function-hd_water_component__dot__rq_wavesStrength_rq_clone_HDWater_float:

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

Strength of the waves.


:Arguments: * **value** : float

.. _function-hd_water_component__dot__rq_wavesDirection_HDWater:

.. das:operator:: HDWater.wavesDirection() : float




.. _function-hd_water_component__dot__rq_wavesDirection_rq_clone_HDWater_float:

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

Direction of the waves in degrees.


:Arguments: * **value** : float

.. _function-hd_water_component__dot__rq_color_HDWater:

.. das:operator:: HDWater.color() : float3




.. _function-hd_water_component__dot__rq_color_rq_clone_HDWater_float3:

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

Color of underwater fog.


:Arguments: * **value** : float3

.. _function-hd_water_component__dot__rq_density_HDWater:

.. das:operator:: HDWater.density() : float




.. _function-hd_water_component__dot__rq_density_rq_clone_HDWater_float:

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

Density of underwater fog.


:Arguments: * **value** : float

.. _function-hd_water_component__dot__rq_cameraDroplets_HDWater:

.. das:operator:: HDWater.cameraDroplets() : bool




.. _function-hd_water_component__dot__rq_cameraDroplets_rq_clone_HDWater_bool:

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

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


:Arguments: * **value** : bool

.. _function-hd_water_component__dot__rq_underwaterVignette_HDWater:

.. das:operator:: HDWater.underwaterVignette() : float




.. _function-hd_water_component__dot__rq_underwaterVignette_rq_clone_HDWater_float:

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

Vignette strength while underwater.


:Arguments: * **value** : float

.. _function-hd_water_component__dot__rq_underwaterAberrations_HDWater:

.. das:operator:: HDWater.underwaterAberrations() : float




.. _function-hd_water_component__dot__rq_underwaterAberrations_rq_clone_HDWater_float:

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

Chromatic aberration strength while underwater.


:Arguments: * **value** : float