FNiagaraRibbonVertexFactory

Beam/Trail particle vertex factory.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NiagaraVertexFactories

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraVertexFactories/Public/NiagaraRibbonVertexFactory.h

Include

#include "NiagaraRibbonVertexFactory.h"

Syntax

class FNiagaraRibbonVertexFactory : public FNiagaraVertexFactoryBase

Remarks

Beam/Trail particle vertex factory.

Constructors

Name Description

Public function

FNiagaraRibbonVertexFactory()

Public function

FNiagaraRibbonVertexFactory

(
    ENiagaraVertexFactoryType InType,
    ERHIFeatureLevel::Type InFeatureLev...
)

Default constructor.

Functions

Name Description

Public function Static

FVertexFacto...

 

ConstructShaderParameters

(
    EShaderFrequency ShaderFrequency
)

Construct shader parameters for this type of vertex factory.

Public function

int32

 

GetFacingMode()

Public function

uint32 &

 

GetFirstIndex()

Public function

int32

 

GetFloatDataOffset()

Public function

int32

 

GetFloatDataStride()

Public function

FIndexBuffer...

 

GetIndexBuffer()

Public function

FShaderResou...

 

GetMultiRibbonIndicesSRV()

Public function

int32 &

 

GetOutTriangleCount()

Public function

FShaderResou...

 

GetPackedPerRibbonDataByIndexSRV()

Public function

FShaderResou...

 

GetParticleDataFloatSRV()

Public function

FNiagaraRibb...

 

GetRibbonUniformBuffer()

Retrieve the uniform buffer for this vertex factory.

Public function

int32

 

GetSortedIndicesOffset()

Public function

FShaderResou...

 

GetSortedIndicesSRV()

Public function

FShaderResou...

 

GetTangentAndDistancesSRV()

Public function Static

void

 

ModifyCompilationEnvironment

(
    const FVertexFactoryType* Type,
    EShaderPlatform Platform,
    const FMaterial* Material,
    FShaderCompilerEnvironment& OutEnv...
)

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

Public function

void

 

SetDynamicParameterBuffer

(
    const FVertexBuffer* InDynamic...,
    int32 ParameterIndex,
    uint32 StreamOffset,
    uint32 Stride
)

Set the source vertex buffer that contains particle dynamic parameter data.

Public function

void

 

SetFacingMode

(
    uint32 InFacingMode
)

Public function

void

 

SetMultiRibbonIndicesSRV

(
    const FShaderResourceViewRHIRef& I...
)

Public function

void

 

SetPackedPerRibbonDataByIndexSRV

(
    const FShaderResourceViewRHIRef& I...
)

Public function

void

 

SetParticleData

(
    const FShaderResourceViewRHIRef& I...,
    uint32 InFloatDataOffset,
    uint32 InFloatDataStride
)

Public function

void

 

SetRibbonUniformBuffer

(
    FNiagaraRibbonUniformBufferRef InSp...
)

Set the uniform buffer for this vertex factory.

Public function

void

 

SetSortedIndices

(
    const FShaderResourceViewRHIRef& I...,
    uint32 InSortedIndicesOffset
)

Public function

void

 

SetTangentAndDistances

(
    const FShaderResourceViewRHIRef& I...
)

Public function

void

 

SetVertexBuffer

(
    const FVertexBuffer* InBuffer,
    uint32 StreamOffset,
    uint32 Stride
)

Set the source vertex buffer.

Public function Static

bool

 

ShouldCompilePermutation

(
    EShaderPlatform Platform,
    const FMaterial* Material,
    const FShaderType* ShaderType
)

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

Overridden from FVertexFactory

Name Description

Public function Virtual Const

FVertexFacto...

 

GetType()

Overridden from FRenderResource

Name Description

Public function Virtual

void

 

InitRHI()

Initialize the Render Hardware Interface for this vertex factory

Constants

Name

Description

StaticType

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback