1. Epic GamesDeveloper
  3. FNiagaraShaderMap

FNiagaraShaderMap

The set of shaders for a single script.

API > API/Plugins > API/Plugins/NiagaraShader

Inheritance Hierarchy

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

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Public function void

AddRef ()

 Reference counting.
Public function TArray< uint8 > * Backs up any FShaders in this shader map to memory through serialization and clears FShader references.
Public function void

Compile ( FNiagaraShaderScript* Script,
const FNiagaraShaderMapId& ShaderMapId,
TRefCountPtr< FSharedShaderCompilerEnvironment > CompilationEnvironment,
const FNiagaraComputeShaderCompilationOutput& InNiagaraCompilationOutput,
EShaderPlatform Platform,
bool bSynchronousCompile,
bool bApplyCompletedShaderMapForRendering
)

 Compiles the shaders for a script and caches them in this shader map.
Public function Const bool  
Public function Static FNiagaraShaderMap *

FindId ( const FNiagaraShaderMapId& ShaderMapId,
EShaderPlatform Platform
)

 Finds the shader map for a script. Finds the shader map for a script.
Public function uint32  
Public function Const uint32  
Public function Const const FMemoryImageString &  
Public function Const const FMemoryImageString &  
Public function Static TMap< TRefCountPtr< FNiagaraShaderMap >, TArray< FNiagaraShaderScript * > > &  
Public function Const int32  
Public function Const TNiagaraShaderRef< ShaderType >

GetShader ( int32 PermutationId
)

  
Public function Const TNiagaraShaderRef< FShader >

GetShader ( FShaderType* ShaderType,
int32 PermutationId
)

  
Public function Const void

GetShaderList ( TMap< FShaderId, TShaderRef< FShader >>& OutShaders
)

 Builds a list of the shaders in a shader map.
Public function Static const FNiagaraShaderMap * Finds a shader map currently being compiled that was enqueued for the given script.
Public function Const const FNiagaraShaderMapId & Accessors.
Public function Const EShaderPlatform  
Public function Const bool  
Public function bool

IsComplete ( const FNiagaraShaderScript* Script,
bool bSilent
)

 Checks whether the shader map is missing any shader types necessary for the given script.
Public function Const bool

IsValid ()

  
Public function Static void

LoadFromDerivedDataCache ( const FNiagaraShaderScript* Script,
const FNiagaraShaderMapId& ShaderMapId,
EShaderPlatform Platform,
TRefCountPtr< FNiagaraShaderMap >& InOutShaderMap
)

 Attempts to load the shader map for the given script from the Derived Data Cache.
Public function void Attempts to load missing shaders from memory.
Public function bool

ProcessCompilationResults ( const TArray< TRefCountPtr< class FShaderCommonCompileJob >>& InCompilationResults,
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.
Public function void

Register ( EShaderPlatform InShaderPlatform
)

 Builds a list of the shader pipelines in a shader map.
Public function void

Release ()

  
Public function Static void  
Public function Static bool Removes a Script from NiagaraShaderMapsBeingCompiled.
Public function void

RestoreShadersFromMemory ( const TArray< uint8 >& ShaderData
)

 Recreates FShaders from the passed in memory, handling shader key changes.
Public function void Saves this shader map to the derived data cache.
Public function bool

Serialize ( FArchive& Ar,
bool bInlineShaderResources,
bool bLoadedByCookedMaterial
)

 Serializes the shader map.
Public function void

SetCompiledSuccessfully ( bool bSuccess
)

  
Public function bool 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.
AllNiagaraShaderMapsGuard Guards access to AllNiagaraShaderMaps, which can be written to from an async loading thread.
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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page