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::PostProcessFeatureProcessorInterface Class Referenceabstract

Abstract interface for PostProcessFeatureProcessor so it can be access outside of Atom (for example in AtomLyIntegration) More...

#include <PostProcessFeatureProcessorInterface.h>

Inherits AZ::RPI::FeatureProcessor.

Inherited by AZ::Render::PostProcessFeatureProcessor.

Public Member Functions

 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 ()
 

Additional Inherited Members

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

Detailed Description

Abstract interface for PostProcessFeatureProcessor so it can be access outside of Atom (for example in AtomLyIntegration)

Member Function Documentation

◆ GetOrCreateSettingsInterface()

virtual PostProcessSettingsInterface * AZ::Render::PostProcessFeatureProcessorInterface::GetOrCreateSettingsInterface ( EntityId  entityId)
pure virtual

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

Implemented in AZ::Render::PostProcessFeatureProcessor.

◆ GetSettingsInterface()

virtual PostProcessSettingsInterface * AZ::Render::PostProcessFeatureProcessorInterface::GetSettingsInterface ( EntityId  entityId)
pure virtual

Retrieves existing post process settings for corresponding entity ID. If none found, returns nullptr.

Implemented in AZ::Render::PostProcessFeatureProcessor.

◆ OnPostProcessSettingsChanged()

virtual void AZ::Render::PostProcessFeatureProcessorInterface::OnPostProcessSettingsChanged ( )
pure virtual

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

Implemented in AZ::Render::PostProcessFeatureProcessor.

◆ RemoveSettingsInterface()

virtual void AZ::Render::PostProcessFeatureProcessorInterface::RemoveSettingsInterface ( EntityId  entityId)
pure virtual

Removes post process settings for corresponding entity ID.

Implemented in AZ::Render::PostProcessFeatureProcessor.


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