className: FSlowAdaptiveGainControl

description: This object accepts an input buffer and current amplitude estimate of that input buffer, Then applies a computed gain target. Works like a standard feed forward limiter, with a threshold of 0.

code: class FSlowAdaptiveGainControl


module: SignalProcessing

code: FSpectrumAnalysisAsyncWorker ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FSpectrumAnalyzer](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzer), ESPMode::ThreadSafe > InAnalyzer, bool bInUseLatestAudio )


className: EPeakInterpolationMethod

description: Peak interpolation method. If the EFFTSize is small but will be densely sampled, it's worth using a linear or quadratic interpolation method.

code: enum EPeakInterpolationMethod { NearestNeighbor, Linear, Quadratic, }


description: Return array of bands using spectrum band extractor.

code: void GetBands ( [ISpectrumBandExtractor](API\Runtime\SignalProcessing\DSP\ISpectrumBandExtractor) & InExtractor, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutValues )


description: Samples magnitude (linearly) for a given frequency, in Hz.

code: float GetMagnitudeForFrequency ( float InFrequency, [EPeakInterpolationMethod](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzer\EPeakInterpolationMethod) InMethod )


code: float GetNormalizedMagnitudeForFrequency ( float InFrequency, [EPeakInterpolationMethod](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzer\EPeakInterpolationMethod) InMethod )


className: FSpectrumAnalysisAsyncWorker

code: class FSpectrumAnalysisAsyncWorker


description: Samples phase for a given frequency, in Hz.

code: float GetPhaseForFrequency ( float InFrequency, [EPeakInterpolationMethod](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzer\EPeakInterpolationMethod) InMethod )


description: Initialize sample rate of analyzer if not known at time of construction.

code: void Init ( float InSampleRate )


code: void Init ( const [FSpectrumAnalyzerSettings](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzerSettings) & InSettings, float InSampleRate )


description: Get the current settings used by this Spectrum Analyzer.

code: void GetSettings ( [FSpectrumAnalyzerSettings](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzerSettings) & OutSettings )


description: Returns false if this instance ofFSpectrumAnalyzerwas constructed with the default constructor andInit()has not been called yet.

code: bool IsInitialized()


description: You can call this function to ensure that you're sampling the same window of frequency data, Then call UnlockOutputBuffer when you're done. Otherwise, GetMagnitudeForFrequency and GetPhaseForFrequency will always use the latest window of frequency data.

code: void LockOutputBuffer()


description: Thread safe call to perform actual FFT. Returns true if it performed the FFT, false otherwise. If bUseLatestAudio is set to true, this function will flush the entire input buffer, potentially losing data. Otherwise it will only consume enough samples necessary to perform a single FFT.

code: bool PerformAnalysisIfPossible ( bool bUseLatestAudio )


description: Push audio to queue. Returns false if the queue is already full.

code: bool PushAudio ( const [TSampleBuffer](API\Runtime\SignalProcessing\TSampleBuffer)< float > & InBuffer )


code: bool PushAudio ( const float * InBuffer, int32 NumSamples )


description: Update the settings used by this Spectrum Analyzer. Safe to call on any thread, but should not be called every tick.

code: void SetSettings ( const [FSpectrumAnalyzerSettings](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzerSettings) & InSettings )


code: void UnlockOutputBuffer()


description: If an instance is created using the default constructor,Init()must be called before it is used.

code: FSpectrumAnalyzer()


description: If an instance is created using either of these constructors,Init()is not neccessary.

code: FSpectrumAnalyzer ( float InSampleRate )


code: FSpectrumAnalyzer ( const [FSpectrumAnalyzerSettings](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzerSettings) & InSettings, float InSampleRate )


description: Output. Used to lock the most recent buffer we analyzed.

code: const [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & LockMostRecentBuffer() const


code: virtual ~FSpectrumAnalyzer()


className: FSpectrumAnalyzer

description: Class built to be a rolling spectrum analyzer for arbitrary, monaural audio data. Class is meant to scale accuracy with CPU and memory budgets. Typical usage is to either callPushAudio()and then PerformAnalysisIfPossible immediately afterwards, or have a seperate thread callPerformAnalysisIfPossible().

code: class FSpectrumAnalyzer


description: Output. Used to lock the most recent buffer we analyzed. OutTimestamp is populated with the timestamp associated with the buffer wehn StopWorkOnBuffer is called.

code: const [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & LockMostRecentBuffer ( double & OutTimestamp ) const


code: void Reset ( int32 InNum )


description: Input. Used on analysis thread to lock a buffer to write to.


code: FSpectrumAnalyzerBuffer ( int32 InNum )


className: FSpectrumAnalyzerBuffer

description: This class locks an input buffer (for writing) and an output buffer (for reading). Uses triple buffering semantics.

code: class FSpectrumAnalyzerBuffer


code: FSpectrumAnalyzerScopeLock ( [FSpectrumAnalyzer](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzer) * InAnalyzer )


code: FSpectrumAnalyzerBuffer()


description: When calling stop work on buffer, also set timestmap associated with buffer.

code: void StopWorkOnBuffer ( double InTimestamp )


className: FSpectrumAnalyzerScopeLock

code: class FSpectrumAnalyzerScopeLock


code: ~FSpectrumAnalyzerScopeLock()


code: FSpectrumAnalyzerSettings()


className: EFFTSize

description: Actual FFT size used. ForFSpectrumAnalyzer, we never zero pad the input buffer.


className: EMetric

description: Metric for output band values.

code: enum EMetric { Magnitude, Power, Decibel, }


className: FSpectrumAnalyzerSettings

code: struct FSpectrumAnalyzerSettings

FFTSize

type: EFFTSize

HopSize

type: float

description: Hop size as a percentage of FFTSize.

WindowType

type: EWindowType


className: FSpectrumBandExtractorSettings

description: Settings for band extractor.

code: struct FSpectrumBandExtractorSettings

AutoRangeAttackTimeInSeconds

description: Time in seconds for autorange to reach 99% of a larger range.

AutoRangeReleaseTimeInSeconds

description: Time in seconds for autorange to reach 99% of a smaller range.

bDoAutoRange

type: bool

description: If true and bDoNormalize is true, then values will be scaled between 0 and 1 based upon relatively recent minimum and maximum values.

bDoNormalize

description: If true, all values are scaled and clamped between 0.0 and 1.f.

DecibelNoiseFloor

description: If the metric is Decibel, this is the minimum decibel value allowed.

Metric

type: EMetric

description: Metric used to calculate return value.


description: Compare whether two settings structures are equal.

code: bool operator== ( const [FSpectrumBandExtractorSpectrumSettings](API\Runtime\SignalProcessing\DSP\FSpectrumBandExtractorSpectrumSe-) & Other ) const


description: Compare whether two settings structures are not equal.

code: bool operator!= ( const [FSpectrumBandExtractorSpectrumSettings](API\Runtime\SignalProcessing\DSP\FSpectrumBandExtractorSpectrumSe-) & Other ) const


className: FSpectrumBandExtractorSpectrumSettings

description: Settings describing the spectrum used for in the band extractor.

FFTScaling

type: EFFTScaling

description: Forward scaling of FFT used in spectrum analyzer

FFTSize

description: Size of fft used in spectrum analyzer

SampleRate

description: Sample rate of audio

WindowType

description: Window used when perform FFT


className: FFilterState

code: struct FFilterState


description: Process an audio buffer.

code: virtual void ProcessAudio ( const float * InBuffer, const int32 InNumSamples, float * OutBuffer )


description: Initialize the filter.

code: virtual void Init ( const float InSampleRate, const int32 InNumChannels, const int32 InVoiceId, [FModulationMatrix](API\Runtime\SignalProcessing\DSP\FModulationMatrix) * InModMatrix )


code: void ProcessAudio ( const float * InSamples, const int32 InNumSamples, float * LpfOutput, float * HpfOutput, float * BpfOutput, float * BsfOutput )


description: Reset the filter.

code: virtual void Reset()


description: Sets the band stop control param (not used on all filters)

code: virtual void SetBandStopControl ( const float InBandStop )


description: Updates the filter.

code: virtual void Update()


code: virtual ~FStateVariableFilter()


className: FStateVariableFilter

code: class FStateVariableFilter : public [Audio::IFilter](API\Runtime\SignalProcessing\DSP\IFilter)

FilterState

type: TArray<FFilter...


className: FStronglyConnectedComponent

description: A strongly connected component contains a subgraph of strongly connected vertices and their corresponding edges.

code: struct FStronglyConnectedComponent

Edges

type: TArray<FDirect...

description: Edges in the strongly connected component.

Vertices

type: TArray< int32 >

description: Vertices in the strongly connected component.


className: MaxAbsPitchShiftInOctaves

code: static constexpr float MaxAbsPitchShiftInOctaves = 6.0f;


description: Initialization of the internal delay with given sample rate, pitch shift in semitones, and delay length in milliseconds.

code: void Init ( const float InSampleRate, const float InPitchShift, const float InDelayLength )


className: MaxDelayLength

code: static constexpr float MaxDelayLength = 100.0f;


className: MinDelayLength

code: static constexpr float MinDelayLength = 10.0f;


description: Process whole block of audio reading to and writing from delay line from input buffer.

code: void ProcessAudio ( [Audio::FDelay](API\Runtime\SignalProcessing\DSP\FDelay) & InDelayBuffer, const float * InAudioBuffer, const int32 InNumFrames, float * OutAudioBuffer )


description: Sets the internal delay line length.

code: void SetDelayLength ( const float InDelayLength )


description: Sets the pitch shift in semitones.

code: void SetPitchShift ( const float InPitchScaleSemitones )


description: Sets the pitch shift in terms of a sample rate ratio.

code: void SetPitchShiftRatio ( const float InPitchShiftRatio )


description: Virtual Destructor.

code: virtual ~FTapDelayPitchShifter()


description: Reads the next sample tap from the input delay buffer.

code: float ReadDopplerShiftedTapFromDelay ( const [Audio::FDelay](API\Runtime\SignalProcessing\DSP\FDelay) & InDelayBuffer, const float ReadOffsetMilliseconds )


description: Constructor.

code: FTapDelayPitchShifter()


className: FTapDelayPitchShifter

description: Class which reads doppler-shifted tap from a delay buffer.

code: class FTapDelayPitchShifter


code: void Init ( [EFilterOrder](API\Runtime\SignalProcessing\DSP\Audio__EFilterOrder) InOrder, const float InSampleRate, const int32 InNumChannels, const float InFrequency, const [EBiquadFilter::Type](API\Runtime\SignalProcessing\DSP\Audio__EBiquadFilter__Type) InType, const float InBandwidth, const float InGain )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FBiquadFilter](API\Runtime\SignalProcessing\DSP\FBiquadFilter) > & GetFilters() const


code: void ProcessAudioBuffer ( const float * InFrame, float * OutFrame, const int32 NumSamples )


code: void ProcessAudioFrame ( const float * InFrame, float * OutFrame )


code: void SetParams ( const [EBiquadFilter::Type](API\Runtime\SignalProcessing\DSP\Audio__EBiquadFilter__Type) InFilterType, const float InCutoffFrequency, const float InBandwidth, const float InGain )


className: FVariablePoleFilter

code: class FVariablePoleFilter


code: uint32 ResampleStereo ( uint32 OutputFramesNeeded, uint32 FixedPointSampleRate, float const * SourceFrames, uint32 SourceFramesStrideFloats, float * OutputFrames, uint32 OutputFramesStrideFloats )


description: stereo is deinterleaved, with the right channels being specified by Frames+StrideFloats.

code: uint32 ResampleMono ( uint32 OutputFramesNeeded, uint32 FixedPointSampleRate, float const * SourceFrames, float * OutputFrames )


description: Returns the number of source frames necessary to generate the requested output count at the given fixed point sample rate (1.0 rate is 65536)

code: uint32 SourceFramesNeeded ( uint32 OutputFramesNeeded, uint32 FixedPointSampleRate )


className: FVectorLinearResampler

description: SourceBufferFrameCount = 0; }

