1. Epic GamesDeveloper
  3. FWaveTableSampler

FWaveTableSampler

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,
float& OutSample,
ESingleSampleMode InMode
)

   WaveTableSampler.h  

float Process ( const FWaveTableView& InTableView,
float& OutSample,
ESingleSampleMode InMode
)

 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,
TArrayView< float > OutSamplesView
)

   WaveTableSampler.h  

float Process ( const FWaveTableView& InTableView,
TArrayView< float > OutSamplesView
)

 Resamples entire table length into given view. WaveTableSampler.h  

float Process ( const FWaveTableData& InTableData,
TArrayView< const float > InFreqModulator,
TArrayView< const float > InPhaseModulator,
TArrayView< const float > InSyncTriggers,
TArrayView< float > OutSamplesView
)

   WaveTableSampler.h  

float Process ( const FWaveTableView& InTableView,
TArrayView< const float > InFreqModulator,
TArrayView< const float > InPhaseModulator,
TArrayView< const float > InSyncTriggers,
TArrayView< float > OutSamplesView
)

   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,
TArrayView< float > InOutIndexToSamplesView,
EInterpolationMode InterpMode
)

   WaveTableSampler.h  

static void Interpolate ( const FWaveTableData& InTableData,
TArrayView< float > InOutIndexToSamplesView,
EInterpolationMode InterpMode
)

 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,
TArrayView< float > InOutIndexToSamplesView,
EInterpolationMode InterpMode
)

   WaveTableSampler.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page