FFXSystemInterface

The interface to an effects system.

Windows
MacOS
Linux

Inheritance Hierarchy

FFXSystemInterface

NiagaraEmitterInstanceBatcher

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/FXSystem.h

Include

#include "FXSystem.h"

Syntax

class FFXSystemInterface

Remarks

The interface to an effects system.

Destructors

Name Description

Protected function Virtual

~FFXSystemInterface()

By making the destructor protected, an instance must be destroyed via FFXSystemInterface::Destroy.

Functions

Name Description

Public function

void

 

AddVectorField

(
    UVectorFieldComponent* VectorF...
)

Add a vector field to the FX system.

Public function Static

FFXSystemInt...

 

Create

(
    ERHIFeatureLevel::Type InFeatureLev...,
    EShaderPlatform InShaderPlatform
)

Create an effects system instance.

Public function Static

void

 

Destroy

(
    FFXSystemInterface* FXSystem
)

Destroy an effects system instance.

Public function

void

 

DrawDebug

(
    FCanvas* Canvas
)

Draw desired debug information related to the effects system.

Public function Virtual

FFXSystemInt...

 

GetInterface

(
    const FName& InName
)

Return the interface bound to the given name.

Public function Const

bool

 

IsPendingKill()

Public function Virtual

void

 

OnDestroy()

Gamethread callback when destroy gets called, allows to clean up references.

Public function

void

 

PostRenderOpaque

(
    FRHICommandListImmediate& RHICmdLi...
)

Helper in case the data necessary for collision is not available.

Public function

void

 

PostRenderOpaque

(
    FRHICommandListImmediate& RHICmdLi...,
    FRHIUniformBuffer* ViewUniform...,
    const FShaderParametersMetadata...,
    FRHIUniformBuffer* SceneTextur...
)

Notification from the renderer that opaque primitives have rendered.

Public function

void

 

PreInitViews

(
    FRHICommandListImmediate& RHICmdLi...
)

Notification from the renderer that it is about to perform visibility checks on FX belonging to this system.

Public function

void

 

PreRender

(
    FRHICommandListImmediate& RHICmdLi...,
    const FGlobalDistanceFieldParameter...,
    bool bAllowGPUParticleSceneUpdate
)

Notification from the renderer that it is about to draw FX belonging to this system.

Public function Static

void

 

RegisterCustomFXSystem

(
    const FName& InterfaceName,
    const FCreateCustomFXSystemDelegate...
)

Register a custom FX system implementation.

Public function

void

 

RemoveVectorField

(
    UVectorFieldComponent* VectorF...
)

Remove a vector field from the FX system.

Public function

void

 

Resume()

Resume the FX system. Has no effect if the system was not suspended.

Public function

void

 

Suspend()

Suspend the FX system.

Public function

void

 

Tick

(
    float DeltaSeconds
)

Tick the effects system.

Public function Static

void

 

UnregisterCustomFXSystem

(
    const FName& InterfaceName
)

Unregister a custom FX system implementation.

Public function

void

 

UpdateVectorField

(
    UVectorFieldComponent* VectorF...
)

Update a vector field registered with the FX system.

Public function Const

bool

 

UsesGlobalDistanceField()

Constants

Name

Description

CreateCustomFXDelegates

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