code: struct FVectorLinearResampler


description:
Decode a sequence using the viterbi algorithm.
An array of the most likely state sequence determined by decoding using the viterbi algorithm.

code: static [TArray](API\Runtime\Core\Containers\TArray)< int32 > Decode ( const [IViterbiObservations](API\Runtime\SignalProcessing\DSP\IViterbiObservations) & InObservations, const [IViterbiInitialProbability](API\Runtime\SignalProcessing\DSP\IViterbiInitialProbability) & InInitialProbability, const [IViterbiTransitionProbability](API\Runtime\SignalProcessing\DSP\IViterbiTransitionProbability) & InTransitionProbability )


description: Activates the fader if currently deactivated. Sets duration to indefinite (-1.0f)

code: void Activate()


description: Deactivates the fader, causing it to remain at the current value and disregard update.

code: void Deactivate()


description: Returns the curve type of the fader


description: Gets time fader is to remain active (-1.0f if always active).

code: float GetActiveDuration() const


description: Returns the duration of the fade.

code: float GetFadeDuration() const


description: Returns the target volume of the fader

code: float GetTargetVolume() const


description: Returns current volume of fader

code: float GetVolume() const


description: Returns the volume given the delta from the current time into the future (Effectively like running to retrieve volume but without actually updating internal state).

code: float GetVolumeAfterTime ( float InDeltaTime ) const


description: Returns whether or not the fader is currently fading over time.

code: bool IsFading() const


description: Whether or not the fader is active.

code: bool IsActive() const


description: Returns whether or not the fader is currently fading over time and value is increasing.

code: bool IsFadingIn() const


description: Returns whether or not the fader is currently fading over time and value is decreasing.

code: bool IsFadingOut() const


description: Sets the duration the fader is to be active in the future, after which point the fader is disabled. When disabled, fader will hold the current fade state until activated, at which point it will continue applying the fade over the remainder of the fade duration.

code: void SetActiveDuration ( float InDuration )


description: Sets the volume immediately, interrupting any currently active fade.

code: void SetVolume ( float InVolume )


description: Applies a volume fade over time with the provided parameters.

code: void StartFade ( float InVolume, float InDuration, [EFaderCurve](API\Runtime\SignalProcessing\DSP\Audio__EFaderCurve) InCurve )


description: Stops fade, maintaining the current value as the target.

code: void StopFade()


description: Updates the fader's state with the given delta in time since last update.

code: void Update ( float InDeltaTime )


className: FVolumeFader

description: Control-rate fader for managing volume fades of various standard shapes.

code: class FVolumeFader


description: Initialize the equalizer.

code: void Init ( const float InSampleRate )


description: Processes one Sample, using ATan Deprecating in favor of ProcessAudioBuffer

code: void ProcessAudio ( const float InSample, float & OutSample )


description: Sets the amount of wave shapping. 0.0 is no effect.

code: void SetAmount ( const float InAmount )


description: Process an entire buffer of audio.

code: void ProcessAudioBuffer ( const float * InBuffer, float * OutBuffer, int32 NumFrames )


description: Set DC offset before processing.

code: void SetBias ( const float InBias )


description: Sets the output gain of the waveshaper.

code: void SetOutputGainDb ( const float InGainDb )


description: Sets the output gain of the waveshaper.

code: void SetOutputGainLinear ( const float InGainLinear )


description: Constructor.

code: FWaveShaper()


code: void SetType ( const [EWaveShaperType](API\Runtime\SignalProcessing\DSP\Audio__EWaveShaperType) InType )


description: Destructor.

code: ~FWaveShaper()


description: Creates a wave table using internal factories for standard wave tables or uses custom wave table factor if it exists.

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWaveTableOsc](API\Runtime\SignalProcessing\DSP\FWaveTableOsc) > CreateWaveTable ( const [EWaveTable::Type](API\Runtime\SignalProcessing\DSP\Audio__EWaveTable__Type) WaveTableType, const int32 WaveTableSize )


className: FWaveShaper

description: A digital wave shaping effect to cause audio distortionhttps://en.wikipedia.org/wiki/Waveshaper

code: class FWaveShaper


description: Processes the wave table, outputs the normal and quad phase (optional) values.

code: void Generate ( float * OutputNormalPhase, float * OutputQuadPhase )


description: Returns the internal table used in the wave table.

code: [TArray](API\Runtime\Core\Containers\TArray)< float > & GetTable()


description: Returns the frequency of the wave table oscillator.

code: float GetFrequencyHz() const


description: Returns the type of the wave table oscillator.


code: const [TArray](API\Runtime\Core\Containers\TArray)< float > & GetTable() const


description: Initialize the wave table oscillator.

code: void Init ( const float InSampleRate, const float InFrequencyHz )


description: Resets the wave table read indices.

code: void Reset()


description: Sets the sample rate of the oscillator.

code: void SetSampleRate ( const float InSampleRate )


description: Sets the amount to scale and add to the output of the wave table.

code: void SetScaleAdd ( const float InScale, const float InAdd )


description: Sets the frequency of the wave table oscillator.

code: void SetFrequencyHz ( const float InFrequencyHz )


description: Constructor.

code: FWaveTableOsc()


description: Virtual Destructor.

code: virtual ~FWaveTableOsc()


className: FWaveTableOsc

description: A wave table oscillator class.

code: class FWaveTableOsc

FrequencyHz

description: The frequency of the output (given the sample rate)

NormalPhaseReadIndex

description: Normal phase read index.

OutputAdd

description: Amount to add to the output.

OutputScale

description: Amount to scale the output by.

PhaseIncrement

description: The phase increment (based on frequency)

QuadPhaseReadIndex

description: The quad-phase read index.

SampleRate

description: The sample rate of the oscillator.

WaveTableBuffer

type: TArray< float >

description: The wave table buffer.

WaveTableType

description: The wave table oscillator type.


className: FWetDry

code: struct FWetDry

DryLevel

description: Level of dry signal.

WetLevel

description: Level of wet signal.


code: FWetDry ( float InWetLevel, float InDryLevel )


description: Generate next sample of white noise

code: float Generate()


description: Generate next sample of white noise (with optional Scale and Add params)

code: float Generate ( float InScale, float InAdd )


code: FWhiteNoise ( int32 InRandomSeed )


className: FWhiteNoise

description: White noise generator Flat spectrum

code: class FWhiteNoise


description: Apply this window to InBuffer, which is expected to be an interleaved buffer with the same amount of frames and channels this window was constructed with.

code: void ApplyToBuffer ( float * InBuffer )


description: Constructor. Allocates buffer and generates window inside of it.

code: FWindow ( [EWindowType](API\Runtime\SignalProcessing\DSP\Audio__EWindowType) InType, int32 InNumFrames, int32 InNumChannels, bool bIsPeriodic )


className: FWindow

description: Class used to generate, contain and apply a DSP window of a given type.

code: class FWindow


className: FInputFormat

description: Description of input audio format.

code: struct FInputFormat

NumChannels

description: Number of channels in input audio format.


className: FOutputFormat

description: Description of output audio format.

code: struct FOutputFormat

description: Number of channels in output audio format.


description: Return the input format handled by this converter.

code: const [FInputFormat](API\Runtime\SignalProcessing\DSP\IChannelFormatConverter\FInputFormat) & GetInputFormat() const


description: The input buffer array must have the same number of channels as theFInputFormatreturn fromGetInputFormat(). Each buffer within that array must have the same number of samples.

code: void ProcessAudio ( const [TArray](API\Runtime\Core\Containers\TArray)< [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) > & InInputBuffers, [TArray](API\Runtime\Core\Containers\TArray)< [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) > & OutOutputBuffers )


description: Return the output format handled by this converter.

code: const [FOutputFormat](API\Runtime\SignalProcessing\DSP\IChannelFormatConverter\FOutputFormat) & GetOutputFormat() const


className: IChannelFormatConverter

description: Inteface for Channel Format Converters which process deinterleaved audio.

code: class IChannelFormatConverter


code: virtual ~IChannelFormatConverter()


description:
Create anIConvertDeinterleaveobject for a given number of input and output channels.
A valid TUniquePtr<> on success, an invalid TUniquePtr<> on failure.

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IConvertDeinterleave](API\Runtime\SignalProcessing\DSP\IConvertDeinterleave) > Create ( const [FConvertDeinterleaveParams](API\Runtime\SignalProcessing\DSP\FConvertDeinterleaveParams) & InParams )


description: Deinterleave and convert the channel format of the input audio.

code: void ProcessAudio ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > InSamples, [FMultichannelBuffer](API\Runtime\SignalProcessing\DSP\FMultichannelBuffer) & OutSamples ) const


code: virtual ~IConvertDeinterleave()


className: IConvertDeinterleave

description: The deinterleaving and channel format conversion operations are combined into this single object as both operations are often required for any given source audio.

code: struct IConvertDeinterleave


description: ([audio input] * [impulse response]) x gain = [audio output]

code: float GetMatrixGain ( int32 InAudioInputIndex, int32 InImpulseResponseIndex, int32 InAudioOutputIndex ) const


description: Maximum supported length of impulse response.


description: Returns number of audio inputs.

code: int32 GetNumAudioInputs() const


description: Returns number of audio outputs.

code: int32 GetNumAudioOutputs() const


description: Return the number of samples in an impulse response.

code: int32 GetNumImpulseResponseSamples ( int32 InImpulseResponseIndex ) const


description: Return the number of impulse responses.

code: int32 GetNumImpulseResponses() const


description: Returns the number of samples in an audio block.

code: int32 GetNumSamplesInBlock() const


