IAtomRuntimePlugin Class Reference

#include <IAtomRuntimePlugin.h>

Inheritance diagram for IAtomRuntimePlugin:

Public Member Functions
virtual	~IAtomRuntimePlugin ()=default
virtual void	Finalize ()=0
virtual FName	GetPluginName () const =0
virtual void	Initialize (const FAtomPluginInitializationParams &InitializationParams)=0
virtual void	OnInitSource (const uint32 SourceId, const FAtomSource *Source)
	UE_BUILD_SHIPPING.
virtual bool	OnPostHelp (FCommonViewportClient *ViewportClient, const TCHAR *Stream)
virtual void	OnReleaseSource (const uint32 SourceId)
virtual int32	OnRenderStat (UViewportStatsSubsystem *ViewportSubsystem, int32 X, int32 Y)
virtual bool	OnToggleStat (FCommonViewportClient *ViewportClient, const TCHAR *Stream)
virtual void	ProcessPlugin (const double InElapsed)=0

Constructor & Destructor Documentation

~IAtomRuntimePlugin()

virtual IAtomRuntimePlugin::~IAtomRuntimePlugin ( )

virtualdefault

Virtual destructor

Member Function Documentation

Finalize()

virtual void IAtomRuntimePlugin::Finalize ( )

pure virtual

Finalize plugin before Atom runtime finalization.

Implemented in FLipsAtomRuntimePlugin.

GetPluginName()

virtual FName IAtomRuntimePlugin::GetPluginName ( ) const

pure virtual

Implemented in FLipsAtomRuntimePlugin.

Initialize()

virtual void IAtomRuntimePlugin::Initialize ( const FAtomPluginInitializationParams & InitializationParams )

pure virtual

Initialize plugin after Atom runtime initialization.

Implemented in FLipsAtomRuntimePlugin.

OnInitSource()

virtual void IAtomRuntimePlugin::OnInitSource ( const uint32 SourceId, const FAtomSource * Source )

inlinevirtual

UE_BUILD_SHIPPING.

Called when a source is assigned to a voice.

Reimplemented in FLipsAtomRuntimePlugin.

OnPostHelp()

virtual bool IAtomRuntimePlugin::OnPostHelp ( FCommonViewportClient * ViewportClient, const TCHAR * Stream )

inlinevirtual

Request to post help from active plugin (non-shipping builds only)

OnReleaseSource()

virtual void IAtomRuntimePlugin::OnReleaseSource ( const uint32 SourceId )

inlinevirtual

Called when a source is done playing and is released.

Reimplemented in FLipsAtomRuntimePlugin.

OnRenderStat()

virtual int32 IAtomRuntimePlugin::OnRenderStat ( UViewportStatsSubsystem * ViewportSubsystem, int32 X, int32 Y )

inlinevirtual

Render stats pertaining debug informations (non-shipping builds only)

OnToggleStat()

virtual bool IAtomRuntimePlugin::OnToggleStat ( FCommonViewportClient * ViewportClient, const TCHAR * Stream )

inlinevirtual

Toggle showing render stats pertaining to plugin (non-shipping builds only)

ProcessPlugin()

virtual void IAtomRuntimePlugin::ProcessPlugin ( const double InElapsed )

pure virtual

Processes on Atom thread after processing Atom.

Implemented in FLipsAtomRuntimePlugin.

---

The documentation for this class was generated from the following file:

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Extensions/IAtomRuntimePlugin.h