Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Water > UGerstnerWaterWaves > UGerstnerWaterWaves::GetWaveAttenuationFactor

Light Theme

Dark Theme

UGerstnerWaterWaves::GetWaveAttenuationFactor

Computes the attenuation factor to apply to the raw wave perturbation.

Windows

MacOS

Linux

Override Hierarchy

UWaterWavesBase::GetWaveAttenuationFactor()

UGerstnerWaterWaves::GetWaveAttenuationFactor()

References

Module	Water
Header	/Engine/Plugins/Experimental/Water/Source/Runtime/Public/GerstnerWaterWaves.h
Include	#include "GerstnerWaterWaves.h"
Source	/Engine/Plugins/Experimental/Water/Source/Runtime/Private/GerstnerWaterWaves.cpp

Syntax

virtual float GetWaveAttenuationFactor
(
    const FVector & InPosition,
    float InWaterDepth,
    float InTargetWaveMaskDepth
) const

Remarks

Computes the attenuation factor to apply to the raw wave perturbation. Attenuates : normal/wave height/max wave height. Should match the GPU version (ComputeWaveDepthAttenuationFactor)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss