Navigation
API > API/Plugins > API/Plugins/NiagaraShader
Base class for all generated Niagara compute shaders.
| Name | FNiagaraShader |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraShader/Public/NiagaraShader.h |
| Include Path | #include "NiagaraShader.h" |
Syntax
class FNiagaraShader : public FShader
Inheritance Hierarchy
- FShader → FNiagaraShader
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| NiagaraShader.h | |||
FNiagaraShader
(
const FNiagaraShaderType::CompiledShaderInitializerType& Initializer |
NiagaraShader.h |
Classes
| Name | Remarks |
|---|---|
| FEmitterParameters | This structure is a replication of FNiagaraEmitterParameters with interpolated parameters includes. |
| FGlobalParameters | This structure is a replication of FNiagaraGlobalParameters with interpolated parameters includes. |
| FOwnerParameters | This structure is a replication of FNiagaraOwnerParameters with interpolated parameters includes. |
| FParameters | |
| FSystemParameters | This structure is a replication of FNiagaraSystemParameters with interpolated parameters includes. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FPermutationParameters | FNiagaraShaderPermutationParameters | NiagaraShader.h | |
| InternalBaseType | typename TGetBaseTypeHelper< FNiagaraShader >::Type | NiagaraShader.h | |
| ShaderMapType | FNiagaraShaderMap | NiagaraShader.h | |
| ShaderMetaType | FNiagaraShaderType | NiagaraShader.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ShaderTypeRegistration | FShaderTypeRegistration | NiagaraShader.h | |
| UniformBufferLayoutName | FName | NiagaraShader.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| boolbNeedsViewUniformBuffer | NiagaraShader.h | |||
| FShaderUniformBufferParameterExternalConstantBufferParam | NiagaraShader.h | |||
| uint16MiscUsageBitMask | NiagaraShader.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataInterfaceParameters | TMemoryImageArray< FNiagaraDataInterfaceParamRef > | NiagaraShader.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TConstArrayView< FNiagaraDataInterfaceParamRef > GetDIParameters() |
NiagaraShader.h | ||
INTERNAL_DECLARE_TYPE_LAYOUT_COMMON
(
FNiagaraShader |
NiagaraShader.h | ||
INTERNAL_LAYOUT_INTERFACE_PREFIX_NonVirtual() |
NiagaraShader.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void BuildClassSchema
(
FAppendToClassSchemaContext& Context |
Called from UNiagaraSystem::AppendToClassSchema() to collect the Script specific details for iterative cooking | NiagaraShader.h | |
static FShader * ConstructCompiledInstance
(
const typename FShader::CompiledShaderInitializerType& Initializer |
NiagaraShader.h | ||
static FShader * ConstructSerializedInstance() |
NiagaraShader.h | ||
static FIntVector GetDefaultThreadGroupSize
(
ENiagaraGpuDispatchType DispatchType |
NiagaraShader.h | ||
static void GetPermutationIdStringImpl
(
int32 PermutationId, |
NiagaraShader.h | ||
static FSpecializationContainerType GetSpecializationValuesImpl
(
const int32 PermutationID |
NiagaraShader.h | ||
static ShaderMetaType & GetStaticType() |
NiagaraShader.h | ||
static int32 GetUnspecializedIdImpl
(
const int32 PermutationID |
NiagaraShader.h | ||
static void InternalDestroy
(
void* Object, |
NiagaraShader.h | ||
static void InternalInitializeBases
(
FTypeLayoutDesc& TypeDesc |
NiagaraShader.h | ||
static void ModifyCompilationEnvironment
(
const FNiagaraShaderPermutationParameters& Parameters, |
NiagaraShader.h | ||
static void ModifyCompilationEnvironmentImpl
(
const FShaderPermutationParameters& Parameters, |
NiagaraShader.h | ||
static bool ShouldCompilePermutationImpl
(
const FShaderPermutationParameters& Parameters |
NiagaraShader.h | ||
static EShaderPermutationPrecacheRequest ShouldPrecachePermutationImpl
(
const FShaderPermutationParameters& Parameters |
NiagaraShader.h | ||
static FTypeLayoutDesc & StaticGetTypeLayout() |
NiagaraShader.h |