Navigation
API > API/Plugins > API/Plugins/GameplayCameras
Implements a 1-dimensional perlin noise generator.
Unlike the FMath::PerlinNoise1D method, this one doesn't use a hard-coded lookup table of pre-generated numbers. Since camera noise doesn't need to generate numbers for thousands or millions of pixels at a time (only a handful every frame), we can afford to get slightly better noise quality here.
Other differences include:
- Multi-octave noise.
- The ability to dynamically change the frequency.
- Input is a delta-time, instead of an absolute undefined value.
| Name | FPerlinNoise |
| Type | struct |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Math/PerlinNoise.h |
| Include Path | #include "Math/PerlinNoise.h" |
Syntax
struct FPerlinNoise
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPerlinNoise () |
Math/PerlinNoise.h | ||
FPerlinNoise
(
const FPerlinNoiseData& InData, |
Math/PerlinNoise.h | ||
FPerlinNoise
(
float InAmplitude, |
Math/PerlinNoise.h |
Structs
| Name | Remarks |
|---|---|
| FSinglePerlinNoise |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MAX_OCTAVES | const uint8 | Math/PerlinNoise.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Amplitude | float | Math/PerlinNoise.h | ||
| Lacunarity | float | Math/PerlinNoise.h | ||
| NumOctaves | uint8 | Math/PerlinNoise.h | ||
| OctaveGain | float | Math/PerlinNoise.h | ||
| Octaves | FSinglePerlinNoise | Math/PerlinNoise.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GenerateValue
(
float DeltaTime |
Math/PerlinNoise.h | ||
float GetAmplitude() |
Math/PerlinNoise.h | ||
float GetFrequency() |
Math/PerlinNoise.h | ||
float GetLacunarity() |
Math/PerlinNoise.h | ||
uint8 GetNumOctaves() |
Math/PerlinNoise.h | ||
float GetOctaveGain() |
Math/PerlinNoise.h | ||
void Serialize
(
FArchive& Ar |
Math/PerlinNoise.h | ||
void SetAmplitude
(
float InAmplitude |
Math/PerlinNoise.h | ||
void SetFrequency
(
float InFrequency |
Math/PerlinNoise.h | ||
void SetLacunarity
(
float InLacunarity |
Math/PerlinNoise.h | ||
void SetNumOctaves
(
uint8 InNumOctaves |
Math/PerlinNoise.h | ||
void SetOctaveGain
(
float InOctaveGain |
Math/PerlinNoise.h |