1. Epic GamesDeveloper
  3. FModulationDestination

FModulationDestination

API > API/Runtime > API/Runtime/Engine

   
Name FModulationDestination
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Sound/SoundModulationDestination.h
Include Path #include "Sound/SoundModulationDestination.h"

Syntax

struct FModulationDestination

Constructors

Name Remarks Include Path Unreal Specifiers

FModulationDestination ( FModulationDestination&& InModulationDestination
)

   Sound/SoundModulationDestination.h  

FModulationDestination ( const FModulationDestination& InModulationDestination
)

   Sound/SoundModulationDestination.h  
  Sound/SoundModulationDestination.h  

Structs

Name Remarks
FModulationDestinationData  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DestinationData TSharedRef< FModulationDestinationData >   Sound/SoundModulationDestination.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearModulators()

   Sound/SoundModulationDestination.h  

const FAlignedFloatBuffer & GetBuffer ()

 Returns buffer of interpolated modulation values. Sound/SoundModulationDestination.h  

bool GetHasProcessed()

 Returns whether or not the destination has requested to process the control or not. Sound/SoundModulationDestination.h  

float GetValue ()

 Returns sample value last reported by modulator. Sound/SoundModulationDestination.h  

void Init ( FDeviceId InDeviceId,
bool bInIsBuffered,
bool bInValueNormalized
)

 Initializes the modulation destination InDeviceId - DeviceId associated with modulation plugin instance bInIsBuffered - Whether or not to run destination in "buffered mode," which manages an internal buffer to smooth modulation value between process calls bInValueNormalized - Whether or not to keep the output value in normalized, unitless [0.0f, 1.0f] space Sound/SoundModulationDestination.h  

void Init ( FDeviceId InDeviceId,
FName InParameterName,
bool bInIsBuffered,
bool bInValueNormalized
)

 Initializes the modulation destination InDeviceId - DeviceId associated with modulation plugin instance InParameterName - Name of parameter used to mix/convert destination value to/from unit space bInIsBuffered - Whether or not to run destination in "buffered mode," which manages an internal buffer to smooth modulation value between process calls bInValueNormalized - Whether or not to keep the output value in normalized, unitless [0.0f, 1.0f] space Sound/SoundModulationDestination.h  

bool IsActive()

 Returns whether or not destination references an active modulator Sound/SoundModulationDestination.h  

bool ProcessControl ( float InValueUnitBase,
int32 InNumSamples
)

 Updates internal value (or buffer if set to bIsBuffered) to current modulated result using the provided value as the base carrier value to modulate. Sound/SoundModulationDestination.h  

void UpdateModulator ( const USoundModulatorBase* InModulator
)

   Sound/SoundModulationDestination.h  

void UpdateModulators ( const TSet< USoundModulatorBase* >& InModulators
)

   Sound/SoundModulationDestination.h  

void UpdateModulators ( const TSet< TObjectPtr< USoundModulatorBase > >& InModulators
)

   Sound/SoundModulationDestination.h  

void UpdateModulators ( const TSet< const USoundModulatorBase* >& InModulators
)

   Sound/SoundModulationDestination.h  

Operators

Name Remarks Include Path Unreal Specifiers

FModulationDestination & operator= ( const FModulationDestination& InModulationDestination
)

   Sound/SoundModulationDestination.h  

FModulationDestination & operator= ( FModulationDestination&& InModulationDestination
)

   Sound/SoundModulationDestination.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page