FST_AudioSceneViewExtension Class Reference

Audio scene view extension class used to manage audio scene data during the rendering process. This class integrates with the scene view system to handle audio input/output data and update the scene's visual representation. It includes methods for setting up the view, pre-rendering, and managing buffers associated with the audio scene. More...

#include <ST_AudioSceneViewExtension.h>

Public Member Functions
	FST_AudioSceneViewExtension (const FAutoRegister &AutoRegister)
virtual	~FST_AudioSceneViewExtension ()
virtual void	SetupViewFamily (FSceneViewFamily &InViewFamily) override
virtual void	SetupView (FSceneViewFamily &InViewFamily, FSceneView &InView) override
virtual void	PreRenderViewFamily_RenderThread (FRDGBuilder &RHICmdList, FSceneViewFamily &InViewFamily) override
virtual void	BeginRenderViewFamily (FSceneViewFamily &InViewFamily) override
virtual bool	IsActiveThisFrame_Internal (const FSceneViewExtensionContext &Context) const override
void	DisposeAudioIODataBuffer ()

Friends
class	UST_AudioScene

Detailed Description

Audio scene view extension class used to manage audio scene data during the rendering process. This class integrates with the scene view system to handle audio input/output data and update the scene's visual representation. It includes methods for setting up the view, pre-rendering, and managing buffers associated with the audio scene.

Constructor & Destructor Documentation

FST_AudioSceneViewExtension()

FST_AudioSceneViewExtension::FST_AudioSceneViewExtension

(

const FAutoRegister &

AutoRegister

)

Constructor for the FST_AudioSceneViewExtension class. Registers the view extension automatically when called.

Parameters

AutoRegister

The auto-registration information for this view extension.

~FST_AudioSceneViewExtension()

FST_AudioSceneViewExtension::~FST_AudioSceneViewExtension ( )

virtual

Destructor for the FST_AudioSceneViewExtension class.

Member Function Documentation

BeginRenderViewFamily()

virtual void FST_AudioSceneViewExtension::BeginRenderViewFamily ( FSceneViewFamily & InViewFamily )

inlineoverridevirtual

Begins the rendering of the view family. This method is called when rendering begins for a view family.

Parameters

InViewFamily

The scene view family to begin rendering.

DisposeAudioIODataBuffer()

void FST_AudioSceneViewExtension::DisposeAudioIODataBuffer

(

)

Disposes of the Audio IO Data Buffer buffer. This method clears any allocated resources related to the Audio IO Data Buffer buffer.

IsActiveThisFrame_Internal()

virtual bool FST_AudioSceneViewExtension::IsActiveThisFrame_Internal ( const FSceneViewExtensionContext & Context ) const

inlineoverridevirtual

Checks if the view extension is active for the current frame. This method determines whether the view extension should be active based on the given context.

Parameters

Context

The context for the current frame's view extension check.

Returns

True if the view extension is active, false otherwise.

PreRenderViewFamily_RenderThread()

void FST_AudioSceneViewExtension::PreRenderViewFamily_RenderThread ( FRDGBuilder & RHICmdList, FSceneViewFamily & InViewFamily )

overridevirtual

Pre-renders the view family using the render thread. This method is called to prepare the rendering of the view family on the render thread.

Parameters

RHICmdList	The render command list used for executing commands.
InViewFamily	The scene view family to pre-render.

SetupView()

virtual void FST_AudioSceneViewExtension::SetupView ( FSceneViewFamily & InViewFamily, FSceneView & InView )

inlineoverridevirtual

Sets up the individual view in the view family. This method allows for custom setup of each view before rendering.

Parameters

InViewFamily	The scene view family to set up.
InView	The individual scene view to set up.

SetupViewFamily()

void FST_AudioSceneViewExtension::SetupViewFamily ( FSceneViewFamily & InViewFamily )

overridevirtual

Sets up the view family for the audio scene. This method is responsible for configuring the view family during the rendering process.

Parameters

InViewFamily

The scene view family to set up.

Friends And Related Symbol Documentation

UST_AudioScene

friend class UST_AudioScene

friend

Friend class that can access private members of this class.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Material/SUB/ST_AudioSceneViewExtension.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Material/SUB/ST_AudioSceneViewExtension.cpp