Navigation
API > API/Plugins > API/Plugins/Niagara
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UNiagaraMergeable
- UNiagaraDataInterfaceBase
- UNiagaraDataInterface
- UNiagaraDataInterfaceAudioSubmix
- UNiagaraDataInterfaceAudioSpectrum
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudioSpectrum.h |
| Include | #include "NiagaraDataInterfaceAudioSpectrum.h" |
Syntax
UCLASS&40;EditInlineNew, Category&61;"Audio", Meta&61;&40;DisplayName&61;"Audio Spectrum"&41;, MinimalAPI&41;
class UNiagaraDataInterfaceAudioSpectrum : public UNiagaraDataInterfaceAudioSubmix
Remarks
Data Interface allowing sampling of recent audio spectrum.
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
float | MaximumFrequency | The maximum frequency represented in the spectrum. |
   |
float | MinimumFrequency | The minimum frequency represented in the spectrum. |
   |
float | NoiseFloorDb | The decibel level considered as silence. This is used to scale the output of the spectrum. |
   |
int32 | Resolution | The number of spectrum samples to pass to the GPU |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UNiagaraDataInterfaceAudioSpectrum
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | GetNumChannels
(
FVectorVMExternalFunctionContext& Context |
|
 |
void | GetSpectrumValue
(
FVectorVMExternalFunctionContext& Context |
VM function overrides: |
Overridden from UNiagaraDataInterface
| Type | Name | Description | |
|---|---|---|---|
   |
bool | AppendCompileHash
(
FNiagaraCompileHashVisitor* InVisitor |
Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile. |
   |
bool | CanExecuteOnTarget
(
ENiagaraSimTarget Target |
|
   |
bool | CopyToInternal
(
UNiagaraDataInterface* Destination |
|
   |
bool | Equals
(
const UNiagaraDataInterface* Other |
Determines if this DataInterface is the same as another. |
  |
bool | GetFunctionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
|
  |
void | GetFunctions
(
TArray< FNiagaraFunctionSignature >& OutFunctions |
Gets all the available functions for this data interface. |
  |
void | GetParameterDefinitionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
|
  |
void | GetVMExternalFunction
(
const FVMExternalFunctionBindingInfo& BindingInfo, |
Returns the delegate for the passed function signature. |
   |
void | SetShaderParameters
(
const FNiagaraDataInterfaceSetShaderParametersContext& Context |
Set the shader parameters will only be called if the data interface provided shader parameters. |
Overridden from UNiagaraDataInterfaceBase
| Type | Name | Description | |
|---|---|---|---|
   |
void | BuildShaderParameters
(
FNiagaraShaderParametersBuilder& ShaderParametersBuilder |
Override this method to provide parameters to the GPU (SRV / UAV / Constants / etc) The most common usage will be to provide a single structure which is nested with other parameters. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. | |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FShaderParameters |
Constants
| Name | Description |
|---|---|
| GetNumChannelsFunctionName | |
| GetSpectrumFunctionName | VM function names. |
| GetSpectrumName | Global variable prefixes. |
| NumChannelsName | |
| ResolutionName |