1. Epic GamesDeveloper
  3. FWaveTableData

FWaveTableData

Serialized WaveTable data, that supports multiple bit depth formats.

API > API/Plugins > API/Plugins/WaveTable

References

   
Module WaveTable
Header /Engine/Plugins/Runtime/WaveTable/Source/WaveTable/Public/WaveTable.h
Include #include "WaveTable.h"

Syntax

USTRUCT (BlueprintType )  
struct FWaveTableData

Remarks

Serialized WaveTable data, that supports multiple bit depth formats.

Constructors

  Type Name Description
Public function    
Public function    
Public function  

FWaveTableData ( TArrayView< const float > InSamples,
float InFinalValue
)

  
Public function  

FWaveTableData ( TArrayView< const int16 > InSamples,
float InFinalValue
)

  

Functions

  Type Name Description
Public function Const void

ArrayMixIn ( TArrayView< float > OutputWaveSamples,
float Gain
)

 Adds this WaveTableData's internal contents to the given float buffer view, initially performing bit depth conversion to values to IEEE_FLOAT if required.
Public function void

Empty ()

 Empties the underlying data container, deallocating memory and invalidating the FinalValue.
Public function Const EWaveTableBitDepth  
Public function Static FName  
Public function bool

GetDataView ( TArrayView< float >& OutData
)

  
Public function Const bool

GetDataView ( TArrayView< const float >& OutData
)

 Returns true if ArrayView of underlying Data in the proper sample format, setting OutData to a view of the Table's data.
Public function bool

GetDataView ( TArrayView< int16 >& OutData
)

  
Public function Const bool

GetDataView ( TArrayView< const int16 >& OutData
)

  
Public function Const float Returns the value to interpolate to beyond the last value of the DataView.
Public function Const float Returns the last data value value as a float. If DataView is empty, returns 0.
Public function Const int32 Returns number of samples within the underlying DataView, not including a FinalValue if set.
Public function Const const TArray< uint8 > & Returns read-only view of byte array that stores sample data.
Public function Const bool

IsEmpty ()

 Whether or not the underlying data is empty.
Public function bool

Resample ( int32 InCurrentSampleRate,
int32 InNewSampleRate,
::WaveTable::FWaveTableSampler::EInterpolationMode InInterpMode
)

 Resamples the underlying data to a provided new sample rate.
Public function void

Reset ( int32 NumSamples
)

 Resets the underlying data to the given number of samples.
Public function bool Converts bit depth and sets internal data to the requested bit depth.
Public function void

SetData ( TArrayView< const float > InData,
bool bIsLoop
)

  
Public function void

SetData ( TArrayView< const int16 > InData,
bool bIsLoop
)

  
Public function void

SetFinalValue ( float InFinalValue
)

  
Public function void

SetRawData ( EWaveTableBitDepth InBitDepth,
TArrayView< const uint8 > InData
)

  
Public function void

SetRawData ( EWaveTableBitDepth InBitDepth,
TArray< uint8 >&& InData
)

  
Public function void

Zero ( int32 InNumSamples
)

 Zeros the underlying data.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page