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::RenderDebugFeatureProcessor Class Referencefinal

Inherits AZ::Render::RenderDebugFeatureProcessorInterface.

Public Member Functions

 AZ_RTTI (AZ::Render::RenderDebugFeatureProcessor, "{1F14912D-43E1-4992-9822-BE8967E59EA3}", AZ::Render::RenderDebugFeatureProcessorInterface)
 
RenderDebugSettingsInterfaceGetSettingsInterface () override
 RenderDebugFeatureProcessorInterface overrides...
 
void OnRenderDebugComponentAdded () override
 Called when a render debug level component is added.
 
void OnRenderDebugComponentRemoved () override
 Called when a render debug level component is removed.
 
void Activate () override
 Perform any necessary activation and gives access to owning Scene.
 
void Deactivate () override
 Perform any necessary deactivation.
 
void Simulate (const RPI::FeatureProcessor::SimulatePacket &packet) override
 
void Render (const RPI::FeatureProcessor::RenderPacket &packet) override
 
- Public Member Functions inherited from AZ::Render::RenderDebugFeatureProcessorInterface
 AZ_RTTI (AZ::Render::RenderDebugFeatureProcessorInterface, "{9774C763-178C-4CE2-99CD-3ABDE12445A4}", AZ::RPI::FeatureProcessor)
 
virtual RenderDebugSettingsInterfaceGetSettingsInterface ()=0
 Retrieves existing settings. If none found, returns nullptr.
 
virtual void OnRenderDebugComponentAdded ()=0
 Called when a render debug level component is added.
 
virtual void OnRenderDebugComponentRemoved ()=0
 Called when a render debug level component is removed.
 
- 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 ()
 

Member Function Documentation

◆ Activate()

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

Perform any necessary activation and gives access to owning Scene.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ Deactivate()

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

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ GetSettingsInterface()

RenderDebugSettingsInterface * AZ::Render::RenderDebugFeatureProcessor::GetSettingsInterface ( )
overridevirtual

◆ OnRenderDebugComponentAdded()

void AZ::Render::RenderDebugFeatureProcessor::OnRenderDebugComponentAdded ( )
overridevirtual

Called when a render debug level component is added.

Implements AZ::Render::RenderDebugFeatureProcessorInterface.

◆ OnRenderDebugComponentRemoved()

void AZ::Render::RenderDebugFeatureProcessor::OnRenderDebugComponentRemoved ( )
overridevirtual

Called when a render debug level component is removed.

Implements AZ::Render::RenderDebugFeatureProcessorInterface.

◆ Render()

void AZ::Render::RenderDebugFeatureProcessor::Render ( const RPI::FeatureProcessor::RenderPacket )
overridevirtual

The feature processor should enqueue draw packets to relevant draw lists.

  • This is called every frame.
  • This may be called in parallel with other feature processors.
  • This may be called in parallel with culling

Reimplemented from AZ::RPI::FeatureProcessor.

◆ Simulate()

void AZ::Render::RenderDebugFeatureProcessor::Simulate ( const RPI::FeatureProcessor::SimulatePacket )
overridevirtual

The feature processor should perform any internal simulation at this point - For instance, updating a particle system or animation. Not every feature processor will need to implement this.

  • This may not be called every frame.
  • This may be called in parallel with other feature processors.

Reimplemented from AZ::RPI::FeatureProcessor.


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