Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraShader > FNiagaraShaderScript

Light Theme

Dark Theme

FNiagaraShaderScript

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

Windows

MacOS

Linux

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

	Name	Description
	FNiagaraShaderScript()	Minimal initialization constructor.

Destructors

	Name	Description
	~FNiagaraShaderScript()	Destructor

Functions

	Name	Description
void	AddCompileId ( uint32 Id )
void	AddReferencedObjects ( FReferenceCollector& Collector )
bool	CacheShaders ( const FNiagaraShaderMapId& ShaderM..., bool bApplyCompletedShaderMapForRen..., bool bForceRecompile, bool bSynchronous )	Caches the shaders for this script with no static parameters on the given platform.
bool	CacheShaders ( bool bApplyCompletedShaderMapForRen..., bool bForceRecompile, bool bSynchronous, const ITargetPlatform* TargetP... )	Caches the shaders for this script with no static parameters on the given platform.
void	CancelCompilation()	Cancels all outstanding compilation jobs
void	DiscardShaderMap()
void	FinishCompilation()	Blocks until compilation has completed. Returns immediately if a compilation is not outstanding.
UNiagaraScri...	GetBaseVMScript()
const TArray...	GetCompileErrors()	Accessors.
TArray< FNia...	GetDataInterfaceParamInfo()
void	GetDependentShaderTypes ( EShaderPlatform Platform, TArray< FShaderType* >& OutSh... )
ERHIFeatureL...	GetFeatureLevel()
const FStrin...	GetFriendlyName()
FNiagaraShad...	GetGameThreadShaderMap()
int32	GetNumPermutations()
int32	GetNumPermutations_RenderThread()
bool	GetScriptHLSLSource ( FString& OutSource )	Get user source code for the shader
FNiagaraShad...	GetShader ( int32 PermutationId )
FNiagaraShad...	GetShaderGameThread ( int32 PermutationId )
void	GetShaderMapId ( EShaderPlatform Platform, const ITargetPlatform* TargetP..., FNiagaraShaderMapId& OutId )
void	GetShaderMapIDsWithUnfinishedCompilation ( TArray< int32 >& ShaderMapIds )	Fills the passed array with IDs of shader maps unfinished compilation jobs.
EShaderPlatf...	GetShaderPlatform()
bool	GetUsesCompressedAttributes()
bool	GetUsesOldShaderStages()
bool	GetUsesSimulationStages()
void	Invalidate()
bool	IsCompilationFinished()	Checks if the compilation for this shader is finished
bool	IsEmitterConstantBufferUsed_RenderThread ( int32 Index )
bool	IsExternalConstantBufferUsed_RenderThread ( int32 Index )
bool	IsGlobalConstantBufferUsed_RenderThread ( int32 Index )
bool	IsOwnerConstantBufferUsed_RenderThread ( int32 Index )
bool	IsPersistent()	Should shaders compiled for this script be saved to disk?
bool	IsSame ( const FNiagaraShaderMapId& InId )
bool	IsShaderMapComplete()
bool	IsShaderMapComplete_RenderThread()
bool	IsSystemConstantBufferUsed_RenderThread ( int32 Index )
bool	IsViewUniformBufferUsed_RenderThread()
void	LegacySerialize ( FArchive& Ar )	Serializes the script.
bool	MatchesScript ( ERHIFeatureLevel::Type InFeatureLev..., EShaderPlatform InShaderPlatform, const FNiagaraVMExecutableDataId& ... )
void	ModifyCompilationEnvironment ( FShaderCompilerEnvironment& OutEnv... )	Allow Niagara script the opportunity to modify the compilation environment for GPU simulations.
void	NotifyCompilationFinished()	Called when compilation finishes, after the GameThreadShaderMap is set and the render command to set the RenderThreadShaderMap is queued
FOnNiagaraSc...	OnCompilationComplete()
int32	PermutationIdToShaderStageIndex ( int32 PermutationId )
bool	QueueForRelease ( FThreadSafeBool& Fence )
void	ReleaseShaderMap()	Releases this script's shader map.
void	RemoveOutstandingCompileId ( const int32 OldOutstandingCompileSh... )
void	SerializeShaderMap ( FArchive& Ar )
void	SetCompileErrors ( const TArray< FString >& InCompile... )
void	SetCompileErrors ( TArray< FString >& InErrors )
void	SetDataInterfaceParamInfo ( const TArray< FNiagaraDataInterface... )
void	SetFeatureLevel ( ERHIFeatureLevel::Type InFeatureLev... )
void	SetGameThreadShaderMap ( FNiagaraShaderMap* InShaderMap )	SetRenderingThreadShaderMap must also be called with the same value, but from the rendering thread.
void	SetHlslOutput ( const FString& InHlslOutput )
void	SetRenderingThreadShaderMap ( FNiagaraShaderMap* InShaderMap )	SetGameThreadShaderMap must also be called with the same value, but from the game thread.
void	SetRenderThreadCachedData ( const FNiagaraShaderMapCachedData&... )
void	SetScript ( UNiagaraScriptBase* InScript, ERHIFeatureLevel::Type InFeatureLev..., EShaderPlatform InShaderPlatform, const FGuid& InCompilerVersion, const TArray< FString >& InAdditio..., const TArray< FString >& InAdditio..., const FNiagaraCompileHash& InBaseC..., const TArray< FNiagaraCompileHash >..., bool bInUsesRapidIterationParams, FString InFriendlyName )
void	SetShaderMap ( FNiagaraShaderMap* InShaderMap )
void	SetSourceName ( FString InSourceName )
int32	ShaderStageIndexToPermutationId_RenderThread ( int32 ShaderStageIndex )
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
void	UpdateCachedData_All()
void	UpdateCachedData_PostCompile ( bool bCalledFromSerialize )
void	UpdateCachedData_PreCompile()

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss