Navigation
API > API/Plugins > API/Plugins/WaveTable
| Name | FWaveTableSampler |
| Type | class |
| Header File | /Engine/Plugins/Runtime/WaveTable/Source/WaveTable/Public/WaveTableSampler.h |
| Include Path | #include "WaveTableSampler.h" |
Syntax
class FWaveTableSampler
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| WaveTableSampler.h | |||
FWaveTableSampler
(
FSettings&& InSettings |
WaveTableSampler.h |
Structs
| Name | Remarks |
|---|---|
| FOneShotData | |
| FSettings |
Enums
Public
| Name | Remarks |
|---|---|
| EInterpolationMode | Interpolation mode when sampling values between indices. |
| ESingleSampleMode | Mode of interpolation between last value in table and subsequent input index when sampling single values. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LastIndex | float | WaveTableSampler.h | ||
| OneShotData | WaveTable::FWaveTableSampler::FOneShotData | WaveTableSampler.h | ||
| PhaseModScratch | TArray< float > | WaveTableSampler.h | ||
| Settings | FSettings | WaveTableSampler.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetIndexFinished () |
If set to one-shot, returns the first index where a reverse or stall occurred in the provided interpolated index, ignoring samples where a "sync" request took place. | WaveTableSampler.h | |
const FSettings & GetSettings() |
WaveTableSampler.h | ||
float Process
(
const FWaveTableData& InTableData, |
WaveTableSampler.h | ||
float Process
(
const FWaveTableView& InTableView, |
Retrieves the sample value at the currently set phase, returning the floating point index which the current phase corresponds to. | WaveTableSampler.h | |
float Process
(
const FWaveTableData& InTableData, |
WaveTableSampler.h | ||
float Process
(
const FWaveTableView& InTableView, |
Resamples entire table length into given view. | WaveTableSampler.h | |
float Process
(
const FWaveTableData& InTableData, |
WaveTableSampler.h | ||
float Process
(
const FWaveTableView& InTableView, |
WaveTableSampler.h | ||
void Reset() |
Resets the last index operated on, restarting the interpolation process for subsequent calls. | WaveTableSampler.h | |
void SetFreq
(
float InFreq |
WaveTableSampler.h | ||
void SetInterpolationMode
(
EInterpolationMode InMode |
WaveTableSampler.h | ||
void SetOneShot
(
bool bInLooping |
WaveTableSampler.h | ||
void SetPhase
(
float InPhase |
WaveTableSampler.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void Interpolate
(
TArrayView< const float > InTableView, |
WaveTableSampler.h | ||
static void Interpolate
(
const FWaveTableData& InTableData, |
Interpolates and converts values in the given table for each provided index in the index-to-samples TArrayView (an array of sub-sample, floating point indices) | WaveTableSampler.h | |
static void Interpolate
(
TArrayView< const int16 > InTableView, |
WaveTableSampler.h |