Open 3D Engine Atom Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Render::PostProcessFeatureProcessor Class Referencefinal

Feature processor for owning and managing post process settings. More...

#include <PostProcessFeatureProcessor.h>

Inherits AZ::Render::PostProcessFeatureProcessorInterface.

Public Member Functions

 AZ_RTTI (AZ::Render::PostProcessFeatureProcessor, "{A6A8357C-5A34-4297-B4DD-A1FB6556CE3E}", AZ::Render::PostProcessFeatureProcessorInterface)
 
void Activate () override
 FeatureProcessor overrides...
 
void Deactivate () override
 Perform any necessary deactivation.
 
void Simulate (const FeatureProcessor::SimulatePacket &packet) override
 
PostProcessSettingsInterfaceGetSettingsInterface (EntityId entityId) override
 PostProcessFeatureProcessorInterface...
 
PostProcessSettingsInterfaceGetOrCreateSettingsInterface (EntityId entityId) override
 Retrieves existing post process settings for corresponding entity ID. If none found, creates a new instance.
 
void RemoveSettingsInterface (EntityId entityId) override
 Removes post process settings for corresponding entity ID.
 
void OnPostProcessSettingsChanged () override
 Called to notify the feature processor that changes have been made to it's owned post process settings.
 
PostProcessSettingsGetLevelSettingsFromView (AZ::RPI::ViewPtr view)
 
void SetViewAlias (const AZ::RPI::ViewPtr sourceView, const AZ::RPI::ViewPtr targetView)
 
void RemoveViewAlias (const AZ::RPI::ViewPtr sourceView)
 
- Public Member Functions inherited from AZ::Render::PostProcessFeatureProcessorInterface
 AZ_RTTI (AZ::Render::PostProcessFeatureProcessorInterface, "{720EE4B9-78C1-4151-AFEF-13DB5CC500D1}", AZ::RPI::FeatureProcessor)
 
virtual PostProcessSettingsInterfaceGetSettingsInterface (EntityId entityId)=0
 Retrieves existing post process settings for corresponding entity ID. If none found, returns nullptr.
 
virtual PostProcessSettingsInterfaceGetOrCreateSettingsInterface (EntityId entityId)=0
 Retrieves existing post process settings for corresponding entity ID. If none found, creates a new instance.
 
virtual void RemoveSettingsInterface (EntityId entityId)=0
 Removes post process settings for corresponding entity ID.
 
virtual void OnPostProcessSettingsChanged ()=0
 Called to notify the feature processor that changes have been made to it's owned post process settings.
 
- Public Member Functions inherited from AZ::RPI::FeatureProcessor
 AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}")
 
 AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)
 
SceneGetParentScene () const
 
virtual void Activate ()
 Perform any necessary activation and gives access to owning Scene.
 
virtual void Deactivate ()
 Perform any necessary deactivation.
 
virtual void ApplyRenderPipelineChange (RenderPipeline *pipeline)
 
virtual void AddRenderPasses (RenderPipeline *pipeline)
 
virtual void PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr > > &)
 
virtual void Simulate (const SimulatePacket &)
 
virtual void Render (const RenderPacket &)
 
virtual void OnEndCulling (const RenderPacket &)
 
virtual void OnRenderEnd ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RPI::FeatureProcessor
void EnableSceneNotification ()
 
void DisableSceneNotification ()
 

Detailed Description

Feature processor for owning and managing post process settings.

Member Function Documentation

◆ Activate()

void AZ::Render::PostProcessFeatureProcessor::Activate ( )
overridevirtual

FeatureProcessor overrides...

Reimplemented from AZ::RPI::FeatureProcessor.

◆ Deactivate()

void AZ::Render::PostProcessFeatureProcessor::Deactivate ( )
overridevirtual

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ GetOrCreateSettingsInterface()

PostProcessSettingsInterface * AZ::Render::PostProcessFeatureProcessor::GetOrCreateSettingsInterface ( EntityId  entityId)
overridevirtual

Retrieves existing post process settings for corresponding entity ID. If none found, creates a new instance.

Implements AZ::Render::PostProcessFeatureProcessorInterface.

◆ GetSettingsInterface()

PostProcessSettingsInterface * AZ::Render::PostProcessFeatureProcessor::GetSettingsInterface ( EntityId  entityId)
overridevirtual

◆ OnPostProcessSettingsChanged()

void AZ::Render::PostProcessFeatureProcessor::OnPostProcessSettingsChanged ( )
overridevirtual

Called to notify the feature processor that changes have been made to it's owned post process settings.

Implements AZ::Render::PostProcessFeatureProcessorInterface.

◆ RemoveSettingsInterface()

void AZ::Render::PostProcessFeatureProcessor::RemoveSettingsInterface ( EntityId  entityId)
overridevirtual

Removes post process settings for corresponding entity ID.

Implements AZ::Render::PostProcessFeatureProcessorInterface.


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