Navigation
API > API/Plugins > API/Plugins/Niagara
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UNiagaraMergeable
- UNiagaraDataInterfaceBase
- UNiagaraDataInterface
- UNiagaraDataInterfaceCamera
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceCamera.h |
| Include | #include "NiagaraDataInterfaceCamera.h" |
Syntax
UCLASS (EditInlineNew, Category="Camera", CollapseCategories, Meta=(DisplayName="Camera Query"),
MinimalAPI)
class UNiagaraDataInterfaceCamera : public UNiagaraDataInterface
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bRequireCurrentFrameData | When this option is disabled, we use the previous frame's data for the camera and issue the simulation early. | |
| int32 | PlayerControllerIndex | This is used to determine which camera position to query for cpu emitters. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UNiagaraDataInterfaceCamera
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
BEGIN_SHADER_PARAMETER_STRUCT
(
FShaderParameters |
|||
| void | CalculateParticleDistances
(
FVectorVMExternalFunctionContext& Context |
||
| SystemLWCTile | |||
| void | GetCameraFOV
(
FVectorVMExternalFunctionContext& Context |
||
| void | GetCameraProperties
(
FVectorVMExternalFunctionContext& Context |
||
| void | GetClosestParticles
(
FVectorVMExternalFunctionContext& Context |
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. | |
| ETickingGroup | CalculateTickGroup
(
const void* PerInstanceData |
||
| bool | CanExecuteOnTarget
(
ENiagaraSimTarget Target |
||
| bool | CopyToInternal
(
UNiagaraDataInterface* Destination |
||
| void | DestroyPerInstanceData
(
void* PerInstanceData, |
Destroys the per instance data for this interface. | |
| bool | Equals
(
const UNiagaraDataInterface* Other |
Determines if this DataInterface is the same as another. | |
| void | GetFeedback
(
UNiagaraSystem* InAsset, |
Query the data interface to give feedback to the end user. | |
| bool | GetFunctionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
||
| void | GetFunctionsInternal
(
TArray< FNiagaraFunctionSignature >& OutFunctions |
||
| void | GetParameterDefinitionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
||
| void | GetVMExternalFunction
(
const FVMExternalFunctionBindingInfo& BindingInfo, |
Returns the delegate for the passed function signature. | |
| bool | |||
| bool | |||
| bool | InitPerInstanceData
(
void* PerInstanceData, |
Initializes the per instance data for this interface. | |
| int32 | Returns the size of the per instance data for this interface. | ||
| bool | PerInstanceTick
(
void* PerInstanceData, |
Ticks the per instance data for this interface, if it has any. | |
| bool | |||
| void | SetShaderParameters
(
const FNiagaraDataInterfaceSetShaderParametersContext& Context |
Set the shader parameters will only be called if the data interface provided shader parameters. | |
| bool | UpgradeFunctionCall
(
FNiagaraFunctionSignature& FunctionSignature |
Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade. |
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 | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |