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 > FNiagaraShaderMap

Light Theme

Dark Theme

FNiagaraShaderMap

The set of shaders for a single script.

Windows

MacOS

Linux

Inheritance Hierarchy

TShaderMap

FDeferredCleanupInterface

FNiagaraShaderMap

References

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

Syntax

class FNiagaraShaderMap :
public TShaderMap< FNiagaraShaderMapContent, FNiagaraShaderMapPointerTable >,
public FDeferredCleanupInterface

Remarks

The set of shaders for a single script.

Constructors

	Name	Description
	FNiagaraShaderMap()

Destructors

	Name	Description
	~FNiagaraShaderMap()	Destructor.

Functions

	Name	Description
void	AddRef()	Reference counting.
TArray< uint...	BackupShadersToMemory()	Backs up any FShaders in this shader map to memory through serialization and clears FShader references.
void	Compile ( FNiagaraShaderScript* Script, const FNiagaraShaderMapId& ShaderM..., TRefCountPtr< FShaderCompilerEnviro..., const FNiagaraComputeShaderCompilat..., EShaderPlatform Platform, bool bSynchronousCompile, bool bApplyCompletedShaderMapForRen... )	Compiles the shaders for a script and caches them in this shader map.
bool	CompiledSuccessfully()
FNiagaraShad...	FindId ( const FNiagaraShaderMapId& ShaderM..., EShaderPlatform Platform )	Finds the shader map for a script. Finds the shader map for a script.
void	FlushShadersByShaderType ( const FShaderType* ShaderType )	Removes all entries in the cache with exceptions based on a shader type
void	FlushShaderTypes ( TArray< const FShaderType* >&... )	Flushes the given shader types from any loaded FNiagaraShaderMaps.
uint32	GetCompilingId()
uint32	GetCompilingId()
const FMemor...	GetDebugDescription()
const FMemor...	GetFriendlyName()
TMap< TRefCo...	GetInFlightShaderMaps()
uint32	GetMaxTextureSamplers()	Returns the maximum number of texture samplers used by any shader in this shader map.
int32	GetNumRefs()
TNiagaraShad...	GetShader()
TNiagaraShad...	GetShader ( FShaderType* ShaderType )
void	GetShaderList ( TMap< FShaderId, TShaderRef< FShade... )	Builds a list of the shaders in a shader map.
const FNiaga...	GetShaderMapBeingCompiled ( const FNiagaraShaderScript* Sc... )	Finds a shader map currently being compiled that was enqueued for the given script.
const FNiaga...	GetShaderMapId()	Accessors.
EShaderPlatf...	GetShaderPlatform()
bool	IsCompilationFinalized()
bool	IsComplete ( const FNiagaraShaderScript* Sc..., bool bSilent )	Checks whether the shader map is missing any shader types necessary for the given script.
bool	IsValid()
void	LoadFromDerivedDataCache ( const FNiagaraShaderScript* Sc..., const FNiagaraShaderMapId& ShaderM..., EShaderPlatform Platform, TRefCountPtr< FNiagaraShaderMap >&... )	Attempts to load the shader map for the given script from the Derived Data Cache.
void	LoadMissingShadersFromMemory ( const FNiagaraShaderScript* Sc... )	Attempts to load missing shaders from memory.
bool	ProcessCompilationResults ( const TArray< TSharedRef< class FSh..., int32& ResultIndex, float& TimeBudget )	Sorts the incoming compiled jobs into the appropriate mesh shader maps, and finalizes this shader map so that it can be used for rendering.
void	Register ( EShaderPlatform InShaderPlatform )	Builds a list of the shader pipelines in a shader map.
void	Release()
void	RemovePendingMap ( FNiagaraShaderMap* Map )
void	RemovePendingScript ( FNiagaraShaderScript* Script )	Removes a Script from NiagaraShaderMapsBeingCompiled.
void	RestoreShadersFromMemory ( const TArray< uint8 >& ShaderData )	Recreates FShaders from the passed in memory, handling shader key changes.
void	SaveToDerivedDataCache()	Saves this shader map to the derived data cache.
bool	Serialize ( FArchive& Ar, bool bInlineShaderResources, bool bLoadedByCookedMaterial )	Serializes the shader map.
void	SetCompiledSuccessfully ( bool bSuccess )
bool	TryToAddToExistingCompilationTask ( FNiagaraShaderScript* Script )	Checks to see if the shader map is already being compiled for another script, and if so adds the specified script to the list to be applied to once the compile finishes.

Typedefs

Name	Description
Super

Constants

Name	Description
AllNiagaraShaderMaps	All script shader maps in memory.
GIdToNiagaraShaderMap	A global map from a script's ID and static switch set to any shader map cached for that script.
NiagaraShaderMapsBeingCompiled	Tracks resources and their shader maps that need to be compiled but whose compilation is being deferred.

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

Take our survey

Dismiss