1. Epic GamesDeveloper
  3. FFXSystemInterface

FFXSystemInterface

The interface to an effects system.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

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

  Type Name Description
Protected function Virtual   By making the destructor protected, an instance must be destroyed via FFXSystemInterface::Destroy.

Functions

  Type Name Description
Public function void

AddVectorField ( UVectorFieldComponent* VectorFieldComponent
)

 Add a vector field to the FX system.
Public function Static FFXSystemInterface *

Create ( ERHIFeatureLevel::Type InFeatureLevel,
FSceneInterface* Scene
)

 Create an effects system instance.
Public function Static void

Destroy ( FFXSystemInterface* FXSystem
)

 Destroy an effects system instance.
Public function Virtual void Gamethread callback when destroy gets called, allows to clean up references.
Public function void

DrawDebug ( FCanvas* Canvas
)

 Draw desired debug information related to the effects system.
Public function Virtual void

DrawDebug_RenderThread ( FRDGBuilder& GraphBuilder,
const FSceneView& View,
const FScreenPassRenderTarget& Output
)

 Draw desired debug information related to the effects system on the render thread.
Public function Virtual void

DrawSceneDebug_RenderThread ( FRDGBuilder& GraphBuilder,
const FSceneView& View,
FRDGTextureRef SceneColor,
FRDGTextureRef SceneDepth
)

 Call to handle debug drawing to the scene (i.e. where depth is available)
Public function Const FGPUSortManager * Get the shared SortManager, used in the rendering loop to call FGPUSortManager::OnPreRender() and FGPUSortManager::OnPostRenderOpaque()
Public function Virtual FFXSystemInterface *

GetInterface ( const FName& InName
)

 Return the interface bound to the given name.
Public function Const FScene *  
Public function Const FSceneInterface *  
Public function Const bool  
Public function Virtual void Gamethread callback when destroy gets called, allows to clean up references.
Public function void

PostInitViews ( FRDGBuilder& GraphBuilder,
TConstStridedView< FSceneView > Views,
bool bAllowGPUParticleUpdate
)

  
Public function void

PostRenderOpaque ( FRDGBuilder& GraphBuilder,
TConstStridedView< FSceneView > Views,
FSceneUniformBuffer& SceneUniformBuffer,
bool bAllowGPUParticleUpdate
)

 Notification from the renderer that opaque primitives have rendered.
Public function void

PreInitViews ( FRDGBuilder& GraphBuilder,
bool bAllowGPUParticleUpdate,
const TArrayView< const FSceneViewFamily* >& ViewFamilies,
const FSceneViewFamily* CurrentFamily
)

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

PreRender ( FRDGBuilder& GraphBuilder,
TConstStridedView< FSceneView > Views,
FSceneUniformBuffer& SceneUniformBuffer,
bool bAllowGPUParticleUpdate
)

 Notification from the renderer that it is about to draw FX belonging to this system.
Public function Static void Queue Destroy the gpu simulation on the render thread
Public function Static void

RegisterCustomFXSystem ( const FName& InterfaceName,
const FCreateCustomFXSystemDelegate& InCreateDelegate
)

 Register a custom FX system implementation.
Public function void

RemoveVectorField ( UVectorFieldComponent* VectorFieldComponent
)

 Remove a vector field from the FX system.
Public function Const bool  
Public function Const bool  
Public function void

Resume ()

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

SetScene ( FScene* InScene
)

  
Public function void

SetSceneInterface ( FSceneInterface* InSceneInterface
)

  
Public function Virtual void  
Public function Virtual Const bool Does the FX system require DrawDebug_RenderThread to be called at all? There is cost to enabling this so only return true when we have something to present.
Public function void

Suspend ()

 Suspend the FX system.
Public function void

Tick ( UWorld* World,
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* VectorFieldComponent
)

 Update a vector field registered with the FX system.
Public function Const bool  
Public function Const bool  

Constants

Name Description
CreateCustomFXDelegates  

Deprecated Functions

  Type Name Description
Public function void

DrawDebug_RenderThread ( FRDGBuilder& GraphBuilder,
const FViewInfo& View,
const FScreenPassRenderTarget& Output
)

 Passing FViewInfo is deprecated in favor of FSceneView. This function will do nothing.
Public function void

DrawSceneDebug_RenderThread ( FRDGBuilder& GraphBuilder,
const FViewInfo& View,
FRDGTextureRef SceneColor,
FRDGTextureRef SceneDepth
)

 Passing FViewInfo is deprecated in favor of FSceneView. This function will do nothing.
Public function void

PostInitViews ( FRDGBuilder& GraphBuilder,
TConstArrayView< FViewInfo > Views,
bool bAllowGPUParticleUpdate
)

 Passing an array of FViewInfo is deprecated in favor of FSceneView. This function will do nothing.
Public function void

PostRenderOpaque ( FRDGBuilder& GraphBuilder,
TConstArrayView< FViewInfo > Views,
bool bAllowGPUParticleUpdate
)

 Passing an array of FViewInfo is deprecated in favor of FSceneView. This function will do nothing.
Public function void

PreRender ( FRDGBuilder& GraphBuilder,
TConstArrayView< FViewInfo > Views,
bool bAllowGPUParticleUpdate
)

 Passing an array of FViewInfo is deprecated in favor of FSceneView. This function will do nothing.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page