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.
Public Member Functions | List of all members
AZ::Render::RenderDebugFeatureProcessorInterface Class Referenceabstract

#include <RenderDebugFeatureProcessorInterface.h>

Inherits AZ::RPI::FeatureProcessor.

Inherited by AZ::Render::RenderDebugFeatureProcessor.

Public Member Functions

 AZ_RTTI (AZ::Render::RenderDebugFeatureProcessorInterface, "{9774C763-178C-4CE2-99CD-3ABDE12445A4}", AZ::RPI::FeatureProcessor)
 
virtual RenderDebugSettingsInterface * GetSettingsInterface ()=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)
 
Scene * GetParentScene () 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

Interface for the RenderDebugFeatureProcessor, which handles debug render settings for the scene, such as displaying normals to screen or showing only diffuse/specular lighting, etc.

Member Function Documentation

◆ GetSettingsInterface()

virtual RenderDebugSettingsInterface * AZ::Render::RenderDebugFeatureProcessorInterface::GetSettingsInterface ( )
pure virtual

Retrieves existing settings. If none found, returns nullptr.

Implemented in AZ::Render::RenderDebugFeatureProcessor.

◆ OnRenderDebugComponentAdded()

virtual void AZ::Render::RenderDebugFeatureProcessorInterface::OnRenderDebugComponentAdded ( )
pure virtual

Called when a render debug level component is added.

Implemented in AZ::Render::RenderDebugFeatureProcessor.

◆ OnRenderDebugComponentRemoved()

virtual void AZ::Render::RenderDebugFeatureProcessorInterface::OnRenderDebugComponentRemoved ( )
pure virtual

Called when a render debug level component is removed.

Implemented in AZ::Render::RenderDebugFeatureProcessor.

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