1. Epic GamesDeveloper
  3. FNiagaraShaderScript

FNiagaraShaderScript

[FNiagaraShaderScript](API\Plugins\NiagaraShader\FNiagaraShaderScript) represents a Niagara script to the shader compilation process

API > API/Plugins > API/Plugins/NiagaraShader

References

   
Module NiagaraShader
Header /Engine/Plugins/FX/Niagara/Source/NiagaraShader/Public/NiagaraShared.h
Include #include "NiagaraShared.h"

Syntax

class FNiagaraShaderScript

Remarks

FNiagaraShaderScript represents a Niagara script to the shader compilation process

Constructors

  Type Name Description
Public function   Minimal initialization constructor.

Destructors

  Type Name Description
Public function Virtual   Destructor

Functions

  Type Name Description
Public function void

AddCompileId ( uint32 Id
)

  
Public function Virtual void  
Public function void  
Public function bool

CacheShaders ( const FNiagaraShaderMapId& ShaderMapId,
bool bApplyCompletedShaderMapForRendering,
bool bForceRecompile,
bool bSynchronous
)

 Caches the shaders for this script with no static parameters on the given platform.
Public function bool

CacheShaders ( bool bApplyCompletedShaderMapForRendering,
bool bForceRecompile,
bool bSynchronous,
const ITargetPlatform* TargetPlatform
)

 Caches the shaders for this script with no static parameters on the given platform.
Public function void Cancels all outstanding compilation jobs
Public function void  
Public function void Blocks until compilation has completed. Returns immediately if a compilation is not outstanding.
Public function Const FNiagaraCompileHash  
Public function UNiagaraScriptBase *  
Public function Const const UNiagaraScriptBase *  
Public function Const const TArray< FString > & Accessors.
Public function Const void

GetDependentShaderTypes ( EShaderPlatform Platform,
TArray< FShaderType* >& OutShaderTypes
)

  
Public function Const ERHIFeatureLevel::Type  
Public function Const const FString &  
Public function Const FNiagaraShaderMap *  
Public function Const int32  
Public function Const int32  
Public function Const FName Returns owner name for tracking
Public function Const bool

GetScriptHLSLSource ( FString& OutSource
)

 Get user source code for the shader
Public function Const TSharedRef< FNiagaraShaderScriptParametersMetadata >  
Public function Const const FNiagaraShaderScriptParametersMetadata &  
Public function Const FNiagaraShaderRef

GetShader ( int32 PermutationId
)

  
Public function Const FNiagaraShaderRef

GetShaderGameThread ( int32 PermutationId
)

  
Public function Virtual Const void

GetShaderMapId ( EShaderPlatform Platform,
const ITargetPlatform* TargetPlatform,
FNiagaraShaderMapId& OutId
)

  
Protected function void Fills the passed array with IDs of shader maps unfinished compilation jobs.
Public function Const EShaderPlatform  
Public function Const bool  
Public function void  
Public function Const bool Checks if the compilation for this shader is finished
Public function Const bool  
Public function Virtual Const bool Should shaders compiled for this script be saved to disk?
Public function Const bool

IsSame ( const FNiagaraShaderMapId& InId
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

MatchesScript ( ERHIFeatureLevel::Type InFeatureLevel,
EShaderPlatform InShaderPlatform,
const FNiagaraVMExecutableDataId& ScriptId
)

  
Public function Virtual Const void

ModifyCompilationEnvironment ( EShaderPlatform Platform,
FShaderCompilerEnvironment& OutEnvironment
)

 Allow Niagara script the opportunity to modify the compilation environment for GPU simulations.
Public function Virtual void Called when compilation finishes, after the GameThreadShaderMap is set and the render command to set the RenderThreadShaderMap is queued
Public function FOnNiagaraScriptCompilationComplete &  
Public function bool  
Public function void Releases this script's shader map.
Public function void

RemoveOutstandingCompileId ( const int32 OldOutstandingCompileShaderMapId
)

  
Public function void

SaveShaderStableKeys ( EShaderPlatform TargetShaderPlatform,
FStableShaderKeyAndValue& SaveKeyVal
)

 Save "stable" shader for identifying the shader in the recorded PSO cache.
Public function void Serializes the script.
Public function void

SetCompileErrors ( const TArray< FString >& InCompileErrors
)

  
Public function void

SetCompileErrors ( TArray< FString >& InErrors
)

  
Protected function void  
Public function void Note: SetRenderingThreadShaderMap must also be called with the same value, but from the rendering thread.
Public function void

SetHlslOutput ( const FString& InHlslOutput
)

  
Public function void Note: SetGameThreadShaderMap must also be called with the same value, but from the game thread.
Public function void

SetRenderThreadCachedData ( const FNiagaraShaderMapCachedData& CachedData
)

  
Public function void

SetScript ( UNiagaraScriptBase* InScript,
ERHIFeatureLevel::Type InFeatureLevel,
EShaderPlatform InShaderPlatform,
const FGuid& InCompilerVersion,
const TArray< FString >& InAdditionalDefines,
const TArray< FString >& InAdditionalVariables,
const FNiagaraCompileHash& InBaseCompileHash,
const TArray< FNiagaraCompileHash >& InReferencedCompileHashes,
bool bInUsesRapidIterationParams,
FString InFriendlyName
)

  
Public function void

SetShaderMap ( FNiagaraShaderMap* InShaderMap
)

  
Public function void

SetSourceName ( FString InSourceName
)

  
Public function Virtual Const bool

ShouldCache ( EShaderPlatform Platform,
const FShaderType* ShaderType
)

 Should the shader for this script with the given platform, shader type and vertex factory type combination be compiled
Protected function void  
Protected function void

UpdateCachedData_PostCompile ( bool bCalledFromSerialize
)

  
Protected function void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page