description: InSamples - A 2D array of input deinterleaved audio samples. InSamples[GetNumAudioInputs()][GetNumSamplesInBlock()]  OutSamples - A 2D array of output deinterleaved audio samples. OutSamples[GetNumAudioOutputs()][GetNumSamplesInBlock()]

code: void ProcessAudioBlock ( const float *const InSamples, float *const OutSamples )


description: Reset internal history buffers.

code: void ResetAudioHistory()


description: Set impulse response values.

code: void SetImpulseResponse ( int32 InImpulseResponseIndex, const float * InSamples, int32 NumSamples )


description: Virtual destructor for inheritance.

code: virtual ~IConvolutionAlgorithm()


className: IConvolutionAlgorithm

description: Interface for Convolution algorithm.

code: class IConvolutionAlgorithm


code: void SetMatrixGain ( int32 InAudioInputIndex, int32 InImpulseResponseIndex, int32 InAudioOutputIndex, float InGain )


description: Returns true if the input settings are supported by this factory.

code: bool AreConvolutionSettingsSupported ( const [FConvolutionSettings](API\Runtime\SignalProcessing\DSP\FConvolutionSettings) & InSettings ) const


description: Name of this particular factory.

code: const [FName](API\Runtime\Core\UObject\FName) GetFactoryName() const


description: Creates a new Convolution algorithm.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IConvolutionAlgorithm](API\Runtime\SignalProcessing\DSP\IConvolutionAlgorithm) > NewConvolutionAlgorithm ( const [FConvolutionSettings](API\Runtime\SignalProcessing\DSP\FConvolutionSettings) & InSettings )


description: If true, this implementation uses hardware acceleration.

code: bool IsHardwareAccelerated() const


description: Name of modular feature for Convolution factory.

code: static const [FName](API\Runtime\Core\UObject\FName) GetModularFeatureName()


description: Perform the forward FFT on real data and produce complex data.

code: void BatchForwardRealToComplex ( int32 InCount, const float *const __restrict InReal, float *__restrict OutComplex )


className: IConvolutionAlgorithmFactory

description: Factory interface for creating convolution algorithms.

code: class IConvolutionAlgorithmFactory : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


code: virtual ~IConvolutionAlgorithmFactory()


description: Perform the inverse FFT on complex data and produce real data.

code: void BatchInverseComplexToReal ( int32 InCount, const float *const __restrict InComplex, float *__restrict OutReal )


code: void ForwardRealToComplex ( const float *__restrict InReal, float *__restrict OutComplex )


code: void InverseComplexToReal ( const float *__restrict InComplex, float *__restrict OutReal )


description: Scaling applied when performing forward FFT.


description: Scaling applied when performing inverse FFT.


description: Number of floats expected in input.

code: int32 NumInputFloats() const


description: Number of floats produced in output.

code: int32 NumOutputFloats() const


description: Number of elements in FFT

code: int32 Size() const


description: Virtual destructor for inheritance.

code: virtual ~IFFTAlgorithm()


className: IFFTAlgorithm

description: Interface for FFT algorithm.

code: class IFFTAlgorithm


description: If true, this implementation requires input and output arrays to be 128 bit aligned.

code: bool Expects128BitAlignedArrays() const


code: bool AreFFTSettingsSupported ( const [FFFTSettings](API\Runtime\SignalProcessing\DSP\FFFTSettings) & InSettings ) const


description: Name of this particular factory.


description: Name of modular feature for FFT factory.


code: virtual ~IFFTAlgorithmFactory()


description: Creates a new FFT algorithm.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IFFTAlgorithm](API\Runtime\SignalProcessing\DSP\IFFTAlgorithm) > NewFFTAlgorithm ( const [FFFTSettings](API\Runtime\SignalProcessing\DSP\FFFTSettings) & InSettings )


code: float GetGCoefficient() const


description: Filter patch destinations.


description: Initialize the filter.

code: virtual void Init ( const float InSampleRate, const int32 InNumChannels, const int32 InVoiceId, [FModulationMatrix](API\Runtime\SignalProcessing\DSP\FModulationMatrix) * InModMatrix )


description: Process an audio buffer.

code: void ProcessAudio ( const float * InBuffer, const int32 InNumSamples, float * OutBuffer )


description: Processes a single frame of audio. Number of channels MUST be what was used during filter initialization.

code: virtual void ProcessAudioFrame ( const float * InFrame, float * OutFrame )


description: Reset the filter.

code: virtual void Reset()


className: IFFTAlgorithmFactory

description: Factory interface for creating fft algorithms.

code: class IFFTAlgorithmFactory : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Sets the filter type.

code: virtual void SetFilterType ( const [EFilter::Type](API\Runtime\SignalProcessing\DSP\Audio__EFilter__Type) InFilterType )


description: Sets the band stop control param (not used on all filters)

code: virtual void SetBandStopControl ( const float InBandStop )


description: Sets an external modulated frequency.

code: virtual void SetFrequencyMod ( const float InModFrequency )


description: Sets the cutoff frequency of the filter.

code: virtual void SetFrequency ( const float InCutoffFrequency )


description: Sets the quality/resonance of the filter.

code: virtual void SetQ ( const float InQ )


description: Sets the band pass gain compensation (not used on all filters)

code: virtual void SetPassBandGainCompensation ( const float InPassBandGainCompensation )


description: Sets an external modulated quality/resonance of the filter.

code: virtual void SetQMod ( const float InModQ )


description: Sets the filter saturation (not used on all filters)

code: virtual void SetSaturation ( const float InSaturation )


description: Updates the filter.

code: virtual void Update()


className: IFilter

description: Base class for filters usable in synthesis.

code: class IFilter

BaseFrequency

description: The base filter cutoff frequency.

BaseQ

description: The base.

ExternalModFrequency

description: A modulatied frequency driven externally.

ExternalModQ

description: An external modulation of Q.

FilterType

description: The filter type of the filter.

Frequency

description: The cutoff frequency currently used by the filter (can be modulated)

ModCutoffFrequencyDest

type: FPatchDestinati...

description: Mod matrix patchable destinations.

ModFrequency

description: A modulated frequency.

ModMatrix

type: FModulationMatr...

ModQ

description: The modulated Q.

description: Number of channels of the sound.

Q

description: The current Q.

SampleRate

description: Sample rate of the filter.

VoiceId

description: The voice id of the owner of the filter (for use with mod matrix)


description: Generates the next sample of audio, optionally passes out the auxillary output (supported in some oscillators)

code: float Generate ( float * AuxOutput )


description: Returns the frequency of the oscillator.

code: float GetFrequency() const


code: float GetGain() const


description: Return patch destinations for various modulatable parameters.


description: Returns the current phase of the oscillator.

code: float GetPhase() const


description: Returns the quadrature phase, wrapped.

code: float GetQuadPhase() const


description: Initializes the oscillator.

code: virtual void Init ( const float InSampleRate, const int32 InVoiceId, [FModulationMatrix](API\Runtime\SignalProcessing\DSP\FModulationMatrix) * InMatrix, const int32 ModMatrixStage )


description: Returns whether or not this oscillator is playing.

code: bool IsPlaying() const


description: Returns if this oscillator should be synced to a leader oscillator.

code: bool IsSync() const


description: Resets the oscillator.

code: virtual void Reset()


description: Resets the phase of this oscillator to 0.0f.

code: virtual void ResetPhase()


code: void SetCents ( const float InCents )


code: void SetDetune ( const float InDetune )


description: Sets the input oscillator as the follower of this oscillator.

code: void SetFollowerOsc ( [IOscBase](API\Runtime\SignalProcessing\DSP\IOscBase) * InFollowerOsc )


code: void SetFreqScale ( const float InFreqScale )


description: Sets the base frequency of the oscillator.

code: void SetFrequency ( const float InFreqBase )


description: Sets a frequency modulation value.

code: void SetFrequencyMod ( const float InFreqMod )


description: Sets the gain modulator of the oscillator.

code: void SetGainMod ( const float InGainMod )


code: void SetOctave ( const float InOctave )


description: Sets the base frequency of the oscillator from the midi note number.

code: void SetNote ( const float InNote )


code: void SetPitchBend ( const float InPitchBend )


description: Sets the LFO pulse width for square-wave type oscillators.

code: void SetPulseWidth ( const float InPulseWidth )


code: void SetSampleRate ( const float InSampleRate )


code: void SetSemitones ( const float InSemiTone )


description: Sets the gain of the oscillator.

code: void SetGain ( const float InGain )


description: Deprecated: use SetFollowerOsc

code: void SetSlaveOsc ( [IOscBase](API\Runtime\SignalProcessing\DSP\IOscBase) * InSlaveOsc )


description: Sets whether or not this oscillator should be synced to a leader oscillator. leader oscillator needs to have set this oscillator as its follower.

code: void SetSync ( const bool bInSync )


description: Starts the oscillator.

code: void Start()


description: Stops the oscillator.

code: void Stop()


description: Updates oscillator state.

code: virtual void Update()


description: Updates the phase based on the phase increment.

code: void UpdatePhase()


description: Returns true if there was a phase wrap this update.

code: bool WrapPhase()


description: Callback for when a specific event type occurs. Listeners register themselves for specific events. But will get the same callback called. I.e. same object can register for multiple events.

code: void OnEvent ( [EEventQuantization](API\Runtime\SignalProcessing\DSP\Audio__EEventQuantization) EventQuantizationType, int32 Bars, float Beat )


className: IOscBase

description: Oscillator base class.

code: class IOscBase

BaseFreq

description: The base frequency of the oscillator.

bIsPlaying

description: Whether or not the oscillator is on or off.

ExternalGainMod

description: Linear gain modulation of the oscillator (used in amplitude modulation)

FollowerOsc

type: IOscBase*

description: Ptr to a follower oscillator that can be triggered to 0 phase if it is synced.

Freq

description: The final frequency of the oscillator after computing all factors contributing to frequency.

FreqData

type: FOscFrequencyMo...

description: Holds all frequency data.

Gain

description: Linear gain of the oscillator.

ModMatrix

description: Modulation matrix to use for this oscillator.

Nyquist

description: Maximum frequency allowed.

Phase

description: The current phase of oscillator (between 0.0 and 1.0)

PhaseInc

description: How much to increment the phase each update.

PulseWidth

description: The final pulse width.

PulseWidthBase

description: Pulse width used in square LFOs.

PulseWidthMod

description: Pulse width modulator factor.

SampleRate

description: Sample rate of the oscillator.

description: The voice ID that this oscillator belongs to.


className: IQuantizedEventListener

description: Event listener interface. Event listeners make callbacks to objects that are interested in specific events. Can be hooked to non-audio systems to trigger BP delegates, animation triggering, etc. Note: this event listener is called from the audio render thread (or async audio rendering/generation task).

code: class IQuantizedEventListener


description: Creates a new instance.

code: static [ISampleRateConverter](API\Runtime\SignalProcessing\DSP\ISampleRateConverter) * CreateSampleRateConverter()


code: void Init ( const float InSampleRateRatio, const int32 InNumChannels )


description:
Process chunks of audio at a time. Saves state so can properly handle buffer boundaries. Use with Reset() to reset internal state before starting realtime SRC.
Number of frames generated.

code: int32 ProcessChunk ( const int16 * BufferChunk, const int32 NumInputSamples, const int32 RequestedFrames, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutBuffer )


code: int32 ProcessChunk ( const float * BufferChunk, const int32 NumInputSamples, const int32 RequestedFrames, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutBuffer )


description:
Given an input buffer, the output buffer is fully sample-rate converted.
Number of frames generated.

code: int32 ProcessFullbuffer ( const int16 * InBuffer, const int32 InNumSamples, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutBuffer )


code: int32 ProcessFullbuffer ( const float * InBuffer, const int32 InNumSamples, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutBuffer )


description: Sets the sample rate ratio and the number of frames to interpolate from the current sample rate ratio.

code: void SetSampleRateRatio ( const float InSampleRateRatio, const int32 NumInterpolationFrames )


code: virtual ~ISampleRateConverter()


className: ISampleRateConverter

code: class ISampleRateConverter


description: Adds a band to extract based on the given settings.

code: void AddBand ( const [FBandSettings](API\Runtime\SignalProcessing\DSP\ISpectrumBandExtractor\FBandSettings) & InSettings )


description: Creates aISpectrumBandExtractor.

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISpectrumBandExtractor](API\Runtime\SignalProcessing\DSP\ISpectrumBandExtractor) > CreateSpectrumBandExtractor ( const [FSpectrumBandExtractorSettings](API\Runtime\SignalProcessing\DSP\FSpectrumBandExtractorSettings) & InSettings )


className: EBandType

code: enum EBandType { NearestNeighbor, Lerp, Quadratic, ConstantQ, }


description: Extract the bands from a complex frequency buffer.

code: void ExtractBands ( const [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & InComplexBuffer, double InTimestamp, [TArray](API\Runtime\Core\Containers\TArray)< float > & OutValues )


className: FBandSettings

description: Settings for a single band

code: struct FBandSettings

CenterFrequency

description: Frequency of interest in hz.

QFactor

description: QFactor is only applicable for the ConstantQ band type.

Type

type: EBandType

description: Type of band to extract.


description: Returns the total number of bands.

code: int32 GetNumBands() const


description: Removes all added bands.

code: void RemoveAllBands()


description: Sets and updates the settings for the band extractor

code: void SetSettings ( const [FSpectrumBandExtractorSettings](API\Runtime\SignalProcessing\DSP\FSpectrumBandExtractorSettings) & InSettings )


description: Set the settings and update cached internal values if needed

code: void SetSpectrumSettings ( const [FSpectrumBandExtractorSpectrumSettings](API\Runtime\SignalProcessing\DSP\FSpectrumBandExtractorSpectrumSe-) & InSettings )


code: virtual ~ISpectrumBandExtractor()


className: ISpectrumBandExtractor

description: The SpectrumBandExtractor allows for band information to be maintained across multiple calls to retrieve bands values.Bymaintaining band information across multiple calls, some intermediate values can be cached to speed up the operation.

code: class ISpectrumBandExtractor


description:
Returns the log probability of an initial state.
The initial log probability of the state.

code: float GetInitialLogProbability ( int32 InState ) const


code: virtual ~IViterbiInitialProbability()


className: IViterbiInitialProbability

description: Interface class for viterbi initial log probabilities.

code: class IViterbiInitialProbability


description:
Returns the log probability for a given state at a specific time step.
The log prability of the emission at the specified timestep for the specified state.

code: float GetEmissionLogProbability ( int32 InTimeStep, int32 InState ) const


description: Returns the number of states at a given states.

code: int32 GetNumStates() const


description: Returns the number of given time steps.

code: int32 GetNumTimeSteps() const


code: virtual ~IViterbiObservations()


className: IViterbiObservations

description: Note that probabilities are returned as the logarithm of a probability to avoid numerical under/over flows.

code: class IViterbiObservations


description:
Return the log probability of going from one state to another state at a specific time step.
The log probability of going from InPreviousState to InCurrentState at timestep InTimeStep.

code: float GetTransitionLogProbability ( int32 InTimeStep, int32 InPreviousState, int32 InCurrentState ) const


className: IViterbiTransitionProbability

description: Interface class for viterbi transition log probabilities.

code: class IViterbiTransitionProbability


code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< float > GetScaleDegreeSet ( bool bChordTonesOnlyIfApplicable )


description: Ctor

code: ScaleDegreeSet ( const [TArray](API\Runtime\Core\Containers\TArray)< float > & InScaleDegrees, const [TArray](API\Runtime\Core\Containers\TArray)< float > & InChordTones )


className: ScaleDegreeSet

code: struct ScaleDegreeSet


description: Return an STL iterator to the first channel.

code: TAutoChannelIterator begin()


description: Return an STL iterator to the end.

code: TAutoChannelIterator end()


className: TAutoChannelIterator

code: typedef [TDeinterleaveView](API\Runtime\SignalProcessing\DSP\TDeinterleaveView)< T >::template [TChannelIterator](API\Runtime\SignalProcessing\DSP\TDeinterleaveView\TChannelIterator)< InAllocator > TAutoChannelIterator


description: InInterleavedArray is the interleaved array to be deinterleaved. InArrayToFill is the array which will be populated with contiguous elements for a channel. InNumChannels is the number of channels in the deinterleaved array.

code: TAutoDeinterleaveView ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const T > InInterleavedArray, [TArray](API\Runtime\Core\Containers\TArray)< T, InAllocator > & InArrayToFill, int32 InNumChannels )


className: TAutoDeinterleaveView

description: TArrayArrayToFill; for (auto Channel : TAudoDeineterleaveView(InterleavedArray, ArrayToFill, 2)) { DoSomethingWithAudio(Channel.Values, Channel.ChannelIndex); }

code: template<typename T, typename InAllocator> class TAutoDeinterleaveView : public [Audio::TDeinterleaveView< T >](API\Runtime\SignalProcessing\DSP\TDeinterleaveView)


description: This iterator maintains a reference to the OutWindow passed into the constructor. That array will be manipulated when the iterator's * operator is called.

code: TAutoSlidingWindowIterator begin()


code: TAutoSlidingWindowIterator end()


className: TAutoSlidingWindowIterator

code: typedef [TSlidingWindow](API\Runtime\SignalProcessing\DSP\TSlidingWindow)< InSampleType >::template [TSlidingWindowIterator](API\Runtime\SignalProcessing\DSP\TSlidingWindow\TSlidingWindowIterator)< InAllocator > TAutoSlidingWindowIterator


description: InSlidingBuffer Holds the previous samples which were not completely used in previous sliding windows. It also defines the window and hop size. InNewBuffer Holds new samples which have not yet been ingested by the InSlidingBuffer. OutWindow is shared by all iterators created by callingbegin()orend(). bDoFlush Controls whether zeros to the final output windows until all possible windows with data from InNewBuffer have been covered.

code: TAutoSlidingWindow ( [TSlidingBuffer](API\Runtime\SignalProcessing\DSP\TSlidingBuffer)< InSampleType > & InBuffer, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const InSampleType > InNewBuffer, [TArray](API\Runtime\Core\Containers\TArray)< InSampleType, InAllocator > & OutWindow, bool bDoFlush )


className: TAutoSlidingWindow

description: ProcessAudio(SlidingBuffer, Buffer2); }

code: template<typename InSampleType, typename InAllocator> class TAutoSlidingWindow : public [Audio::TScopedSlidingWindow< InSampleType >](API\Runtime\SignalProcessing\DSP\TScopedSlidingWindow)


description: Get the current capacity of the buffer.

code: uint32 GetCapacity() const


description: Get number of samples that can be popped off of the buffer.

code: uint32 Num() const


code: [TCircularAudioBuffer](API\Runtime\SignalProcessing\DSP\TCircularAudioBuffer) & operator= ( const [TCircularAudioBuffer](API\Runtime\SignalProcessing\DSP\TCircularAudioBuffer)< SampleType, Alignment > & InOther )


description: Peeks a single element. returns false if the element is empty.

code: bool Peek ( SampleType & OutElement ) const


description: Same asPop(), but does not increment the read counter.

code: int32 Peek ( SampleType * OutBuffer, uint32 NumSamples ) const


description: Pops a single element. Will assert if the buffer is empty. Please checkNum()> 0 before calling.

code: SampleType Pop()


description: Pops some amount of samples into this circular buffer. Returns the amount of samples read.

code: int32 Pop ( uint32 NumSamples )


code: int32 Pop ( SampleType * OutBuffer, uint32 NumSamples )


description: Push an array of values into circular buffer.

code: int32 Push ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const SampleType > InBuffer )


description: Push a single sample onto this buffer. Returns false if the buffer is full.

code: bool Push ( const SampleType & InElement )


code: bool Push ( SampleType && InElement )


description: Pushes some amount of zeros into the circular buffer. Useful when acting as a blocked, mono/interleaved delay line

code: int32 PushZeros ( uint32 NumSamplesOfZeros )


description: Get number of samples that can be pushed onto the buffer before it is full.

code: uint32 Remainder() const


description: Reserve capacity.

code: void Reserve ( uint32 InMinimumCapacity, bool bRetainExistingSamples )


code: void Reset ( uint32 InCapacity )


code: void SetCapacity ( uint32 InCapacity )


description: Pushes some amount of samples into this circular buffer. Returns the amount of samples written. This can only be used for trivially copyable types.

code: int32 Push ( const SampleType * InBuffer, uint32 NumSamples )


description: When called, seeks the read or write cursor to only retain either the NumSamples latest data (if bRetainOldestSamples is false) or the NumSamples oldest data (if bRetainOldestSamples is true) in the buffer. Cannot be used to increase the capacity of this buffer.

code: void SetNum ( uint32 NumSamples, bool bRetainOldestSamples )


code: TCircularAudioBuffer ( uint32 InCapacity )


code: TCircularAudioBuffer ( const [TCircularAudioBuffer](API\Runtime\SignalProcessing\DSP\TCircularAudioBuffer)< SampleType, Alignment > & InOther )


className: TCircularAudioBuffer

description: Basic implementation of a circular buffer built for pushing and popping arbitrary amounts of data at once. Designed to be thread safe for SPSC; However, ifPush()andPop()are both trying to access an overlapping area of the buffer, One of the calls will be truncated. Thus, it is advised that you use a high enough capacity that the producer and consumer are never in contention.

code: template<typename SampleType, size_t Alignment> class TCircularAudioBuffer


