1. Epic GamesDeveloper
  3. FNiagaraSpriteVertexFactory

FNiagaraSpriteVertexFactory

Vertex factory for rendering particle sprites.

API > API/Plugins > API/Plugins/NiagaraVertexFactories

Vertex factory for rendering particle sprites.

   
Name FNiagaraSpriteVertexFactory
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraVertexFactories/Public/NiagaraSpriteVertexFactory.h
Include Path #include "NiagaraSpriteVertexFactory.h"

Syntax

class FNiagaraSpriteVertexFactory : public FNiagaraVertexFactoryBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  NiagaraSpriteVertexFactory.h  

FNiagaraSpriteVertexFactory ( ENiagaraVertexFactoryType InType,
ERHIFeatureLevel::Type InFeatureLevel
)

 Default constructor. NiagaraSpriteVertexFactory.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AlignmentMode uint32   NiagaraSpriteVertexFactory.h  
CutoutGeometrySRV FShaderResourceViewRHIRef   NiagaraSpriteVertexFactory.h  
CutoutParameters uint32   NiagaraSpriteVertexFactory.h  
FacingMode uint32   NiagaraSpriteVertexFactory.h  
LooseParameterUniformBuffer FUniformBufferRHIRef   NiagaraSpriteVertexFactory.h  
SortedIndicesOffset uint32   NiagaraSpriteVertexFactory.h  
SortedIndicesSRV FShaderResourceViewRHIRef   NiagaraSpriteVertexFactory.h  
SpriteUniformBuffer FUniformBufferRHIRef Uniform buffer with sprite parameters. NiagaraSpriteVertexFactory.h  
VertexBufferOverride const FVertexBuffer *   NiagaraSpriteVertexFactory.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

uint32 GetAlignmentMode()

   NiagaraSpriteVertexFactory.h  

FRHIShaderResourceView * GetCutoutGeometrySRV()

   NiagaraSpriteVertexFactory.h  

uint32 GetCutoutParameters()

   NiagaraSpriteVertexFactory.h  

uint32 GetFacingMode()

   NiagaraSpriteVertexFactory.h  

FRHIUniformBuffer * GetLooseParameterUniformBuffer()

   NiagaraSpriteVertexFactory.h  

int32 GetSortedIndicesOffset()

   NiagaraSpriteVertexFactory.h  

FRHIShaderResourceView * GetSortedIndicesSRV()

   NiagaraSpriteVertexFactory.h  

FRHIUniformBuffer * GetSpriteUniformBuffer()

   NiagaraSpriteVertexFactory.h  

virtual void InitRHI ( FRHICommandListBase& RHICmdList
)

 Initialize the Render Hardware Interface for this vertex factory NiagaraSpriteVertexFactory.h  

virtual bool RendersPrimitivesAsCameraFacingSprites()

   NiagaraSpriteVertexFactory.h  

void SetAlignmentMode ( uint32 InMode
)

   NiagaraSpriteVertexFactory.h  

void SetCutoutGeometry ( FRHIShaderResourceView* InCutoutGeometrySRV
)

   NiagaraSpriteVertexFactory.h  

void SetCutoutParameters ( bool bUseSubImage,
int32 InNumCutoutVertexPerSubImage
)

   NiagaraSpriteVertexFactory.h  

void SetFacingMode ( uint32 InMode
)

   NiagaraSpriteVertexFactory.h  

void SetLooseParameterUniformBuffer ( FUniformBufferRHIRef InBuffer
)

   NiagaraSpriteVertexFactory.h  

void SetSortedIndices ( const FShaderResourceViewRHIRef& InSortedIndicesSRV,
uint32 InSortedIndicesOffset
)

   NiagaraSpriteVertexFactory.h  

void SetSpriteUniformBuffer ( const FNiagaraSpriteUniformBufferRef& InSpriteUniformBuffer
)

   NiagaraSpriteVertexFactory.h  

void SetTexCoordBuffer ( const FVertexBuffer* InTexCoordBuffer
)

   NiagaraSpriteVertexFactory.h  

void SetVertexBufferOverride ( const FVertexBuffer* InVertexBufferOverride
)

   NiagaraSpriteVertexFactory.h  

Protected

Name Remarks Include Path Unreal Specifiers

void InitStreams()

 Initialize streams for this vertex factory. NiagaraSpriteVertexFactory.h  

Static

Name Remarks Include Path Unreal Specifiers

static void GetPSOPrecacheVertexFetchElements ( EVertexInputStreamType VertexInputStreamType,
FVertexDeclarationElementList& Elements
)

 Get vertex elements used when during PSO precaching materials using this vertex factory type NiagaraSpriteVertexFactory.h  

static void ModifyCompilationEnvironment ( const FVertexFactoryShaderPermutationParameters& Parameters,
FShaderCompilerEnvironment& OutEnvironment
)

 Can be overridden by FVertexFactory subclasses to modify their compile environment just before compilation occurs. NiagaraSpriteVertexFactory.h  

static bool ShouldCompilePermutation ( const FVertexFactoryShaderPermutationParameters& Parameters
)

 Should we cache the material's shadertype on this platform with this vertex factory? NiagaraSpriteVertexFactory.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page