Navigation
API > API/Plugins > API/Plugins/Niagara
| Name | FNiagaraDataInterfaceProxyOscilloscope |
| Type | struct |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudioOscilloscope.h |
| Include Path | #include "NiagaraDataInterfaceAudioOscilloscope.h" |
Syntax
struct FNiagaraDataInterfaceProxyOscilloscope : public FNiagaraDataInterfaceProxy
Inheritance Hierarchy
- FNiagaraDataInterfaceProxy → FNiagaraDataInterfaceProxyOscilloscope
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraDataInterfaceProxyOscilloscope
(
int32 InResolution, |
NiagaraDataInterfaceAudioOscilloscope.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FNiagaraDataInterfaceProxyOscilloscope() |
NiagaraDataInterfaceAudioOscilloscope.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsSubmixListenerRegistered | bool | NiagaraDataInterfaceAudioOscilloscope.h | ||
| DeviceCreatedHandle | FDelegateHandle | NiagaraDataInterfaceAudioOscilloscope.h | ||
| DeviceDestroyedHandle | FDelegateHandle | NiagaraDataInterfaceAudioOscilloscope.h | ||
| DownsampleBufferLock | FCriticalSection | NiagaraDataInterfaceAudioOscilloscope.h | ||
| DownsampledBuffer | Audio::FAlignedFloatBuffer | NiagaraDataInterfaceAudioOscilloscope.h | ||
| GPUDownsampledBuffer | FReadBuffer | Handle for the SRV used by the generated HLSL. | NiagaraDataInterfaceAudioOscilloscope.h | |
| NumChannelsInDownsampledBuffer | FThreadSafeCounter | NiagaraDataInterfaceAudioOscilloscope.h | ||
| PatchMixer | Audio::FPatchMixer | This mixer is patched into by all instances of FNiagaraSubmixListener in the SubmixListeners map, and is consumed by DownsampleAudioToBuffer(). | NiagaraDataInterfaceAudioOscilloscope.h | |
| PopBuffer | Audio::FAlignedFloatBuffer | The buffer we downsample PoppedBuffer to based on the Resolution property. | NiagaraDataInterfaceAudioOscilloscope.h | |
| Resolution | int32 | NiagaraDataInterfaceAudioOscilloscope.h | ||
| ScopeInMilliseconds | float | NiagaraDataInterfaceAudioOscilloscope.h | ||
| SubmixListeners | TMap< Audio::FDeviceId, TSharedPtr< FNiagaraSubmixListener > > | NiagaraDataInterfaceAudioOscilloscope.h | ||
| SubmixRegisteredTo | USoundSubmix * | NiagaraDataInterfaceAudioOscilloscope.h | ||
| VectorVMReadBuffer | Audio::FAlignedFloatBuffer | Buffer read by VectorVM worker threads. This vector is guaranteed to not be mutated during the VectorVM tasks. | NiagaraDataInterfaceAudioOscilloscope.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FReadBuffer & ComputeAndPostSRV() |
NiagaraDataInterfaceAudioOscilloscope.h | ||
int32 DownsampleAudioToBuffer() |
This function pops audio and downsamples it to our specified resolution. Returns the number of frames of audio in the downsampled buffer. | NiagaraDataInterfaceAudioOscilloscope.h | |
int32 GetNumChannels() |
NiagaraDataInterfaceAudioOscilloscope.h | ||
void OnBeginDestroy() |
NiagaraDataInterfaceAudioOscilloscope.h | ||
void OnUpdateResampling
(
int32 InResolution, |
Called when Resolution or Zoom are changed. | NiagaraDataInterfaceAudioOscilloscope.h | |
void OnUpdateSubmix
(
USoundSubmix* Submix |
Called when the Submix property changes. | NiagaraDataInterfaceAudioOscilloscope.h | |
void PostAudioToGPU() |
This function enqueues a render thread command to decimate the pop audio off of the SubmixListener, downsample it, and post it to the GPUAudioBuffer. | NiagaraDataInterfaceAudioOscilloscope.h | |
void RegisterToAllAudioDevices() |
NiagaraDataInterfaceAudioOscilloscope.h | ||
float SampleAudio
(
float NormalizedPositionInBuffer, |
Sample vertical displacement from the oscilloscope buffer. | NiagaraDataInterfaceAudioOscilloscope.h | |
void UnregisterFromAllAudioDevices
(
USoundSubmix* Submix |
NiagaraDataInterfaceAudioOscilloscope.h |
Overridden from FNiagaraDataInterfaceProxy
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 PerInstanceDataPassedToRenderThreadSize() |
NiagaraDataInterfaceAudioOscilloscope.h |