description: Return an STL iterator to the first channel. It fills the given array with channel elements

code: template<typename InAllocator> [TChannelIterator](API\Runtime\SignalProcessing\DSP\TDeinterleaveView\TChannelIterator)< InAllocator > begin ( [TArray](API\Runtime\Core\Containers\TArray)< T, InAllocator > & InArrayToFill ) const


description: Return an STL iterator to the end.

code: template<typename InAllocator> [TChannelIterator](API\Runtime\SignalProcessing\DSP\TDeinterleaveView\TChannelIterator)< InAllocator > end ( [TArray](API\Runtime\Core\Containers\TArray)< T, InAllocator > & InArrayToFill ) const


code: TChannel &40; TArray< T, InAllocator > & InValues, const int32 InChannelIndex &41;


className: TChannel

description: TChannelprovides a contiguous copy of an single channel from an interleaved array.

code: template<typename InAllocator> class TChannel

ChannelIndex

type: const int32

Values

type: TArray< T, InAl...


className: ChannelIndexEnd

description: Denotes the end of a channel iterator

code: static ChannelIndexEnd = INDEX_NONE;


description: Get the current channel index

code: int32 GetChannelIndex&40;&41; const


description: Check equality between iterators

code: bool operator&33;&61; &40; const TChannelIterator & Other &41; const


description: Dereference the iterator, returns aTChannelobject

code: TChannel< InAllocator > operator&42;&40;&41;


description: Increment the iterator forward by one channel


description: InDeinterleaveView is the parent view provides the source interleaved array for this iterator. InArrayToFill is the array which will be populated with contiguous elements for a channel. InChannelIndex is the channel index which this iterator will point to.

code: TChannelIterator &40; TDeinterleaveView< T > InDeinterleaveView, TArray< T, InAllocator > & InArrayToFill, int32 InChannelIndex &41;


className: TChannelIterator

description: TChannelIteratoriterates over channels in an interleaved array and providing contiguous arrays of a single channel.

code: template<typename InAllocator> class TChannelIterator


className: TDeinterleaveView

description: TDeinterleaveViewprovides iterators to access deinterleaved arrays from an interleaved array.

code: template<typename T> class TDeinterleaveView


description: InInterleavedArray is the interleaved array to be deinterleaved. InNumChannels is the number of channels in the deinterleaved array.

code: TDeinterleaveView ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const T > InInterleavedArray, int32 InNumChannels )


className: Value

code: static const int64 Value = Base * TGetPower<Base, Exp - 1>::Value;


className: TGetPower

description: TGetPower< Base, 0 >

code: template<int Base, int Exp> struct TGetPower


className: TGetPower< Base, 0 >

code: template<int Base> struct TGetPower< Base, 0 >


code: void CopyParams ( T & OutParamsCopy ) const


description: Returns a copy of the params safely if they've changed since last time this was called.

code: bool GetParams ( T * OutParamsCopy )


description: Sets the params.

code: void SetParams ( const T & InParams )


className: TParams

description: Simple parameter object which uses critical section to write to and read from data.

code: template<typename T> class TParams

CritSect

type: FCriticalSectio...

CurrentParams

type: T


code: template<typename ReturnType, uint32 ReturnQ> ReturnType AsFixedPrecisionInt()


code: template<typename ReturnType> ReturnType AsFloat() const


className: MaxValue

description: For fixed precision types, the max and min values that we can represent are calculated here:

code: static constexpr float MaxValue = TGetPower<2, (sizeof(SampleType) * 8 - Q)>::Value;


className: MinValue

code: static constexpr float MinValue = !!TIsSigned<SampleType>::Value ? (-1.0f * MaxValue) : 0.0f;


code: template<typename OtherSampleType> [TSample](API\Runtime\SignalProcessing\DSP\TSample)< SampleType, Q > & operator= ( const OtherSampleType InSample )


code: TSample ( SampleType & InSample )


className: QFactor

description: This is the number used to convert from float to our fixed precision value.

code: static constexpr float QFactor = TGetPower<2, Q>::Value - 1;


className: TSample

description: TSampleVariant type to simplify converting and performing operations on fixed precision and floating point samples.

code: template<typename SampleType, uint32 Q> class TSample


code: template<typename OtherSampleType> [TSampleRef](API\Runtime\SignalProcessing\DSP\TSampleRef)< SampleType, Q > & operator= ( const OtherSampleType InSample )


code: TSampleRef ( SampleType & InSample )


className: TSampleRef

description: bool bThisCodeWorks = FixedPrecisionSample ==TNumericLimits::Max()/ 4;

code: template<typename SampleType, uint32 Q> class TSampleRef


description: Do not allow copying or moving since that may cause the destructor to be called inadvertently.

code: TScopedSlidingWindow &40; TScopedSlidingWindow const & &41;


description: InSlidingBuffer Holds the previous samples which were not completely used in previous sliding windows. It also defines the window and hop size. InNewBuffer Holds new samples which have not yet been ingested by the InSlidingBuffer. bDoFlush Controls whether zeros to the final output windows until all possible windows with data from InNewBuffer have been covered.

code: TScopedSlidingWindow ( [TSlidingBuffer](API\Runtime\SignalProcessing\DSP\TSlidingBuffer)< InSampleType > & InSlidingBuffer, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const InSampleType > InNewBuffer, bool bDoFlush )


code: TScopedSlidingWindow &40; TScopedSlidingWindow && &41;


description: Calls InSlidingBuffer.StoreForFutureWindows(InNewBuffer).

code: virtual ~TScopedSlidingWindow()


className: TScopedSlidingWindow

description: TScopedSlidingWindowprovides a sliding window iterator interface over arrays. WhenTScopedSlidingWindowis destructed, it calls StoreForFutureWindow(...) on theTSlidingBufferpassed into the constructor.

code: template<class InSampleType> class TScopedSlidingWindow : public [Audio::TSlidingWindow< InSampleType >](API\Runtime\SignalProcessing\DSP\TSlidingWindow)


description: Returns the number of samples between windows.

code: int32 GetNumHopSamples() const


description: Returns the number of samples in a window.

code: int32 GetNumWindowSamples() const


description: Resets the internal storage.

code: void Reset()


description: StoreForFutureWindows stores the necessary samples from InBuffer which will be needed for future windows. It ignores all values in InBuffer which can already be composed as a complete window.

code: void StoreForFutureWindows ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const InSampleType > InBuffer )


description: Constructs aTSlidingBufferwith a constant window and hop size

code: TSlidingBuffer ( const int32 InNumWindowSamples, const int32 InNumHopSamples )


description: OutWindowBuffer Used to construct theTSlidingWindowIterator. The iterator will populate the window with samples when the * operator is called.

code: template<typename InAllocator> [TSlidingWindowIterator](API\Runtime\SignalProcessing\DSP\TSlidingWindow\TSlidingWindowIterator)< InAllocator > begin ( [TArray](API\Runtime\Core\Containers\TArray)< InSampleType, InAllocator > & OutWindowBuffer ) const


className: TSlidingBuffer

description: TSlidingBuffershould be used in conjunction with theTSlidingWindow,TScopedSlidingWindoworTAutoSlidingWindowclasses.

code: template<typename InSampleType> class TSlidingBuffer


code: template<typename InAllocator> [TSlidingWindowIterator](API\Runtime\SignalProcessing\DSP\TSlidingWindow\TSlidingWindowIterator)< InAllocator > end ( [TArray](API\Runtime\Core\Containers\TArray)< InSampleType, InAllocator > & OutWindowBuffer ) const


description: Check whether iterators are equal. TSlidingWindowIterators derived from different TSlidingWindows should not be compared.

code: bool operator&33;&61; &40; const TSlidingWindowIterator & Other &41; const


description: Access array of windowed data currently pointed to by iterator.

code: TArray< InSampleType, InAllocator > & operator&42;&40;&41;


description: Increment sliding window iterator forward.


className: ReadIndexEnd

description: Sentinel value marking that the last possible window has been generated.

code: static ReadIndexEnd = INDEX_NONE;


description: Construct an iterator over a sliding window.

code: TSlidingWindowIterator &40; const TSlidingWindow & InSlidingWindow, TArray< InSampleType, InAllocator > & OutWindowBuffer, int32 InReadIndex &41;


className: TSlidingWindowIterator

description: An forward iterator which slides a window over the given buffers.

code: template<typename InAllocator> class TSlidingWindowIterator


code: TSlidingWindow ( const [TSlidingBuffer](API\Runtime\SignalProcessing\DSP\TSlidingBuffer)< InSampleType > & InSlidingBuffer, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const InSampleType > InNewBuffer, bool bDoFlush )


code: virtual ~TSlidingWindow()


className: TSlidingWindow

description: TSlidingWindowallows windows of samples to be iterated over with STL like iterators.

code: template<typename InSampleType> class TSlidingWindow

NewBuffer

type: TArrayView< con...

description: New buffer passed in.

NumHopSamples

description: Copied fromTSlidingBuffer.

NumWindowSamples

description: Copied fromTSlidingBuffer.

StorageBuffer

description: Accessed from friendship withTSlidingBuffer.


className: FSampleBuffer

description: FSampleBuffer is a strictly definedTSampleBufferthat uses the same sample format we use for USoundWaves.


description: Append audio data to internal buffer of different sample type of this sample buffer.

code: template<class OtherSampleType> void Append ( const OtherSampleType * InputBuffer, int32 InNumSamples )


description: Overload of Append that also sets the number of channels and sample rate.

code: template<class OtherSampleType> void Append ( const OtherSampleType * InputBuffer, int32 InNumSamples, int32 InNumChannels, int32 InSampleRate )


code: void Clamp ( float Ceiling )


description: Copy from a container of the same element type

code: void CopyFrom ( const [TArray](API\Runtime\Core\Containers\TArray)< SampleType > & InArray, int32 InNumChannels, int32 InSampleRate )


code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< SampleType > GetArrayView()


code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const SampleType > GetArrayView() const


description: InIndex [0.0f, NumSamples - 1.0f] OutFrame is the multichannel output for one index value Returns InIndex wrapped between 0.0 and NumFrames

code: float GetAudioFrameAtFractionalIndex ( float InIndex, [TArray](API\Runtime\Core\Containers\TArray)< SampleType > & OutFrame ) const


description: InPhase [0, 1], wrapped, through duration of file (ignores sample rate) OutFrame is the multichannel output for one phase value Returns InPhase wrapped between 0.0 and 1.0

code: float GetAudioFrameAtPhase ( float InPhase, [TArray](API\Runtime\Core\Containers\TArray)< SampleType > & OutFrame ) const


description: InTimeSec, get the value of the buffer at the given time (uses sample rate) OutFrame is the multichannel output for one time value Returns InTimeSec wrapped between 0.0 and (NumSamples / SampleRate)

code: float GetAudioFrameAtTime ( float InTimeSec, [TArray](API\Runtime\Core\Containers\TArray)< SampleType > & OutFrame ) const


description: Gets the raw PCM data of the sound wave.

code: const SampleType * GetData() const


description: Gets the number of channels of the sound wave.

code: int32 GetNumChannels() const


description: Gets the number of frames of the sound wave.

code: int32 GetNumFrames() const


description: Gets the number of samples of the sound wave.

code: int32 GetNumSamples() const


code: float GetSampleDuration() const


description: Gets the sample rate of the sound wave.

code: int32 GetSampleRate() const


code: void MixBufferToChannels ( int32 InNumChannels )


description: Vanilla assignment operator:

code: [TSampleBuffer](API\Runtime\SignalProcessing\TSampleBuffer) & operator= ( const [TSampleBuffer](API\Runtime\SignalProcessing\TSampleBuffer) & Other )


description: SampleType converting assignment operator:

code: template<class OtherSampleType> [TSampleBuffer](API\Runtime\SignalProcessing\TSampleBuffer) & operator= ( const [TSampleBuffer](API\Runtime\SignalProcessing\TSampleBuffer)< OtherSampleType > & Other )


code: void SetNumFrames ( int32 InNumFrames )


description: Appends zeroes to the end of this buffer. If called with no arguments or NumFramesToAppend = 0, this will ZeroPad

code: void ZeroPad ( int32 NumFramesToAppend )


code: TSampleBuffer ( const [TSampleBuffer](API\Runtime\SignalProcessing\TSampleBuffer) & Other )


code: TSampleBuffer ( const [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & InData, int32 InNumChannels, int32 InSampleRate )


code: TSampleBuffer ( const float * InBufferPtr, int32 InNumSamples, int32 InNumChannels, int32 InSampleRate )


code: TSampleBuffer ( const int16 * InBufferPtr, int32 InNumSamples, int32 InNumChannels, int32 InSampleRate )


className: TSampleBuffer

description: TSampleBufferThis class owns an audio buffer. To convert between fixed Q15 buffers and float buffers, Use the assignment operator. Example:TSampleBufferAFloatBuffer;TSampleBufferAnIntBuffer = AFloatBuffer;

code: template<class SampleType> class TSampleBuffer


module: SkeletalMeshDescription

code: static void Add ( [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\ContainerType) & InContainer, [FBoneWeight](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\FBoneWeight) InBoneWeight )


className: ContainerType

code: typedef [TArrayAttribute](API\Runtime\MeshDescription\TArrayAttribute)< int32 > ContainerType


code: static [FBoneWeight](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\FBoneWeight) Get ( const [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\ContainerType) & InContainer, int32 InIndex )


code: template<typename Predicate> static int32 IndexOf ( const [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\ContainerType) & InContainer, Predicate InPredicate )


code: static int32 Num ( const [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\ContainerType) & InContainer )


code: static void Remove ( [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\ContainerType) & InContainer, int32 InIndex )


code: static void Set ( [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\ContainerType) & InContainer, int32 InIndex, [FBoneWeight](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\FBoneWeight) InBoneWeight )


code: template<typename Predicate> static void Sort ( [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\ContainerType) & InContainer, Predicate InPredicate )


className: FAttributesRefAdapter

code: struct FAttributesRefAdapter


code: typedef const [TArrayAttribute](API\Runtime\MeshDescription\TArrayAttribute)< const int32 > ContainerType


code: template<typename Predicate> static int32 IndexOf ( const [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapterConst\ContainerType) & InContainer, Predicate InPredicate )


code: static [FBoneWeight](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapterConst\FBoneWeight) Get ( const [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapterConst\ContainerType) & InContainer, int32 InIndex )


code: static void SetNum ( [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapter\ContainerType) & InContainer, int32 InNum )


code: static int32 Num ( const [ContainerType](API\Runtime\SkeletalMeshDescription\FAttributesRefAdapterConst\ContainerType) & InContainer )


className: FAttributesRefAdapterConst

code: struct FAttributesRefAdapterConst


code: [TAttributesSet](API\Runtime\MeshDescription\TAttributesSet)< [FBoneID](API\Runtime\MeshDescription\FBoneID) > & BoneAttributes()


description: Adds a new bone and returns its ID


description: Adds a new bone with the given ID

code: void CreateBone ( const [FBoneID](API\Runtime\MeshDescription\FBoneID) BoneID )


description: Deletes a bone with the given ID

code: void DeleteBone ( const [FBoneID](API\Runtime\MeshDescription\FBoneID) BoneID )


description: Returns the skin weight profile given by its name. NAME_None corresponds to the default profile.

code: [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) GetVertexSkinWeights ( const [FName](API\Runtime\Core\UObject\FName) & InProfileName )


code: virtual void Register ( bool bKeepExistingAttribute )


code: static bool IsReservedAttributeName ( const [FName](API\Runtime\Core\UObject\FName) & InAttributeName )


description: Bones MethodsRegister an optional color attribute for bones

code: void RegisterColorAttribute()


description: Skin Weights MethodsRegister a new skin weight profile with the given name. The attribute name will encode the profile name and it will be listed inGetSkinWeightProfileNames(). Returnstrue_ if the profile was successfully registered. Returnsfalse_ if the attribute was already registered or ifIsValidSkinWeightProfileName()returned false.

code: bool RegisterSkinWeightAttribute ( const [FName](API\Runtime\Core\UObject\FName) & InProfileName )


description: Reserves space for this number of new bones

code: void ReserveNewBones ( const int InNumBones )


code: [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) GetVertexSkinWeightsFromAttributeName ( const [FName](API\Runtime\Core\UObject\FName) & InAttributeName )


className: FSkeletalMeshAttributes

code: class FSkeletalMeshAttributes : public [FStaticMeshAttributes](API\Runtime\StaticMeshDescription\FStaticMeshAttributes), public [FSkeletalMeshAttributesShared](API\Runtime\SkeletalMeshDescription\FSkeletalMeshAttributesShared)


code: const [TAttributesSet](API\Runtime\MeshDescription\TAttributesSet)< [FBoneID](API\Runtime\MeshDescription\FBoneID) > & BoneAttributes() const


code: FSkeletalMeshAttributes ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & InMeshDescription )


code: const [FBoneArray](API\Runtime\SkeletalMeshDescription\FSkeletalMeshAttributesShared\FBoneArray) & Bones() const


className: BonesElementName

description: this is different from the MeshAttribute::Bone::Name attribute. This is a name of the element that is added to the mesh description to represent Bones (similar to the Vertex/Polygons/Edges elements). MeshAttribute::Bone::Name is just one of the attributes of the Bones element.


description: Construct a name for a skin weight attribute with the given skin weight profile name. Each mesh description can hold different skin weight profiles, although the default is always present.

code: static [FName](API\Runtime\Core\UObject\FName) CreateSkinWeightAttributeName ( const [FName](API\Runtime\Core\UObject\FName) & InProfileName )


className: DefaultSkinWeightProfileName

description: The name of the default skin weight profile.


className: FBoneArray

code: typedef [TMeshElementContainer](API\Runtime\MeshDescription\TMeshElementContainer)< [FBoneID](API\Runtime\MeshDescription\FBoneID) > FBoneArray


className: FBoneColorAttributesRef

code: typedef [TMeshAttributesRef](API\Runtime\MeshDescription\TMeshAttributesRef)< [FBoneID](API\Runtime\MeshDescription\FBoneID), FVector4f > FBoneColorAttributesRef


className: FBoneColorAttributesConstRef

code: typedef TMeshAttributesConstRef< [FBoneID](API\Runtime\MeshDescription\FBoneID), FVector4f > FBoneColorAttributesConstRef


className: FBoneNameAttributesConstRef

code: typedef TMeshAttributesConstRef< [FBoneID](API\Runtime\MeshDescription\FBoneID), [FName](API\Runtime\Core\UObject\FName) > FBoneNameAttributesConstRef


className: FBoneParentIndexAttributesRef

code: typedef [TMeshAttributesRef](API\Runtime\MeshDescription\TMeshAttributesRef)< [FBoneID](API\Runtime\MeshDescription\FBoneID), int32 > FBoneParentIndexAttributesRef


className: FBoneNameAttributesRef

code: typedef [TMeshAttributesRef](API\Runtime\MeshDescription\TMeshAttributesRef)< [FBoneID](API\Runtime\MeshDescription\FBoneID), [FName](API\Runtime\Core\UObject\FName) > FBoneNameAttributesRef


className: FBoneParentIndexAttributesConstRef

code: typedef TMeshAttributesConstRef< [FBoneID](API\Runtime\MeshDescription\FBoneID), int32 > FBoneParentIndexAttributesConstRef


className: FBonePoseAttributesRef

code: typedef [TMeshAttributesRef](API\Runtime\MeshDescription\TMeshAttributesRef)< [FBoneID](API\Runtime\MeshDescription\FBoneID), FTransform > FBonePoseAttributesRef


className: FBonePoseAttributesConstRef

code: typedef TMeshAttributesConstRef< [FBoneID](API\Runtime\MeshDescription\FBoneID), FTransform > FBonePoseAttributesConstRef


description: the number of the bones. 0 if bone element does not exist in the MeshDescripion.

code: int32 GetNumBones() const


description: Returns a skin profile name from the attribute name, if the attribute name is a valid skin weights attribute.

code: static [FName](API\Runtime\Core\UObject\FName) GetProfileNameFromAttribute ( const [FName](API\Runtime\Core\UObject\FName) & InAttributeName )


description: Skin Weights Methods

code: [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetSkinWeightProfileNames() const


code: [FSkinWeightsVertexAttributesConstRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesCons-) GetVertexSkinWeights ( const [FName](API\Runtime\Core\UObject\FName) & InProfileName ) const


code: [FSkinWeightsVertexAttributesConstRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesCons-) GetVertexSkinWeightsFromAttributeName ( const [FName](API\Runtime\Core\UObject\FName) & InAttributeName ) const


description: Bones Methods

code: bool HasBoneColorAttribute() const


code: bool HasBoneNameAttribute() const


code: bool HasBonePoseAttribute() const


description: true, if the passed bone ID is valid

code: bool IsBoneValid ( const [FBoneID](API\Runtime\MeshDescription\FBoneID) BoneID ) const


description: true, if bone element was added to the MeshDescription.

code: bool HasBones() const


description: Helper function that indicates whether an attribute name represents a skin weight attribute.

code: static bool IsSkinWeightAttribute ( const [FName](API\Runtime\Core\UObject\FName) & InAttributeName )


description: Returns `true_ if the given identifier is a valid profile name. If the name is empty, or matches the default profile, then the profile name is considered invalid.

code: static bool IsValidSkinWeightProfileName ( const [FName](API\Runtime\Core\UObject\FName) & InProfileName )


code: FSkeletalMeshAttributesShared ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & InMeshDescription )


className: FSkeletalMeshAttributesShared

code: class FSkeletalMeshAttributesShared


code: FSkeletalMeshConstAttributes ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & InMeshDescription )


className: FSkeletalMeshConstAttributes


code: static void AppendSkinWeight ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & SourceMesh, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & TargetMesh, [FSkeletalMeshAppendSettings](API\Runtime\SkeletalMeshDescription\FSkeletalMeshOperations\FSkeletalMeshApp-) & AppendSettings )


className: FSkeletalMeshAppendSettings

code: struct FSkeletalMeshAppendSettings

SourceRemapBoneIndex

type: TArray< FBoneIn...


className: FSkeletalMeshOperations

code: class FSkeletalMeshOperations : public [FStaticMeshOperations](API\Runtime\StaticMeshDescription\FStaticMeshOperations)


code: FVertexBoneWeightsConst Get ( [FVertexID](API\Runtime\MeshDescription\FVertexID) InVertexIndex ) const


code: [FSkinWeightsVertexAttributesConstRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesCons-) & operator= ( const [FSkinWeightsVertexAttributesConstRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesCons-) & InAttributesRef )


code: bool IsValid() const


code: [FSkinWeightsVertexAttributesConstRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesCons-) & operator= ( [FSkinWeightsVertexAttributesConstRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesCons-) && InAttributesRef )


code: [FSkinWeightsVertexAttributesConstRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesCons-) & operator= ( const [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) & InAttribs )


code: FSkinWeightsVertexAttributesConstRef()


code: FSkinWeightsVertexAttributesConstRef ( const [FSkinWeightsVertexAttributesConstRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesCons-) & )


description: Converting constructors from the non-const variant.

code: FSkinWeightsVertexAttributesConstRef ( const [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) & InAttribs )


code: FSkinWeightsVertexAttributesConstRef ( TVertexAttributesRef< [TArrayAttribute](API\Runtime\MeshDescription\TArrayAttribute)< int32 >> InAttributesConstRef )


code: FSkinWeightsVertexAttributesConstRef ( TVertexAttributesRef< [TArrayAttribute](API\Runtime\MeshDescription\TArrayAttribute)< const int32 >> InAttributesConstRef )


className: FSkinWeightsVertexAttributesConstRef


code: FVertexBoneWeights Get ( const [FVertexID](API\Runtime\MeshDescription\FVertexID) InVertexIndex ) const


code: [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) & operator= ( [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) && InAttributesRef )


code: [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) & operator= ( const [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) & InAttributesRef )


code: void Set ( const [FVertexID](API\Runtime\MeshDescription\FVertexID) InVertexIndex, const [UE::AnimationCore::FBoneWeights](API\Runtime\AnimationCore\FBoneWeights) & InWeights )


code: FSkinWeightsVertexAttributesConstRef ( [FSkinWeightsVertexAttributesConstRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesCons-) && )


code: void Set ( const [FVertexID](API\Runtime\MeshDescription\FVertexID) InVertexIndex, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [UE::AnimationCore::FBoneWeight](API\Runtime\AnimationCore\FBoneWeight) > InWeights, const [UE::AnimationCore::FBoneWeightsSettings](API\Runtime\AnimationCore\FBoneWeightsSettings) & InSettings )


code: FSkinWeightsVertexAttributesRef()


code: FSkinWeightsVertexAttributesRef ( const [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) & )


code: FSkinWeightsVertexAttributesRef ( [FSkinWeightsVertexAttributesRef](API\Runtime\SkeletalMeshDescription\FSkinWeightsVertexAttributesRef) && )


code: FSkinWeightsVertexAttributesRef ( TVertexAttributesRef< [TArrayAttribute](API\Runtime\MeshDescription\TArrayAttribute)< int32 >> InAttributesRef )


className: FSkinWeightsVertexAttributesRef

description: Merge these two.

code: class FSkinWeightsVertexAttributesRef


code: bool operator&33;&61; &40; const const_iterator & InOther &41; const


code: const_iterator &40; const TVertexBoneWeightsBase< AdaptorType, StorageType > &42; InWeights, int32 InIndex &41;


description: For compatibility with range-based for loops.

code: class const_iterator

Weights

type: constTVertexBo...


code: TVertexBoneWeightsBase ( const [TArrayAttribute](API\Runtime\MeshDescription\TArrayAttribute)< StorageType > InContainer )


className: Super

code: typedef [UE::AnimationCore::TBoneWeights](API\Runtime\AnimationCore\TBoneWeights)< AdaptorType > Super


className: TVertexBoneWeightsBase

code: template<typename AdaptorType, typename StorageType> class TVertexBoneWeightsBase : public [UE::AnimationCore::TBoneWeights< AdaptorType >](API\Runtime\AnimationCore\TBoneWeights)


module: Slate

code: namespace AnalogCursorMode { enum Type { Accelerated, Direct, } }


description: Set the cached analog stick declinations to 0

code: void ClearAnalogValues()


code: virtual FVector2D CalculateTickedCursorPosition ( const float DeltaTime, [FSlateApplication](API\Runtime\Slate\Framework\Application\FSlateApplication) & SlateApp, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSlateUser](API\Runtime\Slate\Framework\Application\FSlateUser) > SlateUser )


description: Getter

code: const FVector2D & GetAnalogValues ( EAnalogStick Stick ) const


description: Debug name for logging purposes

code: virtual const TCHAR * GetDebugName() const


code: virtual int32 GetOwnerUserIndex() const


description: Analog axis input

code: virtual bool HandleAnalogInputEvent ( [FSlateApplication](API\Runtime\Slate\Framework\Application\FSlateApplication) & SlateApp, const [FAnalogInputEvent](API\Runtime\SlateCore\Input\FAnalogInputEvent) & InAnalogInputEvent )


description: Key up input

code: virtual bool HandleKeyUpEvent ( [FSlateApplication](API\Runtime\Slate\Framework\Application\FSlateApplication) & SlateApp, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description: Key down input

code: virtual bool HandleKeyDownEvent ( [FSlateApplication](API\Runtime\Slate\Framework\Application\FSlateApplication) & SlateApp, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description: Mouse movement input

code: virtual bool HandleMouseMoveEvent ( [FSlateApplication](API\Runtime\Slate\Framework\Application\FSlateApplication) & SlateApp, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual bool IsRelevantInput ( const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & KeyEvent ) const


code: virtual bool IsRelevantInput ( const [FAnalogInputEvent](API\Runtime\SlateCore\Input\FAnalogInputEvent) & AnalogInputEvent ) const


code: virtual bool IsRelevantInput ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) const


code: void SetAcceleration ( float NewAcceleration )


code: void SetDeadZone ( float NewDeadZone )


code: void SetMaxSpeed ( float NewMaxSpeed )


code: void SetMode ( [AnalogCursorMode::Type](API\Runtime\Slate\Framework\Application\AnalogCursorMode__Type) NewMode )


code: void SetStickySlowdown ( float NewStickySlowdown )


code: virtual bool IsRelevantInput ( const [FInputEvent](API\Runtime\SlateCore\Input\FInputEvent) & InputEvent ) const


code: virtual void Tick ( const float DeltaTime, [FSlateApplication](API\Runtime\Slate\Framework\Application\FSlateApplication) & SlateApp, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ICursor](API\Runtime\ApplicationCore\GenericPlatform\ICursor) > Cursor )


description: Handles updating the cursor position and processing a Mouse Move Event

code: virtual void UpdateCursorPosition ( [FSlateApplication](API\Runtime\Slate\Framework\Application\FSlateApplication) & SlateApp, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ICursor](API\Runtime\ApplicationCore\GenericPlatform\ICursor) > Cursor, const FVector2D & NewPosition, bool bForce )


code: virtual void UpdateCursorPosition ( [FSlateApplication](API\Runtime\Slate\Framework\Application\FSlateApplication) & SlateApp, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSlateUser](API\Runtime\Slate\Framework\Application\FSlateUser) > SlateUser, const FVector2D & NewPosition, bool bForce )


description: Dtor

code: virtual ~FAnalogCursor()


className: FAnalogCursor

description: A class that simulates a cursor driven by an analog stick.

code: class FAnalogCursor : public [IInputProcessor](API\Runtime\Slate\Framework\Application\IInputProcessor), public [TSharedFromThis< FAnalogCursor >](API\Runtime\Core\Templates\TSharedFromThis)

Acceleration

type: float

description: Current settings

CurrentOffset

description: Current sub-pixel offset

CurrentSpeed

description: Current speed of the cursor

Mode

type: AnalogCursorMod...


code: bool operator== ( const [FAnalogNavigationKey](API\Runtime\Slate\Framework\Application\FAnalogNavigationKey) & Rhs ) const


code: FAnalogNavigationKey ( const [FKey](API\Runtime\InputCore\FKey) & InKey, const EUINavigation InNavDir )


className: FAnalogNavigationKey

description: Since we now support multiple analog values driving the same navigation axis, we need to key their repeat-state by bothFKeyand EUINavigation

code: struct FAnalogNavigationKey

AnalogKey

type: FKey

NavigationDir

type: EUINavigation


description: Generates gesture messages for all enabled gestures.

code: void GenerateGestures ( [FGenericApplicationMessageHandler](API\Runtime\ApplicationCore\GenericPlatform\FGenericApplicationMessageHandle-) & MessageHandler, const [TBitArray](API\Runtime\Core\Containers\TBitArray)< [FDefaultBitArrayAllocator](API\Runtime\Core\Containers\FDefaultBitArrayAllocator) > & EnabledGestures )


className: FAnalogNavigationState

code: struct FAnalogNavigationState

LastNavigationTime

type: double


description: Call to determine if the gesture is supported by the gesture detector.

code: static bool IsGestureSupported ( EGestureEvent Gesture )


className: LongPressAllowedMovement

description: The amount of movement allowed before the finger is no longer considered valid for a long press, until it's removed and re-pressed.

code: static float LongPressAllowedMovement = 0;


className: LongPressSeconds

description: The amount of time in seconds you hold a finger down before it's detected as a long press.

code: static double LongPressSeconds = 0.800f;


code: void OnTouchEnded ( int32 TouchIndex, const FVector2D & Location )


code: void OnTouchMoved ( int32 TouchIndex, const FVector2D & Location )


code: void OnTouchStarted ( int32 TouchIndex, const FVector2D & Location )


description: Dismisses the entire menu stack

code: void DismissAll()


className: FGestureDetector

description: The gesture detector can simulate the detection of certain kinds of gestures that may or may not be available to be detected at the platform level.

code: class FGestureDetector


description:
Finds a menu in the stack that owns InWindow. Although this method isn't deprecated, it is intended for private use insideFMenuStackand its use as a public method should be avoided. Menus should be identified in client code asIMenuinterfaces.
The menu in the stack that owns InWindow, or an invalid ptr if not found

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > FindMenuFromWindow ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > InWindow ) const


description: Dismisses the menu stack including InFromMenu and all its child menus Dismisses in reverse order (children first)

code: void DismissFrom ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > & InFromMenu )


description:
Searches from bottom to top of the widget path for a menu in the stack. If the widget at the end of PathToQuery is inside a menu, there will be a menu content wrapper widget in the path.
The menu in the stack that contains the widget at the end of PathToQuery, or an invalid ptr if not found

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > FindMenuInWidgetPath ( const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & PathToQuery ) const


description: Returns the widget that is the parent widget that initially created the menu in the stack

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetHostWidget() const


description: Returns the window that is the parent of everything in the stack, if any. If the stack is empty, returns an invalid ptr.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > GetHostWindow() const


description:
Called by the application when showing tooltips. It prevents tooltips from drawing over menu items. If the resulting bool is false, the resulting OutSlateRect will be [0,0,0,0] and should not be used.
A bool indicating whether a solution was found. If false, the resulting OutSlateRect will be [0,0,0,0] and should not be used.

code: bool GetToolTipForceFieldRect ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > & InMenu, const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & InPathContainingMenu, [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & OutSlateRect ) const


description: Notifies the stack that a new window was activated. The menu stack will be dismissed if the activated window is not a menu in the stack

code: void OnWindowActivated ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > ActivatedWindow )


description: Returns whether the menu has child menus. If the menu isn't in the stack, returns false.

code: bool HasOpenSubMenus ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > InMenu ) const


description: Called by the application when any window is destroyed.

code: void OnWindowDestroyed ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > InWindow )


description: True if the stack has one or more menus in it, false if it is empty.

code: bool HasMenus() const


description: Pushes a new child menu onto the stack. Menus are always auto-sized. Use fixed-size content if a fixed size is required.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > Push ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > & InParentMenu, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InContent, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & SummonLocation, const [FPopupTransitionEffect](API\Runtime\Slate\Framework\Application\FPopupTransitionEffect) & TransitionEffect, const bool bFocusImmediately, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & SummonLocationSize, const bool bIsCollapsedByParent, const bool bEnablePerPixelTransparency )


description: Pushes a new menu onto the stack. The widget path will be searched for existing menus and the new menu will be parented appropriately. Menus are always auto-sized. Use fixed-size content if a fixed size is required.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > Push ( const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & InOwnerPath, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InContent, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & SummonLocation, const [FPopupTransitionEffect](API\Runtime\Slate\Framework\Application\FPopupTransitionEffect) & TransitionEffect, const bool bFocusImmediately, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & SummonLocationSize, [TOptional](API\Runtime\Core\IO\TOptional)< EPopupMethod > InMethod, const bool bIsCollapsedByParent, const bool bEnablePerPixelTransparency )


description: Pushes a new child menu onto the stack that is drawn by an external host widget. Menus are always auto-sized. Use fixed-size content if a fixed size is required.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > PushHosted ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > & InParentMenu, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenuHost](API\Runtime\Slate\Framework\Application\IMenuHost) > & InMenuHost, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InContent, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & OutWrappedContent, const [FPopupTransitionEffect](API\Runtime\Slate\Framework\Application\FPopupTransitionEffect) & TransitionEffect, EShouldThrottle ShouldThrottle, const bool bIsCollapsedByParent )


description: Constructor

code: FMenuStack()


className: FMenuStack

description: Represents a stack of open menus. The last item in the stack is the top most menu Menus are described as IMenus. Implementations ofIMenucan control how the menus are created and presented (e.g. in their own window)

code: class FMenuStack


description: Returns the navigation action corresponding to a key event. This version will handle multiple users correctly

code: virtual EUINavigationAction GetNavigationActionFromKey ( const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent ) const


description: Deprecated* GetNavigationActionForKey doesn't handle multiple users properly, use GetNavigationActionFromKey instead

code: virtual EUINavigationAction GetNavigationActionForKey ( const [FKey](API\Runtime\InputCore\FKey) & InKey ) const


description: Gets the navigation direction from a given key event.

code: virtual EUINavigation GetNavigationDirectionFromKey ( const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent ) const


description: Pushes a new menu onto the stack that is drawn by an external host widget. The widget path will be searched for existing menus and the new menu will be parented appropriately. Menus are always auto-sized. Use fixed-size content if a fixed size is required.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > PushHosted ( const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & InOwnerPath, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenuHost](API\Runtime\Slate\Framework\Application\IMenuHost) > & InMenuHost, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InContent, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & OutWrappedContent, const [FPopupTransitionEffect](API\Runtime\Slate\Framework\Application\FPopupTransitionEffect) & TransitionEffect, EShouldThrottle ShouldThrottle, const bool bIsCollapsedByParent )


description: Gets the navigation direction from a given analog event.

code: virtual EUINavigation GetNavigationDirectionFromAnalog ( const [FAnalogInputEvent](API\Runtime\SlateCore\Input\FAnalogInputEvent) & InAnalogEvent )


description: Gets the repeat rate of the navigation based on the current pressure being applied. The idea being that if the user moves the stick a little, we would navigate slowly, if they move it a lot, we would repeat the navigation often.

code: virtual float GetRepeatRateForPressure ( float InPressure, int32 InRepeats ) const


code: virtual bool IsAnalogHorizontalKey ( const [FKey](API\Runtime\InputCore\FKey) & InKey ) const


code: virtual bool IsAnalogVerticalKey ( const [FKey](API\Runtime\InputCore\FKey) & InKey ) const


description: Called when the navigation config is registered with Slate Application

code: virtual void OnRegister()


description: Notified when navigation has caused a widget change to occur

code: virtual void OnNavigationChangedFocus ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > OldWidget, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > NewWidget, [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) FocusEvent )


code: virtual void OnUnregister()


description: Simplification of config as string

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString() const


description: Notified when users are removed from the system, good chance to clean up any user specific state.

code: virtual void OnUserRemoved ( int32 UserIndex )


description: Ctor

code: FNavigationConfig()


description: Gets the navigation direction from the analog internally.

code: virtual EUINavigation GetNavigationDirectionFromAnalogInternal ( const [FAnalogInputEvent](API\Runtime\SlateCore\Input\FAnalogInputEvent) & InAnalogEvent )


description: Dtor

code: virtual ~FNavigationConfig()


className: FNavigationConfig

description: This class is used to control which FKeys and analog axis should move focus.

code: class FNavigationConfig : public [TSharedFromThis< FNavigationConfig >](API\Runtime\Core\Templates\TSharedFromThis)

AnalogHorizontalKey

description: Which Axis Key controls horizontal navigation

AnalogVerticalKey

description: Which Axis Key controls vertical navigation

bAnalogNavigation

type: bool

description: Should we respect the analog stick for navigation.

bKeyNavigation

description: Should we respect keys for navigation.

bTabNavigation

description: Should the Tab key perform next and previous style navigation.

KeyEventRules

type: TMap<FKey, EUI...

description: Digital key navigation rules.

UserNavigationState

type: TMap< int,FUse...

description: Navigation state that we store per user.


className: FNullNavigationConfig

description: A navigation config that doesn't do any navigation.

code: class FNullNavigationConfig : public [FNavigationConfig](API\Runtime\Slate\Framework\Application\FNavigationConfig)


description: Register for a notification when the user clicks outside a specific widget.

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterClickNotification ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & NotifyWhenClickedOutsideMe, const FOnClickedOutside & InNotification )


description: Given a WidgetPath that was clicked, send notifications to any subscribers that were not under the mouse. i.e. Send the "Someone clicked outside me" notifications.

code: void SendNotifications ( const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & WidgetsUnderCursor )


className: FPopupSupport

description: A Delegate for querying whether source code access is possible Delegates for when modal windows open or close Delegate for when window action occurs (ClickedNonClientArea, Maximize, Restore, WindowMenu). Return true if the OS layer should stop processing the action. Allow widgets to find out when someone clicked outside them. Currently needed by MenuAnchros.

code: class FPopupSupport


description: Unregister the notification because it is no longer desired.

code: void UnregisterClickNotification ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle )


className: ESlideDirection

description: Direction to slide in from

code: enum ESlideDirection { None, ComboButton, TopMenu, SubMenu, TypeInPopup, ContextMenu, }


description: Constructor

code: FPopupTransitionEffect ( const [ESlideDirection](API\Runtime\Slate\Framework\Application\FPopupTransitionEffect\ESlideDirection) InitSlideDirection )


className: FPopupTransitionEffect

description: Describes a simple animation for popup window introductions

code: struct FPopupTransitionEffect

SlideDirection

type: enumFPopupTran...


description: Activates the Game Viewport if it is properly childed under a window

code: void ActivateGameViewport()


description: Adds a modal window to the application. In most cases, this function does not return until the modal window is closed (the only exception is a modal window for slow tasks)

code: void AddModalWindow ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > InSlateWindow, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InParentWidget, bool bSlowTaskWindow )


description:
Associates a top level Slate Window with a native window and ensures that it is tracked properly by the application. Calling this method will cause the window to be displayed (unless specified otherwise), so be sure to associate content with the window object you're passing in first!
a reference to theSWindowthat was just added.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > AddWindow ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > InSlateWindow, const bool bShowImmediately )


description: true if the current platform allows cursor positioning in editable text boxes

code: bool AllowMoveCursor()


description:
Associates a top level Slate Window with a native window, and "natively" parents that window to the specified Slate window. Although the window still a top level window in Slate, it will be considered a child window to the operating system.
a reference to theSWindowthat was just added.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > AddWindowAsNativeChild ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > InSlateWindow, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > InParentWindow, const bool bShowImmediately )


description: Returns true if there are any pop-up menus summoned

code: virtual bool AnyMenusVisible() const


description: Returns true if transition effects for new menus and windows should be played

code: bool AreMenuAnimationsEnabled() const


description: Reorders an array of windows so the specified window is "brought to the front"

code: virtual void ArrangeWindowToFrontVirtual ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) >> & Windows, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > & WindowToBringToFront )


code: virtual bool BeginReshapingWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & PlatformWindow )


description: Returns true if this slate application is ready to open modal windows

code: bool CanAddModalWindow() const


description:
Calculates the popup window position from the passed in window position and size. Adjusts position for popup windows which are outside of the work area of the monitor where they reside
The adjusted position

code: virtual [UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) CalculatePopupWindowPosition ( const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & InAnchor, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InSize, bool bAutoAdjustForDPIScale, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InProposedPlacement, const EOrientation Orientation ) const


description:
Calculates the tooltip window position.
The suggested position.

code: virtual [UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) CalculateTooltipWindowPosition ( const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & InAnchorRect, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InSize, bool bAutoAdjustForDPIScale ) const


description: Cancels any in flight drag and drops

code: void CancelDragDrop()